Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document structure refine for our official website #3014

Open
lhw362950217 opened this issue Oct 12, 2020 · 10 comments
Open

Document structure refine for our official website #3014

lhw362950217 opened this issue Oct 12, 2020 · 10 comments

Comments

@lhw362950217
Copy link
Collaborator

lhw362950217 commented Oct 12, 2020 •
edited
Loading

官网文档结构：

  1. 快速开始 / Quick Start (描述体验 SQLFlow Playground的流程，添加指向教程、语法、模型文档的链接)

    1. 云端体验 / Cloud Playground

  2. 部署 / Deployment

    1. 本地快速安装 / Local Try Out
    2. 在Kubernetes集群上部署 / Deploy on Kubernetes Cluster（需介绍如何使用各种数据库）
    3. 高可用部署 / High Availability
    4. 最佳性能部署 / Performance
    5. 连接MySQL、Hive、Maxcompute等多种数据库

  3. 案例教程 / Tutorials：

    1. 泰坦尼克号生存预测
    2. 信用卡欺诈检测
    3. 点击率预估
    4. 汽车价格预测及模型解释
    5. 苹果股价预测（时序特征提取）
    6. 优化问题求解

  4. 语法说明 / Grammar Reference

    1. 训练 / Training
    2. 预测 / Predicting
    3. 模型评估 / Evaluation
    4. 模型解释 / Model Explain
    5. 自定义Runnable / Customized Runnable
    6. 运筹规划

  5. 模型说明 / Model Reference

    1. 有监督学习
      1. Tensorflow Estimator 模型
      2. Tensorflow Keras 模型
      3. XGBoost 模型
      4. GCN 模型
    2. 无监督模型？

  6. 自定义模型

  7. 自定义Runnable

  8. 参与贡献SQLFlow
@typhoonzero
Copy link
Collaborator

  1. 快速开始 / Quick Start
    1. 云端体验 / Cloud Playground
    2. 本地快速安装 / Local Try Out
  2. 部署 / Deployment
    1. 在Kubernetes集群上部署 / Deploy on Kubernetes Cluster
    2. 高可用部署 / High Availability
    3. 最佳性能部署 / Performance
  3. 案例教程 / Tutorials
    1. ...
  4. 语法说明 / Grammar Reference
    1. 训练 / Training
    2. 预测 / Predicting
    3. 模型评估 / Evaluation
    4. 模型解释 / Model Explain
    5. 自定义处理 / Self-defined Runnable
  5. 模型说明
    1. ...
  6. 自定义模型
  7. 自定义处理（名字待讨论）
  8. 参与贡献SQLFlow

设计文档不需要放在官网了应该。用户不太关心，可以只放在Github.

@lhw362950217
Copy link
Collaborator Author

lhw362950217 commented Oct 12, 2020 •
edited
Loading

  1. 快速开始 / Quick Start

    1. 云端体验 / Cloud Playground
    2. 本地快速安装 / Local Try Out

ii 这里是指VM里安装吗？

  1. 部署 / Deployment

    1. 在Kubernetes集群上部署 / Deploy on Kubernetes Cluster
    2. 高可用部署 / High Availability
    3. 最佳性能部署 / Performance

感觉 ii 和 iii 目前没有什么内容好写？

  1. 案例教程 / Tutorials

    1. ...

  2. 语法说明 / Grammar Reference

    1. 训练 / Training
    2. 预测 / Predicting
    3. 模型评估 / Evaluation
    4. 模型解释 / Model Explain
    5. 自定义处理 / Self-defined Runnable

Self-defined -> Customized Runnable ?

  1. 模型说明

    1. ...

  2. 自定义模型

  3. 自定义处理（名字待讨论）

  4. 参与贡献SQLFlow

6,7,8 是否可以放到一个大目录”开发者指南/Developer Guide“下？

设计文档不需要放在官网了应该。用户不太关心，可以只放在Github.

@typhoonzero
Copy link
Collaborator

typhoonzero commented Oct 12, 2020 •
edited
Loading

ii 这里是指VM里安装吗？

是的。

感觉 ii 和 iii 目前没有什么内容好写？

有的。

Self-defined -> Customized Runnable ?

同意。

6,7,8 是否可以放到一个大目录”开发者指南/Developer Guide“下？

不行。开发者指南，顾名思义是开发SQLFlow的指南，很难直接联想到是贡献模型，需要分开。

@sneaxiy
Copy link
Collaborator

sneaxiy commented Oct 12, 2020 •
edited
Loading

