update Chinese file path as en_US (#764)

zh_CN/docs/conf.py → docs/zh_CN/conf.py

@@ -12,9 +12,9 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../../src/sdk/pynni'))
 
 from recommonmark.parser import CommonMarkParser
 from recommonmark.transform import AutoStructify
@@ -44,6 +44,7 @@ extensions = [
     'sphinx.ext.mathjax',
     'sphinx_markdown_tables',
     'sphinxarg.ext',
+    'sphinx.ext.napoleon',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -107,7 +108,7 @@ html_theme_options = {
 #
 # html_sidebars = {}
 
-html_logo = './img/nni_logo_dark.png'
+html_logo = '../img/nni_logo_dark.png'
 
 # -- Options for HTMLHelp output ---------------------------------------------
 
@@ -188,7 +189,6 @@ epub_exclude_files = ['search.html']
 github_doc_root = 'https://github.com/Microsoft/nni/tree/master/doc/'
 def setup(app):
     app.add_config_value('recommonmark_config', {
-        'url_resolver': lambda url: github_doc_root + url if url.startswith('..') else url,
-        'enable_auto_toc_tree': False,
+        'enable_auto_toc_tree': True,
     }, True)
     app.add_transform(AutoStructify)

zh_CN/src/sdk/pynni/nni/curvefitting_assessor/README.md → docs/zh_CN/curvefittingAssessor.md

@@ -50,18 +50,16 @@ Curve Fitting Assessor 是一个 LPA (learning, predicting, assessing，即学
           # (必须) epoch 的总数。
           # 需要此数据来决定需要预测的点。
           epoch_num: 20
-          # (可选项) choice: maximize, minimize
-          # 如果选择了 minimize 模式，需要调整阈值为 >= 1.0 (例如：threshold=1.1)
-          * optimize_mode 的默认值是 maximize
+          # (可选) 选项: maximize, minimize
+          *  optimize_mode 的默认值是 maximize
           optimize_mode: maximize
-          # (可选项) 决定 Trial 是否应被停止的次数
-          # 为了节省资源，只有在大于 start_step(default=6) 的精度点才开始预测。
-          # 只有在收到 start_step 个中间结果之后。
+          # (可选) 为了节约计算资源，在收到了 start_step 个中间结果后，才开始预测。
           # start_step 的默认值是 6。
           start_step: 6
           # (可选) 决定是否提前终止的阈值。
           # 例如，如果 threshold = 0.95, optimize_mode = maximize，最好的历史结果是 0.9，那么会在 Trial 的预测值低于 0.95 * 0.9 = 0.855 时停止。
           * 阈值的默认值是 0.95。
+          # 注意：如果选择了 minimize 模式，要让 threshold >= 1.0 (如 threshold=1.1)
           threshold: 0.95
     
 

zh_CN/docs/gbdt_example.md → docs/zh_CN/gbdt_example.md

@@ -103,7 +103,7 @@ if __name__ == '__main__':
 }
 ```
 
-参考[这里](./SearchSpaceSpec.md)，了解更多变量类型。
+参考[这里](SearchSpaceSpec.md)，了解更多变量类型。
 
 ### 3.3 在代码中使用 NNI SDK
 

zh_CN/src/sdk/pynni/nni/gridsearch_tuner/README.md → docs/zh_CN/gridsearchTuner.md

@@ -2,4 +2,4 @@
 
 ## Grid Search（遍历搜索）
 
-Grid Search 会穷举定义在搜索空间文件中的所有超参组合。 注意，搜索空间仅支持 `choice`, `quniform`, `qloguniform`。 `quniform` 和 `qloguniform` 中的 **数字 `q` 有不同的含义（与[搜索空间](../../../../../docs/SearchSpaceSpec.md)说明不同）。 这里的意义是在 `low` 和 `high` 之间均匀取值的数量。</p>
\ No newline at end of file
+Grid Search 会穷举定义在搜索空间文件中的所有超参组合。 注意，搜索空间仅支持 `choice`, `quniform`, `qloguniform`。 `quniform` 和 `qloguniform` 中的 **数字 `q` 有不同的含义（与[搜索空间](SearchSpaceSpec.md)说明不同）。 这里的意义是在 `low` 和 `high` 之间均匀取值的数量。</p>
\ No newline at end of file

zh_CN/docs/multiPhase.md → docs/zh_CN/multiPhase.md

@@ -12,7 +12,7 @@
 
 参考以下步骤来使用多阶段 Experiment：
 
-1. 实现 nni.multi_phase.MultiPhaseTuner。 例如，[ENAS tuner](https://github.com/countif/enas_nni/blob/master/nni/examples/tuners/enas/nni_controller_ptb.py) 就是一个实现了 nni.multi_phase.MultiPhaseTuner 的 Tuner。 在实现多阶段 Tuner 时，可能要用 generate_parameters 中的 trial_job_id 参数来为每个 Trial 作业生成超参。
+1. 实现 nni.multi_phase.MultiPhaseTuner。 如，[ENAS tuner](https://github.com/countif/enas_nni/blob/master/nni/examples/tuners/enas/nni_controller_ptb.py) 是实现了 nni.multi_phase.MultiPhaseTuner 的 Tuner。 在实现多阶段 Tuner 时，可能要用 generate_parameters 中的 trial_job_id 参数来为每个 Trial 作业生成超参。
 
 2. 设置 `multiPhase` 的值为 `true`，并将第一步中实现的 Tuner 作为自定义 Tuner 进行配置，例如：
     

zh_CN/src/sdk/pynni/nni/networkmorphism_tuner/README.md → docs/zh_CN/networkmorphismTuner.md

-# NNI 中的 Network Morphism Tuner
+# Network Morphism Tuner
 
 ## 1. 介绍
 
 [Autokeras](https://arxiv.org/abs/1806.10282) 是使用 Network Morphism 算法的流行的自动机器学习工具。 Autokeras 的基本理念是使用贝叶斯回归来预测神经网络架构的指标。 每次都会从父网络生成几个子网络。 然后使用朴素贝叶斯回归，从网络的历史训练结果来预测它的指标值。 接下来，会选择预测结果最好的子网络加入训练队列中。 在[此代码](https://github.com/jhfjhfj1/autokeras)的启发下，我们在 NNI 中实现了 Network Morphism 算法。
 
-要了解 Network Morphism Trial 的用法，参考 [Readme.md](../../../../../examples/trials/network-morphism/README.md)，了解更多细节。
+要了解 Network Morphism Trial 的用法，参考 [Readme_zh_CN.md](https://github.com/Microsoft/nni/blob/master/examples/trials/network_morphism/README_zh_CN.md)，了解更多细节。
 
 ## 2. 用法
 

zh_CN/docs/sdk_reference.rst → docs/zh_CN/sdk_reference.rst

@@ -2,7 +2,7 @@
 Python API 参考
 ###########################
 
-Trial
+Trial（尝试）
 ------------------------
 ..  autofunction:: nni.get_next_parameter
 ..  autofunction:: nni.get_current_parameter
@@ -11,7 +11,7 @@ Trial
 ..  autofunction:: nni.get_sequence_id
 
 
-Tuner
+Tuner（调参器）
 ------------------------
 ..  autoclass:: nni.tuner.Tuner
     :members:
@@ -22,13 +22,19 @@ Tuner
 ..  autoclass:: nni.evolution_tuner.evolution_tuner.EvolutionTuner
     :members:
 
+..  autoclass:: nni.smac_tuner.smac_tuner.SMACTuner
+    :members:
+
 ..  autoclass:: nni.gridsearch_tuner.gridsearch_tuner.GridSearchTuner
     :members:
 
-..  autoclass:: nni.smac_tuner.smac_tuner.SMACTuner
+..  autoclass:: nni.networkmorphism_tuner.networkmorphism_tuner.NetworkMorphismTuner
+    :members:
+
+..  autoclass:: nni.metis_tuner.metis_tuner.MetisTuner
     :members:
 
-Assessor
+Assessor（评估器）
 ------------------------
 ..  autoclass:: nni.assessor.Assessor
     :members:
@@ -42,4 +48,5 @@ Assessor
 
 Advisor
 ------------------------
-..  autoclass:: nni.hyperband_advisor.hyperband_advisor.Hyperband
\ No newline at end of file
+..  autoclass:: nni.hyperband_advisor.hyperband_advisor.Hyperband
+    :members:
\ No newline at end of file

docs/zh_CN/smacTuner.md

+# SMAC Tuner
+
+## SMAC
+
+[SMAC](https://www.cs.ubc.ca/~hutter/papers/10-TR-SMAC.pdf) 基于 Sequential Model-Based Optimization (SMBO). 它利用使用过的结果好的模型（高斯随机过程模型），并将随机森林引入到 SMBO 中，来处理分类参数。 NNI 的 SMAC 通过包装 [SMAC3](https://github.com/automl/SMAC3) 来支持。
+
+NNI 中的 SMAC 只支持部分类型的[搜索空间](SearchSpaceSpec.md)，包括`choice`, `randint`, `uniform`, `loguniform`, `quniform(q=1)`。
\ No newline at end of file