Skip to content

GitLab

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

fix doc format for translated content. (#971) 

The indent is changed after add color at title of each list, get whole content aligned with this change.
parent 5aca94db
Hide whitespace changes
Inline Side-by-side
Showing with 176 additions and 178 deletions
docs/en_US/NNICTLDOC.md
View file @ 74587b8d
...@@ -25,22 +25,21 @@ nnictl support commands: ...@@ -25,22 +25,21 @@ nnictl support commands:
### Manage an experiment ### Manage an experiment
<a name="create"></a> <a name="create"></a>
![](https://placehold.it/15/1589F0/000000?text=+) `nnictl create` ![](https://placehold.it/15/1589F0/000000?text=+) `nnictl create`
* Description * Description
You can use this command to create a new experiment, using the configuration specified in config file. 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). 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 * Usage
```bash ```bash
nnictl create [OPTIONS] nnictl create [OPTIONS]
``` ```
* Options * Options
|Name, shorthand|Required|Default|Description| |Name, shorthand|Required|Default|Description|
|------|------|------|------| |------|------|------|------|
...@@ -48,46 +47,47 @@ nnictl support commands: ...@@ -48,46 +47,47 @@ nnictl support commands:
|--port, -p|False| |the port of restful server| |--port, -p|False| |the port of restful server|
|--debug, -d|False||set debug mode| |--debug, -d|False||set debug mode|
* Examples * Examples
> create a new experiment with the default port: 8080
```bash > create a new experiment with the default port: 8080
nnictl create --config nni/examples/trials/mnist/config.yml
```
> create a new experiment with specified port 8088 ```bash
nnictl create --config nni/examples/trials/mnist/config.yml
```
```bash > create a new experiment with specified port 8088
nnictl create --config nni/examples/trials/mnist/config.yml --port 8088
```
> create a new experiment with specified port 8088 and debug mode ```bash
nnictl create --config nni/examples/trials/mnist/config.yml --port 8088
```
```bash > create a new experiment with specified port 8088 and debug mode
nnictl create --config nni/examples/trials/mnist/config.yml --port 8088 --debug
```
Note: ```bash
``` nnictl create --config nni/examples/trials/mnist/config.yml --port 8088 --debug
Debug mode will disable version check function in Trialkeeper.
``` ```
Note:
```text
Debug mode will disable version check function in Trialkeeper.
```
<a name="resume"></a> <a name="resume"></a>
![](https://placehold.it/15/1589F0/000000?text=+) `nnictl resume` ![](https://placehold.it/15/1589F0/000000?text=+) `nnictl resume`
* Description * Description
You can use this command to resume a stopped experiment. You can use this command to resume a stopped experiment.
* Usage * Usage
```bash ```bash
nnictl resume [OPTIONS] nnictl resume [OPTIONS]
``` ```
* Options * Options
|Name, shorthand|Required|Default|Description| |Name, shorthand|Required|Default|Description|
|------|------|------ |------| |------|------|------ |------|
...@@ -95,240 +95,242 @@ nnictl support commands: ...@@ -95,240 +95,242 @@ nnictl support commands:
|--port, -p| False| |Rest port of the experiment you want to resume| |--port, -p| False| |Rest port of the experiment you want to resume|
|--debug, -d|False||set debug mode| |--debug, -d|False||set debug mode|
* Example * Example
> resume an experiment with specified port 8088 > resume an experiment with specified port 8088
```bash ```bash
nnictl resume [experiment_id] --port 8088 nnictl resume [experiment_id] --port 8088
``` ```
<a name="stop"></a> <a name="stop"></a>
![](https://placehold.it/15/1589F0/000000?text=+) `nnictl stop` ![](https://placehold.it/15/1589F0/000000?text=+) `nnictl stop`
* Description * Description
You can use this command to stop a running experiment or multiple experiments. You can use this command to stop a running experiment or multiple experiments.
* Usage * Usage
```bash ```bash
nnictl stop [id] nnictl stop [id]
``` ```
* Details & Examples * Details & Examples
1. If there is no id specified, and there is an experiment running, stop the running experiment, or print error message. 1. If there is no id specified, and there is an experiment running, stop the running experiment, or print error message.
```bash ```bash
nnictl stop nnictl stop
``` ```
2. If there is an id specified, and the id matches the running experiment, nnictl will stop the corresponding experiment, or will print error message. 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.
```bash ```bash
nnictl stop [experiment_id] nnictl stop [experiment_id]
``` ```
3. Users could use 'nnictl stop all' to stop all experiments. 1. Users could use 'nnictl stop all' to stop all experiments.
```bash ```bash
nnictl stop all nnictl stop all
``` ```
4. If the id ends with *, nnictl will stop all experiments whose ids matchs the regular.
5. If the id does not exist but match the prefix of an experiment id, nnictl will stop the matched experiment. 1. If the id ends with *, nnictl will stop all experiments whose ids matchs the regular.
6. If the id does not exist but match multiple prefix of the experiment ids, nnictl will give id information. 1. If the id does not exist but match the prefix of an experiment id, nnictl will stop the matched experiment.
1. If the id does not exist but match multiple prefix of the experiment ids, nnictl will give id information.
<a name="update"></a> <a name="update"></a>
![](https://placehold.it/15/1589F0/000000?text=+) `nnictl update` ![](https://placehold.it/15/1589F0/000000?text=+) `nnictl update`
* __nnictl update searchspace__ * __nnictl update searchspace__
* Description * Description
You can use this command to update an experiment's search space. You can use this command to update an experiment's search space.
* Usage * Usage
```bash ```bash
nnictl update searchspace [OPTIONS] nnictl update searchspace [OPTIONS]
``` ```
* Options * Options
|Name, shorthand|Required|Default|Description| |Name, shorthand|Required|Default|Description|
|------|------|------ |------| |------|------|------ |------|
|id| False| |ID of the experiment you want to set| |id| False| |ID of the experiment you want to set|
|--filename, -f| True| |the file storing your new search space| |--filename, -f| True| |the file storing your new search space|
* Example * Example
`update experiment's new search space with file dir 'examples/trials/mnist/search_space.json'` `update experiment's new search space with file dir 'examples/trials/mnist/search_space.json'`
```bash ```bash
nnictl update searchspace [experiment_id] --file examples/trials/mnist/search_space.json nnictl update searchspace [experiment_id] --file examples/trials/mnist/search_space.json
``` ```
* __nnictl update concurrency__ * __nnictl update concurrency__
* Description
You can use this command to update an experiment's concurrency. * Description
* Usage You can use this command to update an experiment's concurrency.
```bash * Usage
nnictl update concurrency [OPTIONS]
```
* Options ```bash
nnictl update concurrency [OPTIONS]
```
|Name, shorthand|Required|Default|Description| * Options
|------|------|------ |------|
|id| False| |ID of the experiment you want to set|
|--value, -v| True| |the number of allowed concurrent trials|
* Example |Name, shorthand|Required|Default|Description|
|------|------|------ |------|
|id| False| |ID of the experiment you want to set|
|--value, -v| True| |the number of allowed concurrent trials|
> update experiment's concurrency * Example
```bash > update experiment's concurrency
nnictl update concurrency [experiment_id] --value [concurrency_number]
```
* __nnictl update duration__ ```bash
nnictl update concurrency [experiment_id] --value [concurrency_number]
```
* Description * __nnictl update duration__
You can use this command to update an experiment's duration. * Description
* Usage You can use this command to update an experiment's duration.
```bash * Usage
nnictl update duration [OPTIONS]
```
* Options ```bash
nnictl update duration [OPTIONS]
```
|Name, shorthand|Required|Default|Description| * Options
|------|------|------ |------|
|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.|
* Example |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.|
> update experiment's duration * Example
```bash > update experiment's duration
nnictl update duration [experiment_id] --value [duration]
```
* __nnictl update trialnum__ ```bash
* Description nnictl update duration [experiment_id] --value [duration]
```
You can use this command to update an experiment's maxtrialnum. * __nnictl update trialnum__
* Description
* Usage You can use this command to update an experiment's maxtrialnum.
```bash * Usage
nnictl update trialnum [OPTIONS]
```
* Options ```bash
nnictl update trialnum [OPTIONS]
```
|Name, shorthand|Required|Default|Description| * Options
|------|------|------ |------|
|id| False| |ID of the experiment you want to set|
|--value, -v| True| |the new number of maxtrialnum you want to set|
* Example |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|
> update experiment's trial num * Example
```bash > update experiment's trial num
nnictl update trialnum --id [experiment_id] --value [trial_num]
```
<a name="trial"></a> ```bash
nnictl update trialnum --id [experiment_id] --value [trial_num]
```
<a name="trial"></a>
![](https://placehold.it/15/1589F0/000000?text=+) `nnictl trial` ![](https://placehold.it/15/1589F0/000000?text=+) `nnictl trial`
* __nnictl trial ls__ * __nnictl trial ls__
* Description * Description
You can use this command to show trial's information. You can use this command to show trial's information.
* Usage * Usage
```bash ```bash
nnictl trial ls nnictl trial ls
``` ```
* Options * Options
|Name, shorthand|Required|Default|Description| |Name, shorthand|Required|Default|Description|
|------|------|------ |------| |------|------|------ |------|
|id| False| |ID of the experiment you want to set| |id| False| |ID of the experiment you want to set|
* __nnictl trial kill__ * __nnictl trial kill__
* Description * Description
You can use this command to kill a trial job. You can use this command to kill a trial job.
* Usage * Usage
```bash ```bash
nnictl trial kill [OPTIONS] nnictl trial kill [OPTIONS]
``` ```
* Options * Options
|Name, shorthand|Required|Default|Description| |Name, shorthand|Required|Default|Description|
|------|------|------ |------| |------|------|------ |------|
|id| False| |ID of the trial to be killed| |id| False| |ID of the trial to be killed|
|--experiment, -E| True| |Experiment id of the trial| |--experiment, -E| True| |Experiment id of the trial|
* Example * Example
> kill trail job > kill trail job
```bash ```bash
nnictl trial [trial_id] --vexperiment [experiment_id] nnictl trial [trial_id] --vexperiment [experiment_id]
``` ```
* __nnictl trial export__
* Description
You can use this command to export reward & hyper-parameter of trial jobs to a csv file.
* Usage
```bash
nnictl trial export [OPTIONS]
```
* __nnictl trial export__ * Options
* Description
You can use this command to export reward & hyper-parameter of trial jobs to a csv file.
* Usage
```bash
nnictl trial export [OPTIONS]
```
* Options
|Name, shorthand|Required|Default|Description| |Name, shorthand|Required|Default|Description|
|------|------|------ |------| |------|------|------ |------|
|id| False| |ID of the experiment | |id| False| |ID of the experiment |
|--file| True| |File path of the output csv file | |--file| True| |File path of the output csv file |
<a name="top"></a> <a name="top"></a>
![](https://placehold.it/15/1589F0/000000?text=+) `nnictl top` ![](https://placehold.it/15/1589F0/000000?text=+) `nnictl top`
* Description * Description
Monitor all of running experiments. Monitor all of running experiments.
* Usage * Usage
```bash ```bash
nnictl top nnictl top
``` ```
* Options * Options
|Name, shorthand|Required|Default|Description| |Name, shorthand|Required|Default|Description|
|------|------|------ |------| |------|------|------ |------|
...@@ -336,7 +338,6 @@ nnictl support commands: ...@@ -336,7 +338,6 @@ nnictl support commands:
|--time, -t| False| |The interval to update the experiment status, the unit of time is second, and the default value is 3 second.| |--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> <a name="experiment"></a>
![](https://placehold.it/15/1589F0/000000?text=+) `Manage experiment information` ![](https://placehold.it/15/1589F0/000000?text=+) `Manage experiment information`
* __nnictl experiment show__ * __nnictl experiment show__
...@@ -388,18 +389,17 @@ nnictl support commands: ...@@ -388,18 +389,17 @@ nnictl support commands:
``` ```
<a name="config"></a> <a name="config"></a>
![](https://placehold.it/15/1589F0/000000?text=+) `nnictl config show` ![](https://placehold.it/15/1589F0/000000?text=+) `nnictl config show`
* Description * Description
Display the current context information. Display the current context information.
* Usage * Usage
```bash ```bash
nnictl config show nnictl config show
``` ```
<a name="log"></a> <a name="log"></a>
...@@ -474,13 +474,11 @@ nnictl support commands: ...@@ -474,13 +474,11 @@ nnictl support commands:
|--experiment, -E| False| |Experiment ID of the trial, required when id is not empty.| |--experiment, -E| False| |Experiment ID of the trial, required when id is not empty.|
<a name="webui"></a> <a name="webui"></a>
![](https://placehold.it/15/1589F0/000000?text=+) `Manage webui` ![](https://placehold.it/15/1589F0/000000?text=+) `Manage webui`
* __nnictl webui url__ * __nnictl webui url__
<a name="tensorboard"></a> <a name="tensorboard"></a>
![](https://placehold.it/15/1589F0/000000?text=+) `Manage tensorboard` ![](https://placehold.it/15/1589F0/000000?text=+) `Manage tensorboard`
* __nnictl tensorboard start__ * __nnictl tensorboard start__
...@@ -514,7 +512,7 @@ nnictl support commands: ...@@ -514,7 +512,7 @@ nnictl support commands:
* __nnictl tensorboard stop__ * __nnictl tensorboard stop__
* Description * Description
Stop all of the tensorboard process. Stop all of the tensorboard process.
* Usage * Usage
...@@ -583,4 +581,4 @@ nnictl support commands: ...@@ -583,4 +581,4 @@ nnictl support commands:
```bash ```bash
nnictl --version nnictl --version
``` ```
\ 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