“快速开始”里的“部署”是否可以合并在一起呢，比如叫“安装指南”？一般来说，用户希望本地能安装起来，然后再考虑集群安装。而集群部署其实也属于安装的一部分，感觉不太适合单独作为一个章节。

“安装指南”里包含3部分：

  1. 安装指南 / Install Guide
    1. 云端快速体验 / Cloud Playground
    2. 本地快速安装 / Local Try Out
    3. Kubernetes集群安装 / Deployment on Kubernetes Cluster
      1. 高可用部署 / High Availability
      2. 最佳性能部署 / Performance

@sneaxiy
Copy link
Collaborator

sneaxiy commented Oct 12, 2020

  1. 语法说明 / Grammar Reference
    1. 训练 / Training
    2. 预测 / Predicting
    3. 模型评估 / Evaluation
    4. 模型解释 / Model Explain
    5. 自定义处理 / Self-defined Runnable

最后加上“运筹规划”。

@lhw362950217
Copy link
Collaborator Author

lhw362950217 commented Oct 12, 2020 •
edited
Loading

“快速开始”里的“部署”是否可以合并在一起呢，比如叫“安装指南”？一般来说，用户希望本地能安装起来，然后再考虑集群安装。而集群部署其实也属于安装的一部分，感觉不太适合单独作为一个章节。

“安装指南”里包含3部分：

  1. 安装指南 / Install Guide

    1. 云端快速体验 / Cloud Playground

    2. 本地快速安装 / Local Try Out

    3. Kubernetes集群安装 / Deployment on Kubernetes Cluster

      1. 高可用部署 / High Availability
      2. 最佳性能部署 / Performance

快速开始是希望让用户最好不安装就能体验SQLFlow的能力，所以把云端体验放进去了。体验之后如果有兴趣的话可以在本地VM安一个，作为体验或开发的环境。

部署主要是讲线上环境如何部署哈

@sneaxiy
Copy link
Collaborator

sneaxiy commented Oct 12, 2020 •
edited
Loading

“快速开始”里的“部署”是否可以合并在一起呢，比如叫“安装指南”？一般来说，用户希望本地能安装起来，然后再考虑集群安装。而集群部署其实也属于安装的一部分，感觉不太适合单独作为一个章节。
“安装指南”里包含3部分：

  1. 安装指南 / Install Guide

    1. 云端快速体验 / Cloud Playground

    2. 本地快速安装 / Local Try Out

    3. Kubernetes集群安装 / Deployment on Kubernetes Cluster

      1. 高可用部署 / High Availability
      2. 最佳性能部署 / Performance

快速开始是希望让用户最好不安装就能体验SQLFlow的能力，所以把云端体验放进去了。体验之后如果有兴趣的话可以在本地VM安一个，作为体验或开发的环境。

部署主要是讲线上环境如何部署哈

那是否可以考虑下把“快速体验/Quick start”单独作为一个章节，本地安装和集群部署统称为“安装指南/Install Guide”？

@Yancey1989
Copy link
Collaborator

Yancey1989 commented Oct 12, 2020 •
edited
Loading

在Kubernetes集群上部署 / Deploy on Kubernetes Cluster（需介绍如何使用各种数据库）

链接各种数据库是不是可以单独一个章节？不同部署方式和不同数据库应该是正交的。

高可用部署 / High Availability
最佳性能部署 / Performance

最佳性能是指什么性能呢？SQLFlow server 还是作业的性能呢？

@lhw362950217
Copy link
Collaborator Author

在Kubernetes集群上部署 / Deploy on Kubernetes Cluster（需介绍如何使用各种数据库）

链接各种数据库是不是可以单独一个章节？不同部署方式和不同数据库应该是正交的。

Agreed

高可用部署 / High Availability
最佳性能部署 / Performance

最佳性能是指什么性能呢？SQLFlow server 还是作业的性能呢？

指SQLFlow server和作业整体的高性能部署的文档，目前只是站位，还没想好具体内容

@typhoonzero
Copy link
Collaborator

最佳性能是指什么性能呢？SQLFlow server 还是作业的性能呢？

包括SQLFlow 部署需要的怎么和database使用可以达到最佳性能，比如和Hive, MySQL 不能跨机房部署，Kubernetes集群必须有至少几个节点，pod之间网络通信带宽，如果是GPU集群，GPU集群之间的通信带宽等。

This was referenced Oct 16, 2020
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@Yancey1989 @lhw362950217 @typhoonzero @sneaxiy