Resolve conflicts for #4760 (#4762)

.gitignore

@@ -13,6 +13,9 @@
 /test/ut/retiarii/_debug_graph_data.json
 /test/ut/retiarii/out.tmp
 
+# example generated files
+/nni_assets/**/data/
+
 # Logs
 logs
 *.log

CONTRIBUTING.md

-# Contributing to NNI
-
-Welcome, and thank you for your interest in contributing to NNI!
-
-There are many ways in which you can contribute, beyond writing code. The goal of this document is to provide a high-level overview of how you can get involved.
-
-# Provide feedback or ask a question
-
-* [File an issue](https://github.com/microsoft/nni/issues/new/choose) on GitHub.
-* Ask a question with NNI tags on [Stack Overflow](https://stackoverflow.com/questions/tagged/nni?sort=Newest&edited=true).
-* Discuss on the NNI [Gitter](https://gitter.im/Microsoft/nni?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) in NNI.
-
-Join IM discussion groups:
-|Gitter||WeChat|
-|----|----|----|
-|![image](https://user-images.githubusercontent.com/39592018/80665738-e0574a80-8acc-11ea-91bc-0836dc4cbf89.png)| OR |![image](https://github.com/scarlett2018/nniutil/raw/master/wechat.png)|
-
-
-# Look for an existing issue
-Before you create a new issue, please do a search in [open issues](https://github.com/microsoft/nni/issues) to see if the issue or feature request has already been filed.
-
-Be sure to scan through the [most popular](https://github.com/microsoft/nni/issues?q=is%3Aopen+is%3Aissue+label%3AFAQ+sort%3Areactions-%2B1-desc) feature requests.
-
-If you find your issue already exists, make relevant comments and add your [reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments). Use a reaction in place of a "+1" comment:
-
-* 👍 - upvote
-* 👎 - downvote
-
-If you cannot find an existing issue that describes your bug or feature, create a new issue using the guidelines below.
-
-# Writing good bug reports or feature requests
-File a single issue per problem and feature request. Do not enumerate multiple bugs or feature requests in the same issue.
-
-Provide as much information as you think might relevant to the context (thinking the issue is assigning to you, what kinds of info you will need to debug it!!!). To give you a general idea about what kinds of info are useful for developers to dig out the issue, we had provided issue template for you.
-
-Once you had submitted an issue, be sure to follow it for questions and discussions. 
-
-Once the bug is fixed or feature is addressed, be sure to close the issue.
-
-# Contributing fixes or examples
-
-This project welcomes contributions and suggestions. Most contributions require you to agree to a
-Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
-the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
-
-When you submit a pull request, a CLA bot will automatically determine whether you need to provide
-a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
-provided by the bot. You will only need to do this once across all repos using our CLA.
-
-# Code of Conduct
-
-This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
-For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
-contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
-
-# How to Contribute
-
-After getting familiar with contribution agreements, you are ready to create your first PR =), follow the NNI developer tutorials to get start:
-
-* We recommend new contributors to start with simple issues: ['good first issue'](https://github.com/Microsoft/nni/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) or ['help-wanted'](https://github.com/microsoft/nni/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22).
-* [NNI developer environment installation tutorial](docs/en_US/Tutorial/SetupNniDeveloperEnvironment.rst)
-* [How to debug](docs/en_US/Tutorial/HowToDebug.rst)
-* If you have any questions on usage, review [FAQ](https://github.com/microsoft/nni/blob/master/docs/en_US/Tutorial/FAQ.rst) first, if there are no relevant issues and answers to your question, try contact NNI dev team and users in [Gitter](https://gitter.im/Microsoft/nni?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) or [File an issue](https://github.com/microsoft/nni/issues/new/choose) on GitHub.
-* [Customize your own Tuner](docs/en_US/Tuner/CustomizeTuner.rst)
-* [Implement customized TrainingService](docs/en_US/TrainingService/HowToImplementTrainingService.rst)
-* [Implement a new NAS trainer on NNI](docs/en_US/NAS/Advanced.rst)
-* [Customize your own Advisor](docs/en_US/Tuner/CustomizeAdvisor.rst)
-

CONTRIBUTING_zh_CN.md

-# 贡献代码
-
-非常感谢您有兴趣对 NNI 做出贡献！
-
-除了编写代码外，您还可以通过多种方式参与， 本文档的目的是提供一个如何参与贡献的高层次概述。
-
-# 反馈或提问
-
-* 在 Github 上创建 [issue](https://github.com/microsoft/nni/issues/new/choose)。
-* 在 [Stack Overflow](https://stackoverflow.com/questions/tagged/nni?sort=Newest&edited=true) 上使用 nni 标签提问。
-* 在 [Gitter](https://gitter.im/Microsoft/nni?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) 中参与讨论。
-
-加入聊天组：
-| Gitter                                                                                                         |   | 微信                                                                      |
-| -------------------------------------------------------------------------------------------------------------- | - | ----------------------------------------------------------------------- |
-| ![image](https://user-images.githubusercontent.com/39592018/80665738-e0574a80-8acc-11ea-91bc-0836dc4cbf89.png) | 或 | ![image](https://github.com/scarlett2018/nniutil/raw/master/wechat.png) |
-
-
-# 查找现有问题
-在创建新 issue 之前，请在 [open issues](https://github.com/microsoft/nni/issues) 中进行搜索，以查看问题或功能请求是否已经存在。
-
-确保已经浏览了 [最热门](https://github.com/microsoft/nni/issues?q=is%3Aopen+is%3Aissue+label%3AFAQ+sort%3Areactions-%2B1-desc) 的功能请求。
-
-如果您的问题已经存在，请在下方发表评论或添加[回应](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments)。 通过回应来代替“+1”评论：
-
-* 👍 - 赞成
-* 👎 - 反对
-
-如果未能找到描述您 Bug 或功能的现有问题，请使用以下指南创建一个新问题。
-
-# 编写良好的错误报告或功能请求
-针对每个错误和功能请求提交一个问题， 不要在同一问题中列举多个 Bug 或功能请求。
-
-尽可能多地提供您认为与上下文相关的信息（思考问题如果分配给您，您需要什么样的信息来调试它）。 为了让您大致了解哪些信息对开发人员解决问题有帮助，我们为您提供了问题模板。
-
-提交问题后，请务必跟进问题并参与讨论。
-
-修正 Bug 或实现功能后，请务必关闭此问题。
-
-# 贡献修复或示例
-
-此项目欢迎任何贡献和建议。 大多数贡献需要您同意参与者许可协议（CLA），来声明您有权并授予我们使用您贡献的权利。 有关详细信息，请访问 https://cla.opensource.microsoft.com。
-
-当你提交拉取请求时，CLA 机器人会自动检查你是否需要提供 CLA，并修饰这个拉取请求（例如标签、注释等）。 只需要按照机器人提供的说明进行操作即可。 CLA 只需要同意一次，就能应用到所有的代码仓库上。
-
-# 行为准则
-
-该项目采用了 [ Microsoft 开源行为准则 ](https://opensource.microsoft.com/codeofconduct/)。 有关详细信息，请参阅[行为守则常见问题解答](https://opensource.microsoft.com/codeofconduct/faq/)或联系 opencode@microsoft.com 咨询问题或评论。
-
-# 参与贡献
-
-熟悉贡献协议后，即可按照 NNI 开发人员教程，创建第一个 PR =)：
-
-* 推荐新贡献者先从简单的问题开始：['good first issue'](https://github.com/Microsoft/nni/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) 或 ['help-wanted'](https://github.com/microsoft/nni/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)。
-* [NNI 开发环境安装教程](docs/zh_CN/Tutorial/SetupNniDeveloperEnvironment.rst)
-* [如何调试](docs/zh_CN/Tutorial/HowToDebug.rst)
-* 如果有使用上的问题，可先查看[常见问题解答](https://github.com/microsoft/nni/blob/master/docs/zh_CN/Tutorial/FAQ.rst)。如果没能解决问题，可通过 [Gitter](https://gitter.im/Microsoft/nni?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) 联系 NNI 开发团队或在 GitHub 上 [报告问题](https://github.com/microsoft/nni/issues/new/choose)。
-* [自定义 Tuner](docs/zh_CN/Tuner/CustomizeTuner.rst)
-* [实现定制的训练平台](docs/zh_CN/TrainingService/HowToImplementTrainingService.rst)
-* [在 NNI 上实现新的 NAS Trainer](docs/zh_CN/NAS/Advanced.rst)
-* [自定义 Advisor](docs/zh_CN/Tuner/CustomizeAdvisor.rst)
-

SECURITY_zh_CN.md

-<!-- BEGIN MICROSOFT SECURITY.MD V0.0.5 BLOCK -->
-
-## 安全
-
-微软非常重视软件产品和服务的安全性，包括通过我们的 GitHub 组织管理的所有源代码库，其中涵盖 [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin)，和 [我们 GitHub 的组织](https://opensource.microsoft.com/)。
-
-如果你在任何微软拥有的资源库中发现了安全漏洞，并且符合 [微软对安全漏洞的定义](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10))，请按照下文所述向我们报告。
-
-## 报告安全问题
-
-**请不要通过公开的 GitHub 问题报告安全漏洞。**
-
-相反，请向微软安全响应中心（MSRC）报告，链接是 [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report)。
-
-如果您希望在不登录的情况下提交，请发送电子邮件至 [secure@microsoft.com](mailto:secure@microsoft.com)。  如果可能的话，请用我们的 PGP 密钥对您的信息进行加密；请从以下网站下载该密钥 [微软安全响应中心 PGP 密钥页面](https://www.microsoft.com/en-us/msrc/pgp-key-msrc)。
-
-你应该在24小时内收到回复。 如果由于某些原因你没有收到，请通过电子邮件跟进，以确保我们收到你的原始信息。 其他信息可以在以下网站找到 [microsoft.com/msrc](https://www.microsoft.com/msrc)。
-
-请包括以下所要求的信息（尽可能多地提供），以帮助我们更好地了解可能的问题的性质和范围。
-
-  * 问题类型（如缓冲区溢出、SQL 注入、跨站脚本等）
-  * 与问题表现有关的源文件的完整路径
-  * 受影响的源代码位置（标签/分支/提交或 URL）
-  * 重现该问题所需的任何特殊配置
-  * 重现该问题的分步骤说明
-  * 概念证明或漏洞代码（如果可能的话）
-  * 该问题的影响，包括攻击者如何利用该问题
-
-这些信息将帮助我们更快地对你的报告进行分流。
-
-如果您需要报告错误赏金，更完整的报告可有助于获得更高的赏金奖励。 请访问我们的[微软漏洞赏金计划](https://microsoft.com/msrc/bounty)页面，以了解有关我们活动计划的更多详细信息。
-
-## 首选语言
-
-我们希望所有的交流都是用英语进行的。
-
-## 政策
-
-微软遵循[协调漏洞披露](https://www.microsoft.com/en-us/msrc/cvd)的原则。
-
-<!-- END MICROSOFT SECURITY.MD BLOCK -->

dependencies/develop.txt

@@ -2,15 +2,20 @@ coverage
 cython
 flake8
 ipython
-jupyterlab
+jupyter
+jupyterlab == 3.0.9
 nbsphinx
 pylint
+pyright
 pytest
 pytest-azurepipelines
 pytest-cov
 rstcheck
-sphinx
+sphinx >= 4.5
 sphinx-argparse-nni >= 0.4.0
+sphinx-copybutton
 sphinx-gallery
+sphinx-intl
+sphinx-tabs
 sphinxcontrib-bibtex
-git+https://github.com/bashtage/sphinx-material.git
+git+https://github.com/bashtage/sphinx-material@6e0ef82#egg=sphinx_material

dependencies/recommended.txt

@@ -7,8 +7,9 @@ torch == 1.10.0+cpu ; sys_platform != "darwin"
 torch == 1.10.0 ; sys_platform == "darwin"
 torchvision == 0.11.1+cpu ; sys_platform != "darwin"
 torchvision == 0.11.1 ; sys_platform == "darwin"
-pytorch-lightning >= 1.5.0
+pytorch-lightning >= 1.5.0, < 1.6.0
 torchmetrics
+lightgbm
 onnx
 peewee
 graphviz

dependencies/recommended_gpu.txt

@@ -4,7 +4,8 @@
 tensorflow
 torch == 1.10.0+cu111
 torchvision == 0.11.1+cu111
-pytorch-lightning >= 1.5.0
+pytorch-lightning >= 1.5.0, < 1.6.0
+lightgbm
 onnx
 peewee
 graphviz

dependencies/recommended_legacy.txt

@@ -7,6 +7,7 @@ torchvision == 0.8.2+cpu
 pytorch-lightning
 torchmetrics
 
+lightgbm
 onnx
 peewee
 graphviz

dependencies/required.txt

@@ -6,6 +6,7 @@ hyperopt == 0.1.2
 json_tricks >= 3.15.5
 numpy < 1.22 ; python_version < "3.8"
 numpy ; python_version >= "3.8"
+packaging
 pandas
 prettytable
 psutil
@@ -18,5 +19,5 @@ scikit-learn >= 0.24.1
 scipy < 1.8 ; python_version < "3.8"
 scipy ; python_version >= "3.8"
 typeguard
-typing_extensions ; python_version < "3.8"
+typing_extensions >= 4.0.0 ; python_version < "3.8"
 websockets >= 10.1

docs/.gitignore

@@ -2,3 +2,12 @@ build/
 
 # legacy build
 _build/
+
+# ignored copied rst in tutorials
+/source/tutorials/**/cp_*.rst
+
+# auto-generated reference table
+_modules/
+
+# Machine-style translation files
+*.mo

docs/Makefile

@@ -11,6 +11,11 @@ BUILDDIR      = build
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
+# Build message catelogs for translation
+i18n:
+	@$(SPHINXBUILD) -M getpartialtext "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	sphinx-intl update -p "$(BUILDDIR)/getpartialtext" -d "$(SOURCEDIR)/locales" -l zh
+
 .PHONY: help Makefile
 
 # Catch-all target: route all unknown targets to Sphinx using the new