Skip to content

Dev for the coming MegEngine v1.3 #36

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
Merged
chaimode merged 6 commits into from
Mar 25, 2021
Merged

Dev for the coming MegEngine v1.3 #36

chaimode merged 6 commits into from
Mar 25, 2021

Conversation

@chaimode
Copy link
Contributor

@chaimode chaimode commented Mar 4, 2021 •
edited
Loading

本 MR 请勿在 1.3 发版前合入 main 分支，否则将会影响其它 feature branch 的 CI 流程。

注意⚠️ 如果尝试使用 pip install 得到的 MegEngine v1.2 版本进行文档构建，会出现大量的 API warnings.
这是由于目前的文档组织都是为 MegEngine v1.3 版本服务的，使用 v1.2 版本的用户请参考官网文档。

预览地址：https://megengine-docs.iap.hh-b.brainpp.cn/ （仅内部可见）

@chaimode chaimode changed the title Dev for MegEngine v1.3 Dev for the coming MegEngine v1.3 Mar 4, 2021
@chaimode chaimode marked this pull request as draft March 4, 2021 07:50
@bigeagle
Copy link

bigeagle commented Mar 4, 2021

“观察”和“模拟”感觉不是很贴切
不过我一时也想不出更好的词

@chaimode
Copy link
Contributor Author

chaimode commented Mar 4, 2021

“观察”和“模拟”感觉不是很贴切
不过我一时也想不出更好的词

1.3 发布之前应该会抽时间让相关人员把各自负责的模块的文档给更新一下，量化的术语如何定义更方便交流，感觉可以让高频用户一起想一下 （如果实在不好进行接地气翻译其实也可以选择保留英文...）

This was linked to issues Mar 5, 2021
文档 GitHub CI 部署到第三方服务器方案 #39
Closed
需要补充文档的组织逻辑和 RST 语法 #34
Closed
@chaimode
Copy link
Contributor Author

chaimode commented Mar 5, 2021

由于已有的进阶教程（如量化、分布式等）会对内容进行结构性调整，其中已有的部分超链接/引用会先暂时去掉以避免各种 warnings. 等到文档相关的 Style Guide 出来后再按照统一的标准重新进行添加。

@chaimode chaimode self-assigned this Mar 5, 2021
@chaimode chaimode added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 5, 2021
@chaimode chaimode added this to the v1.3 milestone Mar 5, 2021
@chaimode chaimode linked an issue Mar 5, 2021 that may be closed by this pull request
需要能够在 API 页面显示出构建所用的 Commit ID #40
Closed
@chaimode chaimode force-pushed the dev branch 4 times, most recently from fa29e34 to 05bfc1e Compare March 11, 2021 10:58
@chaimode chaimode force-pushed the dev branch 6 times, most recently from 0d49a2b to 5c21054 Compare March 17, 2021 11:01
@chaimode
Copy link
Contributor Author

chaimode commented Mar 23, 2021

Version switcher has been enabled by 7cb37a2. So the example PR #54 will be closed if this PR was merged.

This was linked to issues Mar 23, 2021
规范社区 Git 贡献流程 #14
Closed
支持按照不同的 commit 临时构建文档，方便预览 #44
Closed
@chaimode chaimode added the no-build Don't build the documentation in CI label Mar 25, 2021
@chaimode chaimode added no-cache no-deploy Config for CI labels Mar 25, 2021
@chaimode chaimode marked this pull request as ready for review March 25, 2021 07:23
@chaimode chaimode merged commit 158421b into main Mar 25, 2021
@chaimode chaimode deleted the dev branch March 25, 2021 07:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@chaimode chaimode

Labels

documentation Improvements or additions to documentation enhancement New feature or request no-build Don't build the documentation in CI no-deploy Config for CI

Projects

None yet

Milestone

v1.3

4 participants

@chaimode @bigeagle @dzy97