Unverified Commit fac7364a authored by Yuge Zhang's avatar Yuge Zhang Committed by GitHub
Browse files

Isolate toctree from overview (#4747)

parent 47c77363
Training Services Overview
================= ========
NNI has supported many training services listed below. Users can go through each page to learning how to configure the corresponding training service. NNI has high extensibility by design, users can customize new training service for their special resource, platform or needs. NNI has supported many training services listed below. Users can go through each page to learning how to configure the corresponding training service. NNI has high extensibility by design, users can customize new training service for their special resource, platform or needs.
.. toctree::
:hidden:
Local <local>
Remote <remote>
OpenPAI <openpai>
Kubeflow <kubeflow>
AdaptDL <adaptdl>
FrameworkController <frameworkcontroller>
AML <aml>
PAI-DLC <paidlc>
Hybrid <hybrid>
Customize a Training Service <customize>
Shared Storage <shared_storage>
.. list-table:: .. list-table::
:header-rows: 1 :header-rows: 1
......
...@@ -43,8 +43,8 @@ If you want to use AzureBlob, add below to your config. Full config file see :gi ...@@ -43,8 +43,8 @@ If you want to use AzureBlob, add below to your config. Full config file see :gi
You can find ``storageAccountName``, ``storageAccountKey``, ``containerName`` on azure storage account portal. You can find ``storageAccountName``, ``storageAccountKey``, ``containerName`` on azure storage account portal.
.. image:: ../../img/azure_storage.png .. image:: ../../../img/azure_storage.png
:target: ../../img/azure_storage.png :target: ../../../img/azure_storage.png
:alt: :alt:
If you want to use NFS, add below to your config. Full config file see :githublink:`mnist-sharedstorage/config_nfs.yml <examples/trials/mnist-sharedstorage/config_nfs.yml>`. If you want to use NFS, add below to your config. Full config file see :githublink:`mnist-sharedstorage/config_nfs.yml <examples/trials/mnist-sharedstorage/config_nfs.yml>`.
......
Training Service
================
.. toctree::
:hidden:
Overview <overview>
Local <local>
Remote <remote>
OpenPAI <openpai>
Kubeflow <kubeflow>
AdaptDL <adaptdl>
FrameworkController <frameworkcontroller>
AML <aml>
PAI-DLC <paidlc>
Hybrid <hybrid>
Customize a Training Service <customize>
Shared Storage <shared_storage>
Web Portal
==========
Web portal is for users to conveniently visualize their NNI experiments, tuning and training progress, detailed metrics, and error logs. Web portal also allows users to control their NNI experiments, trials, such as updating an experiment of its concurrency, duration, rerunning trials.
.. toctree::
:hidden:
Experiment Web Portal <webui>
Visualize with TensorBoard <tensorboard>
...@@ -26,20 +26,20 @@ Launch Tensorboard ...@@ -26,20 +26,20 @@ Launch Tensorboard
* Like compare, select the trials you want to combine to launch the tensorboard at first, then click the ``Tensorboard`` button. * Like compare, select the trials you want to combine to launch the tensorboard at first, then click the ``Tensorboard`` button.
.. image:: ../../img/Tensorboard_1.png .. image:: ../../../img/Tensorboard_1.png
:target: ../../img/Tensorboard_1.png :target: ../../../img/Tensorboard_1.png
:alt: :alt:
* After click the ``OK`` button in the pop-up box, you will jump to the tensorboard portal. * After click the ``OK`` button in the pop-up box, you will jump to the tensorboard portal.
.. image:: ../../img/Tensorboard_2.png .. image:: ../../../img/Tensorboard_2.png
:target: ../../img/Tensorboard_2.png :target: ../../../img/Tensorboard_2.png
:alt: :alt:
* You can see the ``SequenceID-TrialID`` on the tensorboard portal. * You can see the ``SequenceID-TrialID`` on the tensorboard portal.
.. image:: ../../img/Tensorboard_3.png .. image:: ../../../img/Tensorboard_3.png
:target: ../../img/Tensorboard_3.png :target: ../../../img/Tensorboard_3.png
:alt: :alt:
Stop All Stop All
...@@ -48,8 +48,8 @@ Stop All ...@@ -48,8 +48,8 @@ Stop All
If you want to open the portal you have already launched, click the tensorboard id. If you don't need the tensorboard anymore, click ``Stop all tensorboard`` button. If you want to open the portal you have already launched, click the tensorboard id. If you don't need the tensorboard anymore, click ``Stop all tensorboard`` button.
.. image:: ../../img/Tensorboard_4.png .. image:: ../../../img/Tensorboard_4.png
:target: ../../img/Tensorboard_4.png :target: ../../../img/Tensorboard_4.png
:alt: :alt:
Web Portal
==========
.. toctree::
:hidden:
Experiment Web Portal <web_portal>
Visualize with TensorBoard <tensorboard>
Webportal Web Portal
========= ==========
Web portal is for users to conveniently visualize their NNI experiments, tuning and training progress, detailed metrics, and error logs. Web portal also allows users to control their NNI experiments, trials, such as updating an experiment of its concurrency, duration, rerunning trials.
.. image:: ../../../static/img/webui.gif
:width: 100%
Q&A Q&A
--- ---
...@@ -19,8 +23,8 @@ What should you do when you think the chart is strange, such as ``Default metric ...@@ -19,8 +23,8 @@ What should you do when you think the chart is strange, such as ``Default metric
.. image:: ../../img/webui-img/summary.png .. image:: ../../../img/webui-img/summary.png
:target: ../../img/webui-img/summary.png :target: ../../../img/webui-img/summary.png
:alt: summary :alt: summary
...@@ -34,8 +38,8 @@ What should you do when your experiment has error ...@@ -34,8 +38,8 @@ What should you do when your experiment has error
.. image:: ../../img/webui-img/experimentError.png .. image:: ../../../img/webui-img/experimentError.png
:target: ../../img/webui-img/experimentError.png :target: ../../../img/webui-img/experimentError.png
:alt: experimentError :alt: experimentError
...@@ -47,14 +51,14 @@ What should you do when your trial fails ...@@ -47,14 +51,14 @@ What should you do when your trial fails
.. image:: ../../img/webui-img/detail/customizedTrialButton.png .. image:: ../../../img/webui-img/detail/customizedTrialButton.png
:target: ../../img/webui-img/detail/customizedTrialButton.png :target: ../../../img/webui-img/detail/customizedTrialButton.png
:alt: customizedTrialButton :alt: customizedTrialButton
.. image:: ../../img/webui-img/detail/customizedTrial.png .. image:: ../../../img/webui-img/detail/customizedTrial.png
:target: ../../img/webui-img/detail/customizedTrial.png :target: ../../../img/webui-img/detail/customizedTrial.png
:alt: customizedTrial :alt: customizedTrial
...@@ -67,8 +71,8 @@ What should you do when your trial fails ...@@ -67,8 +71,8 @@ What should you do when your trial fails
.. image:: ../../img/webui-img/detail/log-local.png .. image:: ../../../img/webui-img/detail/log-local.png
:target: ../../img/webui-img/detail/log-local.png :target: ../../../img/webui-img/detail/log-local.png
:alt: logOnLocal :alt: logOnLocal
...@@ -77,8 +81,8 @@ What should you do when your trial fails ...@@ -77,8 +81,8 @@ What should you do when your trial fails
.. image:: ../../img/webui-img/detail-pai.png .. image:: ../../../img/webui-img/detail-pai.png
:target: ../../img/webui-img/detail-pai.png :target: ../../../img/webui-img/detail-pai.png
:alt: detailPai :alt: detailPai
...@@ -98,8 +102,8 @@ Experiments management page could manage many experiments on your machine. ...@@ -98,8 +102,8 @@ Experiments management page could manage many experiments on your machine.
.. image:: ../../img/webui-img/managerExperimentList/experimentListNav.png .. image:: ../../../img/webui-img/managerExperimentList/experimentListNav.png
:target: ../../img/webui-img/managerExperimentList/experimentListNav.png :target: ../../../img/webui-img/managerExperimentList/experimentListNav.png
:alt: ExperimentList nav :alt: ExperimentList nav
...@@ -108,8 +112,8 @@ Experiments management page could manage many experiments on your machine. ...@@ -108,8 +112,8 @@ Experiments management page could manage many experiments on your machine.
.. image:: ../../img/webui-img/managerExperimentList/expList.png .. image:: ../../../img/webui-img/managerExperimentList/expList.png
:target: ../../img/webui-img/managerExperimentList/expList.png :target: ../../../img/webui-img/managerExperimentList/expList.png
:alt: Experiments list :alt: Experiments list
...@@ -118,8 +122,8 @@ Experiments management page could manage many experiments on your machine. ...@@ -118,8 +122,8 @@ Experiments management page could manage many experiments on your machine.
.. image:: ../../img/webui-img/managerExperimentList/toAnotherExp.png .. image:: ../../../img/webui-img/managerExperimentList/toAnotherExp.png
:target: ../../img/webui-img/managerExperimentList/toAnotherExp.png :target: ../../../img/webui-img/managerExperimentList/toAnotherExp.png
:alt: See this experiment detail :alt: See this experiment detail
...@@ -128,8 +132,8 @@ Experiments management page could manage many experiments on your machine. ...@@ -128,8 +132,8 @@ Experiments management page could manage many experiments on your machine.
.. image:: ../../img/webui-img/managerExperimentList/expFilter.png .. image:: ../../../img/webui-img/managerExperimentList/expFilter.png
:target: ../../img/webui-img/managerExperimentList/expFilter.png :target: ../../../img/webui-img/managerExperimentList/expFilter.png
:alt: filter button :alt: filter button
...@@ -146,8 +150,8 @@ View overview page ...@@ -146,8 +150,8 @@ View overview page
.. image:: ../../img/webui-img/full-oview.png .. image:: ../../../img/webui-img/full-oview.png
:target: ../../img/webui-img/full-oview.png :target: ../../../img/webui-img/full-oview.png
:alt: overview :alt: overview
...@@ -158,8 +162,8 @@ View overview page ...@@ -158,8 +162,8 @@ View overview page
.. image:: ../../img/webui-img/searchSpace.png .. image:: ../../../img/webui-img/searchSpace.png
:target: ../../img/webui-img/searchSpace.png :target: ../../../img/webui-img/searchSpace.png
:alt: searchSpace :alt: searchSpace
...@@ -168,8 +172,8 @@ View overview page ...@@ -168,8 +172,8 @@ View overview page
.. image:: ../../img/webui-img/config.png .. image:: ../../../img/webui-img/config.png
:target: ../../img/webui-img/config.png :target: ../../../img/webui-img/config.png
:alt: config :alt: config
...@@ -178,8 +182,8 @@ View overview page ...@@ -178,8 +182,8 @@ View overview page
.. image:: ../../img/webui-img/review-log.png .. image:: ../../../img/webui-img/review-log.png
:target: ../../img/webui-img/review-log.png :target: ../../../img/webui-img/review-log.png
:alt: logfile :alt: logfile
...@@ -188,8 +192,8 @@ View overview page ...@@ -188,8 +192,8 @@ View overview page
.. image:: ../../img/webui-img/refresh-interval.png .. image:: ../../../img/webui-img/refresh-interval.png
:target: ../../img/webui-img/refresh-interval.png :target: ../../../img/webui-img/refresh-interval.png
:alt: refresh :alt: refresh
...@@ -198,8 +202,8 @@ View overview page ...@@ -198,8 +202,8 @@ View overview page
.. image:: ../../img/webui-img/edit-experiment-param.png .. image:: ../../../img/webui-img/edit-experiment-param.png
:target: ../../img/webui-img/edit-experiment-param.png :target: ../../../img/webui-img/edit-experiment-param.png
:alt: editExperimentParams :alt: editExperimentParams
...@@ -211,8 +215,8 @@ View job default metric ...@@ -211,8 +215,8 @@ View job default metric
.. image:: ../../img/webui-img/default-metric.png .. image:: ../../../img/webui-img/default-metric.png
:target: ../../img/webui-img/default-metric.png :target: ../../../img/webui-img/default-metric.png
:alt: defaultMetricGraph :alt: defaultMetricGraph
...@@ -221,8 +225,8 @@ View job default metric ...@@ -221,8 +225,8 @@ View job default metric
.. image:: ../../img/webui-img/best-curve.png .. image:: ../../../img/webui-img/best-curve.png
:target: ../../img/webui-img/best-curve.png :target: ../../../img/webui-img/best-curve.png
:alt: bestCurveGraph :alt: bestCurveGraph
...@@ -239,8 +243,8 @@ Click the tab ``Hyper-parameter`` to see the parallel chart. ...@@ -239,8 +243,8 @@ Click the tab ``Hyper-parameter`` to see the parallel chart.
.. image:: ../../img/webui-img/hyperPara.png .. image:: ../../../img/webui-img/hyperPara.png
:target: ../../img/webui-img/hyperPara.png :target: ../../../img/webui-img/hyperPara.png
:alt: hyperParameterGraph :alt: hyperParameterGraph
...@@ -252,8 +256,8 @@ Click the tab ``Trial Duration`` to see the bar chart. ...@@ -252,8 +256,8 @@ Click the tab ``Trial Duration`` to see the bar chart.
.. image:: ../../img/webui-img/trial_duration.png .. image:: ../../../img/webui-img/trial_duration.png
:target: ../../img/webui-img/trial_duration.png :target: ../../../img/webui-img/trial_duration.png
:alt: trialDurationGraph :alt: trialDurationGraph
...@@ -265,8 +269,8 @@ Click the tab ``Intermediate Result`` to see the line chart. ...@@ -265,8 +269,8 @@ Click the tab ``Intermediate Result`` to see the line chart.
.. image:: ../../img/webui-img/trials_intermeidate.png .. image:: ../../../img/webui-img/trials_intermeidate.png
:target: ../../img/webui-img/trials_intermeidate.png :target: ../../../img/webui-img/trials_intermeidate.png
:alt: trialIntermediateGraph :alt: trialIntermediateGraph
...@@ -277,8 +281,8 @@ You may find that these trials will get better or worse at an intermediate resul ...@@ -277,8 +281,8 @@ You may find that these trials will get better or worse at an intermediate resul
.. image:: ../../img/webui-img/filter-intermediate.png .. image:: ../../../img/webui-img/filter-intermediate.png
:target: ../../img/webui-img/filter-intermediate.png :target: ../../../img/webui-img/filter-intermediate.png
:alt: filterIntermediateGraph :alt: filterIntermediateGraph
...@@ -293,8 +297,8 @@ Click the tab ``Trials Detail`` to see the status of all trials. Specifically: ...@@ -293,8 +297,8 @@ Click the tab ``Trials Detail`` to see the status of all trials. Specifically:
.. image:: ../../img/webui-img/detail-local.png .. image:: ../../../img/webui-img/detail-local.png
:target: ../../img/webui-img/detail-local.png :target: ../../../img/webui-img/detail-local.png
:alt: detailLocalImage :alt: detailLocalImage
...@@ -305,8 +309,8 @@ Click the tab ``Trials Detail`` to see the status of all trials. Specifically: ...@@ -305,8 +309,8 @@ Click the tab ``Trials Detail`` to see the status of all trials. Specifically:
.. image:: ../../img/webui-img/detail/searchId.png .. image:: ../../../img/webui-img/detail/searchId.png
:target: ../../img/webui-img/detail/searchId.png :target: ../../../img/webui-img/detail/searchId.png
:alt: searchTrialId :alt: searchTrialId
...@@ -315,8 +319,8 @@ Click the tab ``Trials Detail`` to see the status of all trials. Specifically: ...@@ -315,8 +319,8 @@ Click the tab ``Trials Detail`` to see the status of all trials. Specifically:
.. image:: ../../img/webui-img/detail/searchNo.png .. image:: ../../../img/webui-img/detail/searchNo.png
:target: ../../img/webui-img/detail/searchNo.png :target: ../../../img/webui-img/detail/searchNo.png
:alt: searchTrialNo. :alt: searchTrialNo.
...@@ -325,8 +329,8 @@ Click the tab ``Trials Detail`` to see the status of all trials. Specifically: ...@@ -325,8 +329,8 @@ Click the tab ``Trials Detail`` to see the status of all trials. Specifically:
.. image:: ../../img/webui-img/detail/searchStatus.png .. image:: ../../../img/webui-img/detail/searchStatus.png
:target: ../../img/webui-img/detail/searchStatus.png :target: ../../../img/webui-img/detail/searchStatus.png
:alt: searchStatus :alt: searchStatus
...@@ -337,8 +341,8 @@ Click the tab ``Trials Detail`` to see the status of all trials. Specifically: ...@@ -337,8 +341,8 @@ Click the tab ``Trials Detail`` to see the status of all trials. Specifically:
.. image:: ../../img/webui-img/detail/searchParameterChoice.png .. image:: ../../../img/webui-img/detail/searchParameterChoice.png
:target: ../../img/webui-img/detail/searchParameterChoice.png :target: ../../../img/webui-img/detail/searchParameterChoice.png
:alt: searchParameterChoice :alt: searchParameterChoice
...@@ -347,8 +351,8 @@ Click the tab ``Trials Detail`` to see the status of all trials. Specifically: ...@@ -347,8 +351,8 @@ Click the tab ``Trials Detail`` to see the status of all trials. Specifically:
.. image:: ../../img/webui-img/detail/searchParameterRange.png .. image:: ../../../img/webui-img/detail/searchParameterRange.png
:target: ../../img/webui-img/detail/searchParameterRange.png :target: ../../../img/webui-img/detail/searchParameterRange.png
:alt: searchParameterRange :alt: searchParameterRange
...@@ -357,8 +361,8 @@ Click the tab ``Trials Detail`` to see the status of all trials. Specifically: ...@@ -357,8 +361,8 @@ Click the tab ``Trials Detail`` to see the status of all trials. Specifically:
.. image:: ../../img/webui-img/addColumn.png .. image:: ../../../img/webui-img/addColumn.png
:target: ../../img/webui-img/addColumn.png :target: ../../../img/webui-img/addColumn.png
:alt: addColumnGraph :alt: addColumnGraph
...@@ -367,14 +371,14 @@ Click the tab ``Trials Detail`` to see the status of all trials. Specifically: ...@@ -367,14 +371,14 @@ Click the tab ``Trials Detail`` to see the status of all trials. Specifically:
.. image:: ../../img/webui-img/select-trial.png .. image:: ../../../img/webui-img/select-trial.png
:target: ../../img/webui-img/select-trial.png :target: ../../../img/webui-img/select-trial.png
:alt: selectTrialGraph :alt: selectTrialGraph
.. image:: ../../img/webui-img/compare.png .. image:: ../../../img/webui-img/compare.png
:target: ../../img/webui-img/compare.png :target: ../../../img/webui-img/compare.png
:alt: compareTrialsGraph :alt: compareTrialsGraph
...@@ -384,8 +388,8 @@ Click the tab ``Trials Detail`` to see the status of all trials. Specifically: ...@@ -384,8 +388,8 @@ Click the tab ``Trials Detail`` to see the status of all trials. Specifically:
.. image:: ../../img/webui-img/copyParameter.png .. image:: ../../../img/webui-img/copyParameter.png
:target: ../../img/webui-img/copyParameter.png :target: ../../../img/webui-img/copyParameter.png
:alt: copyTrialParameters :alt: copyTrialParameters
...@@ -395,8 +399,8 @@ Click the tab ``Trials Detail`` to see the status of all trials. Specifically: ...@@ -395,8 +399,8 @@ Click the tab ``Trials Detail`` to see the status of all trials. Specifically:
.. image:: ../../img/webui-img/intermediate.png .. image:: ../../../img/webui-img/intermediate.png
:target: ../../img/webui-img/intermediate.png :target: ../../../img/webui-img/intermediate.png
:alt: intermeidateGraph :alt: intermeidateGraph
...@@ -406,8 +410,8 @@ Click the tab ``Trials Detail`` to see the status of all trials. Specifically: ...@@ -406,8 +410,8 @@ Click the tab ``Trials Detail`` to see the status of all trials. Specifically:
.. image:: ../../img/webui-img/kill-running.png .. image:: ../../../img/webui-img/kill-running.png
:target: ../../img/webui-img/kill-running.png :target: ../../../img/webui-img/kill-running.png
:alt: killTrial :alt: killTrial
......
.. ebf0627529ecdbf758f9db38701b4225 .. 424a57ff9c92c3f4738a9beabc4cfb50
Web 界面 Web 界面
======== ========
...@@ -21,8 +21,8 @@ Q&A ...@@ -21,8 +21,8 @@ Q&A
.. image:: ../../img/webui-img/summary.png .. image:: ../../../img/webui-img/summary.png
:target: ../../img/webui-img/summary.png :target: ../../../img/webui-img/summary.png
:alt: summary :alt: summary
...@@ -36,8 +36,8 @@ Q&A ...@@ -36,8 +36,8 @@ Q&A
.. image:: ../../img/webui-img/experimentError.png .. image:: ../../../img/webui-img/experimentError.png
:target: ../../img/webui-img/experimentError.png :target: ../../../img/webui-img/experimentError.png
:alt: experimentError :alt: experimentError
...@@ -49,14 +49,14 @@ Q&A ...@@ -49,14 +49,14 @@ Q&A
.. image:: ../../img/webui-img/detail/customizedTrialButton.png .. image:: ../../../img/webui-img/detail/customizedTrialButton.png
:target: ../../img/webui-img/detail/customizedTrialButton.png :target: ../../../img/webui-img/detail/customizedTrialButton.png
:alt: customizedTrialButton :alt: customizedTrialButton
.. image:: ../../img/webui-img/detail/customizedTrial.png .. image:: ../../../img/webui-img/detail/customizedTrial.png
:target: ../../img/webui-img/detail/customizedTrial.png :target: ../../../img/webui-img/detail/customizedTrial.png
:alt: customizedTrial :alt: customizedTrial
...@@ -69,8 +69,8 @@ Q&A ...@@ -69,8 +69,8 @@ Q&A
.. image:: ../../img/webui-img/detail/log-local.png .. image:: ../../../img/webui-img/detail/log-local.png
:target: ../../img/webui-img/detail/log-local.png :target: ../../../img/webui-img/detail/log-local.png
:alt: logOnLocal :alt: logOnLocal
...@@ -79,8 +79,8 @@ Q&A ...@@ -79,8 +79,8 @@ Q&A
.. image:: ../../img/webui-img/detail-pai.png .. image:: ../../../img/webui-img/detail-pai.png
:target: ../../img/webui-img/detail-pai.png :target: ../../../img/webui-img/detail-pai.png
:alt: detailPai :alt: detailPai
...@@ -99,8 +99,8 @@ Q&A ...@@ -99,8 +99,8 @@ Q&A
.. image:: ../../img/webui-img/managerExperimentList/experimentListNav.png .. image:: ../../../img/webui-img/managerExperimentList/experimentListNav.png
:target: ../../img/webui-img/managerExperimentList/experimentListNav.png :target: ../../../img/webui-img/managerExperimentList/experimentListNav.png
:alt: ExperimentList nav :alt: ExperimentList nav
...@@ -109,8 +109,8 @@ Q&A ...@@ -109,8 +109,8 @@ Q&A
.. image:: ../../img/webui-img/managerExperimentList/expList.png .. image:: ../../../img/webui-img/managerExperimentList/expList.png
:target: ../../img/webui-img/managerExperimentList/expList.png :target: ../../../img/webui-img/managerExperimentList/expList.png
:alt: Experiments list :alt: Experiments list
...@@ -119,8 +119,8 @@ Q&A ...@@ -119,8 +119,8 @@ Q&A
.. image:: ../../img/webui-img/managerExperimentList/toAnotherExp.png .. image:: ../../../img/webui-img/managerExperimentList/toAnotherExp.png
:target: ../../img/webui-img/managerExperimentList/toAnotherExp.png :target: ../../../img/webui-img/managerExperimentList/toAnotherExp.png
:alt: See this experiment detail :alt: See this experiment detail
...@@ -129,8 +129,8 @@ Q&A ...@@ -129,8 +129,8 @@ Q&A
.. image:: ../../img/webui-img/managerExperimentList/expFilter.png .. image:: ../../../img/webui-img/managerExperimentList/expFilter.png
:target: ../../img/webui-img/managerExperimentList/expFilter.png :target: ../../../img/webui-img/managerExperimentList/expFilter.png
:alt: filter button :alt: filter button
...@@ -147,8 +147,8 @@ Q&A ...@@ -147,8 +147,8 @@ Q&A
.. image:: ../../img/webui-img/full-oview.png .. image:: ../../../img/webui-img/full-oview.png
:target: ../../img/webui-img/full-oview.png :target: ../../../img/webui-img/full-oview.png
:alt: overview :alt: overview
...@@ -159,8 +159,8 @@ Q&A ...@@ -159,8 +159,8 @@ Q&A
.. image:: ../../img/webui-img/searchSpace.png .. image:: ../../../img/webui-img/searchSpace.png
:target: ../../img/webui-img/searchSpace.png :target: ../../../img/webui-img/searchSpace.png
:alt: searchSpace :alt: searchSpace
...@@ -169,8 +169,8 @@ Q&A ...@@ -169,8 +169,8 @@ Q&A
.. image:: ../../img/webui-img/config.png .. image:: ../../../img/webui-img/config.png
:target: ../../img/webui-img/config.png :target: ../../../img/webui-img/config.png
:alt: config :alt: config
...@@ -179,8 +179,8 @@ Q&A ...@@ -179,8 +179,8 @@ Q&A
.. image:: ../../img/webui-img/review-log.png .. image:: ../../../img/webui-img/review-log.png
:target: ../../img/webui-img/review-log.png :target: ../../../img/webui-img/review-log.png
:alt: logfile :alt: logfile
...@@ -189,8 +189,8 @@ Q&A ...@@ -189,8 +189,8 @@ Q&A
.. image:: ../../img/webui-img/refresh-interval.png .. image:: ../../../img/webui-img/refresh-interval.png
:target: ../../img/webui-img/refresh-interval.png :target: ../../../img/webui-img/refresh-interval.png
:alt: refresh :alt: refresh
...@@ -199,8 +199,8 @@ Q&A ...@@ -199,8 +199,8 @@ Q&A
.. image:: ../../img/webui-img/edit-experiment-param.png .. image:: ../../../img/webui-img/edit-experiment-param.png
:target: ../../img/webui-img/edit-experiment-param.png :target: ../../../img/webui-img/edit-experiment-param.png
:alt: editExperimentParams :alt: editExperimentParams
...@@ -212,8 +212,8 @@ Q&A ...@@ -212,8 +212,8 @@ Q&A
.. image:: ../../img/webui-img/default-metric.png .. image:: ../../../img/webui-img/default-metric.png
:target: ../../img/webui-img/default-metric.png :target: ../../../img/webui-img/default-metric.png
:alt: defaultMetricGraph :alt: defaultMetricGraph
...@@ -222,8 +222,8 @@ Q&A ...@@ -222,8 +222,8 @@ Q&A
.. image:: ../../img/webui-img/best-curve.png .. image:: ../../../img/webui-img/best-curve.png
:target: ../../img/webui-img/best-curve.png :target: ../../../img/webui-img/best-curve.png
:alt: bestCurveGraph :alt: bestCurveGraph
...@@ -240,8 +240,8 @@ Q&A ...@@ -240,8 +240,8 @@ Q&A
.. image:: ../../img/webui-img/hyperPara.png .. image:: ../../../img/webui-img/hyperPara.png
:target: ../../img/webui-img/hyperPara.png :target: ../../../img/webui-img/hyperPara.png
:alt: hyperParameterGraph :alt: hyperParameterGraph
...@@ -253,8 +253,8 @@ Q&A ...@@ -253,8 +253,8 @@ Q&A
.. image:: ../../img/webui-img/trial_duration.png .. image:: ../../../img/webui-img/trial_duration.png
:target: ../../img/webui-img/trial_duration.png :target: ../../../img/webui-img/trial_duration.png
:alt: trialDurationGraph :alt: trialDurationGraph
...@@ -266,8 +266,8 @@ Q&A ...@@ -266,8 +266,8 @@ Q&A
.. image:: ../../img/webui-img/trials_intermeidate.png .. image:: ../../../img/webui-img/trials_intermeidate.png
:target: ../../img/webui-img/trials_intermeidate.png :target: ../../../img/webui-img/trials_intermeidate.png
:alt: trialIntermediateGraph :alt: trialIntermediateGraph
...@@ -278,8 +278,8 @@ Trial 在训练过程中可能有大量中间结果。 为了更清楚的理解 ...@@ -278,8 +278,8 @@ Trial 在训练过程中可能有大量中间结果。 为了更清楚的理解
.. image:: ../../img/webui-img/filter-intermediate.png .. image:: ../../../img/webui-img/filter-intermediate.png
:target: ../../img/webui-img/filter-intermediate.png :target: ../../../img/webui-img/filter-intermediate.png
:alt: filterIntermediateGraph :alt: filterIntermediateGraph
...@@ -294,8 +294,8 @@ Trial 在训练过程中可能有大量中间结果。 为了更清楚的理解 ...@@ -294,8 +294,8 @@ Trial 在训练过程中可能有大量中间结果。 为了更清楚的理解
.. image:: ../../img/webui-img/detail-local.png .. image:: ../../../img/webui-img/detail-local.png
:target: ../../img/webui-img/detail-local.png :target: ../../../img/webui-img/detail-local.png
:alt: detailLocalImage :alt: detailLocalImage
...@@ -306,8 +306,8 @@ Trial 在训练过程中可能有大量中间结果。 为了更清楚的理解 ...@@ -306,8 +306,8 @@ Trial 在训练过程中可能有大量中间结果。 为了更清楚的理解
.. image:: ../../img/webui-img/detail/searchId.png .. image:: ../../../img/webui-img/detail/searchId.png
:target: ../../img/webui-img/detail/searchId.png :target: ../../../img/webui-img/detail/searchId.png
:alt: searchTrialId :alt: searchTrialId
...@@ -316,8 +316,8 @@ Trial 在训练过程中可能有大量中间结果。 为了更清楚的理解 ...@@ -316,8 +316,8 @@ Trial 在训练过程中可能有大量中间结果。 为了更清楚的理解
.. image:: ../../img/webui-img/detail/searchNo.png .. image:: ../../../img/webui-img/detail/searchNo.png
:target: ../../img/webui-img/detail/searchNo.png :target: ../../../img/webui-img/detail/searchNo.png
:alt: searchTrialNo. :alt: searchTrialNo.
...@@ -326,8 +326,8 @@ Trial 在训练过程中可能有大量中间结果。 为了更清楚的理解 ...@@ -326,8 +326,8 @@ Trial 在训练过程中可能有大量中间结果。 为了更清楚的理解
.. image:: ../../img/webui-img/detail/searchStatus.png .. image:: ../../../img/webui-img/detail/searchStatus.png
:target: ../../img/webui-img/detail/searchStatus.png :target: ../../../img/webui-img/detail/searchStatus.png
:alt: searchStatus :alt: searchStatus
...@@ -338,8 +338,8 @@ Trial 在训练过程中可能有大量中间结果。 为了更清楚的理解 ...@@ -338,8 +338,8 @@ Trial 在训练过程中可能有大量中间结果。 为了更清楚的理解
.. image:: ../../img/webui-img/detail/searchParameterChoice.png .. image:: ../../../img/webui-img/detail/searchParameterChoice.png
:target: ../../img/webui-img/detail/searchParameterChoice.png :target: ../../../img/webui-img/detail/searchParameterChoice.png
:alt: searchParameterChoice :alt: searchParameterChoice
...@@ -348,8 +348,8 @@ Trial 在训练过程中可能有大量中间结果。 为了更清楚的理解 ...@@ -348,8 +348,8 @@ Trial 在训练过程中可能有大量中间结果。 为了更清楚的理解
.. image:: ../../img/webui-img/detail/searchParameterRange.png .. image:: ../../../img/webui-img/detail/searchParameterRange.png
:target: ../../img/webui-img/detail/searchParameterRange.png :target: ../../../img/webui-img/detail/searchParameterRange.png
:alt: searchParameterRange :alt: searchParameterRange
...@@ -358,8 +358,8 @@ Trial 在训练过程中可能有大量中间结果。 为了更清楚的理解 ...@@ -358,8 +358,8 @@ Trial 在训练过程中可能有大量中间结果。 为了更清楚的理解
.. image:: ../../img/webui-img/addColumn.png .. image:: ../../../img/webui-img/addColumn.png
:target: ../../img/webui-img/addColumn.png :target: ../../../img/webui-img/addColumn.png
:alt: addColumnGraph :alt: addColumnGraph
...@@ -368,14 +368,14 @@ Trial 在训练过程中可能有大量中间结果。 为了更清楚的理解 ...@@ -368,14 +368,14 @@ Trial 在训练过程中可能有大量中间结果。 为了更清楚的理解
.. image:: ../../img/webui-img/select-trial.png .. image:: ../../../img/webui-img/select-trial.png
:target: ../../img/webui-img/select-trial.png :target: ../../../img/webui-img/select-trial.png
:alt: selectTrialGraph :alt: selectTrialGraph
.. image:: ../../img/webui-img/compare.png .. image:: ../../../img/webui-img/compare.png
:target: ../../img/webui-img/compare.png :target: ../../../img/webui-img/compare.png
:alt: compareTrialsGraph :alt: compareTrialsGraph
...@@ -385,8 +385,8 @@ Trial 在训练过程中可能有大量中间结果。 为了更清楚的理解 ...@@ -385,8 +385,8 @@ Trial 在训练过程中可能有大量中间结果。 为了更清楚的理解
.. image:: ../../img/webui-img/copyParameter.png .. image:: ../../../img/webui-img/copyParameter.png
:target: ../../img/webui-img/copyParameter.png :target: ../../../img/webui-img/copyParameter.png
:alt: copyTrialParameters :alt: copyTrialParameters
...@@ -396,8 +396,8 @@ Trial 在训练过程中可能有大量中间结果。 为了更清楚的理解 ...@@ -396,8 +396,8 @@ Trial 在训练过程中可能有大量中间结果。 为了更清楚的理解
.. image:: ../../img/webui-img/intermediate.png .. image:: ../../../img/webui-img/intermediate.png
:target: ../../img/webui-img/intermediate.png :target: ../../../img/webui-img/intermediate.png
:alt: intermeidateGraph :alt: intermeidateGraph
...@@ -407,8 +407,8 @@ Trial 在训练过程中可能有大量中间结果。 为了更清楚的理解 ...@@ -407,8 +407,8 @@ Trial 在训练过程中可能有大量中间结果。 为了更清楚的理解
.. image:: ../../img/webui-img/kill-running.png .. image:: ../../../img/webui-img/kill-running.png
:target: ../../img/webui-img/kill-running.png :target: ../../../img/webui-img/kill-running.png
:alt: killTrial :alt: killTrial
......
.. 74ffd973c9cc0edea8dc524ed9a86840
###################
特征工程
###################
很高兴在 NNI 上引入了特征工程工具包,
其仍处于试验阶段,会根据使用反馈来演化。
诚挚邀请您使用、反馈,或更多贡献。
详细信息,参考以下教程:
.. toctree::
:maxdepth: 2
概述 <overview>
GradientFeatureSelector <gradient_feature_selector>
GBDTSelector <gbdt_selector>
Feature Engineering with NNI Feature Engineering with NNI
============================ ============================
We are glad to announce the alpha release for Feature Engineering toolkit on top of NNI, it's still in the experiment phase which might evolve based on user feedback. We'd like to invite you to use, feedback and even contribute. .. note::
We are glad to announce the alpha release for Feature Engineering toolkit on top of NNI, it's still in the experiment phase which might evolve based on user feedback. We'd like to invite you to use, feedback and even contribute.
For now, we support the following feature selector: For now, we support the following feature selector:
* `GradientFeatureSelector <./gradient_feature_selector.rst>`__ * :doc:`GradientFeatureSelector <./gradient_feature_selector>`
* `GBDTSelector <./gbdt_selector.rst>`__ * :doc:`GBDTSelector <./gbdt_selector>`
These selectors are suitable for tabular data(which means it doesn't include image, speech and text data). These selectors are suitable for tabular data(which means it doesn't include image, speech and text data).
......
###################
Feature Engineering Feature Engineering
################### ===================
We are glad to introduce Feature Engineering toolkit on top of NNI,
it's still in the experiment phase which might evolve based on usage feedback.
We'd like to invite you to use, feedback and even contribute.
For details, please refer to the following tutorials:
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
......
###########################
Hyperparameter Optimization Hyperparameter Optimization
########################### ===========================
Auto hyperparameter optimization (HPO), or auto tuning, is one of the key features of NNI.
.. raw:: html
<script>
const parts = window.location.href.split('/');
if (parts.pop() === 'index.html') {
window.location.replace(parts.join('/') + '/overview.html')
}
</script>
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
......
...@@ -77,7 +77,7 @@ from simple on-premise servers to scalable commercial clouds. ...@@ -77,7 +77,7 @@ from simple on-premise servers to scalable commercial clouds.
With NNI you can write one piece of model code, and concurrently evaluate hyperparameter sets on local machine, SSH servers, With NNI you can write one piece of model code, and concurrently evaluate hyperparameter sets on local machine, SSH servers,
Kubernetes-based clusters, AzureML service, and much more. Kubernetes-based clusters, AzureML service, and much more.
Main article: :doc:`/experiment/training_service` Main article: :doc:`/experiment/training_service/overview`
.. _hpo-overview-portal: .. _hpo-overview-portal:
...@@ -87,7 +87,7 @@ Web Portal ...@@ -87,7 +87,7 @@ Web Portal
NNI provides a web portal to monitor training progress, to visualize hyperparameter performance, NNI provides a web portal to monitor training progress, to visualize hyperparameter performance,
to manually customize hyperparameters, and to manage multiple HPO experiments. to manually customize hyperparameters, and to manage multiple HPO experiments.
Main article: :doc:`/experiment/web_portal` Main article: :doc:`/experiment/web_portal/web_portal`
.. image:: ../../static/img/webui.gif .. image:: ../../static/img/webui.gif
:width: 100% :width: 100%
...@@ -107,6 +107,6 @@ After you are familiar with basic usage, you can explore more HPO features: ...@@ -107,6 +107,6 @@ After you are familiar with basic usage, you can explore more HPO features:
* :doc:`Use command line tool to create and manage experiments (nnictl) </reference/nnictl>` * :doc:`Use command line tool to create and manage experiments (nnictl) </reference/nnictl>`
* :doc:`Early stop non-optimal models (assessor) <assessors>` * :doc:`Early stop non-optimal models (assessor) <assessors>`
* :doc:`TensorBoard integration </experiment/tensorboard>` * :doc:`TensorBoard integration </experiment/web_portal/tensorboard>`
* :doc:`Implement your own algorithm <custom_algorithm>` * :doc:`Implement your own algorithm <custom_algorithm>`
* :doc:`Benchmark tuners <hpo_benchmark>` * :doc:`Benchmark tuners <hpo_benchmark>`
.. 9b97cac44e07efbd393a2ab21f247c95 .. 317442fd7a0540c0776a08ad773566cf
超参调优 超参调优
======== ========
...@@ -66,7 +66,7 @@ NNI内建了很多流行的调优算法,包括朴素算法如随机搜索、 ...@@ -66,7 +66,7 @@ NNI内建了很多流行的调优算法,包括朴素算法如随机搜索、
如果想利用更多计算资源加速调优过程,您也可以使用NNI内建的训练平台集成,从简单的SSH服务器到可扩容的Kubernetes集群NNI都提供支持。 如果想利用更多计算资源加速调优过程,您也可以使用NNI内建的训练平台集成,从简单的SSH服务器到可扩容的Kubernetes集群NNI都提供支持。
完整内容: :doc:`/experiment/training_service` 完整内容: :doc:`/experiment/training_service/overview`
.. _zh-hpo-overview-portal: .. _zh-hpo-overview-portal:
...@@ -75,7 +75,7 @@ NNI内建了很多流行的调优算法,包括朴素算法如随机搜索、 ...@@ -75,7 +75,7 @@ NNI内建了很多流行的调优算法,包括朴素算法如随机搜索、
您可以使用NNI的网页控制台来监控超参调优实验,它支持实时显示实验进度、对超参性能进行可视化、人工修改超参数值、同时管理多个实验等诸多功能。 您可以使用NNI的网页控制台来监控超参调优实验,它支持实时显示实验进度、对超参性能进行可视化、人工修改超参数值、同时管理多个实验等诸多功能。
完整内容: :doc:`/experiment/web_portal` 完整内容: :doc:`/experiment/web_portal/web_portal`
.. image:: ../../static/img/webui.gif .. image:: ../../static/img/webui.gif
:width: 100% :width: 100%
...@@ -95,6 +95,6 @@ NNI内建了很多流行的调优算法,包括朴素算法如随机搜索、 ...@@ -95,6 +95,6 @@ NNI内建了很多流行的调优算法,包括朴素算法如随机搜索、
* :doc:`Use command line tool to create and manage experiments (nnictl) </reference/nnictl>` * :doc:`Use command line tool to create and manage experiments (nnictl) </reference/nnictl>`
* :doc:`Early stop non-optimal models (assessor) <assessors>` * :doc:`Early stop non-optimal models (assessor) <assessors>`
* :doc:`TensorBoard integration </experiment/tensorboard>` * :doc:`TensorBoard integration </experiment/web_portal/tensorboard>`
* :doc:`Implement your own algorithm <custom_algorithm>` * :doc:`Implement your own algorithm <custom_algorithm>`
* :doc:`Benchmark tuners <hpo_benchmark>` * :doc:`Benchmark tuners <hpo_benchmark>`
...@@ -17,8 +17,8 @@ NNI Documentation ...@@ -17,8 +17,8 @@ NNI Documentation
Hyperparameter Optimization <hpo/index> Hyperparameter Optimization <hpo/index>
Neural Architecture Search <nas/index> Neural Architecture Search <nas/index>
Model Compression <compression/index> Model Compression <compression/index>
Feature Engineering <feature_engineering/index> feature_engineering/toctree
Experiment <experiment/overview> experiment/toctree
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
...@@ -224,7 +224,7 @@ NNI eases the effort to scale and manage AutoML experiments ...@@ -224,7 +224,7 @@ NNI eases the effort to scale and manage AutoML experiments
.. codesnippetcard:: .. codesnippetcard::
:icon: ../img/thumbnails/training-service-small.svg :icon: ../img/thumbnails/training-service-small.svg
:title: Training Service :title: Training Service
:link: experiment/training_service :link: experiment/training_service/overview
:seemore: See more here. :seemore: See more here.
An AutoML experiment requires many trials to explore feasible and potentially good-performing models. An AutoML experiment requires many trials to explore feasible and potentially good-performing models.
...@@ -235,7 +235,7 @@ NNI eases the effort to scale and manage AutoML experiments ...@@ -235,7 +235,7 @@ NNI eases the effort to scale and manage AutoML experiments
.. codesnippetcard:: .. codesnippetcard::
:icon: ../img/thumbnails/web-portal-small.svg :icon: ../img/thumbnails/web-portal-small.svg
:title: Web Portal :title: Web Portal
:link: experiment/web_portal :link: experiment/web_portal/web_portal
:seemore: See more here. :seemore: See more here.
Web portal visualizes the tuning process, exposing the ability to inspect, monitor and control the experiment. Web portal visualizes the tuning process, exposing the ability to inspect, monitor and control the experiment.
...@@ -246,7 +246,7 @@ NNI eases the effort to scale and manage AutoML experiments ...@@ -246,7 +246,7 @@ NNI eases the effort to scale and manage AutoML experiments
.. codesnippetcard:: .. codesnippetcard::
:icon: ../img/thumbnails/experiment-management-small.svg :icon: ../img/thumbnails/experiment-management-small.svg
:title: Experiment Management :title: Experiment Management
:link: experiment/exp_management :link: experiment/experiment_management
:seemore: See more here. :seemore: See more here.
The DNN model tuning often requires more than one experiment. The DNN model tuning often requires more than one experiment.
......
.. 57966d1be5afdd7a7fcb74e7ea25b1ec .. e604b6ad83ae8de856b569c841feafea
########################### ###########################
Neural Network Intelligence Neural Network Intelligence
...@@ -16,8 +16,8 @@ Neural Network Intelligence ...@@ -16,8 +16,8 @@ Neural Network Intelligence
超参调优 <hpo/index> 超参调优 <hpo/index>
神经网络架构搜索<nas/index> 神经网络架构搜索<nas/index>
模型压缩<compression/index> 模型压缩<compression/index>
特征工程<feature_engineering/index> 特征工程<feature_engineering/toctree>
NNI实验 <experiment/overview> NNI实验 <experiment/toctree>
HPO API Reference <reference/hpo> HPO API Reference <reference/hpo>
Experiment API Reference <reference/experiment> Experiment API Reference <reference/experiment>
nnictl Commands <reference/nnictl> nnictl Commands <reference/nnictl>
......
...@@ -66,7 +66,7 @@ Performance estimation ...@@ -66,7 +66,7 @@ Performance estimation
The objective of NAS is typically to find architectures that achieve high predictive performance on unseen data. Performance estimation refers to the process of estimating this performance. The problem with performance estimation is mostly its scalability, i.e., how can I run and manage multiple trials simultaneously. The objective of NAS is typically to find architectures that achieve high predictive performance on unseen data. Performance estimation refers to the process of estimating this performance. The problem with performance estimation is mostly its scalability, i.e., how can I run and manage multiple trials simultaneously.
In NNI, we standardize this process is implemented with :doc:`evaluator <evaluator>`, which is responsible of estimating a model's performance. The choices of evaluators also range from the simplest option, e.g., to perform a standard training and validation of the architecture on data, to complex configurations and implementations. Evaluators are run in *trials*, where trials can be spawn onto distributed platforms with our powerful :doc:`training service </experiment/training_service>`. In NNI, we standardize this process is implemented with :doc:`evaluator <evaluator>`, which is responsible of estimating a model's performance. The choices of evaluators also range from the simplest option, e.g., to perform a standard training and validation of the architecture on data, to complex configurations and implementations. Evaluators are run in *trials*, where trials can be spawn onto distributed platforms with our powerful :doc:`training service </experiment/training_service/overview>`.
Tutorials Tutorials
--------- ---------
......
Quickstart Quickstart
========== ==========
.. TOC
.. toctree::
:maxdepth: 2
:hidden:
tutorials/hpo_quickstart_pytorch/cp_global_quickstart_hpo
tutorials/cp_global_quickstart_nas
tutorials/cp_global_quickstart_compression
.. ----------------------
.. cardlinkitem:: .. cardlinkitem::
:header: HPO Quickstart with PyTorch :header: Hyperparameter Optimization Quickstart with PyTorch
:description: Use HPO to tune a PyTorch FashionMNIST model :description: Use Hyperparameter Optimization (HPO) to tune a PyTorch FashionMNIST model.
:link: tutorials/hpo_quickstart_pytorch/cp_global_quickstart_hpo.html :link: tutorials/hpo_quickstart_pytorch/main
:image: ../img/thumbnails/hpo-pytorch.svg :image: ../img/thumbnails/hpo-pytorch.svg
:background: purple :background: purple
.. cardlinkitem:: .. cardlinkitem::
:header: NAS Quickstart :header: Neural Architecture Search Quickstart
:description: Beginners' NAS tutorial on how to search for neural architectures for MNIST dataset. :description: Beginners' NAS tutorial on how to search for neural architectures for MNIST dataset.
:link: tutorials/cp_global_quickstart_nas.html :link: tutorials/hello_nas
:image: ../img/thumbnails/nas-tutorial.svg :image: ../img/thumbnails/nas-tutorial.svg
:background: cyan :background: cyan
.. cardlinkitem:: .. cardlinkitem::
:header: Get Started with Model Pruning on MNIST :header: Model Compression Quickstart
:description: Familiarize yourself with pruning to compress your model. :description: Familiarize yourself with pruning to compress your model.
:link: tutorials/cp_global_quickstart_compression.html :link: tutorials/pruning_quick_start_mnist
:image: ../img/thumbnails/pruning-tutorial.svg :image: ../img/thumbnails/pruning-tutorial.svg
:background: blue :background: blue
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