Skip to content

docs: include application eco system#3697

Merged
tobegit3hub merged 22 commits into4paradigm:mainfrom
Elliezza:docs_update_sidebar
Jan 11, 2024
Merged

docs: include application eco system#3697
tobegit3hub merged 22 commits into4paradigm:mainfrom
Elliezza:docs_update_sidebar

Conversation

@Elliezza
Copy link
Copy Markdown
Collaborator

  • What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

  • What is the current behavior? (You can also link to an open issue here)

  • What is the new behavior (if this is a feature change)?

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 10, 2024
Copy link
Copy Markdown
Collaborator

@tobegit3hub tobegit3hub left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

docs/zh/conf.py Outdated
# include branch that is main or v{X}.{Y}
smv_branch_whitelist = r"^(main|v\d+\.\d+)$"
# smv_branch_whitelist = r"^(main|v\d+\.\d+)$"
smv_branch_whitelist = r"^(docs_update_sidebar)$"
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pls revert, this will break document workflow

docs/en/conf.py Outdated
# include branch that is main or v{X}.{Y}
smv_branch_whitelist = r"^(main|v\d+\.\d+)$"
#smv_branch_whitelist = r"^(main|v\d+\.\d+)$"
smv_branch_whitelist = r"^(docs_update_sidebar)$"
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same

@@ -0,0 +1,257 @@
# 应用指南

OpenMLDB SQL Emulator 是一个[OpenMLDB](https://github.com/4paradigm/OpenMLDB)的轻量级的SQL模拟器,旨在于更加高效方便的开发、调试 OpenMLDB SQL。
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

是一个由社区贡献的OpenMLDB的。。。

- 特征工程和预处理功能:用于自动化特征处理和工程化的工具和功能。
- 离线场景:使用分布式计算,对离线数据进行特征计算并导出机器学习所需的样本文件。同时提供离线样本,离线任务管理功能。
- 在线场景:上线特征服务,使用在线数据提供硬实时的在线特征抽取接口。
- 高级用法-SQL场景:可以执行任意的OpenMLDB SQL语句,在线模式下会请求在线数据库,可进行在线数据的增删改查;离线模式下会提交分布式执行的 SQL,可进行离线探索或样本生成。
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

现在好像叫SQL实验?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

对,改成“SQL实验室”了。

@lumianph
Copy link
Copy Markdown
Collaborator

这个tutorial长相不是tutorial,还是一个说明手册。这里tutorial最好是偏实操性质的,通过一个具体的数据(我们可以提供一些sample数据,更加方便让用户尝试)、场景,用户可以直接跟着上手使用,可以把主要流程实践走一遍,而不是只是把概念介绍一遍

# 使用教程

特征平台支持在线场景和离线场景的使用。基本使用流程如下:
1. 使用任意网页浏览器访问特征平台服务地址 http://127.0.0.1:8888/ 。
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

一定是这个地址?不能远程地址?这个地址怎么来的

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

可以是其他地址,这个要根据可以部署的环境来。

@tobegit3hub tobegit3hub merged commit ea70e9c into 4paradigm:main Jan 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants