Commit bc0e55a0 authored by Shufan Huang's avatar Shufan Huang Committed by QuanluZhang
Browse files

Unified doc's name & update docs (#1069)

* update docs
parent 0b864c7a
......@@ -63,4 +63,4 @@ After the code changes, use **step 3** to rebuild your codes, then the changes w
---
At last, wish you have a wonderful day.
For more contribution guidelines on making PR's or issues to NNI source code, you can refer to our [CONTRIBUTING](./CONTRIBUTING.md) document.
For more contribution guidelines on making PR's or issues to NNI source code, you can refer to our [Contributing](./Contributing.md) document.
......@@ -41,14 +41,14 @@ RECEIVED_PARAMS = nni.get_next_parameter()
```python
nni.report_intermediate_result(metrics)
```
`metrics` could be any python object. If users use NNI built-in tuner/assessor, `metrics` can only have two formats: 1) a number e.g., float, int, 2) a dict object that has a key named `default` whose value is a number. This `metrics` is reported to [assessor](Builtin_Assessors.md). Usually, `metrics` could be periodically evaluated loss or accuracy.
`metrics` could be any python object. If users use NNI built-in tuner/assessor, `metrics` can only have two formats: 1) a number e.g., float, int, 2) a dict object that has a key named `default` whose value is a number. This `metrics` is reported to [assessor](BuiltinAssessors.md). Usually, `metrics` could be periodically evaluated loss or accuracy.
- Report performance of the configuration
```python
nni.report_final_result(metrics)
```
`metrics` also could be any python object. If users use NNI built-in tuner/assessor, `metrics` follows the same format rule as that in `report_intermediate_result`, the number indicates the model's performance, for example, the model's accuracy, loss etc. This `metrics` is reported to [tuner](Builtin_Tuner.md).
`metrics` also could be any python object. If users use NNI built-in tuner/assessor, `metrics` follows the same format rule as that in `report_intermediate_result`, the number indicates the model's performance, for example, the model's accuracy, loss etc. This `metrics` is reported to [tuner](BuiltinTuner.md).
### Step 3 - Enable NNI API
......@@ -156,8 +156,8 @@ For more information, please refer to [HowToDebug](HowToDebug.md)
<a name="more-examples"></a>
## More Trial Examples
* [MNIST examples](mnist_examples.md)
* [Finding out best optimizer for Cifar10 classification](cifar10_examples.md)
* [How to tune Scikit-learn on NNI](sklearn_examples.md)
* [Automatic Model Architecture Search for Reading Comprehension.](SQuAD_evolution_examples.md)
* [Tuning GBDT on NNI](gbdt_example.md)
* [MNIST examples](MnistExamples.md)
* [Finding out best optimizer for Cifar10 classification](Cifar10Examples.md)
* [How to tune Scikit-learn on NNI](SklearnExamples.md)
* [Automatic Model Architecture Search for Reading Comprehension.](SquadEvolutionExamples.md)
* [Tuning GBDT on NNI](GbdtExample.md)
......@@ -2,5 +2,5 @@ Advanced Features
=====================
.. toctree::
MultiPhase<multiPhase>
AdvancedNAS
\ No newline at end of file
MultiPhase<MultiPhase>
AdvancedNas<AdvancedNas>
\ No newline at end of file
......@@ -15,5 +15,5 @@ Like Tuners, users can either use built-in Assessors, or customize an Assessor o
.. toctree::
:maxdepth: 2
Builtin Assessors<builtinAssessor>
Customized Assessors<Customize_Assessor>
Builtin Assessors<BuiltinAssessor>
Customized Assessors<CustomizeAssessor>
Builtin-Tuners
==================
.. toctree::
:maxdepth: 1
Overview<Builtin_Tuner>
TPE<hyperoptTuner>
Random Search<hyperoptTuner>
Anneal<hyperoptTuner>
Naive Evolution<evolutionTuner>
SMAC<smacTuner>
Batch Tuner<batchTuner>
Grid Search<gridsearchTuner>
Hyperband<hyperbandAdvisor>
Network Morphism<networkmorphismTuner>
Metis Tuner<metisTuner>
BOHB<bohbAdvisor>
\ No newline at end of file
......@@ -4,6 +4,6 @@ Builtin-Assessors
.. toctree::
:maxdepth: 1
Overview<Builtin_Assessors>
Medianstop<medianstopAssessor>
Curvefitting<curvefittingAssessor>
\ No newline at end of file
Overview<BuiltinAssessors>
Medianstop<MedianstopAssessor>
Curvefitting<CurvefittingAssessor>
\ No newline at end of file
Builtin-Tuners
==================
.. toctree::
:maxdepth: 1
Overview<BuiltinTuner>
TPE<HyperoptTuner>
Random Search<HyperoptTuner>
Anneal<HyperoptTuner>
Naive Evolution<EvolutionTuner>
SMAC<SmacTuner>
Batch Tuner<BatchTuner>
Grid Search<GridsearchTuner>
Hyperband<HyperbandAdvisor>
Network Morphism<NetworkmorphismTuner>
Metis Tuner<MetisTuner>
BOHB<BohbAdvisor>
\ No newline at end of file
......@@ -3,5 +3,5 @@ Contribute to NNI
###############################
.. toctree::
Development Setup<SetupNNIDeveloperEnvironment>
Contribution Guide<CONTRIBUTING>
\ No newline at end of file
Development Setup<SetupNniDeveloperEnvironment>
Contribution Guide<Contributing>
\ No newline at end of file
......@@ -5,8 +5,8 @@ Examples
.. toctree::
:maxdepth: 2
MNIST<mnist_examples>
Cifar10<cifar10_examples>
Scikit-learn<sklearn_examples>
EvolutionSQuAD<SQuAD_evolution_examples>
GBDT<gbdt_example>
MNIST<MnistExamples>
Cifar10<Cifar10Examples>
Scikit-learn<SklearnExamples>
EvolutionSQuAD<SquadEvolutionExamples>
GBDT<GbdtExample>
......@@ -13,10 +13,10 @@ Contents
Overview
QuickStart<QuickStart>
Tutorials
Examples
Reference
Tutorials<tutorials>
Examples<examples>
Reference<reference>
FAQ
Contribution
Changelog<RELEASE>
Contribution<contribution>
Changelog<Release>
Blog<Blog/index>
......@@ -4,7 +4,7 @@ References
.. toctree::
:maxdepth: 3
Command Line <NNICTLDOC>
Command Line <Nnictl>
Python API <sdk_reference>
Annotation <AnnotationSpec>
Configuration<ExperimentConfig>
......
......@@ -4,6 +4,6 @@ Introduction to NNI Training Services
.. toctree::
Local<LocalMode>
Remote<RemoteMachineMode>
OpenPAI<PAIMode>
OpenPAI<PaiMode>
Kubeflow<KubeflowMode>
FrameworkController<FrameworkControllerMode>
\ No newline at end of file
......@@ -13,6 +13,6 @@ For details, please refer to the following tutorials:
.. toctree::
:maxdepth: 2
Builtin Tuners<builtinTuner>
Customized Tuners<Customize_Tuner>
Customized Advisor<Customize_Advisor>
\ No newline at end of file
Builtin Tuners<BuiltinTuner>
Customized Tuners<CustomizeTuner>
Customized Advisor<CustomizeAdvisor>
\ No newline at end of file
......@@ -54,4 +54,4 @@ python >= 3.5
please reference to the [NNI CTL document].
[NNI CTL document]: ../docs/en_US/NNICTLDOC.md
[NNI CTL document]: ../docs/en_US/Nnictl.md
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment