From 72489e34ce8f4edad776f68bb785d33502e162a1 Mon Sep 17 00:00:00 2001 From: Chi Song Date: Tue, 21 May 2019 15:36:27 +0800 Subject: [PATCH] update names --- docs/zh_CN/AdvancedNas.md | 2 +- docs/zh_CN/Contributing.md | 4 ++-- docs/zh_CN/Release.md | 24 +++++++++++----------- docs/zh_CN/SetupNniDeveloperEnvironment.md | 2 +- docs/zh_CN/contribution.rst | 4 ++-- docs/zh_CN/examples.rst | 10 ++++----- docs/zh_CN/reference.rst | 2 +- 7 files changed, 24 insertions(+), 24 deletions(-) diff --git a/docs/zh_CN/AdvancedNas.md b/docs/zh_CN/AdvancedNas.md index e326d3686a..f77ef2fa1c 100644 --- a/docs/zh_CN/AdvancedNas.md +++ b/docs/zh_CN/AdvancedNas.md @@ -15,7 +15,7 @@ ```yaml tuner: codeDir: path/to/customer_tuner - classFileName: customer_tuner.py + classFileName: customer_tuner.py className: CustomerTuner classArgs: ... diff --git a/docs/zh_CN/Contributing.md b/docs/zh_CN/Contributing.md index 5e9ea69550..f4d622f0ad 100644 --- a/docs/zh_CN/Contributing.md +++ b/docs/zh_CN/Contributing.md @@ -29,7 +29,7 @@ 拉取请求需要选好正确的标签，表明是 Bug 修复还是功能改进。 所有代码都需要遵循正确的命名约定和代码风格。 -参考[如何配置 NNI 的开发环境](./SetupNniDeveloperEnvironment.md)，来安装开发环境。 +参考[如何配置 NNI 的开发环境](./SetupNNIDeveloperEnvironment.md)，来安装开发环境。 与[快速入门](QuickStart.md)类似。 其它内容，参考[NNI 文档](http://nni.readthedocs.io)。 @@ -42,7 +42,7 @@ ## 代码风格和命名约定 * NNI 遵循 [PEP8](https://www.python.org/dev/peps/pep-0008/) 的 Python 代码命名约定。在提交拉取请求时，请尽量遵循此规范。 可通过`flake8`或`pylint`的提示工具来帮助遵循规范。 -* NNI 还遵循 [NumPy Docstring 风格](https://www.sphinx-doc.org/en/master/usage/extensions/example_numpy.html#example-numpy) 的 Python Docstring 命名方案。 Python API 使用了[sphinx.ext.napoleon](https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html) 来[生成文档](Contributing.md#documentation)。 +* NNI 还遵循 [NumPy Docstring 风格](https://www.sphinx-doc.org/en/master/usage/extensions/example_numpy.html#example-numpy) 的 Python Docstring 命名方案。 Python API 使用了[sphinx.ext.napoleon](https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html) 来[生成文档](CONTRIBUTING.md#documentation)。 ## 文档 diff --git a/docs/zh_CN/Release.md b/docs/zh_CN/Release.md index 4d87d5b648..722db6cfa4 100644 --- a/docs/zh_CN/Release.md +++ b/docs/zh_CN/Release.md @@ -6,9 +6,9 @@ * [支持在 Windows 上使用 NNI](./WindowsLocalMode.md) * NNI 可在 Windows 上使用本机模式 -* [支持新的 Advisor: BOHB](./BohbAdvisor.md) +* [支持新的 Advisor: BOHB](./bohbAdvisor.md) * 支持新的 BOHB Advisor，这是一个健壮而有效的超参调优算法，囊括了贝叶斯优化和 Hyperband 的优点 -* [支持通过 nnictl 来导入导出 Experiment 数据](./Nnictl.md#experiment) +* [支持通过 nnictl 来导入导出 Experiment 数据](./NNICTLDOC.md#experiment) * 在 Experiment 执行完后，可生成分析结果报告 * 支持将先前的调优数据导入到 Tuner 和 Advisor 中 * [可为 NNI Trial 任务指定 GPU](./ExperimentConfig.md#localConfig) @@ -31,7 +31,7 @@ ### 主要功能 -* [版本检查](https://github.com/Microsoft/nni/blob/master/docs/zh_CN/PaiMode.md#version-check) +* [版本检查](https://github.com/Microsoft/nni/blob/master/docs/en_US/PAIMode.md#version-check) * 检查 nniManager 和 trialKeeper 的版本是否一致 * [提前终止的任务也可返回最终指标](https://github.com/Microsoft/nni/issues/776) * 如果 includeIntermediateResults 为 true，最后一个 Assessor 的中间结果会被发送给 Tuner 作为最终结果。 includeIntermediateResults 的默认值为 false。 @@ -93,10 +93,10 @@ #### 支持新的 Tuner 和 Assessor -* 支持新的 [Metis Tuner](MetisTuner.md)。 **在线**超参调优的场景下，Metis 算法已经被证明非常有效。 +* 支持新的 [Metis Tuner](metisTuner.md)。 **在线**超参调优的场景下，Metis 算法已经被证明非常有效。 * 支持 [ENAS customized tuner](https://github.com/countif/enas_nni)。由 GitHub 社区用户所贡献。它是神经网络的搜索算法，能够通过强化学习来学习神经网络架构，比 NAS 的性能更好。 -* 支持 [Curve fitting （曲线拟合）Assessor](CurvefittingAssessor.md)，通过曲线拟合的策略来实现提前终止 Trial。 -* 进一步支持 [Weight Sharing（权重共享）](./AdvancedNas.md)：为 NAS Tuner 通过 NFS 来提供权重共享。 +* 支持 [Curve fitting （曲线拟合）Assessor](curvefittingAssessor.md)，通过曲线拟合的策略来实现提前终止 Trial。 +* 进一步支持 [Weight Sharing（权重共享）](./AdvancedNAS.md)：为 NAS Tuner 通过 NFS 来提供权重共享。 #### 改进训练平台 @@ -118,7 +118,7 @@ #### 支持新的 Tuner -* 支持新的 [network morphism](NetworkmorphismTuner.md) Tuner。 +* 支持新的 [network morphism](networkmorphismTuner.md) Tuner。 #### 改进训练平台 @@ -152,8 +152,8 @@ * [Kubeflow 训练服务](./KubeflowMode.md) * 支持 tf-operator * 使用 Kubeflow 的[分布式 Trial 样例](https://github.com/Microsoft/nni/tree/master/examples/trials/mnist-distributed/dist_mnist.py) -* [网格搜索 Tuner](GridsearchTuner.md) -* [Hyperband Tuner](HyperbandAdvisor.md) +* [网格搜索 Tuner](gridsearchTuner.md) +* [Hyperband Tuner](hyperbandAdvisor.md) * 支持在 MAC 上运行 NNI Experiment * Web 界面 * 支持 hyperband Tuner @@ -187,7 +187,7 @@ nnictl create --port 8081 --config ``` -* 支持更新最大 Trial 的数量。 使用 `nnictl update --help` 了解详情。 或参考 [NNICTL](Nnictl.md) 查看完整帮助。 +* 支持更新最大 Trial 的数量。 使用 `nnictl update --help` 了解详情。 或参考 [NNICTL](NNICTLDOC.md) 查看完整帮助。 ### API 的新功能和更新 @@ -233,10 +233,10 @@ ### 主要功能 -* 支持 [OpenPAI](https://github.com/Microsoft/pai) (又称 pai) 训练服务 (参考[这里](./PaiMode.md)来了解如何在 pai 模式下提交 NNI 任务) +* 支持 [OpenPAI](https://github.com/Microsoft/pai) (又称 pai) 训练服务 (参考[这里](./PAIMode.md)来了解如何在 OpenPAI 下提交 NNI 任务) * 支持 pai 模式的训练服务。 NNI Trial 可发送至 OpenPAI 集群上运行 * NNI Trial 输出 (包括日志和模型文件) 会被复制到 OpenPAI 的 HDFS 中。 -* 支持 [SMAC](https://www.cs.ubc.ca/~hutter/papers/10-TR-SMAC.pdf) Tuner (参考[这里](SmacTuner.md)，了解如何使用 SMAC Tuner) +* 支持 [SMAC](https://www.cs.ubc.ca/~hutter/papers/10-TR-SMAC.pdf) Tuner (参考[这里](smacTuner.md)，了解如何使用 SMAC Tuner) * [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 安装在 [conda](https://conda.io/docs/index.html) 和 Python 虚拟环境中。 * 其它 diff --git a/docs/zh_CN/SetupNniDeveloperEnvironment.md b/docs/zh_CN/SetupNniDeveloperEnvironment.md index 3ad07ae443..e243be2a11 100644 --- a/docs/zh_CN/SetupNniDeveloperEnvironment.md +++ b/docs/zh_CN/SetupNniDeveloperEnvironment.md @@ -57,4 +57,4 @@ Trial 启动 Experiment 来检查环境。 例如，运行命令 * * * -最后，希望一切顺利。 参考[贡献](./Contributing.md)文档，来了解更多创建拉取请求或问题的指南。 \ No newline at end of file +最后，希望一切顺利。 参考[贡献](./CONTRIBUTING.md)文档，来了解更多创建拉取请求或问题的指南。 \ No newline at end of file diff --git a/docs/zh_CN/contribution.rst b/docs/zh_CN/contribution.rst index 227aa22c03..74940f7c7a 100644 --- a/docs/zh_CN/contribution.rst +++ b/docs/zh_CN/contribution.rst @@ -3,5 +3,5 @@ ############################### .. toctree:: - 设置开发环境 - 贡献指南 \ No newline at end of file + 设置开发环境 + 贡献指南 \ No newline at end of file diff --git a/docs/zh_CN/examples.rst b/docs/zh_CN/examples.rst index 95437431c1..0e4e0bccb2 100644 --- a/docs/zh_CN/examples.rst +++ b/docs/zh_CN/examples.rst @@ -5,8 +5,8 @@ .. toctree:: :maxdepth: 2 - MNIST - Cifar10 - Scikit-learn - EvolutionSQuAD - GBDT + MNIST + Cifar10 + Scikit-learn + EvolutionSQuAD + GBDT diff --git a/docs/zh_CN/reference.rst b/docs/zh_CN/reference.rst index 67f41eed70..bcace87714 100644 --- a/docs/zh_CN/reference.rst +++ b/docs/zh_CN/reference.rst @@ -4,7 +4,7 @@ .. toctree:: :maxdepth: 3 - 命令行 + 命令行 Python API Annotation 配置