Merge pull request #189 from microsoft/master

merge master

docs/zh_CN/Contributing.md

@@ -46,7 +46,7 @@
 
 ## 文档
 
-文档使用了 [sphinx](http://sphinx-doc.org/) 来生成，支持 [Markdown](https://guides.github.com/features/mastering-markdown/) 和 [reStructuredText](http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html) 格式。 所有文档都在 <docs> 目录下。
+文档使用了 [sphinx](http://sphinx-doc.org/) 来生成，支持 [Markdown](https://guides.github.com/features/mastering-markdown/) 和 [reStructuredText](http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html) 格式。 所有文档都在 [docs/zh_CN](docs) 目录下。
 
 * 在提交文档改动前，请先**在本地生成文档**：`cd docs/zh_CN && make html`，然后，可以在 `docs/zh_CN/_build/html` 目录下找到所有生成的网页。 请认真分析生成日志中的**每个 WARNING**，这非常有可能是或**空连接**或其它问题。
 

docs/zh_CN/CustomizeTuner.md

@@ -31,7 +31,7 @@ class CustomizedTuner(Tuner):
     def __init__(self, ...):
         ...
 
-    def receive_trial_result(self, parameter_id, parameters, value):
+    def receive_trial_result(self, parameter_id, parameters, value, **kwargs):
     '''
     接收 Trial 的最终结果。
     parameter_id: int
@@ -41,7 +41,7 @@ class CustomizedTuner(Tuner):
     # 实现代码
     ...
 
-    def generate_parameters(self, parameter_id):
+    def generate_parameters(self, parameter_id, **kwargs):
     '''
     返回 Trial 的超参组合的序列化对象
     parameter_id: int
@@ -51,14 +51,14 @@ class CustomizedTuner(Tuner):
     ...
 ```
 
-`receive_trial_result` 从输入中会接收 `parameter_id, parameters, value` 参数。 Tuner 会收到 Trial 进程发送的完全一样的 `value` 值。
+`receive_trial_result` 从输入中会接收 `parameter_id, parameters, value` 参数。 Tuner 会收到 Trial 进程发送的完全一样的 `value` 值。 如果在 Experiment 配置文件里 `multiPhase` 为 `true`， 会有一个附加的 `trial_job_id` 在 `**kwargs` 参数中返回给 `receive_trial_result` 和 `generate_parameters`。
 
 `generate_parameters` 函数返回的 `your_parameters`，会被 NNI SDK 打包为 json。 然后 SDK 会将 json 对象解包给 Trial 进程。因此，Trial 进程会收到来自 Tuner 的完全相同的 `your_parameters`。
 
 例如： 如下实现了 `generate_parameters`：
 
 ```python
-def generate_parameters(self, parameter_id):
+def generate_parameters(self, parameter_id, **kwargs):
     '''
     返回 Trial 的超参组合的序列化对象
     parameter_id: int

docs/zh_CN/ExperimentConfig.md

@@ -2,10 +2,10 @@
 
 创建 Experiment 时，需要给 nnictl 命令提供配置文件的路径。 配置文件是 YAML 格式，需要保证其格式正确。 本文介绍了配置文件的内容，并提供了一些示例和模板。
 
-- [Experiment（实验）配置参考](#experiment-config-reference) 
-  - [模板](#template)
-  - [说明](#configuration-spec)
-  - [样例](#examples)
+- [Experiment（实验）配置参考](#Experiment-config-reference) 
+  - [模板](#Template)
+  - [说明](#Configuration-spec)
+  - [样例](#Examples)
 
 <a name="Template"></a>
 
@@ -128,14 +128,17 @@ machineList:
   
   - 说明
     
-    **authorName** 是创建 Experiment 的作者。 待定: 增加默认值
+    **authorName** 是创建 Experiment 的作者。
+    
+    待定: 增加默认值
 
 - **experimentName**
   
   - 说明
     
-    **experimentName** 是 Experiment 的名称。  
-    待实现：增加默认值
+    **experimentName** 是创建的 Experiment 的名称。
+    
+    待定: 增加默认值
 
 - **trialConcurrency**
   
@@ -153,11 +156,17 @@ machineList:
     
     注意：maxExecDuration 设置的是 Experiment 执行的时间，不是 Trial 的。 如果 Experiment 达到了设置的最大时间，Experiment 不会停止，但不会再启动新的 Trial 作业。
 
+- **versionCheck**
+  
+  - 说明
+    
+    NNI 会校验 remote, pai 和 Kubernetes 模式下 NNIManager 与 trialKeeper 进程的版本。 如果需要禁用版本校验，versionCheck 应设置为 false。
+
 - **debug**
   
   - 说明
     
-    NNI 会校验 remote, pai 和 Kubernetes 模式下 NNIManager 与 trialKeeper 进程的版本。 如果需要禁用版本校验，debug 应设置为 true。
+    调试模式会将 versionCheck 设置为 False，并将 logLevel 设置为 'debug'。
 
 - **maxTrialNum**
   
@@ -171,7 +180,7 @@ machineList:
     
     **trainingServicePlatform** 定义运行 Experiment 的平台，包括：{**local**, **remote**, **pai**, **kubeflow**}.
     
-    - **local** 在本机的 ubuntu 上运行 Experiment。
+    - **local** 在本机的 Ubuntu 上运行 Experiment。
     
     - **remote** 将任务提交到远程的 Ubuntu 上，必须用 **machineList** 来指定远程的 SSH 连接信息。
     
@@ -259,7 +268,7 @@ machineList:
     
         __gpuNum__ 指定了运行 Tuner 进程的 GPU 数量。 此字段的值必须是正整数。
         
-        注意: 只能使用一种方法来指定 Tuner，例如：设置{tunerName, optimizationMode} 或 {tunerCommand, tunerCwd}，不能同时设置。
+        注意: 只能使用一种方法来指定 Tuner，例如：设置 {tunerName, optimizationMode} 或 {tunerCommand, tunerCwd}，不能同时设置两者。
         
   
   - **includeIntermediateResults**
@@ -281,7 +290,7 @@ machineList:
     
     - **classArgs**
       
-      **classArgs** 指定了 Assessor 算法的参数。
+      **classArgs** 指定了 Assessor 算法的参数
   
   - **codeDir**, **classFileName**, **className** 和 **classArgs**
     
@@ -495,7 +504,7 @@ machineList:
   
   - **keyVault**
     
-    如果用户使用 Azure Kubernetes Service，需要设置 keyVault 来使用 Azure 存储账户的私钥。 参考: https://docs.microsoft.com/en-us/azure/key-vault/key-vault-manage-with-cli2
+    如果用户使用 Azure Kubernetes Service，需要设置 keyVault 来使用 Azure 存储账户的私钥。 参考: https://docs.microsoft.com/zh-cn/azure/key-vault/key-vault-manage-with-cli2
     
     - **vaultName**
       

docs/zh_CN/FrameworkControllerMode.md

-# **在 FrameworkController 上运行 Experiment**
+# 在 FrameworkController 上运行 Experiment
 
-NNI 支持使用 [FrameworkController](https://github.com/Microsoft/frameworkcontroller)，来运行 Experiment，称之为 frameworkcontroller 模式。 FrameworkController 构建于 Kubernetes 上，用于编排各种应用。这样，可以不用为某个深度学习框架安装 Kubeflow 的 tf-operator 的 pytorch-operator 等。 而直接用 FrameworkController 作为 NNI Experiment 的训练服务。
+=== NNI 支持使用 [FrameworkController](https://github.com/Microsoft/frameworkcontroller)，来运行 Experiment，称之为 frameworkcontroller 模式。 FrameworkController 构建于 Kubernetes 上，用于编排各种应用。这样，可以不用为某个深度学习框架安装 Kubeflow 的 tf-operator 的 pytorch-operator 等。 而直接用 FrameworkController 作为 NNI Experiment 的训练服务。
 
 ## 私有部署的 Kubernetes 的准备工作
 
@@ -8,54 +8,59 @@ NNI 支持使用 [FrameworkController](https://github.com/Microsoft/frameworkcon
 2. 配置 **kubeconfig** 文件，NNI 将使用此配置与 Kubernetes API 服务交互。 默认情况下，NNI 管理器会使用 $(HOME)/.kube/config 作为 kubeconfig 文件的路径。 也可以通过环境变量 **KUBECONFIG** 来指定其它 kubeconfig 文件。 根据[指南](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig)了解更多 kubeconfig 的信息。
 3. 如果 NNI Trial 作业需要 GPU 资源，需按照[指南](https://github.com/NVIDIA/k8s-device-plugin)来配置 **Kubernetes 下的 Nvidia 插件**。
 4. 准备 **NFS 服务器** 并导出通用的装载 (mount)，推荐将 NFS 服务器路径映射到 `root_squash 选项`，否则可能会在 NNI 复制文件到 NFS 时出现权限问题。 参考[页面](https://linux.die.net/man/5/exports)，来了解关于 root_squash 选项，或 **Azure File Storage**。
-5. 在安装 NNI 并运行 nnictl 的计算机上安装 **NFS 客户端**。 运行此命令安装 NFSv4 客户端： ```apt-get install nfs-common```
+5. 在安装 NNI 并运行 nnictl 的计算机上安装 **NFS 客户端**。 运行此命令安装 NFSv4 客户端：
+  
+      ```bash
+      apt-get install nfs-common
+      ```
+      
 
 6. 参考[指南](QuickStart.md)安装 **NNI**。
 
 ## Azure 部署的 Kubernetes 的准备工作
 
-1. NNI 支持基于 Azure Kubernetes Service 的 Kubeflow，参考[指南](https://azure.microsoft.com/en-us/services/kubernetes-service/)来设置 Azure Kubernetes Service。
-2. 安装 [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest) 和 **kubectl**。 使用 `az login` 命令来设置 Azure 账户吗，并将 kubectl 客户端连接到 AKS，参考此[指南](https://docs.microsoft.com/en-us/azure/aks/kubernetes-walkthrough#connect-to-the-cluster)。
-3. 参考此[指南](https://docs.microsoft.com/en-us/azure/storage/common/storage-quickstart-create-account?tabs=portal)来创建 Azure 文件存储账户。 NNI 需要 Azure Storage Service 来存取代码和输出文件。
-4. NNI 需要访问密钥来连接 Azure 存储服务，NNI 使用 [Azure Key Vault](https://azure.microsoft.com/en-us/services/key-vault/) 服务来保护私钥。 设置 Azure Key Vault 服务，并添加密钥到 Key Vault 中来存取 Azure 存储账户。 参考[指南](https://docs.microsoft.com/en-us/azure/key-vault/quick-create-cli)来存储访问密钥。
+1. NNI 支持基于 Azure Kubernetes Service 的 Kubeflow，参考[指南](https://azure.microsoft.com/zh-cn/services/kubernetes-service/)来设置 Azure Kubernetes Service。
+2. 安装 [Azure CLI](https://docs.microsoft.com/zh-cn/cli/azure/install-azure-cli?view=azure-cli-latest) 和 **kubectl**。 使用 `az login` 命令来设置 Azure 账户吗，并将 kubectl 客户端连接到 AKS，参考此[指南](https://docs.microsoft.com/zh-cn/azure/aks/kubernetes-walkthrough#connect-to-the-cluster)。
+3. 参考此[指南](https://docs.microsoft.com/zh-cn/azure/storage/common/storage-quickstart-create-account?tabs=portal)来创建 Azure 文件存储账户。 NNI 需要 Azure Storage Service 来存取代码和输出文件。
+4. NNI 需要访问密钥来连接 Azure 存储服务，NNI 使用 [Azure Key Vault](https://azure.microsoft.com/zh-cn/services/key-vault/) 服务来保护私钥。 设置 Azure Key Vault 服务，并添加密钥到 Key Vault 中来存取 Azure 存储账户。 参考[指南](https://docs.microsoft.com/zh-cn/azure/key-vault/quick-create-cli)来存储访问密钥。
 
 ## 安装 FrameworkController
 
-参考[指南](https://github.com/Microsoft/frameworkcontroller/tree/master/example/run)来在 Kubernetes 集群中配置 Frameworkcontroller。NNI 通过 statefulset 模式来 支持 Frameworkcontroller。
+参考[指南](https://github.com/Microsoft/frameworkcontroller/tree/master/example/run)来在 Kubernetes 集群中配置 FrameworkController。NNI 通过 statefulset 模式来 支持 FrameworkController。
 
 ## 设计
 
-参考[Kubeflow 训练服务](./KubeflowMode.md)，Frameworkcontroller 服务管道非常类似。
+参考[Kubeflow 训练服务](./KubeflowMode.md)，FrameworkController 服务管道非常类似。
 
 ## 样例
 
-Frameworkcontroller 配置文件的格式如下：
-
-    authorName: default
-    experimentName: example_mnist
-    trialConcurrency: 1
-    maxExecDuration: 10h
-    maxTrialNum: 100
-    #可选项: local, remote, pai, kubeflow, frameworkcontroller
-    trainingServicePlatform: frameworkcontroller
-    searchSpacePath: ~/nni/examples/trials/mnist/search_space.json
-    #可选项: true, false
-    useAnnotation: false
-    tuner:
+FrameworkController 配置文件的格式如下：
+
+```yaml
+authorName: default
+experimentName: example_mnist
+trialConcurrency: 1
+maxExecDuration: 10h
+maxTrialNum: 100
+#可选项: local, remote, pai, kubeflow, frameworkcontroller
+trainingServicePlatform: frameworkcontroller
+searchSpacePath: ~/nni/examples/trials/mnist/search_space.json
+#可选项: true, false
+useAnnotation: false
+tuner:
   #可选项: TPE, Random, Anneal, Evolution
   builtinTunerName: TPE
   classArgs:
     #可选项: maximize, minimize
     optimize_mode: maximize
-    assessor:
+assessor:
   builtinAssessorName: Medianstop
   classArgs:
     optimize_mode: maximize
   gpuNum: 0
-    trial:
+trial:
   codeDir: ~/nni/examples/trials/mnist
   taskRoles:
-    
     - name: worker
       taskNum: 1
       command: python3 mnist.py
@@ -66,16 +71,17 @@ Frameworkcontroller 配置文件的格式如下：
       frameworkAttemptCompletionPolicy:
         minFailedTaskCount: 1
         minSucceededTaskCount: 1
-    frameworkcontrollerConfig:
+frameworkcontrollerConfig:
   storage: nfs
   nfs:
     server: {your_nfs_server}
     path: {your_nfs_server_exported_path}
-    
+```
 
 如果使用了 Azure Kubernetes Service，需要在 YAML 文件中如下设置 `frameworkcontrollerConfig`：
 
-    frameworkcontrollerConfig:
+```yaml
+frameworkcontrollerConfig:
   storage: azureStorage
   keyVault:
     vaultName: {your_vault_name}
@@ -83,11 +89,12 @@ Frameworkcontroller 配置文件的格式如下：
   azureStorage:
     accountName: {your_storage_account_name}
     azureShare: {your_azure_share_name}
-    
+```
 
 注意：如果用 FrameworkController 模式运行，需要在 YAML 文件中显式设置 `trainingServicePlatform: frameworkcontroller`。
 
 FrameworkController 模式的 Trial 配置格式，是 FrameworkController 官方配置的简化版。参考 [frameworkcontroller 的 tensorflow 样例](https://github.com/Microsoft/frameworkcontroller/blob/master/example/framework/scenario/tensorflow/cpu/tensorflowdistributedtrainingwithcpu.yaml) 了解详情。
+
 frameworkcontroller 模式中的 Trial 配置使用以下主键：
 
 * taskRoles: 配置文件中可以设置多个任务角色，每个任务角色都是在 Kubernetes 集群中的基本执行单元。 
@@ -98,11 +105,11 @@ frameworkcontroller 模式中的 Trial 配置使用以下主键：
   * cpuNum: 容器中要使用的 CPU 数量。
   * memoryMB: 容器的内存限制。
   * image: 用来创建 pod，并运行程序的 Docker 映像。
-   * frameworkAttemptCompletionPolicy: 运行框架的策略，参考[用户手册](https://github.com/Microsoft/frameworkcontroller/blob/master/doc/user-manual.md#frameworkattemptcompletionpolicy)了解更多信息。 这些策略可以用来控制 pod，例如，如果 worker 任务停止了，但 ps 没有停止，CompletionPolicy 策略可以停止 ps。
+  * frameworkAttemptCompletionPolicy: 运行框架的策略，参考[用户手册](https://github.com/Microsoft/frameworkcontroller/blob/master/doc/user-manual.md#frameworkattemptcompletionpolicy)了解更多信息。 这些策略可以用来控制 pod，例如，如果 worker 任务停止了，但 ps 还在运行，要通过完成策略来停止 ps。
 
 ## 如何运行示例
 
-准备好配置文件后，通过运行 nnictl 来启动 Experiment。 在 Frameworkcontroller 上开始 Experiment 的方法与 Kubeflow 类似，可参考[指南](./KubeflowMode.md)了解更多信息。
+准备好配置文件后，通过运行 nnictl 来启动 Experiment。 在 FrameworkController 上开始 Experiment 的方法与 Kubeflow 类似，可参考[指南](./KubeflowMode.md)了解更多信息。
 
 ## 版本校验
 

docs/zh_CN/GPTuner.md

+# NNI 中的 GP Tuner
+
+## GP Tuner
+
+贝叶斯优化会构建一个能最好的描述优化目标的后验分布函数（使用高斯过程）。 随着观测值的增加，后验分布会得到改善，会在参数空间中确定哪些范围值得进一步探索，哪一些不值得。
+
+GP Tuner 被设计为通过最大化或最小化步数来找到最接近最优结果的参数组合。 GP Tuner 使用了代理优化问题（找到采集函数的最大值）。虽然这仍然是个难题，但成本更低（从计算的角度来看），并且有通用的工具。 因此，贝叶斯优化适合于采样函数的成本非常高时来使用。
+
+优化方法在 [Algorithms for Hyper-Parameter Optimization](https://papers.nips.cc/paper/4443-algorithms-for-hyper-parameter-optimization.pdf) 的第三章有详细描述。
\ No newline at end of file

docs/zh_CN/HowToImplementTrainingService.md

@@ -8,8 +8,9 @@ TrainingService 是与平台管理、任务调度相关的模块。 TrainingServ
 
 ![](../img/NNIDesign.jpg)
 
-NNI 的架构如图所示。 NNIManager 是系统的核心管理模块，负责调用 TrainingService 来管理 Trial，并负责不同模块之间的通信。 Dispatcher 是消息处理中心。 TrainingService 是管理任务的模块，它和 NNIManager 通信，并且根据平台的特点有不同的实现。 当前，NNI 支持本地平台、[远程平台](RemoteMachineMode.md)、[OpenPAI 平台](PaiMode.md)、[Kubeflow 平台](KubeflowMode.md)和[FrameworkController 平台](FrameworkController.md)。  
-在这个文档中，会简要介绍 TrainingService 的设计。 如果要添加新的 TrainingService，只需要继承 TrainingServcie 类并实现相应的方法，不需要理解NNIManager、Dispatcher 等其它模块的细节。
+NNI 的架构如图所示。 NNIManager 是系统的核心管理模块，负责调用 TrainingService 来管理 Trial，并负责不同模块之间的通信。 Dispatcher 是消息处理中心。 TrainingService 是管理任务的模块，它和 NNIManager 通信，并且根据平台的特点有不同的实现。 当前，NNI 支持本机，[远程平台](RemoteMachineMode.md)，[OpenPAI 平台](PaiMode.md)，[Kubeflow 平台](KubeflowMode.md) 以及 [FrameworkController 平台](FrameworkController.md)。
+
+本文中，会介绍 TrainingService 的简要设计。 如果要添加新的 TrainingService，只需要继承 TrainingServcie 类并实现相应的方法，不需要理解NNIManager、Dispatcher 等其它模块的细节。
 
 ## 代码文件夹结构
 
@@ -67,7 +68,8 @@ NNI 的文件夹结构如下：
 TrainingService 父类有一些抽象方法，用户需要继承并实现这些抽象方法。
 
 **setClusterMetadata(key: string, value: string)**
-ClusterMetadata 是与平台数据有关的方法，例如，在远程平台上的 ClusterMetadata 定义是：
+
+ClusterMetadata 是与平台细节相关的数据，例如，ClusterMetadata 在远程服务器的定义是：
 
     export class RemoteMachineMeta {
         public readonly ip : string;
@@ -96,10 +98,12 @@ ClusterMetadata 是与平台数据有关的方法，例如，在远程平台上
 Metadata 中包括了主机地址，用户名和其它平台相关配置。 用户需要定义自己的 Metadata 格式，并在这个方法中相应实现。 这个方法在 Experiment 启动之前调用。
 
 **getClusterMetadata(key: string)**
-这个方法返回 metadata 的内容，如果不需要使用这个方法，可将方法内容留空。
+
+此函数将返回相应值的元数据值，如果不需要使用，可留空。
 
 **submitTrialJob(form: JobApplicationForm)**
-SubmitTrialJob 是用来提交 Trial 任务的方法，用户需要在这个方法中生成 TrialJobDetail 类型的实例。 TrialJobDetail 定义如下：
+
+SubmitTrialJob 是用来提交新 Trial 任务的函数，需要生成一个 TrialJobDetail 类型的任务实例。 TrialJobDetail 定义如下：
 
     interface TrialJobDetail {
         readonly id: string;
@@ -119,36 +123,49 @@ SubmitTrialJob 是用来提交 Trial 任务的方法，用户需要在这个方
 根据不同的实现，用户可能需要把 Trial 任务放入队列中，并不断地从队里中取出任务进行提交。 或者也可以直接在这个方法中完成作业提交过程。
 
 **cancelTrialJob(trialJobId: string, isEarlyStopped?: boolean)**
-如果这个方法被调用， Trial 应该被取消执行。 不同的平台有不同的取消作业的方式，这个方法应该根据不同平台的特点，实现相应的细节。
+
+如果此函数被调用，应取消平台启动的 Trial。 不同的平台有不同的取消作业的方式，这个方法应该根据不同平台的特点，实现相应的细节。
 
 **updateTrialJob(trialJobId: string, form: JobApplicationForm)**
-这个方法用来更新 Trial 的状态，不同平台有不同的检测作业状态的方法，并把状态更新为`RUNNING`, `SUCCEED`, `FAILED` 等。
+
+调用此函数可更新 Trial 的任务状态，Trial 任务状态根据不同的平台来检测，并需要更新为 `RUNNING`, `SUCCEED`, `FAILED` 等状态。
 
 **getTrialJob(trialJobId: string)**
-这个方法用来根据 Trial Id 来返回相应的 Trial 实例。
+
+此函数根据 trialJobId 返回 trialJob 的实例。
 
 **listTrialJobs()**
-用户需要在这个方法中把所有的 Trial 实例放入一个列表中，并返回。
+
+用户需要将所有 Trial 任务详情存入列表并返回。
 
 **addTrialJobMetricListener(listener: (metric: TrialJobMetric) => void)**
-NNI 会启动一个 EventEmitter 来处理作业的指标数据，如果有检测到有新的数据，EventEmitter就会被触发，来执行相应的事件。 用户需要在这个方法中开始 EventEmitter。
+
+NNI 会启动一个 EventEmitter 来处理任务的指标数据，如果有检测到有新的数据，EventEmitter就会被触发，来执行相应的事件。 用户需要在这个方法中开始 EventEmitter。
 
 **removeTrialJobMetricListener(listener: (metric: TrialJobMetric) => void)**
-移除 EventEmitter。
+
+关闭 EventEmitter。
 
 **run()**
+
 Run() 函数是 TrainingService 的主循环，用户可以在这个函数中循环执行他们的代码逻辑，这个函数在实验结束前会一直循环执行。
 
 **cleanUp()**
-当实验结束后，这个方法用来清除实验环境。 用户需要在这个方法中实现与平台相关的清除操作。
+
+当实验结束后，此方法用来清除实验环境。 用户需要在这个方法中实现与平台相关的清除操作。
 
 ## TrialKeeper 工具
 
-NNI 提供了 TrialKeeper 工具，用来帮助维护 Trial 任务。 可以在 `nni/tools/nni_trial_tool` 文件夹中找到 TrialKeeper 的源代码。 如果想要运行在云平台上，这是维护任务的好工具。 TrialKeeper 的架构如下：  
+NNI 提供了 TrialKeeper 工具，用来帮助维护 Trial 任务。 可以在 `nni/tools/nni_trial_tool` 文件夹中找到 TrialKeeper 的源代码。 如果想要运行在云平台上，这是维护任务的好工具。
+
+TrialKeeper 的架构如下：
+
 ![](../img/trialkeeper.jpg)
-当用户需要在远程云平台上运行作业，要把作业启动的命令行传入 TrailKeeper 中，并在远程云平台上启动 TriakKeeper 进程。 注意，TrialKeeper 在远程平台中使用 RESTful 服务来和 TrainingService 进行通信，用户需要在本地机器启动一个 RESTful 服务来接受 TrialKeeper 的请求。 关于 RESTful 服务的源代码可以在 `nni/src/nni_manager/training_service/common/clusterJobRestServer.ts` 文件夹中找到.
+
+当用户需要在远程云平台上运行作业，要把作业启动的命令行传入 TrailKeeper 中，并在远程云平台上启动 TrailKeeper 进程。 注意，TrialKeeper 在远程平台中使用 RESTful 服务来和 TrainingService 进行通信，用户需要在本地机器启动一个 RESTful 服务来接受 TrialKeeper 的请求。 关于 RESTful 服务的源代码可以在 `nni/src/nni_manager/training_service/common/clusterJobRestServer.ts` 文件夹中找到.
 
 ## 参考
 
-更多关于如何调试的信息，请[参考这里](HowToDebug.md)。  
-关于如何贡献代码，请[参考这里](Contributing.md)。
\ No newline at end of file
+有关调试的进一步信息，可参考[这里](HowToDebug.md)。
+
+如何参与贡献的指南，请参考[这里](Contributing.md)。
\ No newline at end of file

docs/zh_CN/Installation.md

@@ -28,12 +28,6 @@
 
 ## **在 Windows 上安装**
 
-在第一次使用 PowerShell 运行脚本时，需要用**使用管理员权限**运行如下命令：
-
-```powershell
-Set-ExecutionPolicy -ExecutionPolicy Unrestricted
-```
-
 推荐使用 Anaconda 或 Miniconda。
 
 * **通过 pip 命令安装 NNI**
@@ -48,12 +42,10 @@ Set-ExecutionPolicy -ExecutionPolicy Unrestricted
     
     先决条件：`python >=3.5`, `git`, `PowerShell`
     
-    然后可以使用管理员或当前用户安装 NNI：
-    
     ```bash
     git clone -b v0.8 https://github.com/Microsoft/nni.git
     cd nni
-    powershell .\install.ps1
+    powershell -ExecutionPolicy Bypass -file install.ps1
     ```
 
 ## **系统需求**

docs/zh_CN/KubeflowMode.md

-# **在 Kubeflow 上运行 Experiment**
+# 在 Kubeflow 上运行 Experiment
 
-NNI 支持在 [Kubeflow](https://github.com/kubeflow/kubeflow)上运行，称为 kubeflow 模式。 在开始使用 NNI 的 kubeflow 模式前，需要有一个 kubernetes 集群，可以是私有部署的，或者是 [Azure Kubernetes Service(AKS)](https://azure.microsoft.com/en-us/services/kubernetes-service/)，并需要一台配置好 [kubeconfig](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/) 的 Ubuntu 计算机连接到此 kubernetes 集群。 如果不熟悉 Kubernetes，可先浏览[这里](https://kubernetes.io/docs/tutorials/kubernetes-basics/)。 在 kubeflow 模式下，每个 Trial 程序会在 Kubernetes 集群中作为一个 kubeflow 作业来运行。
+===
+
+NNI 支持在 [Kubeflow](https://github.com/kubeflow/kubeflow)上运行，称为 kubeflow 模式。 在开始使用 NNI 的 Kubeflow 模式前，需要有一个 Kubernetes 集群，可以是私有部署的，或者是 [Azure Kubernetes Service(AKS)](https://azure.microsoft.com/zh-cn/services/kubernetes-service/)，并需要一台配置好 [kubeconfig](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/) 的 Ubuntu 计算机连接到此 Kubernetes 集群。 如果不熟悉 Kubernetes，可先浏览[这里](https://kubernetes.io/docs/tutorials/kubernetes-basics/)。 在 kubeflow 模式下，每个 Trial 程序会在 Kubernetes 集群中作为一个 Kubeflow 作业来运行。
 
 ## 私有部署的 Kubernetes 的准备工作
 
 1. 采用 Kubernetes 1.8 或更高版本。 根据[指南](https://kubernetes.io/docs/setup/)来安装 Kubernetes。
-2. 在 Kubernetes 集群中下载、安装、部署 **Kubelow**。 根据[指南](https://www.kubeflow.org/docs/started/getting-started/)安装 Kubeflow。
+2. 在 Kubernetes 集群中下载、安装、部署 **Kubeflow**。 根据[指南](https://www.kubeflow.org/docs/started/getting-started/)安装 Kubeflow。
 3. 配置 **kubeconfig** 文件，NNI 将使用此配置与 Kubernetes API 服务交互。 默认情况下，NNI 管理器会使用 $(HOME)/.kube/config 作为 kubeconfig 文件的路径。 也可以通过环境变量 **KUBECONFIG** 来指定其它 kubeconfig 文件。 根据[指南](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig)了解更多 kubeconfig 的信息。
 4. 如果 NNI Trial 作业需要 GPU 资源，需按照[指南](https://github.com/NVIDIA/k8s-device-plugin)来配置 **Kubernetes 下的 Nvidia 插件**。
 5. 准备 **NFS 服务器** 并导出通用的装载 (mount)，推荐将 NFS 服务器路径映射到 `root_squash 选项`，否则可能会在 NNI 复制文件到 NFS 时出现权限问题。 参考[页面](https://linux.die.net/man/5/exports)，来了解关于 root_squash 选项，或 **Azure File Storage**。
-6. 在安装 NNI 并运行 nnictl 的计算机上安装 **NFS 客户端**。 运行此命令安装 NFSv4 客户端：
-    
-        apt-get install nfs-common 
-        
+6. 在安装 NNI 并运行 nnictl 的计算机上安装 **NFS 客户端**。 运行此命令安装 NFSv4 客户端： ```apt-get install nfs-common```
 
 7. 参考[指南](QuickStart.md)安装 **NNI**。
 
 ## Azure 部署的 Kubernetes 的准备工作
 
-1. NNI 支持基于 Azure Kubernetes Service 的 Kubeflow，参考[指南](https://azure.microsoft.com/en-us/services/kubernetes-service/)来设置 Azure Kubernetes Service。
-2. 安装 [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest) 和 **kubectl**。 使用 `az login` 命令来设置 Azure 账户吗，并将 kubectl 客户端连接到 AKS，参考此[指南](https://docs.microsoft.com/en-us/azure/aks/kubernetes-walkthrough#connect-to-the-cluster)。
+1. NNI 支持基于 Azure Kubernetes Service 的 Kubeflow，参考[指南](https://azure.microsoft.com/zh-cn/services/kubernetes-service/)来设置 Azure Kubernetes Service。
+2. 安装 [Azure CLI](https://docs.microsoft.com/zh-cn/cli/azure/install-azure-cli?view=azure-cli-latest) 和 **kubectl**。 使用 `az login` 命令来设置 Azure 账户吗，并将 kubectl 客户端连接到 AKS，参考此[指南](https://docs.microsoft.com/zh-cn/azure/aks/kubernetes-walkthrough#connect-to-the-cluster)。
 3. 在 Azure Kubernetes Service 上部署 Kubeflow，参考此[指南](https://www.kubeflow.org/docs/started/getting-started/)。
-4. 参考此[指南](https://docs.microsoft.com/en-us/azure/storage/common/storage-quickstart-create-account?tabs=portal)来创建 Azure 文件存储账户。 NNI 需要 Azure Storage Service 来存取代码和输出文件。
-5. NNI 需要访问密钥来连接 Azure 存储服务，NNI 使用 [Azure Key Vault](https://azure.microsoft.com/en-us/services/key-vault/) 服务来保护私钥。 设置 Azure Key Vault 服务，并添加密钥到 Key Vault 中来存取 Azure 存储账户。 参考[指南](https://docs.microsoft.com/en-us/azure/key-vault/quick-create-cli)来存储访问密钥。
+4. 参考此[指南](https://docs.microsoft.com/zh-cn/azure/storage/common/storage-quickstart-create-account?tabs=portal)来创建 Azure 文件存储账户。 NNI 需要 Azure Storage Service 来存取代码和输出文件。
+5. NNI 需要访问密钥来连接 Azure 存储服务，NNI 使用 [Azure Key Vault](https://azure.microsoft.com/zh-cn/services/key-vault/) 服务来保护私钥。 设置 Azure Key Vault 服务，并添加密钥到 Key Vault 中来存取 Azure 存储账户。 参考[指南](https://docs.microsoft.com/zh-cn/azure/key-vault/quick-create-cli)来存储访问密钥。
 
 ## 设计
 
-![](../img/kubeflow_training_design.png) Kubeflow 训练服务会实例化一个 kubernetes 客户端来与 Kubernetes 集群的 API 服务器交互。
+![](../img/kubeflow_training_design.png) Kubeflow 训练服务会实例化一个 Kubernetes 客户端来与 Kubernetes 集群的 API 服务器交互。
 
-对于每个 Trial，会上传本机 codeDir 路径（在 nni_config.yml 中配置）中的所有文件，包括 parameter.cfg 这样的生成的文件到存储卷中。 当前支持两种存储卷：[nfs](https://en.wikipedia.org/wiki/Network_File_System) 和 [Azure 文件存储](https://azure.microsoft.com/en-us/services/storage/files/)，需要在 NNI 的 YAML 文件中进行配置。 当文件准备好后，Kubeflow 训练服务会调用 Kubernetes 的 API 来创建 Kubeflow 作业 ([tf-operator](https://github.com/kubeflow/tf-operator) 作业或 [pytorch-operator](https://github.com/kubeflow/pytorch-operator) 作业) ，并将存储卷挂载到作业的 pod 中。 Kubeflow 作业的输出文件，例如 stdout, stderr, trial.log 以及模型文件，也会被复制回存储卷。 NNI 会在网页中显示每个 Trial 的存储卷的 URL，以便浏览日志和输出文件。
+对于每个 Trial，会上传本机 codeDir 路径（在 nni_config.yml 中配置）中的所有文件，包括 parameter.cfg 这样的生成的文件到存储卷中。 当前支持两种存储卷：[nfs](https://en.wikipedia.org/wiki/Network_File_System) 和 [Azure 文件存储](https://azure.microsoft.com/zh-cn/services/storage/files/)，需要在 NNI 的 YAML 文件中进行配置。 当文件准备好后，Kubeflow 训练服务会调用 Kubernetes 的 API 来创建 Kubeflow 作业 ([tf-operator](https://github.com/kubeflow/tf-operator) 作业或 [pytorch-operator](https://github.com/kubeflow/pytorch-operator) 作业) ，并将存储卷挂载到作业的 pod 中。 Kubeflow 作业的输出文件，例如 stdout, stderr, trial.log 以及模型文件，也会被复制回存储卷。 NNI 会在网页中显示每个 Trial 的存储卷的 URL，以便浏览日志和输出文件。
 
 ## 支持的操作符（operator）
 
-NNI 仅支持 kubeflow 的 tf-operator 和 pytorch-operator，其它操作符未经测试。 可以在配置文件中设置操作符类型。 这是 tf-operator 的设置：
+NNI 仅支持 Kubeflow 的 tf-operator 和 pytorch-operator，其它操作符未经测试。 可以在配置文件中设置操作符类型。 这是 tf-operator 的设置：
 
-    kubeflowConfig:
+```yaml
+kubeflowConfig:
   operator: tf-operator
-    
+```
 
 这是 pytorch-operator 的设置：
 
-    kubeflowConfig:
+```yaml
+kubeflowConfig:
   operator: pytorch-operator
-    
+```
 
 如果要使用 tf-operator，需要在 Trial 配置中设置 `ps` 和 `worker`。如果要使用 pytorch-operator，需要在 Trial 配置中设置 `master` 和 `worker`。
 
 ## 支持的存储类型
 
 NNI 支持使用 NFS 和 Azure 存储来存储代码和输出文件，可在配置文件进行相应的配置。
+
 NFS 存储配置如下：
 
-    kubeflowConfig:
+```yaml
+kubeflowConfig:
   storage: nfs
   nfs:
     # NFS 服务器 IP， 如 10.10.10.10
     server: {your_nfs_server_ip}
     # NFS 服务器的导出路径，如 /var/nfs/nni
     path: {your_nfs_server_export_path}
-    
+```
 
 如果使用了 Azure 存储，需要在 YAML 文件中如下设置 `kubeflowConfig`：
 
-    kubeflowConfig:
+```yaml
+kubeflowConfig:
   storage: azureStorage
   keyVault:
     vaultName: {your_vault_name}
@@ -70,34 +74,35 @@ NFS 存储配置如下：
   azureStorage:
     accountName: {your_storage_account_name}
     azureShare: {your_azure_share_name}
-    
+```
 
 ## 运行 Experiment
 
 以 `examples/trials/mnist` 为例。 这是一个 TensorFlow 作业，使用了 Kubeflow 的 tf-operator。 NNI 的 YAML 配置文件如下：
 
-    authorName: default
-    experimentName: example_mnist
-    trialConcurrency: 2
-    maxExecDuration: 1h
-    maxTrialNum: 20
-    #可选项: local, remote, pai, kubeflow
-    trainingServicePlatform: kubeflow
-    searchSpacePath: search_space.json
-    #可选项: true, false
-    useAnnotation: false
-    tuner:
+```yaml
+authorName: default
+experimentName: example_mnist
+trialConcurrency: 2
+maxExecDuration: 1h
+maxTrialNum: 20
+#可选项: local, remote, pai, kubeflow
+trainingServicePlatform: kubeflow
+searchSpacePath: search_space.json
+#可选项: true, false
+useAnnotation: false
+tuner:
   #可选项: TPE, Random, Anneal, Evolution
   builtinTunerName: TPE
   classArgs:
     #可选项: maximize, minimize
     optimize_mode: maximize
-    assessor:
+assessor:
   builtinAssessorName: Medianstop
   classArgs:
     optimize_mode: maximize
   gpuNum: 0
-    trial:
+trial:
   codeDir: .
   worker:
     replicas: 2
@@ -113,7 +118,7 @@ NFS 存储配置如下：
     cpuNum: 1
     memoryMB: 8196
     image: msranni/nni:latest
-    kubeflowConfig:
+kubeflowConfig:
   operator: tf-operator
   apiVersion: v1alpha2
   storage: nfs
@@ -122,29 +127,30 @@ NFS 存储配置如下：
     server: {your_nfs_server_ip}
     # NFS 服务器的导出路径，如 /var/nfs/nni
     path: {your_nfs_server_export_path}
-    
+```
 
 注意：如果用 Kubeflow 模式运行，需要在 YAML 文件中显式设置 `trainingServicePlatform: kubeflow`。
 
 如果要运行 Pytorch 作业，需要如下配置：
 
-    authorName: default
-    experimentName: example_mnist_distributed_pytorch
-    trialConcurrency: 1
-    maxExecDuration: 1h
-    maxTrialNum: 10
-    #可选项: local, remote, pai, kubeflow
-    trainingServicePlatform: kubeflow
-    searchSpacePath: search_space.json
-    #可选项: true, false
-    useAnnotation: false
-    tuner:
+```yaml
+authorName: default
+experimentName: example_mnist_distributed_pytorch
+trialConcurrency: 1
+maxExecDuration: 1h
+maxTrialNum: 10
+#可选项: local, remote, pai, kubeflow
+trainingServicePlatform: kubeflow
+searchSpacePath: search_space.json
+#可选项: true, false
+useAnnotation: false
+tuner:
   #可选项: TPE, Random, Anneal, Evolution
   builtinTunerName: TPE
   classArgs:
     #可选项: maximize, minimize
     optimize_mode: minimize
-    trial:
+trial:
   codeDir: .
   master:
     replicas: 1
@@ -160,7 +166,7 @@ NFS 存储配置如下：
     cpuNum: 1
     memoryMB: 2048
     image: msranni/nni:latest
-    kubeflowConfig:
+kubeflowConfig:
   operator: pytorch-operator
   apiVersion: v1alpha2
   nfs:
@@ -168,7 +174,7 @@ NFS 存储配置如下：
     server: {your_nfs_server_ip}
     # NFS 服务器导出路径，如  /var/nfs/nni
     path: {your_nfs_server_export_path}
-    
+```
 
 Kubeflow 模式的配置有下列主键：
 
@@ -193,8 +199,9 @@ Kubeflow 模式的配置有下列主键：
 
 完成并保存 NNI Experiment 配置文件后（例如可保存为：exp_kubeflow.yml），运行以下命令：
 
-    nnictl create --config exp_kubeflow.yml
-    
+```bash
+nnictl create --config exp_kubeflow.yml
+```
 
 来在 Kubeflow 模式下启动 Experiment。 NNI 会为每个 Trial 创建 Kubeflow tfjob 或 pytorchjob，作业名称的格式为 `nni_exp_{experiment_id}_trial_{trial_id}`。 可以在 Kubernetes 面板中看到创建的 Kubeflow tfjob。
 

docs/zh_CN/MetisTuner.md

@@ -2,7 +2,7 @@
 
 ## Metis Tuner
 
-大多数调参工具仅仅预测最优配置，而 [Metis](https://www.microsoft.com/en-us/research/publication/metis-robustly-tuning-tail-latencies-cloud-systems/) 的优势在于有两个输出：(a) 最优配置的当前预测结果， 以及 (b) 下一次 Trial 的建议。 不再需要随机猜测!
+大多数调参工具仅仅预测最优配置，而 [Metis](https://www.microsoft.com/zh-cn/research/publication/metis-robustly-tuning-tail-latencies-cloud-systems/) 的优势在于有两个输出：(a) 最优配置的当前预测结果， 以及 (b) 下一次 Trial 的建议。 不再需要随机猜测!
 
 大多数工具假设训练集没有噪声数据，但 Metis 会知道是否需要对某个超参重新采样。
 

docs/zh_CN/MultiPhase.md

@@ -39,7 +39,16 @@ Trial 代码中使用多阶段非常容易，样例如下：
 
 ### 编写使用多阶段的 Tuner：
 
-强烈建议首先阅读[自定义 Tuner](https://nni.readthedocs.io/en/latest/Customize_Tuner.html)，再开始编写多阶段 Tuner。 与普通 Tuner 不同的是，必须继承于 `MultiPhaseTuner`（在 nni.multi_phase_tuner 中）。 `Tuner` 与 `MultiPhaseTuner` 之间最大的不同是，MultiPhaseTuner 多了一些信息，即 `trial_job_id`。 有了这个信息， Tuner 能够知道哪个 Trial 在请求配置信息， 返回的结果是哪个 Trial 的。 通过此信息，Tuner 能够灵活的为不同的 Trial 及其阶段实现功能。 例如，可在 generate_parameters 方法中使用 trial_job_id 来为特定的 Trial 任务生成超参。
+强烈建议首先阅读[自定义 Tuner](https://nni.readthedocs.io/en/latest/Customize_Tuner.html)，再开始编写多阶段 Tuner。 与普通 Tuner 一样，需要从 `Tuner` 类继承。 当通过配置启用多阶段时（将 `multiPhase` 设为 true），Tuner 会通过下列方法得到一个新的参数 `trial_job_id`：
+
+    generate_parameters
+    generate_multiple_parameters
+    receive_trial_result
+    receive_customized_trial_result
+    trial_end
+    
+
+有了这个信息， Tuner 能够知道哪个 Trial 在请求配置信息， 返回的结果是哪个 Trial 的。 通过此信息，Tuner 能够灵活的为不同的 Trial 及其阶段实现功能。 例如，可在 generate_parameters 方法中使用 trial_job_id 来为特定的 Trial 任务生成超参。
 
 当然，要使用自定义的多阶段 Tuner ，也需要**在 Experiment 的 YAML 配置文件中增加`multiPhase: true`**。
 

docs/zh_CN/NniOnWindows.md

@@ -22,16 +22,6 @@ nnictl create --config nni\examples\trials\mnist\config_windows.yml
 
 > building 'simplejson._speedups' extension error: [WinError 3] The system cannot find the path specified
 
-### 从源代码安装 NNI 时，遇到 PowerShell 错误
-
-如果第一次运行 PowerShell 脚本，且没有设置过执行脚本的策略，会遇到下列错误。 需要以管理员身份运行此命令：
-
-```bash
-Set-ExecutionPolicy -ExecutionPolicy Unrestricted
-```
-
-> ...cannot be loaded because running scripts is disabled on this system.
-
 ### 在命令行或 PowerShell 中，Trial 因为缺少 DLL 而失败
 
 此错误因为缺少 LIBIFCOREMD.DLL 和 LIBMMD.DLL 文件，且 SciPy 安装失败。 使用 Anaconda 或 Miniconda 和 Python（64位）可解决。
@@ -40,11 +30,7 @@ Set-ExecutionPolicy -ExecutionPolicy Unrestricted
 
 ### Web 界面上的 Trial 错误
 
-检查 Trial 日志文件来了解详情。 如果没有日志文件，且 NNI 是通过 pip 安装的，则需要在管理员权限下先运行以下命令：
-
-```bash
-Set-ExecutionPolicy -ExecutionPolicy Unrestricted
-```
+检查 Trial 日志文件来了解详情。
 
 如果存在 stderr 文件，也需要查看其内容。 可能的错误情况包括：
 

docs/zh_CN/Nnictl.md

@@ -15,6 +15,7 @@ nnictl 支持的命令：
 * [nnictl trial](#trial)
 * [nnictl top](#top)
 * [nnictl experiment](#experiment)
+* [nnictl platform](#platform)
 * [nnictl config](#config)
 * [nnictl log](#log)
 * [nnictl webui](#webui)
@@ -376,6 +377,24 @@ nnictl 支持的命令：
     nnictl experiment list
     ```
 
+* **nnictl experiment delete**
+  
+  * 说明
+    
+    删除一个或所有 Experiment，包括日志、结果、环境信息和缓存。 用于删除无用的 Experiment 结果，或节省磁盘空间。
+  
+  * 用法
+    
+    ```bash
+    nnictl experiment delete [OPTIONS]
+    ```
+  
+  * 选项
+  
+  | 参数及缩写 | 是否必需  | 默认值 | 说明            |
+  | ----- | ----- | --- | ------------- |
+  | id    | False |     | Experiment ID |
+
 <a name="export"></a>
 
 * **nnictl experiment export**
@@ -464,6 +483,31 @@ nnictl 支持的命令：
     nnictl experiment import [experiment_id] -f experiment_data.json
     ```
 
+<a name="platform"></a>
+![](https://placehold.it/15/1589F0/000000?text=+) `管理平台的信息`
+
+* **nnictl platform clean**
+  
+  * 说明
+    
+    用于清理目标平台上的磁盘空间。 所提供的 YAML 文件包括了目标平台的信息，与 NNI 配置文件的格式相同。
+  
+  * 注意
+    
+    如果目标平台正在被别人使用，可能会造成他人的意外错误。
+  
+  * 用法
+    
+    ```bash
+    nnictl platform clean [OPTIONS]
+    ```
+  
+  * 选项
+  
+  | 参数及缩写    | 是否必需 | 默认值 | 说明                            |
+  | -------- | ---- | --- | ----------------------------- |
+  | --config | True |     | 创建 Experiment 时的 YAML 配置文件路径。 |
+
 <a name="config"></a>
 ![](https://placehold.it/15/1589F0/000000?text=+) `nnictl config show`
 
@@ -497,12 +541,12 @@ nnictl 支持的命令：
   
   | 参数及缩写      | 是否必需  | 默认值 | 说明                    |
   | ---------- | ----- | --- | --------------------- |
-  | id         | False |     | 需要设置的 Experiment 的 id |
+  | id         | False |     | 需要设置的 Experiment 的 ID |
   | --head, -h | False |     | 显示 stdout 开始的若干行      |
   | --tail, -t | False |     | 显示 stdout 结尾的若干行      |
   | --path, -p | False |     | 显示 stdout 文件的路径       |
   
-  * 样例
+  * 示例
     
     > 显示 stdout 结尾的若干行
     
@@ -526,7 +570,7 @@ nnictl 支持的命令：
   
   | 参数及缩写      | 是否必需  | 默认值 | 说明                    |
   | ---------- | ----- | --- | --------------------- |
-  | id         | False |     | 需要设置的 Experiment 的 id |
+  | id         | False |     | 需要设置的 Experiment 的 ID |
   | --head, -h | False |     | 显示 stderr 开始的若干行      |
   | --tail, -t | False |     | 显示 stderr 结尾的若干行      |
   | --path, -p | False |     | 显示 stderr 文件的路径       |
@@ -574,23 +618,23 @@ nnictl 支持的命令：
   
   | 参数及缩写          | 是否必需  | 默认值  | 说明                    |
   | -------------- | ----- | ---- | --------------------- |
-  | id             | False |      | 需要设置的 Experiment 的 ID |
+  | id             | False |      | 需要设置的 Experiment 的 id |
   | --trial_id, -T | False |      | Trial 的 id            |
   | --port         | False | 6006 | Tensorboard 进程的端口     |
   
   * 详细说明
     
-    1. NNICTL 当前仅支持本机和远程平台的 tensorboard，其它平台暂不支持。 
-    2. 如果要使用 tensorboard，需要将 tensorboard 日志输出到环境变量 [NNI_OUTPUT_DIR] 路径下。 
-    3. 在 local 模式中，nnictl 会直接设置 --logdir=[NNI_OUTPUT_DIR] 并启动 tensorboard 进程。
-    4. 在 remote 模式中，nnictl 会创建一个 ssh 客户端来将日志数据从远程计算机复制到本机临时目录中，然后在本机开始 tensorboard 进程。 需要注意的是，nnictl 只在使用此命令时复制日志数据，如果要查看最新的 tensorboard 结果，需要再次执行 nnictl tensorboard 命令。
-    5. 如果只有一个 Trial 任务，不需要设置 Trial ID。 如果有多个运行的 Trial 作业，需要设置 Trial ID，或使用 [nnictl tensorboard start --trial_id all] 来将 --logdir 映射到所有 Trial 的路径。
+    1. NNICTL 当前仅支持本机和远程平台的 Tensorboard，其它平台暂不支持。
+    2. 如果要使用 Tensorboard，需要将 Tensorboard 日志输出到环境变量 [NNI_OUTPUT_DIR] 路径下。
+    3. 在 local 模式中，nnictl 会直接设置 --logdir=[NNI_OUTPUT_DIR] 并启动 Tensorboard 进程。
+    4. 在 remote 模式中，nnictl 会创建一个 SSH 客户端来将日志数据从远程计算机复制到本机临时目录中，然后在本机开始 Tensorboard 进程。 需要注意的是，nnictl 只在使用此命令时复制日志数据，如果要查看最新的 tensorboard 结果，需要再次执行 nnictl tensorboard 命令。
+    5. 如果只有一个 Trial 任务，不需要设置 Trial ID。 如果有多个运行的 Trial 任务，需要设置 Trial ID，或使用 [nnictl tensorboard start --trial_id all] 来将 --logdir 映射到所有 Trial 的路径。
 
 * **nnictl tensorboard stop**
   
   * 说明
     
-    停止所有 tensorboard 进程。
+    停止所有 Tensorboard 进程。
   
   * 用法
     
@@ -602,7 +646,7 @@ nnictl 支持的命令：
   
   | 参数及缩写 | 是否必需  | 默认值 | 说明                    |
   | ----- | ----- | --- | --------------------- |
-  | id    | False |     | 需要设置的 Experiment 的 id |
+  | id    | False |     | 需要设置的 Experiment 的 ID |
 
 <a name="package"></a>
 
@@ -626,7 +670,7 @@ nnictl 支持的命令：
   | ------ | ---- | --- | ------- |
   | --name | True |     | 要安装的包名称 |
   
-  * 样例
+  * 示例
     
     > 安装 SMAC Tuner 所需要的包
     

docs/zh_CN/PaiMode.md

@@ -86,12 +86,10 @@ paiConfig:
 
 ## 版本校验
 
-从 0.6 开始，NNI 支持版本校验。确保 NNIManager 与 trialKeeper 的版本一致，避免兼容性错误。  
-检查策略：
+从 0.6 开始，NNI 支持版本校验。确保 NNIManager 与 trialKeeper 的版本一致，避免兼容性错误。 检查策略：
 
 1. 0.6 以前的 NNIManager 可与任何版本的 trialKeeper 一起运行，trialKeeper 支持向后兼容。
 2. 从 NNIManager 0.6 开始，与 triakKeeper 的版本必须一致。 例如，如果 NNIManager 是 0.6 版，则 trialKeeper 也必须是 0.6 版。
 3. 注意，只有版本的前两位数字才会被检查。例如，NNIManager 0.6.1 可以和 trialKeeper 的 0.6 或 0.6.2 一起使用，但不能与 trialKeeper 的 0.5.1 或 0.7 版本一起使用。
 
-如果 Experiment 无法运行，而且不能确认是否是因为版本不匹配造成的，可以在 Web 界面检查是否有相关的错误消息。  
-![](../img/version_check.png)
\ No newline at end of file
+如果 Experiment 无法运行，而且不能确认是否是因为版本不匹配造成的，可以在 Web 界面检查是否有相关的错误消息。 ![](../img/version_check.png)
\ No newline at end of file

docs/zh_CN/QuickStart.md

@@ -12,14 +12,6 @@
 
 #### Windows
 
-如果在 Windows 上使用 NNI，首次使用 PowerShell 时，需要以管理员身份运行下列命令。
-
-```bash
-    Set-ExecutionPolicy -ExecutionPolicy Unrestricted
-```
-
-然后通过 pip 安装 NNI：
-
 ```bash
     python -m pip install --upgrade nni
 ```
@@ -34,7 +26,7 @@
 
 NNI 是一个能进行自动机器学习实验的工具包。 它可以自动进行获取超参、运行 Trial，测试结果，调优超参的循环。 下面会展示如何使用 NNI 来找到最佳超参组合。
 
-这是**没有 NNI** 的样例代码，用 CNN 在 MNIST 数据集上训练：
+这是还**没有 NNI** 的样例代码，用 CNN 在 MNIST 数据集上训练：
 
 ```python
 def run_trial(params):
@@ -64,7 +56,7 @@ NNI 用来帮助超参调优。它的流程如下：
 
 ```pseudo
 输入: 搜索空间, Trial 代码, 配置文件
-输出: 一组最优的参数配置
+输出: 一组最佳的超参配置
 
 1: For t = 0, 1, 2, ..., maxTrialNum,
 2:      hyperparameter = 从搜索空间选择一组参数
@@ -72,7 +64,7 @@ NNI 用来帮助超参调优。它的流程如下：
 4:      返回最终结果给 NNI
 5:      If 时间达到上限,
 6:          停止实验
-7: 返回最好的实验结果
+7: return 最好的实验结果
 ```
 
 如果需要使用 NNI 来自动训练模型，找到最佳超参，需要如下三步：
@@ -205,7 +197,7 @@ You can use these commands to get more information about the experiment
 启动 Experiment 后，可以在命令行界面找到如下的 `Web 界面地址`：
 
 ```text
-The Web UI urls are: [IP 地址]:8080
+Web 地址为：[IP 地址]:8080
 ```
 
 在浏览器中打开 `Web 界面地址`(即：`[IP 地址]:8080`)，就可以看到 Experiment 的详细信息，以及所有的 Trial 任务。 如果无法打开终端中的 Web 界面链接，可以参考 [FAQ](FAQ.md)。

docs/zh_CN/Release.md

 # 更改日志
 
-# 发布 0.8 - 6/4/2019
+## 发布 0.8 - 6/4/2019
 
-## 主要功能
+### 主要功能
 
 * 在 Windows 上支持 NNI 的 OpenPAI 和远程模式 
   * NNI 可在 Windows 上使用 OpenPAI 模式
@@ -17,13 +17,13 @@
   * 提供新命令 `nnictl trial codegen` 来调试 NAS 代码生成部分
   * 提供 NAS 编程接口教程，NAS 在 MNIST 上的示例，用于 NAS 的可定制的随机 Tuner
 * 支持在恢复 Experiment 时，同时恢复 Tuner 和 Advisor 的状态
-    * 在恢复 Experiment 时，Tuner 和 Advisor 会导入已完成的 Trial 的数据。
+* 在恢复 Experiment 时，Tuner 和 Advisor 会导入已完成的 Trial 的数据。
 * Web 界面 
   * 改进拷贝 Trial 参数的设计
   * 在 hyper-parameter 图中支持 'randint' 类型
   * 使用 ComponentUpdate 来避免不必要的刷新
 
-## Bug 修复和其它更新
+### Bug 修复和其它更新
 
 * 修复 `nnictl update` 不一致的命令行风格
 * SMAC Tuner 支持导入数据
@@ -66,7 +66,7 @@
 
 ### 主要功能
 
-* [版本检查](https://github.com/Microsoft/nni/blob/master/docs/en_US/PaiMode.md#version-check) 
+* [版本检查](https://github.com/Microsoft/nni/blob/master/docs/zh_CN/PaiMode.md#version-check) 
   * 检查 nniManager 和 trialKeeper 的版本是否一致
 * [提前终止的任务也可返回最终指标](https://github.com/Microsoft/nni/issues/776) 
   * 如果 includeIntermediateResults 为 true，最后一个 Assessor 的中间结果会被发送给 Tuner 作为最终结果。 includeIntermediateResults 的默认值为 false。
@@ -175,7 +175,7 @@
 * 为指标数值图提供自动缩放的数轴
 * 改进 Annotation，支持在搜索空间中显示实际的选项
 
-### 新样例
+### 新示例
 
 * [FashionMnist](https://github.com/Microsoft/nni/tree/master/examples/trials/network_morphism)，使用 network morphism Tuner
 * 使用 PyTorch 的[分布式 MNIST 样例](https://github.com/Microsoft/nni/tree/master/examples/trials/mnist-distributed-pytorch)
@@ -246,7 +246,7 @@
 
 * **Batch Tuner（批处理调参器）** 会执行所有超参组合，可被用来批量提交 Trial 任务。
 
-### 新样例
+### 新示例
 
 * 公开的 NNI Docker 映像：
   

docs/zh_CN/SearchSpaceSpec.md

@@ -91,6 +91,7 @@
 |  Grid Search Tuner  | ✓ |          |          | ✓ |            |  ✓   |          |          |           |            |
 |  Hyperband Advisor  | ✓ | ✓ | ✓ | ✓ |  ✓  |  ✓   | ✓ | ✓ | ✓  |  ✓  |
 |     Metis Tuner     | ✓ | ✓ | ✓ | ✓ |            |             |          |          |           |            |
+|      GP Tuner       | ✓ | ✓ | ✓ | ✓ |  ✓  |  ✓   |          |          |           |            |
 
 已知的局限：
 

docs/zh_CN/SklearnExamples.md

 # NNI 中使用 scikit-learn
 
-[scikit-learn](https://github.com/scikit-learn/scikit-learn) (sklearn) 是数据挖掘和分析的流行工具。 它支持多种机器学习模型，如线性回归，逻辑回归，决策树，支持向量机等。 提高 scikit-learn 的效率是非常有价值的课题。  
-NNI 支持多种调优算法，可以为 scikit-learn 搜索最佳的模型和超参，并支持本机、远程服务器组、云等各种环境。
+[scikit-learn](https://github.com/scikit-learn/scikit-learn) (sklearn) 是流行的数据挖掘和分析工具。 它支持多种机器学习模型，如线性回归，逻辑回归，决策树，支持向量机等。 如何更高效的使用 scikit-learn，是一个很有价值的话题。
+
+NNI 支持多种调优算法来为 scikit-learn 搜索最好的模型和超参，并支持本机、远程服务器和云服务等多种环境。
 
 ## 1. 如何运行此样例
 
-安装 NNI 包，并使用命令行工具 `nnictl` 来启动 Experiment。 有关安装和环境准备的内容，参考[这里](QuickStart.md)。 安装完 NNI 后，进入相应的目录，输入下列命令即可启动 Experiment：
+安装 NNI 包，并使用命令行工具 `nnictl` 来启动 Experiment。 有关安装和环境准备的内容，参考[这里](QuickStart.md)。
+
+安装完 NNI 后，进入相应的目录，输入下列命令即可启动 Experiment：
 
 ```bash
 nnictl create --config ./config.yml
@@ -15,16 +18,19 @@ nnictl create --config ./config.yml
 
 ### 2.1 分类
 
-此样例使用了数字数据集，由 1797 张 8x8 的图片组成，每张图片都是一个手写数字。目标是将这些图片分到 10 个类别中。  
-在此样例中，使用了 SVC 作为模型，并选择了一些参数，包括 `"C", "keral", "degree", "gamma" 和 "coef0"`。 关于这些参数的更多信息，可参考[这里](https://scikit-learn.org/stable/modules/generated/sklearn.svm.SVC.html)。
+示例使用了数字数据集，它是由 1797 个 8x8 的图片组成，每个图片都是一个手写数字，目标是将图片分为 10 类。
+
+在这个示例中，使用 SVC 作为模型，并为此模型选择一些参数，包括 `"C", "keral", "degree", "gamma" 和 "coef0"`。 关于这些参数的更多信息，可参考[这里](https://scikit-learn.org/stable/modules/generated/sklearn.svm.SVC.html)。
 
 ### 2.2 回归
 
-此样例使用了波士顿房价数据，数据集由波士顿各地区房价所组成，还包括了房屋的周边信息，例如：犯罪率 (CRIM)，非零售业务的面积 (INDUS)，房主年龄 (AGE) 等等。这些信息可用来预测波士顿的房价。 本例中，尝试了不同的回归模型，包括 `"LinearRegression", "SVR", "KNeighborsRegressor", "DecisionTreeRegressor"` 和一些参数，如 `"svr_kernel", "knr_weights"`。 关于这些模型算法和参数的更多信息，可参考[这里](https://scikit-learn.org/stable/supervised_learning.html#supervised-learning)。
+此样例使用了波士顿房价数据，数据集由波士顿各地区房价所组成，还包括了房屋的周边信息，例如：犯罪率 (CRIM)，非零售业务的面积 (INDUS)，房主年龄 (AGE) 等等。这些信息可用来预测波士顿的房价。
+
+本例中，尝试了不同的回归模型，包括 `"LinearRegression", "SVR", "KNeighborsRegressor", "DecisionTreeRegressor"` 和一些参数，如 `"svr_kernel", "knr_weights"`。 关于这些模型算法和参数的更多信息，可参考[这里](https://scikit-learn.org/stable/supervised_learning.html#supervised-learning)。
 
-## 3. 如何在 NNI 中使用 sklearn
+## 3. 如何在 NNI 中使用 scikit-learn
 
-只需要如下几步，即可在 sklearn 代码中使用 NNI。
+只需要如下几步，即可在 scikit-learn 代码中使用 NNI。
 
 * **第一步**
     
@@ -49,7 +55,10 @@ nnictl create --config ./config.yml
     在 Python 代码中，可以将这些值作为一个 dict，读取到 Python 代码中。
 
 * **第二步**
-    在代码最前面，加上 `import nni` 来导入 NNI 包。 首先，要使用 `nni.get_next_parameter()` 函数从 NNI 中获取参数。 然后在代码中使用这些参数。 例如，如果定义了如下的 search_space.json：
+    
+    在代码最前面，加上 `import nni` 来导入 NNI 包。
+    
+    首先，要使用 `nni.get_next_parameter()` 函数从 NNI 中获取参数。 然后在代码中使用这些参数。 例如，如果定义了如下的 search_space.json：
     
     ```json
     {
@@ -76,5 +85,7 @@ nnictl create --config ./config.yml
     就可以使用这些变量来编写 scikit-learn 的代码。
 
 * **第三步**
-    完成训练后，可以得到模型分数，如：精度，召回率，均方差等等。 NNI 会将分数发送给 Tuner 算法，并据此生成下一组参数，所以需要将分数返回给 NNI。NNI 会开始下一个 Trial 任务。  
-    只需要在训练结束后调用 `nni.report_final_result(score)`，就可以将分数传给 NNI。 如果训练过程中有中间分数，也可以使用 `nni.report_intemediate_result(score)` 返回给 NNI。 注意， 可以不返回中间分数，但必须返回最终的分数。
\ No newline at end of file
+    
+    完成训练后，可以得到模型分数，如：精度，召回率，均方差等等。 NNI 需要将分数传入 Tuner 算法，并生成下一组参数，将结果回传给 NNI，并开始下一个 Trial 任务。
+    
+    在运行完 scikit-learn 代码后，只需要使用 `nni.report_final_result(score)` 来与 NNI 通信即可。 或者在每一步中都有多个分值，可使用 `nni.report_intemediate_result(score)` 来将它们回传给 NNI。 注意， 可以不返回中间分数，但必须返回最终的分数。
\ No newline at end of file

docs/zh_CN/Trials.md

@@ -35,7 +35,9 @@
 RECEIVED_PARAMS = nni.get_next_parameter()
 ```
 
-`RECEIVED_PARAMS` 是一个对象，如： `{"conv_size": 2, "hidden_size": 124, "learning_rate": 0.0307, "dropout_rate": 0.2029}`.
+`RECEIVED_PARAMS` 是一个对象，如：
+
+`{"conv_size": 2, "hidden_size": 124, "learning_rate": 0.0307, "dropout_rate": 0.2029}`.
 
 * 定期返回指标数据（可选）
 
@@ -138,7 +140,7 @@ Annotation 的语法和用法等，参考 [Annotation](AnnotationSpec.md)。
 
 如果使用了 Annotation 方法，转换后的 Trial 代码会存放在另一个临时目录中。 可以在 `run.sh` 文件中的 `NNI_OUTPUT_DIR` 变量找到此目录。 文件中的第二行（即：`cd`）会切换到代码所在的实际路径。 参考 `run.sh` 文件样例：
 
-```shell
+```bash
 #!/bin/bash
 cd /tmp/user_name/nni/annotation/tmpzj0h72x6 #This is the actual directory
 export NNI_PLATFORM=local