Document structure design

[llxxxll]

Document structure design

- The principle of gradual progress.
- Users at different stages of learning can find the corresponding guide.
- Each model should have a corresponding application example.

• Get Started
  • Installation
  • Running a Demo
• SQLFlow Tutorials
  • The 40s: build TensorFlow DNNClassifier model
  • Train model
  • Save model
  • Test model
  • Prediction services(Offline)
  • Application scenarios
    • [DNNClassifier example] The Credit Card Fraud Detection Example
    • [DNNRegressor example]
• Docs
  • Custom Database
    • Parameters
    • Supported Databases
      • the Hive example
      • the MySQL example
  • Data Loading
    • SQL syntax
    • Automatic read columns
  • Extended SQL Syntax
    • TRAIN
    • WITH
    • COLUMN
    • LABEL
    • PREDICT
    • Extended in Development
  • Commit distributed tasks
  • Prediction services and deployment
• Resources
  • Models
• Contributions
  • Build from source code.
  • The walkthrough of the source code
  • The choice of parser generator
  • customized model
  • support for other databases
• Features

[hungry1526]

Current structure

SQLFlow

• Installation
• Design
• Contribute
  GoHive
  PySQLFlow

Proposed structure

SQLFlow

• Introduction
  • What is SQLFlow
  • Motivation
  • Where can I use SQLFlow
• Concepts (specific to SQLFlow)
• Installation
  • Docker Image
  • Build from source
  • Demo/Tutorials
• More examples
  • DNNClassifier
  • DNNRegressor
  • etc…
• Design (Component level details)
  • Submitter, ProducerToConsumer, DB Abstraction layer, Parser, Executer etc…
  • Model
  • GoHive, PySQLFlow, and other connectors
• Roadmap
• Team

Team, please review and comment.

[hungry1526]

@llxxxll any suggestion?

[weiguoz]

Looks good.
What are the Concepts (specific to SQLFlow)? would you plz add more details

[typhoonzero]

Test model -> model validation
Prediction services(Offline) -> batch predict on a data table

[hungry1526]

Looks good.
What are the Concepts (specific to SQLFlow)? would you plz add more details

This part means adding some definitions for some terminologies we use in SQLFlow, e.g. executer, SQLFlow server, RPC server, etc...For sure the less terms we created, the better.

[hungry1526]

Test model -> model validation
Prediction services(Offline) -> batch predict on a data table

Thanks for the review, Any suggestion for the structure I proposed?

[Yancey0623]

I updated the structure following the latest SQLFlow repo:

• Get Started
  • QuickStart, issues/832
  • User Guide, issues/826
  • run SQLFLow command line
• Installation
  • Install SQLFlow using Docker issue/849
  • Install SQLFlow on Cloud
    • GCP
    • AliYun, issues/836
    • Kubernetes
  • run SQLFlow with SQL Engines
    • MySQL [DOC] How to connect MySQL with SQLFlow sqlflow#917
    • Hive via HiveServer2, issues/835
    • MaxCompute, issues/834
• Examples
  • Iris Classification (DNN Classifier)
  • Text Classification (LSTM Classifier)
  • TBD: (Unsupervised ClusterModel )
  • Credit Card Fraud Detection (DNN Classifier), issues/833
  • Boston Housing Price (XGBoost Regression Model)
  • Analyze Tutorial
• Models
  • DNNClassifier
  • LSTMClassifier
  • XGBoost Regression Model
  • XGBoost Classification Model
• Design
  • ALPS Design
  • Analyze Design
  • AntXGBoost Design
  • Auth Design
  • ClusterModel Design
  • Customized Model Design
  • ElasticDL on SQLFlow Design
  • Feature Derivation Design
  • ….
• Contributions
  • Build From Source Code
  • Code Walkthrough
  • Custom Model