-
-
-
+
](https://nni.readthedocs.io/)
-* Those who want to **try different AutoML algorithms** in their training code/model.
-* Those who want to run AutoML trial jobs **in different environments** to speed up search.
-* Researchers and data scientists who want to easily **implement and experiment new AutoML algorithms**, may it be: hyperparameter tuning algorithm, neural architect search algorithm or model compression algorithm.
-* ML Platform owners who want to **support AutoML in their platform**.
+NNI automates feature engineering, neural architecture search, hyperparameter tuning, and model compression for deep learning. Find the latest features, API, examples and tutorials in our **[official documentation](https://nni.readthedocs.io/) ([简体中文版点这里](https://nni.readthedocs.io/zh/stable))**.
-## **What's NEW!** 
+## What's NEW!
-* **New release**: [v2.6 is available](https://github.com/microsoft/nni/releases/tag/v2.6) - _released on Jan-19-2022_
-* **New demo available**: [Youtube entry](https://www.youtube.com/channel/UCKcafm6861B2mnYhPbZHavw) | [Bilibili 入口](https://space.bilibili.com/1649051673) - _last updated on May-26-2021_
+* **New release**: [v2.7 is available](https://github.com/microsoft/nni/releases/tag/v2.7) - _released on Apr-18-2022_
+* **New demo available**: [Youtube entry](https://www.youtube.com/channel/UCKcafm6861B2mnYhPbZHavw) | [Bilibili 入口](https://space.bilibili.com/1649051673) - _last updated on Apr-18-2022_
* **New webinar**: [Introducing Retiarii: A deep learning exploratory-training framework on NNI](https://note.microsoft.com/MSR-Webinar-Retiarii-Registration-Live.html) - _scheduled on June-24-2021_
* **New community channel**: [Discussions](https://github.com/microsoft/nni/discussions)
-* **New emoticons release**: [nnSpider](./docs/source/Tutorial/NNSpider.md)
-
- 
-
- 
-
| - | -
- Frameworks & Libraries
- 
- |
-
- Algorithms
-
- |
-
- Training Services
-
- |
-
| - Built-in - | -
-
-
-
- |
-
- Hyperparameter Tuning
-
|
-
-
|
-
| - References - | -
-
|
- - - | -- - | -
+
-* Run the MNIST example.
-
- Linux or macOS
-
- ```bash
- nnictl create --config nni/examples/trials/mnist-pytorch/config.yml
- ```
-
- Windows
-
- ```powershell
- nnictl create --config nni\examples\trials\mnist-pytorch\config_windows.yml
- ```
-
-* Wait for the message `INFO: Successfully started experiment!` in the command line. This message indicates that your experiment has been successfully started. You can explore the experiment using the `Web UI url`.
-
-```text
-INFO: Starting restful server...
-INFO: Successfully started Restful server!
-INFO: Setting local config...
-INFO: Successfully set local config!
-INFO: Starting experiment...
-INFO: Successfully started experiment!
------------------------------------------------------------------------
-The experiment id is egchD4qy
-The Web UI urls are: http://223.255.255.1:8080 http://127.0.0.1:8080
------------------------------------------------------------------------
-
-You can use these commands to get more information about the experiment
------------------------------------------------------------------------
- commands description
-1. nnictl experiment show show the information of experiments
-2. nnictl trial ls list all of trial jobs
-3. nnictl top monitor the status of running experiments
-4. nnictl log stderr show stderr log content
-5. nnictl log stdout show stdout log content
-6. nnictl stop stop an experiment
-7. nnictl trial kill kill a trial job by id
-8. nnictl --help get help information about nnictl
------------------------------------------------------------------------
-```
-
-* Open the `Web UI url` in your browser, you can view detailed information of the experiment and all the submitted trial jobs as shown below. [Here](https://nni.readthedocs.io/en/stable/Tutorial/WebUI.html) are more Web UI pages.
+| + |
+Hyperparameter Tuning
+
+ |
+
+Neural Architecture Search
+
+ |
+
+Model Compression
+
+ |
+
| +Algorithms + | ++ + | +
+
|
++ + | +
| + |
+Supported Frameworks
+
+ |
+
+Training Services
+
+ |
+
+Tutorials
+
+ |
+
| +Supports + | +
+
|
+
+
|
+
+
|
+
-## **Releases and Contributing**
-NNI has a monthly release cycle (major releases). Please let us know if you encounter a bug by [filling an issue](https://github.com/microsoft/nni/issues/new/choose).
-
-We appreciate all contributions. If you are planning to contribute any bug-fixes, please do so without further discussions.
+## Resources
-If you plan to contribute new features, new tuners, new training services, etc. please first open an issue or reuse an exisiting issue, and discuss the feature with us. We will discuss with you on the issue timely or set up conference calls if needed.
+* [NNI Documentation Homepage](https://nni.readthedocs.io/)
+* [NNI Installation Guide](https://nni.readthedocs.io/en/stable/installation.html)
+* [NNI Examples](https://nni.readthedocs.io/en/latest/examples.html)
+* [Python API Reference](https://nni.readthedocs.io/en/latest/reference/python_api.html)
+* [Releases (Change Log)](https://nni.readthedocs.io/en/latest/release.html)
+* [Related Research and Publications](https://nni.readthedocs.io/en/latest/notes/research_publications.html)
+* [Youtube Channel of NNI](https://www.youtube.com/channel/UCKcafm6861B2mnYhPbZHavw)
+* [Bilibili Space of NNI](https://space.bilibili.com/1649051673)
+* [Webinar of Introducing Retiarii: A deep learning exploratory-training framework on NNI](https://note.microsoft.com/MSR-Webinar-Retiarii-Registration-Live.html)
+* [Community Discussions](https://github.com/microsoft/nni/discussions)
-To learn more about making a contribution to NNI, please refer to our [How-to contribution page](https://nni.readthedocs.io/en/stable/contribution.html).
+## Contribution guidelines
-We appreciate all contributions and thank all the contributors!
+If you want to contribute to NNI, be sure to review the [contribution guidelines](https://nni.readthedocs.io/en/stable/notes/contributing.html), which includes instructions of submitting feedbacks, best coding practices, and code of conduct.
-
+
+
-
-
](#nni-released-reminder)
-
-* **最新版本**：[v2.6 已发布](https://github.com/microsoft/nni/releases/tag/v2.6) - *2022年1月19日*
-* **最新视频 demo**：[Youtube 入口](https://www.youtube.com/channel/UCKcafm6861B2mnYhPbZHavw) | [Bilibili 入口](https://space.bilibili.com/1649051673) - *上次更新：2021年5月26日*
-* **最新网络研讨会**: [介绍Retiarii：NNI 上的深度学习探索性训练框架](https://note.microsoft.com/MSR-Webinar-Retiarii-Registration-Live.html) - *2021年6月24日*
-* **最新互动渠道**: [Discussions](https://github.com/microsoft/nni/discussions)
-* **最新粉丝福利表情包上线**： [nnSpider](./docs/en_US/Tutorial/NNSpider.md)
-
-
-
-
-
| - | -
- 支持的框架和库
-
- |
-
- 算法
-
- |
-
- 训练平台
-
- |
-
| - 内置 - | -
-
-
-
- |
-
- 超参调优
-
|
-
-
|
-
| - 参考 - | -
-
|
- - - | -- - | -
-
-## **发布和贡献**
-
-NNI 有一个月度发布周期（主要发布）。 如果您遇到问题可以通过 [创建 issue](https://github.com/microsoft/nni/issues/new/choose) 来报告。
-
-我们感谢所有的贡献。 我们感谢所有的贡献。 如果您计划提供任何 Bug 修复，请放手去做，不需要任何顾虑。
-
-如果您计划提供新的功能、新的 Tuner 和 新的训练平台等， 请先创建一个新的 issue 或重用现有 issue，并与我们讨论该功能。 我们会及时与您讨论这个问题，如有需要会安排电话会议。
-
-再次感谢所有的贡献者！
-
-再次感谢所有的贡献者！
-
-
-
-## **反馈**
-
-* [在 GitHub 上提交问题](https://github.com/microsoft/nni/issues/new/choose)。
-* 在 [Gitter](https://gitter.im/Microsoft/nni?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) 中参与讨论。
-* NNI 有一个月度发布周期（主要发布）。 如果您遇到问题可以通过 [创建 issue](https://github.com/microsoft/nni/issues/new/choose) 来报告。
-
-加入聊天组：
-
-| Gitter | | 微信 |
-| -------------------------------------------------------------------------------------------------------------- | - | ----------------------------------------------------------------------- |
-|  | 或 |  |
-
-## 测试状态
-
-### 必需
-
-| 类型 | 状态 |
-|:------------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
-| Fast test | [](https://msrasrg.visualstudio.com/NNIOpenSource/_build/latest?definitionId=54&branchName=master) |
-| Full linux | [](https://msrasrg.visualstudio.com/NNIOpenSource/_build/latest?definitionId=62&repoName=microsoft%2Fnni&branchName=master) |
-| Full windows | [](https://msrasrg.visualstudio.com/NNIOpenSource/_build/latest?definitionId=63&branchName=master) |
-
-### 训练平台
-
-| 类型 | 状态 |
-|:-------------------------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
-| Remote - linux to linux | [](https://msrasrg.visualstudio.com/NNIOpenSource/_build/latest?definitionId=64&branchName=master) |
-| Remote - linux to windows | [](https://msrasrg.visualstudio.com/NNIOpenSource/_build/latest?definitionId=67&branchName=master) |
-| Remote - windows to linux | [](https://msrasrg.visualstudio.com/NNIOpenSource/_build/latest?definitionId=68&branchName=master) |
-| OpenPAI | [](https://msrasrg.visualstudio.com/NNIOpenSource/_build/latest?definitionId=65&branchName=master) |
-| Frameworkcontroller | [](https://msrasrg.visualstudio.com/NNIOpenSource/_build/latest?definitionId=70&branchName=master) |
-| Kubeflow | [](https://msrasrg.visualstudio.com/NNIOpenSource/_build/latest?definitionId=69&branchName=master) |
-| Hybrid | [](https://msrasrg.visualstudio.com/NNIOpenSource/_build/latest?definitionId=79&branchName=master) |
-| AzureML | [](https://msrasrg.visualstudio.com/NNIOpenSource/_build/latest?definitionId=78&branchName=master) |
-
-## 相关项目
-
-针对开放性和推进最先进的技术，[微软研究院（MSR)](https://www.microsoft.com/en-us/research/group/systems-and-networking-research-group-asia/) 还发布了其他几个开源项目。
-
-* [OpenPAI](https://github.com/Microsoft/pai)：作为开源平台，提供了完整的 AI 模型训练和资源管理能力，能轻松扩展，并支持各种规模的私有部署、云和混合环境。
-* [FrameworkController](https://github.com/Microsoft/frameworkcontroller)：开源的通用 Kubernetes Pod 控制器，通过单个控制器来编排 Kubernetes 上所有类型的应用。
-* [MMdnn](https://github.com/Microsoft/MMdnn)：一个完整、跨框架的解决方案，能够转换、可视化、诊断深度神经网络模型。 MMdnn 中的 "MM" 表示 model management（模型管理），而 "dnn" 是 deep neural network（深度神经网络）的缩写。 MMdnn 中的 "MM" 表示 model management（模型管理），而 "dnn" 是 deep neural network（深度神经网络）的缩写。
-* [SPTAG](https://github.com/Microsoft/SPTAG) : Space Partition Tree And Graph (SPTAG) 是用于大规模向量的最近邻搜索场景的开源库。
-
-我们鼓励研究人员和学生利用这些项目来加速 AI 开发和研究。
-
-## **许可协议**
-
-代码库遵循 [MIT 许可协议](LICENSE)
diff --git a/SECURITY_zh_CN.md b/SECURITY_zh_CN.md
deleted file mode 100644
index bfd7da66aa9b56a490e5590ba3d6503c1a01bf94..0000000000000000000000000000000000000000
--- a/SECURITY_zh_CN.md
+++ /dev/null
@@ -1,41 +0,0 @@
-
-
-## 安全
-
-微软非常重视软件产品和服务的安全性，包括通过我们的 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)的原则。
-
-
diff --git a/dependencies/develop.txt b/dependencies/develop.txt
index 56a4dcadc743eef8ae974a134363cee450d471b9..0e87993cbb72501b803dc9884eca10cc7ed8a615 100644
--- a/dependencies/develop.txt
+++ b/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
diff --git a/dependencies/recommended.txt b/dependencies/recommended.txt
index 572dac3489c01db7aec6c4c4b16e6ff5c85a9211..2459808c5a086b362dfcf9190def67909eb73639 100644
--- a/dependencies/recommended.txt
+++ b/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
diff --git a/dependencies/recommended_gpu.txt b/dependencies/recommended_gpu.txt
index 54f75b0661546d241686f1b2a0c4a27076bbbec8..f9a5b6d8f56262cd76019b59fd2fca90774f5999 100644
--- a/dependencies/recommended_gpu.txt
+++ b/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
diff --git a/dependencies/recommended_legacy.txt b/dependencies/recommended_legacy.txt
index 5c5b39ee61f298fac39ef0c805410bf8dd95105f..da4cacb06f440e9e5aa99bc45ff065fdd2691434 100644
--- a/dependencies/recommended_legacy.txt
+++ b/dependencies/recommended_legacy.txt
@@ -7,6 +7,7 @@ torchvision == 0.8.2+cpu
pytorch-lightning
torchmetrics
+lightgbm
onnx
peewee
graphviz
diff --git a/dependencies/required.txt b/dependencies/required.txt
index 2ce30c9cd9e0aded06f8acab7e3c81df59466bdb..bb8d0cc8b9e2b9fd9b93dcb1652b3864d3dec8d3 100644
--- a/dependencies/required.txt
+++ b/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
diff --git a/docs/.gitignore b/docs/.gitignore
index 20b5bd428820e468305c3bb80a62d8e23fe4843c..522de2ff58d13b94c70e6d3cecd9064ea0a3fd56 100644
--- a/docs/.gitignore
+++ b/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
diff --git a/docs/Makefile b/docs/Makefile
index ba501f6f5b1bfd30093a73f5fc04b85122e604a4..1d14ccfe792908ba28451f100e5d0b16a59c9b3d 100644
--- a/docs/Makefile
+++ b/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
diff --git a/docs/source/Assessor/CurvefittingAssessor.rst b/docs/_removed/CurvefittingAssessor.rst
similarity index 100%
rename from docs/source/Assessor/CurvefittingAssessor.rst
rename to docs/_removed/CurvefittingAssessor.rst
diff --git a/docs/source/Tutorial/HowToDebug.rst b/docs/_removed/HowToDebug.rst
similarity index 100%
rename from docs/source/Tutorial/HowToDebug.rst
rename to docs/_removed/HowToDebug.rst
diff --git a/docs/source/Tutorial/HowToLaunchFromPython.rst b/docs/_removed/HowToLaunchFromPython.rst
similarity index 100%
rename from docs/source/Tutorial/HowToLaunchFromPython.rst
rename to docs/_removed/HowToLaunchFromPython.rst
diff --git a/docs/source/Tutorial/HowToUseDocker.rst b/docs/_removed/HowToUseDocker.rst
similarity index 100%
rename from docs/source/Tutorial/HowToUseDocker.rst
rename to docs/_removed/HowToUseDocker.rst
diff --git a/docs/source/Tutorial/InstallationLinux.rst b/docs/_removed/InstallationLinux.rst
similarity index 100%
rename from docs/source/Tutorial/InstallationLinux.rst
rename to docs/_removed/InstallationLinux.rst
diff --git a/docs/source/Tutorial/InstallationLinux_zh.rst b/docs/_removed/InstallationLinux_zh.rst
similarity index 100%
rename from docs/source/Tutorial/InstallationLinux_zh.rst
rename to docs/_removed/InstallationLinux_zh.rst
diff --git a/docs/source/Tutorial/InstallationWin.rst b/docs/_removed/InstallationWin.rst
similarity index 100%
rename from docs/source/Tutorial/InstallationWin.rst
rename to docs/_removed/InstallationWin.rst
diff --git a/docs/source/Tutorial/InstallationWin_zh.rst b/docs/_removed/InstallationWin_zh.rst
similarity index 100%
rename from docs/source/Tutorial/InstallationWin_zh.rst
rename to docs/_removed/InstallationWin_zh.rst
diff --git a/docs/source/Release_v1.0.md b/docs/_removed/Release_v1.0.md
similarity index 100%
rename from docs/source/Release_v1.0.md
rename to docs/_removed/Release_v1.0.md
diff --git a/docs/source/SupportedFramework_Library.rst b/docs/_removed/SupportedFramework_Library.rst
similarity index 100%
rename from docs/source/SupportedFramework_Library.rst
rename to docs/_removed/SupportedFramework_Library.rst
diff --git a/docs/source/TrainingService/AMLMode.rst b/docs/_removed/TrainingService/AMLMode.rst
similarity index 100%
rename from docs/source/TrainingService/AMLMode.rst
rename to docs/_removed/TrainingService/AMLMode.rst
diff --git a/docs/source/TrainingService/FrameworkControllerMode.rst b/docs/_removed/TrainingService/FrameworkControllerMode.rst
similarity index 100%
rename from docs/source/TrainingService/FrameworkControllerMode.rst
rename to docs/_removed/TrainingService/FrameworkControllerMode.rst
diff --git a/docs/source/TrainingService/HybridMode.rst b/docs/_removed/TrainingService/HybridMode.rst
similarity index 100%
rename from docs/source/TrainingService/HybridMode.rst
rename to docs/_removed/TrainingService/HybridMode.rst
diff --git a/docs/source/TrainingService/KubeflowMode.rst b/docs/_removed/TrainingService/KubeflowMode.rst
similarity index 100%
rename from docs/source/TrainingService/KubeflowMode.rst
rename to docs/_removed/TrainingService/KubeflowMode.rst
diff --git a/docs/source/TrainingService/Overview.rst b/docs/_removed/TrainingService/Overview.rst
similarity index 100%
rename from docs/source/TrainingService/Overview.rst
rename to docs/_removed/TrainingService/Overview.rst
diff --git a/docs/source/TrainingService/PaiMode.rst b/docs/_removed/TrainingService/PaiMode.rst
similarity index 100%
rename from docs/source/TrainingService/PaiMode.rst
rename to docs/_removed/TrainingService/PaiMode.rst
diff --git a/docs/source/TrainingService/RemoteMachineMode.rst b/docs/_removed/TrainingService/RemoteMachineMode.rst
similarity index 100%
rename from docs/source/TrainingService/RemoteMachineMode.rst
rename to docs/_removed/TrainingService/RemoteMachineMode.rst
diff --git a/docs/source/TrialExample/Cifar10Examples.rst b/docs/_removed/TrialExample/Cifar10Examples.rst
similarity index 100%
rename from docs/source/TrialExample/Cifar10Examples.rst
rename to docs/_removed/TrialExample/Cifar10Examples.rst
diff --git a/docs/source/TrialExample/GbdtExample.rst b/docs/_removed/TrialExample/GbdtExample.rst
similarity index 100%
rename from docs/source/TrialExample/GbdtExample.rst
rename to docs/_removed/TrialExample/GbdtExample.rst
diff --git a/docs/source/TrialExample/MnistExamples.rst b/docs/_removed/TrialExample/MnistExamples.rst
similarity index 100%
rename from docs/source/TrialExample/MnistExamples.rst
rename to docs/_removed/TrialExample/MnistExamples.rst
diff --git a/docs/source/TrialExample/Pix2pixExample.rst b/docs/_removed/TrialExample/Pix2pixExample.rst
similarity index 100%
rename from docs/source/TrialExample/Pix2pixExample.rst
rename to docs/_removed/TrialExample/Pix2pixExample.rst
diff --git a/docs/source/TrialExample/SklearnExamples.rst b/docs/_removed/TrialExample/SklearnExamples.rst
similarity index 100%
rename from docs/source/TrialExample/SklearnExamples.rst
rename to docs/_removed/TrialExample/SklearnExamples.rst
diff --git a/docs/source/TrialExample/Trials.rst b/docs/_removed/Trials.rst
similarity index 100%
rename from docs/source/TrialExample/Trials.rst
rename to docs/_removed/Trials.rst
diff --git a/docs/source/Tuner/BohbAdvisor.rst b/docs/_removed/Tuner/BohbAdvisor.rst
similarity index 100%
rename from docs/source/Tuner/BohbAdvisor.rst
rename to docs/_removed/Tuner/BohbAdvisor.rst
diff --git a/docs/source/Tuner/CustomizeAdvisor.rst b/docs/_removed/Tuner/CustomizeAdvisor.rst
similarity index 100%
rename from docs/source/Tuner/CustomizeAdvisor.rst
rename to docs/_removed/Tuner/CustomizeAdvisor.rst
diff --git a/docs/source/Tuner/DngoTuner.rst b/docs/_removed/Tuner/DngoTuner.rst
similarity index 100%
rename from docs/source/Tuner/DngoTuner.rst
rename to docs/_removed/Tuner/DngoTuner.rst
diff --git a/docs/source/Tuner/EvolutionTuner.rst b/docs/_removed/Tuner/EvolutionTuner.rst
similarity index 100%
rename from docs/source/Tuner/EvolutionTuner.rst
rename to docs/_removed/Tuner/EvolutionTuner.rst
diff --git a/docs/source/Tuner/GPTuner.rst b/docs/_removed/Tuner/GPTuner.rst
similarity index 100%
rename from docs/source/Tuner/GPTuner.rst
rename to docs/_removed/Tuner/GPTuner.rst
diff --git a/docs/source/Tuner/HyperbandAdvisor.rst b/docs/_removed/Tuner/HyperbandAdvisor.rst
similarity index 100%
rename from docs/source/Tuner/HyperbandAdvisor.rst
rename to docs/_removed/Tuner/HyperbandAdvisor.rst
diff --git a/docs/source/Tuner/MetisTuner.rst b/docs/_removed/Tuner/MetisTuner.rst
similarity index 100%
rename from docs/source/Tuner/MetisTuner.rst
rename to docs/_removed/Tuner/MetisTuner.rst
diff --git a/docs/source/Tuner/PBTTuner.rst b/docs/_removed/Tuner/PBTTuner.rst
similarity index 100%
rename from docs/source/Tuner/PBTTuner.rst
rename to docs/_removed/Tuner/PBTTuner.rst
diff --git a/docs/source/Tuner/SmacTuner.rst b/docs/_removed/Tuner/SmacTuner.rst
similarity index 100%
rename from docs/source/Tuner/SmacTuner.rst
rename to docs/_removed/Tuner/SmacTuner.rst
diff --git a/docs/source/Tutorial/NNSpider.md b/docs/_removed/Tutorial/NNSpider.md
similarity index 100%
rename from docs/source/Tutorial/NNSpider.md
rename to docs/_removed/Tutorial/NNSpider.md
diff --git a/docs/source/Tutorial/python_api_connect.ipynb b/docs/_removed/Tutorial/python_api_connect.ipynb
similarity index 100%
rename from docs/source/Tutorial/python_api_connect.ipynb
rename to docs/_removed/Tutorial/python_api_connect.ipynb
diff --git a/docs/source/Tutorial/python_api_start.ipynb b/docs/_removed/Tutorial/python_api_start.ipynb
similarity index 100%
rename from docs/source/Tutorial/python_api_start.ipynb
rename to docs/_removed/Tutorial/python_api_start.ipynb
diff --git a/docs/source/Tutorial/WebUI.rst b/docs/_removed/WebUI.rst
similarity index 100%
rename from docs/source/Tutorial/WebUI.rst
rename to docs/_removed/WebUI.rst
diff --git a/docs/source/Tutorial/FAQ.rst b/docs/_removed/faq.rst
similarity index 100%
rename from docs/source/Tutorial/FAQ.rst
rename to docs/_removed/faq.rst
diff --git a/docs/_removed/installation.rst b/docs/_removed/installation.rst
new file mode 100644
index 0000000000000000000000000000000000000000..5688b3b4c832cb889d91e32b11fe1af9e7e9f2d0
--- /dev/null
+++ b/docs/_removed/installation.rst
@@ -0,0 +1,12 @@
+############
+Installation
+############
+
+Currently we support installation on Linux, Mac and Windows. We also allow you to use docker.
+
+.. toctree::
+ :maxdepth: 2
+
+ Linux & Mac {tags}
""" -CARD_TEMPLATE = """ +CARD_HEADER = """ .. raw:: html![](\"../../img/nas-bench-nlp-example1.jpeg\")
\n",
- "\n",
- "\n",
- "arch2 : ![](\"../../img/nas-bench-nlp-example2.jpeg\")
\n",
- "\n"
- ]
- },
- {
- "cell_type": "code",
- "execution_count": 1,
- "metadata": {},
- "outputs": [
- {
- "output_type": "stream",
- "name": "stdout",
- "text": [
- "{'config': {'arch': {'h_new_0_input_0': 'node_3',\n 'h_new_0_input_1': 'node_2',\n 'h_new_0_input_2': 'node_1',\n 'h_new_0_op': 'blend',\n 'node_0_input_0': 'x',\n 'node_0_input_1': 'h_prev_0',\n 'node_0_op': 'linear',\n 'node_1_input_0': 'node_0',\n 'node_1_op': 'activation_tanh',\n 'node_2_input_0': 'h_prev_0',\n 'node_2_input_1': 'node_1',\n 'node_2_input_2': 'x',\n 'node_2_op': 'linear',\n 'node_3_input_0': 'node_2',\n 'node_3_op': 'activation_leaky_relu'},\n 'dataset': 'ptb',\n 'id': 20003},\n 'id': 16291,\n 'test_loss': 4.680262297102549,\n 'train_loss': 4.132040537087838,\n 'training_time': 177.05208373069763,\n 'val_loss': 4.707944253177966}\n"
- ]
- }
- ],
- "source": [
- "import pprint\n",
- "from nni.nas.benchmarks.nlp import query_nlp_trial_stats\n",
- "\n",
- "arch1 = {'h_new_0_input_0': 'node_3', 'h_new_0_input_1': 'node_2', 'h_new_0_input_2': 'node_1', 'h_new_0_op': 'blend', 'node_0_input_0': 'x', 'node_0_input_1': 'h_prev_0', 'node_0_op': 'linear','node_1_input_0': 'node_0', 'node_1_op': 'activation_tanh', 'node_2_input_0': 'h_prev_0', 'node_2_input_1': 'node_1', 'node_2_input_2': 'x', 'node_2_op': 'linear', 'node_3_input_0': 'node_2', 'node_3_op': 'activation_leaky_relu'}\n",
- "for i in query_nlp_trial_stats(arch=arch1, dataset=\"ptb\"):\n",
- " pprint.pprint(i)"
- ]
- },
- {
- "cell_type": "code",
- "execution_count": 6,
- "metadata": {},
- "outputs": [
- {
- "output_type": "stream",
- "name": "stdout",
- "text": [
- "[{'current_epoch': 46,\n 'id': 1796,\n 'test_loss': 6.233430054978619,\n 'train_loss': 6.4866799231542664,\n 'training_time': 146.5680329799652,\n 'val_loss': 6.326836978687959},\n {'current_epoch': 47,\n 'id': 1797,\n 'test_loss': 6.2402057403023825,\n 'train_loss': 6.485401405247535,\n 'training_time': 146.05511450767517,\n 'val_loss': 6.3239741605870865},\n {'current_epoch': 48,\n 'id': 1798,\n 'test_loss': 6.351145308363877,\n 'train_loss': 6.611281181173992,\n 'training_time': 145.8849437236786,\n 'val_loss': 6.436160816865809},\n {'current_epoch': 49,\n 'id': 1799,\n 'test_loss': 6.227155079159031,\n 'train_loss': 6.473414458249545,\n 'training_time': 145.51414465904236,\n 'val_loss': 6.313294354607077}]\n"
- ]
- }
- ],
- "source": [
- "arch2 = {\"h_new_0_input_0\":\"node_0\",\"h_new_0_input_1\":\"node_1\",\"h_new_0_op\":\"elementwise_sum\",\"node_0_input_0\":\"x\",\"node_0_input_1\":\"h_prev_0\",\"node_0_op\":\"linear\",\"node_1_input_0\":\"node_0\",\"node_1_op\":\"activation_tanh\"}\n",
- "for i in query_nlp_trial_stats(arch=arch2, dataset='wikitext-2', include_intermediates=True):\n",
- " pprint.pprint(i['intermediates'][45:49])"
- ]
- },
- {
- "cell_type": "code",
- "execution_count": 4,
- "metadata": {
- "pycharm": {},
- "tags": []
- },
- "outputs": [
- {
- "output_type": "stream",
- "name": "stdout",
- "text": [
- "Elapsed time: 5.60982608795166 seconds\n"
- ]
- }
- ],
- "source": [
- "print('Elapsed time: ', time.time() - ti, 'seconds')"
- ]
- }
- ],
- "metadata": {
- "file_extension": ".py",
- "kernelspec": {
- "display_name": "Python 3",
- "language": "python",
- "name": "python3"
- },
- "language_info": {
- "codemirror_mode": {
- "name": "ipython",
- "version": 3
- },
- "name": "python",
- "version": "3.8.5-final"
- },
- "mimetype": "text/x-python",
- "name": "python",
- "npconvert_exporter": "python",
- "orig_nbformat": 2,
- "pygments_lexer": "ipython3",
- "version": 3
- },
- "nbformat": 4,
- "nbformat_minor": 2
-}
\ No newline at end of file
diff --git a/docs/source/NAS/DARTS.rst b/docs/source/NAS/DARTS.rst
deleted file mode 100644
index 20dfef7ba435109ae19a06f6eba8a6d89937657b..0000000000000000000000000000000000000000
--- a/docs/source/NAS/DARTS.rst
+++ /dev/null
@@ -1,66 +0,0 @@
-DARTS
-=====
-
-Introduction
-------------
-
-The paper `DARTS: Differentiable Architecture Search