Skip to content

GitLab

Unverified Commit 39782f12 authored by xuehui's avatar xuehui Committed by GitHub
Browse files

Update all doc structure (#1285) 

* update readme in ga_squad

* update readme

* fix typo

* Update README.md

* Update README.md

* Update README.md

* update readme

* update

* fix path

* update reference

* fix bug in config file

* update nni_arch_overview.png

* update

* update

* update

* update home page

* update default value of metis tuner

* fix broken link in CommunitySharings

* update docs about nested search space

* update docs

* rename cascding to nested

* fix broken link

* update

* update issue link

* fix typo

* update evaluate parameters from GMM

* refine code

* fix optimized mode bug

* update import warning

* update warning

* update optimized mode

* first commit for update doc structure

* mv the localmode and remotemode to traningservice

* update
parent b7cd20e6
Hide whitespace changes
Inline Side-by-side
Showing with 73 additions and 73 deletions
docs/en_US/QuickStart.md → docs/en_US/Tutorial/QuickStart.md
View file @ 39782f12
...@@ -201,28 +201,28 @@ Click the tab "Overview". ...@@ -201,28 +201,28 @@ Click the tab "Overview".
Information about this experiment will be shown in the WebUI, including the experiment trial profile and search space message. NNI also support `download these information and parameters` through the **Download** button. You can download the experiment result anytime in the middle for the running or at the end of the execution, etc. Information about this experiment will be shown in the WebUI, including the experiment trial profile and search space message. NNI also support `download these information and parameters` through the **Download** button. You can download the experiment result anytime in the middle for the running or at the end of the execution, etc.
![](../img/QuickStart1.png) ![](../../img/QuickStart1.png)
Top 10 trials will be listed in the Overview page, you can browse all the trials in "Trials Detail" page. Top 10 trials will be listed in the Overview page, you can browse all the trials in "Trials Detail" page.
![](../img/QuickStart2.png) ![](../../img/QuickStart2.png)
#### View trials detail page #### View trials detail page
Click the tab "Default Metric" to see the point graph of all trials. Hover to see its specific default metric and search space message. Click the tab "Default Metric" to see the point graph of all trials. Hover to see its specific default metric and search space message.
![](../img/QuickStart3.png) ![](../../img/QuickStart3.png)
Click the tab "Hyper Parameter" to see the parallel graph. Click the tab "Hyper Parameter" to see the parallel graph.
* You can select the percentage to see top trials. * You can select the percentage to see top trials.
* Choose two axis to swap its positions * Choose two axis to swap its positions
![](../img/QuickStart4.png) ![](../../img/QuickStart4.png)
Click the tab "Trial Duration" to see the bar graph. Click the tab "Trial Duration" to see the bar graph.
![](../img/QuickStart5.png) ![](../../img/QuickStart5.png)
Below is the status of the all trials. Specifically: Below is the status of the all trials. Specifically:
...@@ -231,20 +231,20 @@ Below is the status of the all trials. Specifically: ...@@ -231,20 +231,20 @@ Below is the status of the all trials. Specifically:
* Kill: you can kill a job that status is running. * Kill: you can kill a job that status is running.
* Support to search for a specific trial. * Support to search for a specific trial.
![](../img/QuickStart6.png) ![](../../img/QuickStart6.png)
* Intermediate Result Graph * Intermediate Result Graph
![](../img/QuickStart7.png) ![](../../img/QuickStart7.png)
## Related Topic ## Related Topic
* [Try different Tuners](BuiltinTuner.md) * [Try different Tuners](../Tuner/BuiltinTuner.md)
* [Try different Assessors](BuiltinAssessor.md) * [Try different Assessors](../Assessor/BuiltinAssessor.md)
* [How to use command line tool nnictl](Nnictl.md) * [How to use command line tool nnictl](Nnictl.md)
* [How to write a trial](Trials.md) * [How to write a trial](../TrialExample/Trials.md)
* [How to run an experiment on local (with multiple GPUs)?](LocalMode.md) * [How to run an experiment on local (with multiple GPUs)?](../TrainingService/LocalMode.md)
* [How to run an experiment on multiple machines?](RemoteMachineMode.md) * [How to run an experiment on multiple machines?](../TrainingService/RemoteMachineMode.md)
* [How to run an experiment on OpenPAI?](PaiMode.md) * [How to run an experiment on OpenPAI?](../TrainingService/PaiMode.md)
* [How to run an experiment on Kubernetes through Kubeflow?](KubeflowMode.md) * [How to run an experiment on Kubernetes through Kubeflow?](../TrainingService/KubeflowMode.md)
* [How to run an experiment on Kubernetes through FrameworkController?](FrameworkControllerMode.md) * [How to run an experiment on Kubernetes through FrameworkController?](../TrainingService/FrameworkControllerMode.md)
docs/en_US/SearchSpaceSpec.md → docs/en_US/Tutorial/SearchSpaceSpec.md
View file @ 39782f12
...@@ -102,4 +102,4 @@ Known Limitations: ...@@ -102,4 +102,4 @@ Known Limitations:
* Only Random Search/TPE/Anneal/Evolution tuner supports nested search space * Only Random Search/TPE/Anneal/Evolution tuner supports nested search space
* We do not support nested search space "Hyper Parameter" parallel graph now, the enhancement is being considered in #1110(https://github.com/microsoft/nni/issues/1110), any suggestions or discussions or contributions are warmly welcomed * We do not support nested search space "Hyper Parameter" in visualization now, the enhancement is being considered in #1110(https://github.com/microsoft/nni/issues/1110), any suggestions or discussions or contributions are warmly welcomed
docs/en_US/WebUI.md → docs/en_US/Tutorial/WebUI.md
View file @ 39782f12
...@@ -10,16 +10,16 @@ Click the tab "Overview". ...@@ -10,16 +10,16 @@ Click the tab "Overview".
* If you have any question, you can click "Feedback" to report it. * If you have any question, you can click "Feedback" to report it.
* If your experiment have more than 1000 trials, you can change the refresh interval on here. * If your experiment have more than 1000 trials, you can change the refresh interval on here.
![](../img/webui-img/over1.png) ![](../../img/webui-img/over1.png)
* See good performance trials. * See good performance trials.
![](../img/webui-img/over2.png) ![](../../img/webui-img/over2.png)
## View job default metric ## View job default metric
Click the tab "Default Metric" to see the point graph of all trials. Hover to see its specific default metric and search space message. Click the tab "Default Metric" to see the point graph of all trials. Hover to see its specific default metric and search space message.
![](../img/accuracy.png) ![](../../img/accuracy.png)
## View hyper parameter ## View hyper parameter
...@@ -28,24 +28,24 @@ Click the tab "Hyper Parameter" to see the parallel graph. ...@@ -28,24 +28,24 @@ Click the tab "Hyper Parameter" to see the parallel graph.
* You can select the percentage to see top trials. * You can select the percentage to see top trials.
* Choose two axis to swap its positions * Choose two axis to swap its positions
![](../img/hyperPara.png) ![](../../img/hyperPara.png)
## View Trial Duration ## View Trial Duration
Click the tab "Trial Duration" to see the bar graph. Click the tab "Trial Duration" to see the bar graph.
![](../img/trial_duration.png) ![](../../img/trial_duration.png)
## View Trial Intermediate Result Graph ## View Trial Intermediate Result Graph
Click the tab "Intermediate Result" to see the lines graph. Click the tab "Intermediate Result" to see the lines graph.
![](../img/webui-img/trials_intermeidate.png) ![](../../img/webui-img/trials_intermeidate.png)
The graph has a filter function. You can open the filter button. And then enter your focus point The graph has a filter function. You can open the filter button. And then enter your focus point
in the scape input. Simultaneously, intermediate result inputs can limit the intermediate's range. in the scape input. Simultaneously, intermediate result inputs can limit the intermediate's range.
![](../img/webui-img/filter_intermediate.png) ![](../../img/webui-img/filter_intermediate.png)
## View trials status ## View trials status
...@@ -53,27 +53,27 @@ Click the tab "Trials Detail" to see the status of the all trials. Specifically: ...@@ -53,27 +53,27 @@ Click the tab "Trials Detail" to see the status of the all trials. Specifically:
* Trial detail: trial's id, trial's duration, start time, end time, status, accuracy and search space file. * Trial detail: trial's id, trial's duration, start time, end time, status, accuracy and search space file.
![](../img/webui-img/detail-local.png) ![](../../img/webui-img/detail-local.png)
* The button named "Add column" can select which column to show in the table. If you run an experiment that final result is dict, you can see other keys in the table. * The button named "Add column" can select which column to show in the table. If you run an experiment that final result is dict, you can see other keys in the table.
![](../img/webui-img/addColumn.png) ![](../../img/webui-img/addColumn.png)
* If you want to compare some trials, you can select them and then click "Compare" to see the results. * If you want to compare some trials, you can select them and then click "Compare" to see the results.
![](../img/webui-img/compare.png) ![](../../img/webui-img/compare.png)
* You can use the button named "Copy as python" to copy trial's parameters. * You can use the button named "Copy as python" to copy trial's parameters.
![](../img/webui-img/copyParameter.png) ![](../../img/webui-img/copyParameter.png)
* If you run on OpenPAI or Kubeflow platform, you can also see the hdfsLog. * If you run on OpenPAI or Kubeflow platform, you can also see the hdfsLog.
![](../img/webui-img/detail-pai.png) ![](../../img/webui-img/detail-pai.png)
* Kill: you can kill a job that status is running. * Kill: you can kill a job that status is running.
* Support to search for a specific trial. * Support to search for a specific trial.
* Intermediate Result Graph: you can see default and other keys in this graph. * Intermediate Result Graph: you can see default and other keys in this graph.
![](../img/webui-img/intermediate.png) ![](../../img/webui-img/intermediate.png)
docs/en_US/advanced.rst
View file @ 39782f12
...@@ -2,6 +2,6 @@ Advanced Features ...@@ -2,6 +2,6 @@ Advanced Features
===================== =====================
.. toctree:: .. toctree::
MultiPhase<MultiPhase> MultiPhase<./AdvancedFeature/MultiPhase>
AdvancedNas<AdvancedNas> AdvancedNas<./AdvancedFeature/AdvancedNas>
NAS Programming Interface<GeneralNasInterfaces> NAS Programming Interface<./AdvancedFeature/GeneralNasInterfaces>
\ No newline at end of file \ No newline at end of file
docs/en_US/assessors.rst
View file @ 39782f12
...@@ -15,5 +15,5 @@ Like Tuners, users can either use built-in Assessors, or customize an Assessor o ...@@ -15,5 +15,5 @@ Like Tuners, users can either use built-in Assessors, or customize an Assessor o
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
Builtin Assessors<BuiltinAssessor> Builtin Assessors<./Assessor/BuiltinAssessor>
Customized Assessors<CustomizeAssessor> Customized Assessors<./Assessor/CustomizeAssessor>
docs/en_US/builtin_assessor.rst
View file @ 39782f12
...@@ -4,6 +4,6 @@ Builtin-Assessors ...@@ -4,6 +4,6 @@ Builtin-Assessors
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
Overview<BuiltinAssessor> Overview<./Assessor/BuiltinAssessor>
Medianstop<MedianstopAssessor> Medianstop<./Assessor/MedianstopAssessor>
Curvefitting<CurvefittingAssessor> Curvefitting<./Assessor/CurvefittingAssessor>
\ No newline at end of file \ No newline at end of file
docs/en_US/builtin_tuner.rst
View file @ 39782f12
...@@ -4,15 +4,15 @@ Builtin-Tuners ...@@ -4,15 +4,15 @@ Builtin-Tuners
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
Overview<BuiltinTuner> Overview<./Tuner/BuiltinTuner>
TPE<HyperoptTuner> TPE<./Tuner/HyperoptTuner>
Random Search<HyperoptTuner> Random Search<./Tuner/HyperoptTuner>
Anneal<HyperoptTuner> Anneal<./Tuner/HyperoptTuner>
Naive Evolution<EvolutionTuner> Naive Evolution<./Tuner/EvolutionTuner>
SMAC<SmacTuner> SMAC<./Tuner/SmacTuner>
Batch Tuner<BatchTuner> Batch Tuner<./Tuner/BatchTuner>
Grid Search<GridsearchTuner> Grid Search<./Tuner/GridsearchTuner>
Hyperband<HyperbandAdvisor> Hyperband<./Tuner/HyperbandAdvisor>
Network Morphism<NetworkmorphismTuner> Network Morphism<./Tuner/NetworkmorphismTuner>
Metis Tuner<MetisTuner> Metis Tuner<./Tuner/MetisTuner>
BOHB<BohbAdvisor> BOHB<./Tuner/BohbAdvisor>
\ No newline at end of file \ No newline at end of file
docs/en_US/contribution.rst
View file @ 39782f12
...@@ -3,5 +3,5 @@ Contribute to NNI ...@@ -3,5 +3,5 @@ Contribute to NNI
############################### ###############################
.. toctree:: .. toctree::
Development Setup<SetupNniDeveloperEnvironment> Development Setup<./Tutorial/SetupNniDeveloperEnvironment>
Contribution Guide<Contributing> Contribution Guide<./Tutorial/Contributing>
\ No newline at end of file \ No newline at end of file
docs/en_US/examples.rst
View file @ 39782f12
...@@ -5,8 +5,8 @@ Examples ...@@ -5,8 +5,8 @@ Examples
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
MNIST<MnistExamples> MNIST<./TrialExample/MnistExamples>
Cifar10<Cifar10Examples> Cifar10<./TrialExample/Cifar10Examples>
Scikit-learn<SklearnExamples> Scikit-learn<./TrialExample/SklearnExamples>
EvolutionSQuAD<SquadEvolutionExamples> EvolutionSQuAD<./TrialExample/SquadEvolutionExamples>
GBDT<GbdtExample> GBDT<./TrialExample/GbdtExample>
docs/en_US/index.rst
View file @ 39782f12
...@@ -12,7 +12,7 @@ Contents ...@@ -12,7 +12,7 @@ Contents
:titlesonly: :titlesonly:
Overview Overview
QuickStart<QuickStart> QuickStart<./Tutorial/QuickStart>
Tutorials<tutorials> Tutorials<tutorials>
Examples<examples> Examples<examples>
Reference<reference> Reference<reference>
......
docs/en_US/reference.rst
View file @ 39782f12
...@@ -4,9 +4,9 @@ References ...@@ -4,9 +4,9 @@ References
.. toctree:: .. toctree::
:maxdepth: 3 :maxdepth: 3
Command Line <Nnictl> Command Line <./Tutorial/Nnictl>
Python API <sdk_reference> Python API <sdk_reference>
Annotation <AnnotationSpec> Annotation <./Tutorial/AnnotationSpec>
Configuration<ExperimentConfig> Configuration<./Tutorial/ExperimentConfig>
Search Space <SearchSpaceSpec> Search Space <./Tutorial/SearchSpaceSpec>
TrainingService <HowToImplementTrainingService> TrainingService <./Tutorial/HowToImplementTrainingService>
docs/en_US/training_services.rst
View file @ 39782f12
...@@ -2,8 +2,8 @@ Introduction to NNI Training Services ...@@ -2,8 +2,8 @@ Introduction to NNI Training Services
===================================== =====================================
.. toctree:: .. toctree::
Local<LocalMode> Local<./TrainingService/LocalMode>
Remote<RemoteMachineMode> Remote<./TrainingService/RemoteMachineMode>
OpenPAI<PaiMode> OpenPAI<./TrainingService/PaiMode>
Kubeflow<KubeflowMode> Kubeflow<./TrainingService/KubeflowMode>
FrameworkController<FrameworkControllerMode> FrameworkController<./TrainingService/FrameworkControllerMode>
\ No newline at end of file \ No newline at end of file
docs/en_US/tuners.rst
View file @ 39782f12
...@@ -13,6 +13,6 @@ For details, please refer to the following tutorials: ...@@ -13,6 +13,6 @@ For details, please refer to the following tutorials:
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
Builtin Tuners<BuiltinTuner> Builtin Tuners<./Tuner/BuiltinTuner>
Customized Tuners<CustomizeTuner> Customized Tuners<./Tuner/CustomizeTuner>
Customized Advisor<CustomizeAdvisor> Customized Advisor<./Tuner/CustomizeAdvisor>
\ No newline at end of file \ No newline at end of file
docs/en_US/tutorials.rst
View file @ 39782f12
...@@ -6,11 +6,11 @@ Tutorials ...@@ -6,11 +6,11 @@ Tutorials
:maxdepth: 2 :maxdepth: 2
Installation Installation
Write Trial<Trials> Write Trial<./TrialExample/Trials>
Tuners<tuners> Tuners<tuners>
Assessors<assessors> Assessors<assessors>
WebUI WebUI
Training Platform<training_services> Training Platform<training_services>
How to use docker<HowToUseDocker> How to use docker<./Tutorial/HowToUseDocker>
advanced advanced
Debug HowTo<HowToDebug> Debug HowTo<./Tutorial/HowToDebug>
\ No newline at end of file \ No newline at end of file
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