add Chinese translation (#661)

microsoft · Jan 31, 2019 · df4f05c · df4f05c
1 parent b38c043
commit df4f05c
Show file tree

Hide file tree

Showing 126 changed files with 6,492 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -11,6 +11,8 @@
 [![Pull Requests](https://img.shields.io/github/issues-pr-raw/Microsoft/nni.svg)](https://github.com/Microsoft/nni/pulls?q=is%3Apr+is%3Aopen)
 [![Version](https://img.shields.io/github/release/Microsoft/nni.svg)](https://github.com/Microsoft/nni/releases) [![Join the chat at https://gitter.im/Microsoft/nni](https://badges.gitter.im/Microsoft/nni.svg)](https://gitter.im/Microsoft/nni?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
+[简体中文](zh_CN/README.md)
+
 NNI (Neural Network Intelligence) is a toolkit to help users run automated machine learning (AutoML) experiments. 
 The tool dispatches and runs trial jobs generated by tuning algorithms to search the best neural architecture and/or hyper-parameters in different environments like local machine, remote servers and cloud.
 

diff --git a/docs/RELEASE.md b/docs/RELEASE.md
@@ -79,8 +79,8 @@
 * [Kubeflow Training service](./KubeflowMode.md)
   * Support tf-operator
   * [Distributed trial example](https://github.com/Microsoft/nni/tree/master/examples/trials/mnist-distributed/dist_mnist.py) on Kubeflow
-* [Grid search tuner](https://github.com/Microsoft/nni/tree/master/src/sdk/pynni/nni/README.md#Grid) 
-* [Hyperband tuner](https://github.com/Microsoft/nni/tree/master/src/sdk/pynni/nni/README.md#Hyperband)
+* [Grid search tuner](Builtin_Tuner.md#GridSearch) 
+* [Hyperband tuner](Builtin_Tuner.md#Hyperband)
 * Support launch NNI experiment on MAC
 * WebUI
   * UI support for hyperband tuner

diff --git a/zh_CN/README.Makefile.md b/zh_CN/README.Makefile.md
@@ -0,0 +1,82 @@
+# Makefile 文件和安装配置
+
+NNI 使用 GNU 来生成和安装。
+
+`Makefile` 提供标准的目标 `生成`、`安装` 和 `卸载`, 以及不同设置的安装对象：
+
+* `easy-install`: 针对非专家用户，自动处理所有内容；
+* `dev-easy-install`: 针对专家用户，自动处理所有内容；
+* `install`: 针对 NNI 普通用户，通过复制文件来安装 NNI;
+* `dev-install`: 针对 NNI 贡献者，通过创建 symlinks 而不是复制文件来安装 NNI;
+* `pip-install`: 针对使用 `setup.py` 安装的情况;
+
+下文会有更详细的介绍。
+
+## 依赖项
+
+NNI 依赖于 Node.js, Yarn, 和 pip 来生成，推荐安装 TypeScript。
+
+NNI 需要 Node.js 以及运行所需要的所有库。 需要的 Node.js 库 (包括 TypeScript) 可以通过 Yarn 来安装， 需要的 Python 库可以通过 setuptools 或者 PIP 来安装。
+
+NNI *用户*可以用 `make install-dependencies` 来安装 Node.js 和 Yarn。 Node.js 会被安装到 NNI 的安装目录，Yarn 会被安装到 `/tmp/nni-yarn`。 安装过程需要 wget。
+
+NNI *开发人员*推荐手工安装 Node.js 和 Yarn。 可浏览相应的官方文档了解安装过程。
+
+## 生成 NNI
+
+当依赖项安装好后，运行 `make` 即可。
+
+## 安装
+
+### 目录层次
+
+NNI 项目主要由两个 Node.js 模块 (`nni_manager`, `webui`) 以及两个 Python 包 (`nni`, `nnictl`) 所组成。
+
+默认情况下，Node.js 模块可以为所有用户安装在 `/usr/share/nni` 目录下，也可为只安装在当前用户的 `~/.local/nni` 目录下。
+
+Python 包使用 setuptools 安装，所以安装路径依赖于 Python 配置。 如果为没有权限的用户安装，并且没有虚拟环境的时候，要加上 `--user` 参数。
+
+此外，`nnictl` 是一个 bash 脚本，会被安装在 `/usr/share/bash-completion/completions` 或 `~/.bash_completion.d` 目录下。
+
+在某些配置情况下，NNI 也会将 Node.js 安装到 `/usr/share/nni` 目录下。
+
+以上所有目录都可以配置。 可参考下一章节。
+
+### 配置
+
+`Makefile` 中可以用环境变量来替换默认设置。
+
+支持的变量如下：
+
+| 名称                 | 说明                             | 普通用户下的默认值                          | root 下的默认值                                      |
+| ------------------ | ------------------------------ | ---------------------------------- | ----------------------------------------------- |
+| `BIN_PATH`         | 执行文件路径                         | `~/.local/bin`                     | `/usr/bin`                                      |
+| `INSTALL_PREFIX`   | Node.js 模块的路径 (最后会加上 `nni`)    | `~/.local`                         | `/usr/share`                                    |
+| `BASH_COMP_SCRIPT` | Bash 自动完成脚本的路径                 | `~/.bash_completion.d/nnictl`      | `/usr/share/bash-completion/completions/nnictl` |
+| `PIP_MODE`         | `python3 setup.py install` 的参数 | 如果 `VIRTUAL_ENV` 没有设置，会加上 `--user` | (无)                                             |
+| `NODE_PATH`        | Node.js 运行时的路径                 | `$INSTALL_PREFIX/nni/node`         | `$INSTALL_PREFIX/nni/node`                      |
+| `YARN_PATH`        | Yarn 的安装路径                     | `/tmp/nni-yarn`                    | `/tmp/nni-yarn`                                 |
+| `NODE`             | Node.js 命令                     | 参考源代码                              | 参考源代码                                           |
+| `YARN`             | Yarn 命令                        | 参考源代码                              | 参考源代码                                           |
+
+注意，这些变量不仅会影响安装路径，也会影响申城的 `nnictl` 和 `nnimanager` 脚本。 如果复制文件的路径和运行时的不一样（例如，创建发行版本包时），需要手工编辑 `nnictl` 和 `nnimanager`。
+
+### 目标
+
+安装目标的流程如下：
+
+| 目标                 | 流程                                               |
+| ------------------ | ------------------------------------------------ |
+| `easy-install`     | 安装依赖项，生成，安装 NNI，并编辑 `~/.bashrc`                  |
+| `dev-easy-install` | 安装依赖项，生成，将 NNI 作为 symlinks 来安装，并编辑 `~/.bashrc`   |
+| `install`          | 安装 Python 包，Node.js 模块，NNI 脚本和样例                 |
+| `dev-install`      | 将 Python 和 Node.js 模块作为 symlinks 安装，然后安装 scripts |
+| `pip-install`      | 安装依赖项，生成，安装 NNI，但不安装 Python 包                    |
+
+## TODO
+
+* `clean` 目标
+* `test` 目标
+* `lint` 目标
+* 每个目标的测试用例
+* 评审变量
diff --git a/zh_CN/README.md b/zh_CN/README.md
@@ -0,0 +1,220 @@
+<p align="center">
+<img src="https://microsoft.github.io/nni/docs/img/nni_logo.png" width="300"/>
+</p>
+
+* * *
+
+[![MIT 许可证](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://github.com/Microsoft/nni/blob/master/LICENSE) [![生成状态](https://msrasrg.visualstudio.com/NNIOpenSource/_apis/build/status/Microsoft.nni)](https://msrasrg.visualstudio.com/NNIOpenSource/_build/latest?definitionId=6) [![问题](https://img.shields.io/github/issues-raw/Microsoft/nni.svg)](https://github.com/Microsoft/nni/issues?q=is%3Aissue+is%3Aopen) [![Bug](https://img.shields.io/github/issues/Microsoft/nni/bug.svg)](https://github.com/Microsoft/nni/issues?q=is%3Aissue+is%3Aopen+label%3Abug) [![拉取请求](https://img.shields.io/github/issues-pr-raw/Microsoft/nni.svg)](https://github.com/Microsoft/nni/pulls?q=is%3Apr+is%3Aopen) [![版本](https://img.shields.io/github/release/Microsoft/nni.svg)](https://github.com/Microsoft/nni/releases) [![进入 https://gitter.im/Microsoft/nni 聊天室提问](https://badges.gitter.im/Microsoft/nni.svg)](https://gitter.im/Microsoft/nni?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+[English](../README.md)
+
+NNI (Neural Network Intelligence) 是自动机器学习（AutoML）的工具包。 它通过多种调优的算法来搜索最好的神经网络结构和（或）超参，并支持单机、本地多机、云等不同的运行环境。
+
+### **NNI [v0.5](https://github.com/Microsoft/nni/releases) 已发布！**
+
+<p align="center">
+  <a href="#nni-v05-has-been-released"><img src="https://microsoft.github.io/nni/docs/img/overview.svg" /></a>
+</p>
+
+<table>
+  <tbody>
+    <tr align="center" valign="bottom">
+      <td>
+        <b>支持的框架</b>
+        <img src="https://user-images.githubusercontent.com/44491713/51381727-e3d0f780-1b4f-11e9-96ab-d26b9198ba65.png"/>
+      </td>
+      <td>
+        <b>调优算法</b>
+        <img src="https://user-images.githubusercontent.com/44491713/51381727-e3d0f780-1b4f-11e9-96ab-d26b9198ba65.png"/>
+      </td>
+      <td>
+        <b>训练服务</b>
+        <img src="https://user-images.githubusercontent.com/44491713/51381727-e3d0f780-1b4f-11e9-96ab-d26b9198ba65.png"/>
+      </td>
+    </tr>
+    <tr/>
+    <tr valign="top">
+      <td>
+        <ul>
+          <li>PyTorch</li>
+          <li>TensorFlow</li>
+          <li>Keras</li>
+          <li>MXNet</li>
+          <li>Caffe2</li>
+          <li>CNTK (Python 语言)</li>
+          <li>Chainer</li>
+          <li>Theano</li>
+        </ul>
+      </td>
+      <td>
+        <a href="docs/Builtin_Tuner.md">Tuner（调参器）</a>
+        <ul>
+          <li><a href="docs/Builtin_Tuner.md#TPE">TPE</a></li>
+          <li><a href="docs/Builtin_Tuner.md#Random">Random Search（随机搜索）</a></li>
+          <li><a href="docs/Builtin_Tuner.md#Anneal">Anneal（退火算法）</a></li>
+          <li><a href="docs/Builtin_Tuner.md#Evolution">Naive Evolution（进化算法）</a></li>
+          <li><a href="docs/Builtin_Tuner.md#SMAC">SMAC</a></li>
+          <li><a href="docs/Builtin_Tuner.md#Batch">Batch（批处理）</a></li>
+          <li><a href="docs/Builtin_Tuner.md#Grid">Grid Search（遍历搜索）</a></li>
+          <li><a href="docs/Builtin_Tuner.md#Hyperband">Hyperband</a></li>
+          <li><a href="docs/Builtin_Tuner.md#NetworkMorphism">Network Morphism</a></li>
+          <li><a href="examples/tuners/enas_nni/README.md">ENAS</a></li>
+          <li><a href="docs/Builtin_Tuner.md#NetworkMorphism#MetisTuner">Metis Tuner</a></li>
+        </ul> 
+          <a href="docs/Builtin_Tuner.md#assessor">Assessor（评估器）</a> 
+        <ul>
+          <li><a href="docs/Builtin_Tuner.md#Medianstop">Median Stop</a></li>
+          <li><a href="docs/Builtin_Tuner.md#Curvefitting">Curve Fitting</a></li>
+        </ul>
+      </td>
+      <td>
+      <ul>
+        <li><a href="docs/tutorial_1_CR_exp_local_api.md">本地计算机</a></li>
+        <li><a href="docs/RemoteMachineMode.md">远程计算机</a></li>
+        <li><a href="docs/PAIMode.md">OpenPAI</a></li>
+        <li><a href="docs/KubeflowMode.md">Kubeflow</a></li>
+        <li><a href="docs/FrameworkControllerMode.md">基于 Kubernetes（AKS 等等）的 FrameworkController</a></li>
+      </ul>
+      </td>
+    </tr>
+  </tbody>
+</table>
+
+## **使用场景**
+
+* 在本地 Trial 不同的自动机器学习算法来训练模型。
+* 在分布式环境中加速自动机器学习（如：远程 GPU 工作站和云服务器）。
+* 定制自动机器学习算法，或比较不同的自动机器学习算法。
+* 在自己的机器学习平台中支持自动机器学习。
+
+## 相关项目
+
+以开发和先进技术为目标，[Microsoft Research (MSR)](https://www.microsoft.com/en-us/research/group/systems-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（深度神经网络）的缩写。 我们鼓励研究人员和学生利用这些项目来加速 AI 开发和研究。
+
+## **安装和验证**
+
+**通过 pip 命令安装**
+
+* 当前支持 Linux 和 MacOS。测试并支持的版本包括：Ubuntu 16.04 及更高版本，MacOS 10.14.1。 在 `python >= 3.5` 的环境中，只需要运行 `pip install` 即可完成安装。 
+
+```bash
+    python3 -m pip install --upgrade nni
+```
+
+注意：
+
+* 如果需要将 NNI 安装到自己的 home 目录中，可使用 `--user`，这样也不需要任何特殊权限。
+* 如果遇到如`Segmentation fault` 这样的任何错误请参考[常见问题](docs/FAQ.md)。
+
+**通过源代码安装**
+
+* 当前支持 Linux（Ubuntu 16.04 及更高版本） 和 MacOS（10.14.1）。 
+* 在 `python >= 3.5` 的环境中运行命令： `git` 和 `wget`，确保安装了这两个组件。
+
+```bash
+    git clone -b v0.5 https://github.com/Microsoft/nni.git
+    cd nni  
+    source install.sh   
+```
+
+参考[安装 NNI](docs/Installation.md) 了解系统需求。
+
+**验证安装**
+
+以下示例 Experiment 依赖于 TensorFlow 。 在运行前确保安装了 **TensorFlow**。
+
+* 通过克隆源代码下载示例。 
+
+```bash
+    git clone -b v0.5 https://github.com/Microsoft/nni.git
+```
+
+* 运行 mnist 示例。
+
+```bash
+    nnictl create --config nni/examples/trials/mnist/config.yml
+```
+
+* 在命令行中等待输出 `INFO: Successfully started experiment!`。 此消息表明 Experiment 已成功启动。 通过命令行输出的 `Web UI url` 来访问 Experiment 的界面。
+
+    ```
+    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
+    -----------------------------------------------------------------------
+    
+
+* 在浏览器中打开 `Web UI url`，可看到下图的 Experiment 详细信息，以及所有的 Trial 任务。 查看[这里的](docs/WebUI.md)更多页面示例。
+
+<table style="border: none">
+    <th><img src="./docs/img/webui_overview_page.png" alt="drawing" width="395"/></th>
+    <th><img src="./docs/img/webui_trialdetail_page.png" alt="drawing" width="410"/></th>
+</table>
+
+## **文档**
+
+* [NNI 概述](docs/Overview.md)
+* [快速入门](docs/QuickStart.md)
+
+## **入门**
+
+* [安装 NNI](docs/Installation.md)
+* [使用命令行工具 nnictl](docs/NNICTLDOC.md)
+* [使用 NNIBoard](docs/WebUI.md)
+* [如何定义搜索空间](docs/SearchSpaceSpec.md)
+* [如何定义一次 Trial](docs/Trials.md)
+* [如何选择 Tuner、搜索算法](docs/Builtin_Tuner.md)
+* [配置 Experiment](docs/ExperimentConfig.md)
+* [如何使用 Annotation](docs/Trials.md#nni-python-annotation)
+
+## **教程**
+
+* [在本机运行 Experiment (支持多 GPU 卡)](docs/tutorial_1_CR_exp_local_api.md)
+* [在多机上运行 Experiment](docs/RemoteMachineMode.md)
+* [在 OpenPAI 上运行 Experiment](docs/PAIMode.md)
+* [在 Kubeflow 上运行 Experiment。](docs/KubeflowMode.md)
+* [尝试不同的 Tuner](docs/tuners.rst)
+* [尝试不同的 Assessor](docs/assessors.rst)
+* [实现自定义 Tuner](docs/Customize_Tuner.md)
+* [实现自定义 Assessor](examples/assessors/README.md)
+* [使用进化算法为阅读理解任务找到好模型](examples/trials/ga_squad/README.md)
+
+## **贡献**
+
+欢迎贡献代码或提交建议，可在 [GitHub issues](https://github.com/Microsoft/nni/issues) 跟踪需求和 Bug。
+
+推荐新贡献者从标有 **good first issue** 的简单需求开始。
+
+如要安装 NNI 开发环境，参考： [配置 NNI 开发环境](docs/SetupNNIDeveloperEnvironment.md)。
+
+在写代码之前，请查看并熟悉 NNI 代码贡献指南：[贡献](docs/CONTRIBUTING.md)。
+
+我们正在编写 [如何调试](docs/HowToDebug.md) 的页面，欢迎提交建议和问题。
+
+## **许可协议**
+
+整个代码库遵循 [MIT 许可协议](https://github.com/Microsoft/nni/blob/master/LICENSE)
diff --git a/zh_CN/deployment/docker/README.md b/zh_CN/deployment/docker/README.md
@@ -0,0 +1,48 @@
+# Dockerfile
+
+## 1. 说明
+
+这是 NNI 项目的 Dockerfile 文件。 其中包含了 NNI 以及多个流行的深度学习框架。 在 `Ubuntu 16.04 LTS` 上进行过测试：
+
+    CUDA 9.0, CuDNN 7.0
+    numpy 1.14.3,scipy 1.1.0
+    TensorFlow 1.10.0
+    Keras 2.1.6
+    PyTorch 0.4.1
+    scikit-learn 0.20.0
+    pandas 0.23.4
+    lightgbm 2.2.2
+    NNI v0.5
+
+
+此 Dockerfile 可作为定制的参考。
+
+## 2.如何生成和运行
+
+**使用 `nni/deployment/docker` 的下列命令来生成 docker 映像。**
+
+        docker build -t nni/nni .
+
+
+**运行 docker 映像**
+
+* 如果 docker 容器中没有 GPU，运行下面的命令
+
+        docker run -it nni/nni
+
+
+* 如果 docker 容器中有 GPU，确保安装了 [NVIDIA 容器运行包](https://github.com/NVIDIA/nvidia-docker)，然后运行下面的命令
+
+        nvidia-docker run -it nni/nni
+
+
+或者
+
+        docker run --runtime=nvidia -it nni/nni
+
+
+## 3.拉取 docker 映像
+
+使用下列命令从 docker Hub 中拉取 NNI docker 映像。
+
+    docker pull msranni/nni:latest