Chinese translation (#1936)

049634f7 · Chi Song · GitHub · 71fbff17 · 049634f7 · 049634f7
Unverified Commit 049634f7 authored Jan 23, 2020 by Chi Song Committed by GitHub Jan 23, 2020
10 changed files
--- a/docs/zh_CN/Tutorial/Installation.md
+++ b/docs/zh_CN/Tutorial/Installation.md
 # 安装 NNI
-当前支持在 Linux，Mac 和 Windows 下安装。
+当前支持在 Linux，macOS 和 Windows 下安装。
-## **在 Linux 和 Mac 下安装**
+## 在 Linux 或 macOS 上安装
-* **通过 pip 命令安装 NNI**
+* 通过 pip 命令安装 NNI
-    先决条件：`python >= 3.5`
+    先决条件：`python 64-bit >= 3.5`
    ```bash
    python3 -m pip install --upgrade nni
    ```
-* **通过源代码安装 NNI**
+* 通过源代码安装 NNI
-    先决条件：`python >=3.5`, `git`, `wget`
+    如果对某个或最新版本的代码感兴趣，可通过源代码安装 NNI。
+    先决条件：`python 64-bit >=3.5`, `git`, `wget`
    ```bash
    git clone -b v0.8 https://github.com/Microsoft/nni.git
@@ -22,25 +24,27 @@
    ./install.sh
    ```
-* **在 docker 映像中安装 NNI**
+* 在 Docker 映像中使用 NNI
    也可将 NNI 安装到 docker 映像中。 参考[这里](../deployment/docker/README.md)来生成 NNI 的 Docker 映像。 也可通过此命令从 Docker Hub 中直接拉取 NNI 的映像 `docker pull msranni/nni:latest`。
-## **在 Windows 上安装**
+## 在 Windows 上安装
-推荐使用 Anaconda 或 Miniconda。
+强烈建议使用 Anaconda 或 Miniconda 来管理多个 Python 环境。
-* **通过 pip 命令安装 NNI**
+* 通过 pip 命令安装 NNI
-    先决条件：`python(64-bit) >= 3.5`
+    先决条件：`python 64-bit >= 3.5`
    ```bash
    python -m pip install --upgrade nni
    ```
-* **通过源代码安装 NNI**
+* 通过源代码安装 NNI
+    如果对某个或最新版本的代码感兴趣，可通过源代码安装 NNI。
-    先决条件：`python >=3.5`, `git`, `PowerShell`
+    先决条件：`python 64-bit >=3.5`, `git`, `PowerShell`
    ```bash
    git clone -b v0.8 https://github.com/Microsoft/nni.git
@@ -48,43 +52,104 @@
    powershell -ExecutionPolicy Bypass -file install.ps1
    ```
-## **系统需求**
+## 验证安装
-以下是 NNI 在 Linux 下的最低配置。 由于程序变更，NNI 的最低配置会有所更改。
+以下示例基于 TensorFlow 1.x 。确保运行环境中使用的的是 ** TensorFlow 1.x**。
-|          | 最低配置                                  | 推荐配置                                      |
+* 通过克隆源代码下载示例。
-| -------- | ------------------------------------- | ----------------------------------------- |
-| **操作系统** | Ubuntu 16.04 或以上版本                    | Ubuntu 16.04 或以上版本                        |
+    ```bash
-| **CPU**  | Intel® Core™ i3 或 AMD Phenom™ X3 8650 | Intel® Core™ i5 或 AMD Phenom™ II X3 或更高配置 |
+    git clone -b v1.3 https://github.com/Microsoft/nni.git
-| **GPU**  | NVIDIA® GeForce® GTX 460              | NVIDIA® GeForce® GTX 660 或更高配置            |
+    ```
-| **内存**   | 4 GB                                  | 6 GB                                      |
-| **存储**   | 30 GB 可用的磁盘空间                         |                                           |
+* 运行 MNIST 示例。
-| **网络**   | 宽带连接                                  |                                           |
-| **分辨率**  | 1024 x 768 以上                         |                                           |
+    Linux 或 macOS
-以下是 NNI 在 MacOS 下的最低配置。 由于程序变更，NNI 的最低配置会有所更改。
+    ```bash
+    nnictl create --config nni/examples/trials/mnist-tfv1/config.yml
-|          | 最低配置                                               | 推荐配置                     |
+    ```
-| -------- | -------------------------------------------------- | ------------------------ |
-| **操作系统** | macOS 10.14.1 (最新版本)                               | macOS 10.14.1 (最新版本)     |
+    Windows
-| **CPU**  | Intel® Core™ i5-760 或更高                            | Intel® Core™ i7-4770 或更高 |
-| **GPU**  | NVIDIA® GeForce® GT 750M 或 AMD Radeon™ R9 M290 或更高 | AMD Radeon™ R9 M395X 或更高 |
+    ```bash
-| **内存**   | 4 GB                                               | 8 GB                     |
+    nnictl create --config nni\examples\trials\mnist-tfv1\config_windows.yml
-| **存储**   | 70GB 可用空间及 7200 RPM 硬盘                             | 70GB 可用空间 SSD 硬盘         |
+    ```
-| **网络**   | 宽带连接                                               |                          |
-| **分辨率**  | 1024 x 768 以上                                      |                          |
+* 在命令行中等待输出 `INFO: Successfully started experiment!`。 此消息表明 Experiment 已成功启动。 通过命令行输出的 `Web UI url` 来访问 Experiment 的界面。
-以下是 NNI 在 Windows 上的最低配置，推荐使用 Windows 10 1809 版。 由于程序变更，NNI 的最低配置会有所更改。
+```text
+INFO: Starting restful server...
-|          | 最低配置                                  | 推荐配置                                      |
+INFO: Successfully started Restful server!
-| -------- | ------------------------------------- | ----------------------------------------- |
+INFO: Setting local config...
-| **操作系统** | Windows 10                            | Windows 10                                |
+INFO: Successfully set local config!
-| **CPU**  | Intel® Core™ i3 或 AMD Phenom™ X3 8650 | Intel® Core™ i5 或 AMD Phenom™ II X3 或更高配置 |
+INFO: Starting experiment...
-| **GPU**  | NVIDIA® GeForce® GTX 460              | NVIDIA® GeForce® GTX 660 或更高配置            |
+INFO: Successfully started experiment!
-| **内存**   | 4 GB                                  | 6 GB                                      |
+-----------------------------------------------------------------------
-| **存储**   | 30 GB 可用的磁盘空间                         |                                           |
+The experiment id is egchD4qy
-| **网络**   | 宽带连接                                  |                                           |
+The Web UI urls are: http://223.255.255.1:8080   http://127.0.0.1:8080
-| **分辨率**  | 1024 x 768 以上                         |                                           |
+-----------------------------------------------------------------------
+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
+-----------------------------------------------------------------------
+```
+* 在浏览器中打开 `Web UI url`，可看到下图的 Experiment 详细信息，以及所有的 Trial 任务。 查看[这里](../Tutorial/WebUI.md)的更多页面。
+![概述](../../img/webui_overview_page.png)
+![详细说明](../../img/webui_trialdetail_page.png)
+## 系统需求
+由于程序变更，NNI 的最低配置会有所更改。
+### Linux
+|          | 推荐配置                                      | 最低配置                                  |
+| -------- | ----------------------------------------- | ------------------------------------- |
+| **操作系统** | Ubuntu 16.04 或以上版本                        |                                       |
+| **CPU**  | Intel® Core™ i5 或 AMD Phenom™ II X3 或更高配置 | Intel® Core™ i3 或 AMD Phenom™ X3 8650 |
+| **GPU**  | NVIDIA® GeForce® GTX 660 或更高配置            | NVIDIA® GeForce® GTX 460              |
+| **内存**   | 6 GB                                      | 4 GB                                  |
+| **存储**   | 30 GB 可用的磁盘空间                             |                                       |
+| **网络**   | 宽带连接                                      |                                       |
+| **分辨率**  | 1024 x 768 以上                             |                                       |
+### macOS
+|          | 推荐配置                     | 最低配置                                               |
+| -------- | ------------------------ | -------------------------------------------------- |
+| **操作系统** | macOS 10.14.1 或更高版本      |                                                    |
+| **CPU**  | Intel® Core™ i7-4770 或更高 | Intel® Core™ i5-760 或更高                            |
+| **GPU**  | AMD Radeon™ R9 M395X 或更高 | NVIDIA® GeForce® GT 750M 或 AMD Radeon™ R9 M290 或更高 |
+| **内存**   | 8 GB                     | 4 GB                                               |
+| **存储**   | 70GB 可用空间 SSD 硬盘         | 70GB 可用空间及 7200 RPM 硬盘                             |
+| **网络**   | 宽带连接                     |                                                    |
+| **分辨率**  | 1024 x 768 以上            |                                                    |
+### Windows
+|          | 推荐配置                                      | 最低配置                                  |
+| -------- | ----------------------------------------- | ------------------------------------- |
+| **操作系统** | Windows 10 1809 或更高版本                     |                                       |
+| **CPU**  | Intel® Core™ i5 或 AMD Phenom™ II X3 或更高配置 | Intel® Core™ i3 或 AMD Phenom™ X3 8650 |
+| **GPU**  | NVIDIA® GeForce® GTX 660 或更高配置            | NVIDIA® GeForce® GTX 460              |
+| **内存**   | 6 GB                                      | 4 GB                                  |
+| **存储**   | 30 GB 可用的磁盘空间                             |                                       |
+| **网络**   | 宽带连接                                      |                                       |
+| **分辨率**  | 1024 x 768 以上                             |                                       |
 ## 更多

--- a/docs/zh_CN/Tutorial/Nnictl.md
+++ b/docs/zh_CN/Tutorial/Nnictl.md
@@ -49,6 +49,7 @@ nnictl 支持的命令：
  | --config, -c | True  |     | Experiment 的 YAML 配置文件 |
  | --port, -p   | False |     | RESTful 服务的端口          |
  | --debug, -d  | False |     | 设置为调试模式                |
+  | --watch, -w  | False |     | 启动为监视模式                |
 * 示例
@@ -97,6 +98,7 @@ nnictl 支持的命令：
  | id          | True  |     | 要恢复的 Experiment 标识               |
  | --port, -p  | False |     | 要恢复的 Experiment 使用的 RESTful 服务端口 |
  | --debug, -d | False |     | 设置为调试模式                          |
+  | --watch, -w | False |     | 启动为监视模式                          |
 * 示例

--- a/docs/zh_CN/Tutorial/QuickStart.md
+++ b/docs/zh_CN/Tutorial/QuickStart.md
@@ -2,15 +2,15 @@
 ## 安装
-当前支持 Linux，MacOS 和 Windows，在 Ubuntu 16.04 或更高版本，MacOS 10.14.1 以及 Windows 10.1809 上进行了测试。 在 `python >= 3.5` 的环境中，只需要运行 `pip install` 即可完成安装。
+当前支持 Linux，macOS 和 Windows，在 Ubuntu 16.04 或更高版本，macOS 10.14.1 以及 Windows 10.1809 上进行了测试。 在 `python >= 3.5` 的环境中，只需要运行 `pip install` 即可完成安装。
-#### Linux 和 MacOS
+**Linux 和 macOS**
 ```bash
    python3 -m pip install --upgrade nni
 ```
-#### Windows
+**Windows**
 ```bash
    python -m pip install --upgrade nni
@@ -18,7 +18,7 @@
 注意：
-* 在 Linux 和 MacOS 上，如果要将 NNI 安装到当前用户的 home 目录中，可使用 `--user`，则不需要特殊权限。
+* 在 Linux 和 macOS 上，如果要将 NNI 安装到当前用户的 home 目录中，可使用 `--user`，则不需要特殊权限。
 * 如果遇到如`Segmentation fault` 这样的任何错误请参考[常见问题](FAQ.md)。
 * 参考[安装 NNI](Installation.md)，来了解`系统需求`。
@@ -54,21 +54,22 @@ if __name__ == '__main__':
 NNI 用来帮助超参调优。它的流程如下：
-    输入: 搜索空间, Trial 代码, 配置文件
+```text
-    输出: 一组最佳的超参配置
+输入: 搜索空间, Trial 代码, 配置文件
+输出: 一组最佳的超参配置
-    1: For t = 0, 1, 2, ..., maxTrialNum,
-    2:      hyperparameter = 从搜索空间选择一组参数
+1: For t = 0, 1, 2, ..., maxTrialNum,
-    3:      final result = run_trial_and_evaluate(hyperparameter)
+2:      hyperparameter = 从搜索空间选择一组参数
-    4:      返回最终结果给 NNI
+3:      final result = run_trial_and_evaluate(hyperparameter)
-    5:      If 时间达到上限,
+4:      返回最终结果给 NNI
-    6:          停止实验
+5:      If 时间达到上限,
-    7: return 最好的实验结果
+6:          停止实验
+7: return 最好的实验结果
+```
 如果需要使用 NNI 来自动训练模型，找到最佳超参，需要如下三步：
-**使用 NNI 时的三个步骤**
+**启动 Experiment 的三个步骤**
 **第一步**：定义 JSON 格式的`搜索空间`文件，包括所有需要搜索的超参的`名称`和`分布`（离散和连续值均可）。
@@ -140,7 +141,7 @@ trial:
 上面的代码都已准备好，并保存在 [examples/trials/mnist-tfv1/](https://github.com/Microsoft/nni/tree/master/examples/trials/mnist-tfv1)。
-#### Linux 和 macOS
+**Linux 和 macOS**
 从命令行使用 **config.yml** 文件启动 MNIST Experiment 。
@@ -148,17 +149,17 @@ trial:
    nnictl create --config nni/examples/trials/mnist-tfv1/config.yml
 ```
-#### Windows
+**Windows**
 从命令行使用 **config_windows.yml** 文件启动 MNIST Experiment 。
-**注意**：如果使用 Windows，则需要在 config.yml 文件中，将 `python3` 改为 `python`，或者使用 config_windows.yml 来开始 Experiment。
+注意：如果使用 Windows，则需要在 config.yml 文件中，将 `python3` 改为 `python`，或者使用 config_windows.yml 来开始 Experiment。
 ```bash
    nnictl create --config nni\examples\trials\mnist-tfv1\config_windows.yml
 ```
-注意：**nnictl** 是一个命令行工具，用来控制 NNI Experiment，如启动、停止、继续 Experiment，启动、停止 NNIBoard 等等。 查看[这里](Nnictl.md)，了解 `nnictl` 更多用法。
+注意：`nnictl` 是一个命令行工具，用来控制 NNI Experiment，如启动、停止、继续 Experiment，启动、停止 NNIBoard 等等。 查看[这里](Nnictl.md)，了解 `nnictl` 更多用法。
 在命令行中等待输出 `INFO: Successfully started experiment!`。 此消息表明 Experiment 已成功启动。 期望的输出如下：
@@ -201,7 +202,7 @@ Web 地址为：[IP 地址]:8080
 在浏览器中打开 `Web 界面地址`(即：`[IP 地址]:8080`)，就可以看到 Experiment 的详细信息，以及所有的 Trial 任务。 如果无法打开终端中的 Web 界面链接，可以参考 [FAQ](FAQ.md)。
-#### 查看概要页面
+### 查看概要页面
 点击标签 "Overview"。
@@ -213,7 +214,7 @@ Experiment 相关信息会显示在界面上，配置和搜索空间等。 可
 ![](../../img/QuickStart2.png)
-#### 查看 Trial 详情页面
+### 查看 Trial 详情页面
 点击 "Default Metric" 来查看所有 Trial 的点图。 悬停鼠标来查看默认指标和搜索空间信息。

--- a/docs/zh_CN/conf.py
+++ b/docs/zh_CN/conf.py
@@ -47,6 +47,9 @@ extensions = [
    'sphinx.ext.napoleon',
 ]
+# 添加示例模块
+autodoc_mock_imports = ['apex']
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -72,7 +75,7 @@ language = None
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'Release_v1.0.md']
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = None

--- a/docs/zh_CN/examples.rst
+++ b/docs/zh_CN/examples.rst
@@ -11,3 +11,5 @@
    EvolutionSQuAD<./TrialExample/SquadEvolutionExamples>
    GBDT<./TrialExample/GbdtExample>
    RocksDB <./TrialExample/RocksdbExamples>
+    KD 示例 <./TrialExample/KDExample>
+    EfficientNet <./TrialExample/EfficientNet>
--- a/docs/zh_CN/model_compression.rst
+++ b/docs/zh_CN/model_compression.rst
@@ -18,7 +18,7 @@ NNI 中也内置了一些流程的模型压缩算法。
    概述 <Compressor/Overview>
    Level Pruner <Compressor/Pruner>
    AGP Pruner <Compressor/Pruner>
-    L1Filter Pruner <Compressor/L1FilterPruner>
+    L1Filter Pruner <Compressor/l1filterpruner>
    Slim Pruner <Compressor/SlimPruner>
    Lottery Ticket Pruner <Compressor/LotteryTicketHypothesis>
    FPGM Pruner <Compressor/Pruner>

--- a/docs/zh_CN/nas.rst
+++ b/docs/zh_CN/nas.rst
@@ -22,4 +22,6 @@ NAS 算法
    NAS 接口 <NAS/NasInterface>
    ENAS <NAS/ENAS>
    DARTS <NAS/DARTS>
-    P-DARTS <NAS/Overview>
+    P-DARTS <NAS/PDARTS>
+    SPOS <NAS/SPOS>
+    CDARTS <NAS/CDARTS>
--- a/docs/zh_CN/training_services.rst
+++ b/docs/zh_CN/training_services.rst
@@ -6,5 +6,6 @@ NNI 支持的训练平台介绍
    本机<./TrainingService/LocalMode>
    远程<./TrainingService/RemoteMachineMode>
    OpenPAI<./TrainingService/PaiMode>
+    OpenPAI Yarn 模式<./TrainingService/PaiYarnMode>
    Kubeflow<./TrainingService/KubeflowMode>
    FrameworkController<./TrainingService/FrameworkControllerMode>
--- a/examples/feature_engineering/auto-feature-engineering/README_zh_CN.md
+++ b/examples/feature_engineering/auto-feature-engineering/README_zh_CN.md
-**NNI 中的自动特征工程**  
+ **NNI 中的自动特征工程** ===
-===
-此[示例](https://github.com/SpongebBob/tabular_automl_NNI)在 NNI 中实现了自动特征工程。
+  此[示例](https://github.com/SpongebBob/tabular_automl_NNI)在 NNI 中实现了自动特征工程。
-代码来自于贡献者。 谢谢可爱的贡献者！
+  代码来自于贡献者。 谢谢可爱的贡献者！
-欢迎越来越多的人加入我们！
+ 欢迎越来越多的人加入我们！
\ No newline at end of file
--- a/examples/trials/efficientnet/README_zh_CN.md
+++ b/examples/trials/efficientnet/README_zh_CN.md
-# EfficientNet
+[文档](https://nni.readthedocs.io/en/latest/TrialExample/EfficientNet.html)
\ No newline at end of file
-[EfficientNet: 重新思考卷积神经网络的模型尺度](https://arxiv.org/abs/1905.11946)
-这里提供了：使用遍历搜索为 EfficientNet-B1 找到最佳元组（alpha，beta，gamma）的搜索空间和 Tuner。参考[论文](https://arxiv.org/abs/1905.11946) 3.3。
-## 说明
-1. 设置此目录为当前目录。
-2. 运行 `git clone https://github.com/ultmaster/EfficientNet-PyTorch` 来 clone 修改过的 [EfficientNet-PyTorch](https://github.com/lukemelas/EfficientNet-PyTorch)。 修改尽可能接近原始的 [TensorFlow 版本](https://github.com/tensorflow/tpu/tree/master/models/official/efficientnet) （包括 EMA，标记平滑度等等。）；另外添加了代码从 Tuner 获取参数并回调中间和最终结果。 将其 clone 至 `EfficientNet-PyTorch`；`main.py`，`train_imagenet.sh` 等文件会在配置文件中指定的路径。
-3. 运行 `nnictl create --config config_net.yml` 来找到最好的 EfficientNet-B1。 根据环境来调整训练平台（OpenPAI、本机、远程），batch size。
-在 ImageNet 上的训练，可阅读 `EfficientNet-PyTorch/train_imagenet.sh`。 下载 ImageNet，并参考 [PyTorch 格式](https://pytorch.org/docs/stable/torchvision/datasets.html#imagenet) 来解压，然后将 `/mnt/data/imagenet` 替换为 ImageNet 的路径。 此文件也是如何将 ImageNet 挂载到 OpenPAI 容器的示例。
-## 结果
-下图展示了 acc@1 和 alpha、beta、gamma 之间的关系。
-![](assets/search_result.png)
\ No newline at end of file