byzer-org/byzer-doc

https://docs.byzer.org

Byzer™ Documentation

online docs: https://docs.byzer.org/ powered by docsify

Document Structure

- _images: images for doc sites, not for doc content  
- _media: medias for doc sites
- byzer-notebook: content of byzer notebook docs
    - zh-cn
    - en-us
- byzer-lang: content of byzer-lang docs
    - zh-cn
    - en-us
- public: content of public blogs and shared slide
- index.html
- coverpage.md: the content of index.html

• If you add a new markdown file in byzer-lang or byzer-notebook, please make sure this file has been included in _sidebar.md
• If you want to cite pictures in the document, please create a image folder in the same level directory as the markdown file
• If you want to public a shared slide or blog, please ensure that the material is desensitized

Contributing

Welcome to file an ISSUE or submit a PR when:

• If you find a bug
• If you want to improve
• If you want to post a blog or share a slide

Before you submit a PR, please make sure you have previewed the content in local

How to preview docs in local

• Please make sure that node has been installed in your local machine
• Just fork byzer-doc to your repository
• Clone your repo to your local machine
• Install docsify by npm i docsify-cli -g
• Run cd /path/to/byzer-doc
• Run docsify serve ./

License

Apache License Version 2.0

Contributors

This docment exists thanks to all the people who contribute.

mlsql-docs is the predecessor of Byzer Docments, the contributors are listed below:

Made with contrib.rocks.

Become the member of Byzer Docs User Group

If you want to become a member of byzer orgnization, you will be accepted after you contributed to this org.

If you want to join Byzer Docs User Group, you can contribute the following things or more by:

• Post the blog or shared slides about any Byzer projects
• Write the documentation of Byzer-Lang or Byzer-Notebook
• Translate all the content to English

Then, just file an issue with the tile like Join Byzer Docs User Group

byzer-doc's Issues

show space between chinese and character/number

Add missing documents

As of 22th Dec, some docs are still missing from docs.byzer.org. Here's a list

• https://docs.byzer.org/#/byzer-lang/zh-cn/dl/load_image 基于Java的深度学习框架集成 之 加载图片数据
• https://docs.byzer.org/#/byzer-lang/zh-cn/dl/cifar10 Cifar10 示例
• https://docs.byzer.org/#/byzer-lang/zh-cn/extension/datasource/excel DataSource 插件 Excel
• https://docs.byzer.org/#/byzer-lang/zh-cn/extension/datasource/hbase DataSource 插件 HBase
• https://docs.byzer.org/#/byzer-lang/zh-cn/security/interface_acl/README 安全与权限 接口访问控制
• https://docs.byzer.org/#/byzer-lang/zh-cn/security/data_acl/README 数据访问权限管理
• https://docs.byzer.org/#/byzer-lang/zh-cn/developer/it/integration_test 开发者指南 自动化测试用例开发
• https://docs.byzer.org/#/byzer-lang/zh-cn/developer/api/run_script_api API Byzer Engine Rest API 脚本执行API
• https://docs.byzer.org/#/byzer-lang/zh-cn/developer/api/code_suggest API Byzer Engine Rest API 代码提示API
• https://docs.byzer.org/#/byzer-lang/zh-cn/developer/api/liveness API Byzer Engine Rest API Liveness API
• https://docs.byzer.org/#/byzer-lang/zh-cn/developer/api/readiness API Byzer Engine Rest API Readiness API
• https://docs.byzer.org/#/byzer-lang/zh-cn/developer/tunning/dynamic_resource 开发者指南性能调优
• https://docs.byzer.org/#/byzer-lang/zh-cn/appendix/terms 附录 术语表

If you want to take a task, please leave a message,

Fix typo in python setup doc

should be activate .

Evaluation ET 增加 ROC曲线计算

Evaluation ET增加 KS 曲线计算

The sidebar of doc site can‘t be expand when first load

Need refresh once

[Help Wanted] Need help for translation in English

Hi guys,

如果 Kolo-Lang 和 Byzer Notebook 对你有帮助，或你有兴趣想要贡献自己的一份力量，我们希望得到你的帮助，将中文内容翻译成英文来让非中文的开发者和用户也可以更快地了解和使用 Kolo-Lang 以及 Byzer Notebook。

---

If Kolo-Lang and Byzer Notebook are helpful to you, or if you are interested in contributing your own strength, we hope to get your help to translate Chinese content into English so that non-Chinese developers and users can also learn more quickly understand and use Kolo-Lang and Byzer Notebook.

The community welcomes any kind of contribution

Add section of sql supported and unsupported

As byzer-lang says it's compatible with spark sql，we need to distinguish the difference between spark sql and byzer-lang.

For example, how byzer-lang supports update

缺少 docker 安装 notebook 章节说明

scorecard 写成 markdown 文档

test issue to test the slack connectivity

change the image path instead of hosting in github

Currently we use the code snippet as below to zoom the image

<p align="center">
    <img src="https://raw.githubusercontent.com/byzer-org/byzer-doc/main/kolo-lang/zh-cn/introduction/images/register.png" alt="name"  width="800"/>
</p>

it uses the image absolute path in github.

But in china, the network can not access the githubusercontent, we need to find another way

ET Discretizer doc

#128

Please fix the problem and resubmit the doc

Many pages are not available

404 - Not Found

List:

• https://docs.byzer.org/#/byzer-notebook/zh-cn/what's_new/new_features
• https://docs.byzer.org/#/byzer-notebook/zh-cn/operation/scheduler
• https://docs.byzer.org/#/byzer-notebook/zh-cn/use_case/case_1
• https://docs.byzer.org/#/byzer-notebook/zh-cn/appendix/faq

测试Byzer里的评分卡流程，完成整个链路在Byzer里跑通，并截图到文档里

modify the download site in doc

modify all the download site links from https://mlsql-downloads.kyligence.io to https://download.byzer.org

Byzer-lang 语法手册模块 include 语法中不应该有 kolo 字样

桌面版后缀名需要确定

有太多令人费解的语法, 文档却只字未提

比如说下面这段示例的 st( ) 到底是在做什么事
load mockStream.datasource` options

stepSizeRange="0-3"

and valueFormat="csv"

and valueSchema="st(field(column1,string),field(column2,string),field(column3,string))"

as newkafkatable1;
`

这种非常多见