Skip to content

GitLab

Unverified Commit 83684388 authored by Chi Song's avatar Chi Song Committed by GitHub
Browse files

fix table of NNICTLDOC (#678) 

* fix table of NNICTLDOC
parent ac255b5f
Hide whitespace changes
Inline Side-by-side
Showing with 74 additions and 704 deletions
docs/NNICTL.rst deleted 100644 → 0
View file @ ac255b5f
.. role:: raw-html-m2r(raw)
:format: html
nnictl
======
Introduction
------------
**nnictl** is a command line tool, which can be used to control experiments, such as start/stop/resume an experiment, start/stop NNIBoard, etc.
Commands
--------
nnictl support commands:
* `nnictl create <#create>`_
* `nnictl resume <#resume>`_
* `nnictl stop <#stop>`_
* `nnictl update <#update>`_
* `nnictl trial <#trial>`_
* `nnictl top <#top>`_
* `nnictl experiment <#experiment>`_
* `nnictl config <#config>`_
* `nnictl log <#log>`_
* `nnictl webui <#webui>`_
* `nnictl tensorboard <#tensorboard>`_
* `nnictl package <#package>`_
Manage an experiment
^^^^^^^^^^^^^^^^^^^^
:raw-html-m2r:`<a name="create"></a>`
*
**nnictl create**
*
Description
You can use this command to create a new experiment, using the configuration specified in config file.
After this command is successfully done, the context will be set as this experiment,
which means the following command you issued is associated with this experiment,
unless you explicitly changes the context(not supported yet).
*
Usage
.. code-block:: bash
nnictl create [OPTIONS]
*
Options:
+-------------------+-----------+-----------+-------------------------------------+
| Name, shorthand | Required | Default | Description |
+===================+===========+===========+=====================================+
| --config, -c | True | |yaml configure file of the experiment|
+-------------------+-----------+-----------+-------------------------------------+
| --port, -p | False | |the port of restful server |
+-------------------+-----------+-----------+-------------------------------------+
:raw-html-m2r:`<a name="resume"></a>`
*
**nnictl resume**
*
Description
You can use this command to resume a stopped experiment.
*
Usage
.. code-block:: bash
nnictl resume [OPTIONS]
*
Options:
+-------------------+-----------+-----------+-----------------------------------------------+
| Name, shorthand | Required | Default | Description |
+===================+===========+===========+===============================================+
| id | False | |The id of the experiment you want to resume |
+-------------------+-----------+-----------+-----------------------------------------------+
| --port, -p | False | |Rest port of the experiment you want to resume |
+-------------------+-----------+-----------+-----------------------------------------------+
:raw-html-m2r:`<a name="stop"></a>`
*
**nnictl stop**
*
Description
You can use this command to stop a running experiment or multiple experiments.
*
Usage
.. code-block:: bash
nnictl stop [id]
*
Detail
1.If there is an id specified, and the id matches the running experiment, nnictl will stop the corresponding experiment, or will print error message.
2.If there is no id specified, and there is an experiment running, stop the running experiment, or print error message.
3.If the id ends with *, nnictl will stop all experiments whose ids matchs the regular.
4.If the id does not exist but match the prefix of an experiment id, nnictl will stop the matched experiment.
5.If the id does not exist but match multiple prefix of the experiment ids, nnictl will give id information.
6.Users could use 'nnictl stop all' to stop all experiments
:raw-html-m2r:`<a name="update"></a>`
*
**nnictl update**
*
**nnictl update searchspace**
*
Description
You can use this command to update an experiment's search space.
*
Usage
.. code-block:: bash
nnictl update searchspace [OPTIONS]
*
Options:
+-------------------+-----------+-----------+-----------------------------------------------+
| Name, shorthand | Required | Default | Description |
+===================+===========+===========+===============================================+
| id | False | |ID of the experiment you want to set |
+-------------------+-----------+-----------+-----------------------------------------------+
| --filename, -f | True | |the file storing your new search space |
+-------------------+-----------+-----------+-----------------------------------------------+
*
**nnictl update concurrency**
*
Description
You can use this command to update an experiment's concurrency.
*
Usage
.. code-block:: bash
nnictl update concurrency [OPTIONS]
*
Options:
+-------------------+-----------+-----------+-----------------------------------------------+
| Name, shorthand | Required | Default | Description |
+===================+===========+===========+===============================================+
| id | False | |ID of the experiment you want to set |
+-------------------+-----------+-----------+-----------------------------------------------+
| --value, -v | True | |the number of allowed concurrent trials |
+-------------------+-----------+-----------+-----------------------------------------------+
*
**nnictl update duration**
*
Description
You can use this command to update an experiment's concurrency.
*
Usage
.. code-block:: bash
nnictl update duration [OPTIONS]
*
Options:
+-------------------+-----------+-----------+-----------------------------------------------+
| Name, shorthand | Required | Default | Description |
+===================+===========+===========+===============================================+
| id | False | |ID of the experiment you want to set |
+-------------------+-----------+-----------+-----------------------------------------------+
| --value, -v | True | |the experiment duration will be NUMBER seconds.|
| | | |SUFFIX may be 's' for seconds (the default), |
| | | |'m' for minutes, 'h' for hours or 'd' for days.|
+-------------------+-----------+-----------+-----------------------------------------------+
*
**nnictl update trialnum**
*
Description
You can use this command to update an experiment's maxtrialnum.
*
Usage
.. code-block:: bash
nnictl update trialnum [OPTIONS]
*
Options:
+-------------------+-----------+-----------+-----------------------------------------------+
| Name, shorthand | Required | Default | Description |
+===================+===========+===========+===============================================+
| id | False | |ID of the experiment you want to set |
+-------------------+-----------+-----------+-----------------------------------------------+
| --value, -v | True | |the new number of maxtrialnum you want to set |
+-------------------+-----------+-----------+-----------------------------------------------+
:raw-html-m2r:`<a name="trial"></a>`
*
**nnictl trial**
*
**nnictl trial ls**
*
Description
You can use this command to show trial's information.
*
Usage
.. code-block:: bash
nnictl trial ls
*
Options:
+-------------------+-----------+-----------+-----------------------------------------------+
| Name, shorthand | Required | Default | Description |
+===================+===========+===========+===============================================+
| id | False | |ID of the experiment you want to set |
+-------------------+-----------+-----------+-----------------------------------------------+
*
**nnictl trial kill**
*
Description
You can use this command to kill a trial job.
*
Usage
.. code-block:: bash
nnictl trial kill [OPTIONS]
*
Options:
+-------------------+-----------+-----------+-----------------------------------------------+
| Name, shorthand | Required | Default | Description |
+===================+===========+===========+===============================================+
| id | False | |ID of the experiment you want to set |
+-------------------+-----------+-----------+-----------------------------------------------+
| --trialid, -t | True | |ID of the trial you want to kill. |
+-------------------+-----------+-----------+-----------------------------------------------+
:raw-html-m2r:`<a name="top"></a>`
*
**nnictl top**
*
Description
Monitor all of running experiments.
*
Usage
.. code-block:: bash
nnictl top
*
Options:
+-------------------+-----------+-----------+-----------------------------------------------+
| Name, shorthand | Required | Default | Description |
+===================+===========+===========+===============================================+
| id | False | |ID of the experiment you want to set |
+-------------------+-----------+-----------+-----------------------------------------------+
| --time, -t | False | |The interval to update the experiment status, |
| | | |the unit of time is second, |
| | | |and the default value is 3 second. |
+-------------------+-----------+-----------+-----------------------------------------------+
:raw-html-m2r:`<a name="experiment"></a>`
Manage experiment information
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
*
**nnictl experiment show**
*
Description
Show the information of experiment.
*
Usage
.. code-block:: bash
nnictl experiment show
*
Options:
+-------------------+-----------+-----------+-----------------------------------------------+
| Name, shorthand | Required | Default | Description |
+===================+===========+===========+===============================================+
| id | False | |ID of the experiment you want to set |
+-------------------+-----------+-----------+-----------------------------------------------+
*
**nnictl experiment status**
*
Description
Show the status of experiment.
*
Usage
.. code-block:: bash
nnictl experiment status
*
Options:
+-------------------+-----------+-----------+-----------------------------------------------+
| Name, shorthand | Required | Default | Description |
+===================+===========+===========+===============================================+
| id | False | |ID of the experiment you want to check |
+-------------------+-----------+-----------+-----------------------------------------------+
*
**nnictl experiment list**
*
Description
Show the information of all the (running) experiments.
*
Usage
.. code-block:: bash
nnictl experiment list
:raw-html-m2r:`<a name="config"></a>`
*
**nnictl config show**
*
Description
Display the current context information.
*
Usage
.. code-block:: bash
nnictl config show
:raw-html-m2r:`<a name="log"></a>`
Manage log
^^^^^^^^^^
*
**nnictl log stdout**
*
Description
Show the stdout log content.
*
Usage
.. code-block:: bash
nnictl log stdout [options]
*
Options:
+-------------------+-----------+-----------+-----------------------------------------------+
| Name, shorthand | Required | Default | Description |
+===================+===========+===========+===============================================+
| id | False | |ID of the experiment you want to set |
+-------------------+-----------+-----------+-----------------------------------------------+
| --head, -h | False | |show head lines of stdout |
+-------------------+-----------+-----------+-----------------------------------------------+
| --tail, -t | False | |show tail lines of stdout |
+-------------------+-----------+-----------+-----------------------------------------------+
| --path, -p | False | |show the path of stdout file |
+-------------------+-----------+-----------+-----------------------------------------------+
*
**nnictl log stderr**
*
Description
Show the stderr log content.
*
Usage
.. code-block:: bash
nnictl log stderr [options]
*
Options:
+-------------------+-----------+-----------+-----------------------------------------------+
| Name, shorthand | Required | Default | Description |
+===================+===========+===========+===============================================+
| id | False | |ID of the experiment you want to set |
+-------------------+-----------+-----------+-----------------------------------------------+
| --head, -h | False | |show head lines of stderr |
+-------------------+-----------+-----------+-----------------------------------------------+
| --tail, -t | False | |show tail lines of stderr |
+-------------------+-----------+-----------+-----------------------------------------------+
| --path, -p | False | |show the path of stderr file |
+-------------------+-----------+-----------+-----------------------------------------------+
*
**nnictl log trial**
*
Description
Show trial log path.
*
Usage
:raw-html-m2r:`<a name="webui"></a>`
Manage webui
^^^^^^^^^^^^
*
**nnictl webui url**
:raw-html-m2r:`<a name="tensorboard"></a>`
Manage tensorboard
^^^^^^^^^^^^^^^^^^
*
**nnictl tensorboard start**
*
Description
Start the tensorboard process.
*
Usage
.. code-block:: bash
nnictl tensorboard start
*
Options:
+-------------------+-----------+-----------+-----------------------------------------------+
| Name, shorthand | Required | Default | Description |
+===================+===========+===========+===============================================+
| id | False | |ID of the experiment you want to set |
+-------------------+-----------+-----------+-----------------------------------------------+
| --trialid | False | |ID of the trial |
+-------------------+-----------+-----------+-----------------------------------------------+
| --port | False | 6006 |The port of the tensorboard process |
+-------------------+-----------+-----------+-----------------------------------------------+
*
Detail
#. NNICTL support tensorboard function in local and remote platform for the moment, other platforms will be supported later.
#. If you want to use tensorboard, you need to write your tensorboard log data to environment variable [NNI_OUTPUT_DIR] path.
#. In local mode, nnictl will set --logdir=[NNI_OUTPUT_DIR] directly and start a tensorboard process.
#. In remote mode, nnictl will create a ssh client to copy log data from remote machine to local temp directory firstly, and then start a tensorboard process in your local machine. You need to notice that nnictl only copy the log data one time when you use the command, if you want to see the later result of tensorboard, you should execute nnictl tensorboard command again.
#. If there is only one trial job, you don't need to set trialid. If there are multiple trial jobs running, you should set the trialid, or you could use [nnictl tensorboard start --trialid all] to map --logdir to all trial log paths.
*
**nnictl tensorboard stop**
*
Description
Stop all of the tensorboard process.
*
Usage
.. code-block:: bash
nnictl tensorboard stop
*
Options:
+-------------------+-----------+-----------+-----------------------------------------------+
| Name, shorthand | Required | Default | Description |
+===================+===========+===========+===============================================+
| id | False | |ID of the experiment |
+-------------------+-----------+-----------+-----------------------------------------------+
:raw-html-m2r:`<a name="package"></a>`
Manage package
^^^^^^^^^^^^^^
*
**nnictl package install**
*
Description
Install the packages needed in nni experiments.
*
Usage
.. code-block:: bash
nnictl package install [OPTIONS]
*
Options:
+-------------------+-----------+-----------+-----------------------------------------------+
| Name, shorthand | Required | Default | Description |
+===================+===========+===========+===============================================+
| --name | True | |The name of package to be installed |
+-------------------+-----------+-----------+-----------------------------------------------+
*
**nnictl package show**
*
Description
.. code-block:: bash
List the packages supported.
*
Usage
.. code-block:: bash
nnictl package show
docs/NNICTLDOC.md
View file @ 83684388
......@@ -41,10 +41,10 @@ nnictl support commands:
* Options
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|--config, -c| True| |YAML configure file of the experiment|
|--port, -p|False| |the port of restful server|
|Name, shorthand|Required|Default|Description|
|------|------|------|------|
|--config, -c| True| |YAML configure file of the experiment|
|--port, -p|False| |the port of restful server|
<a name="resume"></a>
* __nnictl resume__
......@@ -61,10 +61,10 @@ nnictl support commands:
* Options
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|id| False| |The id of the experiment you want to resume|
|--port, -p| False| |Rest port of the experiment you want to resume|
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|id| False| |The id of the experiment you want to resume|
|--port, -p| False| |Rest port of the experiment you want to resume|
<a name="stop"></a>
* __nnictl stop__
......@@ -81,12 +81,12 @@ nnictl support commands:
* Detail
1.If there is an id specified, and the id matches the running experiment, nnictl will stop the corresponding experiment, or will print error message.
2.If there is no id specified, and there is an experiment running, stop the running experiment, or print error message.
3.If the id ends with *, nnictl will stop all experiments whose ids matchs the regular.
4.If the id does not exist but match the prefix of an experiment id, nnictl will stop the matched experiment.
5.If the id does not exist but match multiple prefix of the experiment ids, nnictl will give id information.
6.Users could use 'nnictl stop all' to stop all experiments.
1. If there is an id specified, and the id matches the running experiment, nnictl will stop the corresponding experiment, or will print error message.
2. If there is no id specified, and there is an experiment running, stop the running experiment, or print error message.
3. If the id ends with *, nnictl will stop all experiments whose ids matchs the regular.
4. If the id does not exist but match the prefix of an experiment id, nnictl will stop the matched experiment.
5. If the id does not exist but match multiple prefix of the experiment ids, nnictl will give id information.
6. Users could use 'nnictl stop all' to stop all experiments.
<a name="update"></a>
* __nnictl update__
......@@ -104,10 +104,10 @@ nnictl support commands:
* Options
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|id| False| |ID of the experiment you want to set|
|--filename, -f| True| |the file storing your new search space|
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|id| False| |ID of the experiment you want to set|
|--filename, -f| True| |the file storing your new search space|
* __nnictl update concurrency__
* Description
......@@ -122,10 +122,10 @@ nnictl support commands:
* Options
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|id| False| |ID of the experiment you want to set|
|--value, -v| True| |the number of allowed concurrent trials|
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|id| False| |ID of the experiment you want to set|
|--value, -v| True| |the number of allowed concurrent trials|
* __nnictl update duration__
......@@ -140,10 +140,10 @@ nnictl support commands:
```
* Options
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|id| False| |ID of the experiment you want to set|
|--value, -v| True| |the experiment duration will be NUMBER seconds. SUFFIX may be 's' for seconds (the default), 'm' for minutes, 'h' for hours or 'd' for days.|
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|id| False| |ID of the experiment you want to set|
|--value, -v| True| |the experiment duration will be NUMBER seconds. SUFFIX may be 's' for seconds (the default), 'm' for minutes, 'h' for hours or 'd' for days.|
* __nnictl update trialnum__
* Description
......@@ -158,10 +158,10 @@ nnictl support commands:
* Options
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|id| False| |ID of the experiment you want to set|
|--value, -v| True| |the new number of maxtrialnum you want to set|
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|id| False| |ID of the experiment you want to set|
|--value, -v| True| |the new number of maxtrialnum you want to set|
<a name="trial"></a>
* __nnictl trial__
......@@ -180,9 +180,9 @@ nnictl support commands:
* Options
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|id| False| |ID of the experiment you want to set|
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|id| False| |ID of the experiment you want to set|
* __nnictl trial kill__
......@@ -198,10 +198,10 @@ nnictl support commands:
* Options
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|id| False| |ID of the experiment you want to set|
|--trialid, -t| True| |ID of the trial you want to kill.|
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|id| False| |ID of the experiment you want to set|
|--trialid, -t| True| |ID of the trial you want to kill.|
<a name="top"></a>
* __nnictl top__
......@@ -218,10 +218,10 @@ nnictl support commands:
* Options
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|id| False| |ID of the experiment you want to set|
|--time, -t| False| |The interval to update the experiment status, the unit of time is second, and the default value is 3 second.|
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|id| False| |ID of the experiment you want to set|
|--time, -t| False| |The interval to update the experiment status, the unit of time is second, and the default value is 3 second.|
<a name="experiment"></a>
### Manage experiment information
......@@ -240,9 +240,9 @@ nnictl support commands:
* Options
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|id| False| |ID of the experiment you want to set|
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|id| False| |ID of the experiment you want to set|
* __nnictl experiment status__
......@@ -258,9 +258,9 @@ nnictl support commands:
* Options
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|id| False| |ID of the experiment you want to set|
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|id| False| |ID of the experiment you want to set|
* __nnictl experiment list__
......@@ -304,12 +304,12 @@ nnictl support commands:
* Options
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|id| False| |ID of the experiment you want to set|
|--head, -h| False| |show head lines of stdout|
|--tail, -t| False| |show tail lines of stdout|
|--path, -p| False| |show the path of stdout file|
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|id| False| |ID of the experiment you want to set|
|--head, -h| False| |show head lines of stdout|
|--tail, -t| False| |show tail lines of stdout|
|--path, -p| False| |show the path of stdout file|
* __nnictl log stderr__
* Description
......@@ -324,12 +324,12 @@ nnictl support commands:
* Options
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|id| False| |ID of the experiment you want to set|
|--head, -h| False| |show head lines of stderr|
|--tail, -t| False| |show tail lines of stderr|
|--path, -p| False| |show the path of stderr file|
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|id| False| |ID of the experiment you want to set|
|--head, -h| False| |show head lines of stderr|
|--tail, -t| False| |show tail lines of stderr|
|--path, -p| False| |show the path of stderr file|
* __nnictl log trial__
......@@ -345,9 +345,9 @@ nnictl support commands:
* Options
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|id| False| |the id of trial|
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|id| False| |the id of trial|
<a name="webui"></a>
### Manage webui
......@@ -371,11 +371,11 @@ nnictl support commands:
* Options
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|id| False| |ID of the experiment you want to set|
|--trialid| False| |ID of the trial|
|--port| False| 6006|The port of the tensorboard process|
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|id| False| |ID of the experiment you want to set|
|--trialid| False| |ID of the trial|
|--port| False| 6006|The port of the tensorboard process|
* Detail
......@@ -398,9 +398,9 @@ nnictl support commands:
* Options
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|id| False| |ID of the experiment you want to set|
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|id| False| |ID of the experiment you want to set|
<a name="package"></a>
### Manage package
......@@ -418,9 +418,9 @@ nnictl support commands:
* Options
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|--name| True| |The name of package to be installed|
|Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|--name| True| |The name of package to be installed|
* __nnictl package show__
......
docs/Reference.rst
View file @ 83684388
......@@ -4,7 +4,7 @@ References
.. toctree::
:maxdepth: 3
Command Line <NNICTL>
Command Line <NNICTLDOC>
Python API <sdk_reference>
Annotation <AnnotationSpec>
Configuration<ExperimentConfig>
......
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