Merge pull request #133 from Microsoft/master

update Chinese file path as en_US (microsoft#764)

README.md

@@ -11,7 +11,7 @@
 [![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)
+[简体中文](README_zh_CN.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.

zh_CN/README.md → README_zh_CN.md

@@ -1,35 +1,35 @@
 <p align="center">
-<img src="https://github.com/Microsoft/nni/blob/master/docs/img/nni_logo.png" width="300"/>
+<img src="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)
+[![MIT 许可证](https://img.shields.io/badge/license-MIT-brightgreen.svg)](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)
+[English](README.md)
 
 NNI (Neural Network Intelligence) 是自动机器学习（AutoML）的工具包。 它通过多种调优的算法来搜索最好的神经网络结构和（或）超参，并支持单机、本地多机、云等不同的运行环境。
 
 ### **NNI [v0.5.1](https://github.com/Microsoft/nni/releases) 已发布！**
 
 <p align="center">
-  <a href="#nni-v05-has-been-released"><img src="https://github.com/Microsoft/nni/blob/master/docs/img/overview.svg" /></a>
+  <a href="#nni-v05-has-been-released"><img src="docs/img/overview.svg" /></a>
 </p>
 
 <table>
   <tbody>
     <tr align="center" valign="bottom">
       <td>
         <b>支持的框架</b>
-        <img src="https://github.com/Microsoft/nni/blob/master/docs/img/bar.png"/>
+        <img src="docs/img/bar.png"/>
       </td>
       <td>
         <b>调优算法</b>
-        <img src="https://github.com/Microsoft/nni/blob/master/docs/img/bar.png"/>
+        <img src="docs/img/bar.png"/>
       </td>
       <td>
         <b>训练服务</b>
-        <img src="https://github.com/Microsoft/nni/blob/master/docs/img/bar.png"/>
+        <img src="docs/img/bar.png"/>
       </td>
     </tr>
     <tr/>
@@ -47,33 +47,33 @@ NNI (Neural Network Intelligence) 是自动机器学习（AutoML）的工具包
         </ul>
       </td>
       <td>
-        <a href="docs/Builtin_Tuner.md">Tuner（调参器）</a>
+        <a href="docs/zh_CN/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>
+          <li><a href="docs/zh_CN/Builtin_Tuner.md#TPE">TPE</a></li>
+          <li><a href="docs/zh_CN/Builtin_Tuner.md#Random">Random Search（随机搜索）</a></li>
+          <li><a href="docs/zh_CN/Builtin_Tuner.md#Anneal">Anneal（退火算法）</a></li>
+          <li><a href="docs/zh_CN/Builtin_Tuner.md#Evolution">Naive Evolution（进化算法）</a></li>
+          <li><a href="docs/zh_CN/Builtin_Tuner.md#SMAC">SMAC</a></li>
+          <li><a href="docs/zh_CN/Builtin_Tuner.md#Batch">Batch（批处理）</a></li>
+          <li><a href="docs/zh_CN/Builtin_Tuner.md#Grid">Grid Search（遍历搜索）</a></li>
+          <li><a href="docs/zh_CN/Builtin_Tuner.md#Hyperband">Hyperband</a></li>
+          <li><a href="docs/zh_CN/Builtin_Tuner.md#NetworkMorphism">Network Morphism</a></li>
+          <li><a href="examples/tuners/enas_nni/README_zh_CN.md">ENAS</a></li>
+          <li><a href="docs/zh_CN/Builtin_Tuner.md#NetworkMorphism#MetisTuner">Metis Tuner</a></li>
         </ul> 
-          <a href="docs/Builtin_Assessors.md#assessor">Assessor（评估器）</a> 
+          <a href="docs/zh_CN/Builtin_Assessors.md#assessor">Assessor（评估器）</a> 
         <ul>
-          <li><a href="docs/Builtin_Assessors.md#Medianstop">Median Stop</a></li>
-          <li><a href="docs/Builtin_Assessors.md#Curvefitting">Curve Fitting</a></li>
+          <li><a href="docs/zh_CN/Builtin_Assessors.md#Medianstop">Median Stop</a></li>
+          <li><a href="docs/zh_CN/Builtin_Assessors.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>
+        <li><a href="docs/zh_CN/tutorial_1_CR_exp_local_api.md">本地计算机</a></li>
+        <li><a href="docs/zh_CN/RemoteMachineMode.md">远程计算机</a></li>
+        <li><a href="docs/zh_CN/PAIMode.md">OpenPAI</a></li>
+        <li><a href="docs/zh_CN/KubeflowMode.md">Kubeflow</a></li>
+        <li><a href="docs/zh_CN/FrameworkControllerMode.md">基于 Kubernetes（AKS 等等）的 FrameworkController</a></li>
       </ul>
       </td>
     </tr>
@@ -108,7 +108,7 @@ NNI (Neural Network Intelligence) 是自动机器学习（AutoML）的工具包
 注意：
 
 * 如果需要将 NNI 安装到自己的 home 目录中，可使用 `--user`，这样也不需要任何特殊权限。
-* 如果遇到如`Segmentation fault` 这样的任何错误请参考[常见问题](docs/FAQ.md)。
+* 如果遇到如`Segmentation fault` 这样的任何错误请参考[常见问题](docs/zh_CN/FAQ.md)。
 
 **通过源代码安装**
 
@@ -121,7 +121,7 @@ NNI (Neural Network Intelligence) 是自动机器学习（AutoML）的工具包
     source install.sh   
 ```
 
-参考[安装 NNI](docs/Installation.md) 了解系统需求。
+参考[安装 NNI](docs/zh_CN/Installation.md) 了解系统需求。
 
 **验证安装**
 
@@ -168,7 +168,7 @@ NNI (Neural Network Intelligence) 是自动机器学习（AutoML）的工具包
     -----------------------------------------------------------------------
     
 
-* 在浏览器中打开 `Web UI url`，可看到下图的 Experiment 详细信息，以及所有的 Trial 任务。 查看[这里的](docs/WebUI.md)更多页面示例。
+* 在浏览器中打开 `Web UI url`，可看到下图的 Experiment 详细信息，以及所有的 Trial 任务。 查看[这里的](docs/zh_CN/WebUI.md)更多页面示例。
 
 <table style="border: none">
     <th><img src="./docs/img/webui_overview_page.png" alt="drawing" width="395"/></th>
@@ -177,44 +177,44 @@ NNI (Neural Network Intelligence) 是自动机器学习（AutoML）的工具包
 
 ## **文档**
 
-* [NNI 概述](docs/Overview.md)
-* [快速入门](docs/QuickStart.md)
+* [NNI 概述](docs/zh_CN/Overview.md)
+* [快速入门](docs/zh_CN/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)
+* [安装 NNI](docs/zh_CN/Installation.md)
+* [使用命令行工具 nnictl](docs/zh_CN/NNICTLDOC.md)
+* [使用 NNIBoard](docs/zh_CN/WebUI.md)
+* [如何定义搜索空间](docs/zh_CN/SearchSpaceSpec.md)
+* [如何定义一次 Trial](docs/zh_CN/Trials.md)
+* [如何选择 Tuner、搜索算法](docs/zh_CN/Builtin_Tuner.md)
+* [配置 Experiment](docs/zh_CN/ExperimentConfig.md)
+* [如何使用 Annotation](docs/zh_CN/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](docs/Customize_Assessor.md)
-* [使用进化算法为阅读理解任务找到好模型](examples/trials/ga_squad/README.md)
+* [在本机运行 Experiment (支持多 GPU 卡)](docs/zh_CN/tutorial_1_CR_exp_local_api.md)
+* [在多机上运行 Experiment](docs/zh_CN/RemoteMachineMode.md)
+* [在 OpenPAI 上运行 Experiment](docs/zh_CN/PAIMode.md)
+* [在 Kubeflow 上运行 Experiment。](docs/zh_CN/KubeflowMode.md)
+* [尝试不同的 Tuner](docs/zh_CN/tuners.rst)
+* [尝试不同的 Assessor](docs/zh_CN/assessors.rst)
+* [实现自定义 Tuner](docs/zh_CN/Customize_Tuner.md)
+* [实现自定义 Assessor](docs/zh_CN/Customize_Assessor.md)
+* [使用进化算法为阅读理解任务找到好模型](examples/trials/ga_squad/README_zh_CN.md)
 
 ## **贡献**
 
 欢迎贡献代码或提交建议，可在 [GitHub issues](https://github.com/Microsoft/nni/issues) 跟踪需求和 Bug。
 
 推荐新贡献者从标有 **good first issue** 的简单需求开始。
 
-如要安装 NNI 开发环境，参考： [配置 NNI 开发环境](docs/SetupNNIDeveloperEnvironment.md)。
+如要安装 NNI 开发环境，参考： [配置 NNI 开发环境](docs/zh_CN/SetupNNIDeveloperEnvironment.md)。
 
-在写代码之前，请查看并熟悉 NNI 代码贡献指南：[贡献](docs/CONTRIBUTING.md)。
+在写代码之前，请查看并熟悉 NNI 代码贡献指南：[贡献](docs/zh_CN/CONTRIBUTING.md)。
 
-我们正在编写 [如何调试](docs/HowToDebug.md) 的页面，欢迎提交建议和问题。
+我们正在编写[如何调试](docs/zh_CN/HowToDebug.md) 的页面，欢迎提交建议和问题。
 
 ## **许可协议**
 
-代码库遵循 [MIT 许可协议](https://github.com/Microsoft/nni/blob/master/LICENSE)
+代码库遵循 [MIT 许可协议](LICENSE)

docs/.gitignore

@@ -1 +1 @@
-*/_build
+**/_build

zh_CN/docs/Builtin_Assessors.md → docs/zh_CN/Builtin_Assessors.md

@@ -4,10 +4,15 @@ NNI 提供了先进的调优算法，使用上也很简单。 下面是内置 As
 
 注意：点击 **Assessor 的名称**可跳转到算法的详细描述，点击**用法**可看到 Assessor 的安装要求、建议场景和使用样例等等。
 
-| Assessor                                                                                                                                   | 算法简介                                                                                                                                                                                                                                                     |
-| ------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [Medianstop](https://github.com/Microsoft/nni/blob/master/zh_CN/src/sdk/pynni/nni/medianstop_assessor/README.md) [(用法)](#MedianStop)       | Medianstop 是一个简单的提前终止算法。 如果 Trial X 的在步骤 S 的最好目标值比所有已完成 Trial 的步骤 S 的中位数值明显要低，就会停止运行 Trial X。 [参考论文](https://static.googleusercontent.com/media/research.google.com/en//pubs/archive/46180.pdf)                                                          |
-| [Curvefitting](https://github.com/Microsoft/nni/blob/master/zh_CN/src/sdk/pynni/nni/curvefitting_assessor/README.md) [(用法)](#Curvefitting) | Curve Fitting Assessor 是一个 LPA (learning, predicting, assessing，即学习、预测、评估) 的算法。 如果预测的 Trial X 在 step S 比性能最好的 Trial要差，就会提前终止它。 此算法中采用了 12 种曲线来拟合精度曲线。 [参考论文](http://aad.informatik.uni-freiburg.de/papers/15-IJCAI-Extrapolation_of_Learning_Curves.pdf) |
+当前支持的 Assessor：
+
+* [Medianstop（中位数终止）](medianstopAssessor.md)
+* [Curvefitting（曲线拟合）](curvefittingAssessor.md)
+
+| Assessor                                   | 算法简介                                                                                                                                                                                                                                                      |
+| ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| __Medianstop__ [(用法)](#MedianStop)     | Medianstop 是一个简单的提前终止算法。 如果 Trial X 的在步骤 S 的最好目标值比所有已完成 Trial 的步骤 S 的中位数值明显要低，这个 Trial 就会被提前停止。 [参考论文](https://static.googleusercontent.com/media/research.google.com/en//pubs/archive/46180.pdf)                                                         |
+| __Curvefitting__ [(用法)](#Curvefitting) | Curve Fitting Assessor 是一个 LPA (learning, predicting, assessing，即学习、预测、评估) 的算法。 如果预测的 Trial X 在 step S 比性能最好的 Trial 要差，就会提前终止它。 此算法中采用了 12 种曲线来拟合精度曲线。 [参考论文](http://aad.informatik.uni-freiburg.de/papers/15-IJCAI-Extrapolation_of_Learning_Curves.pdf) |
 
 ## 用法