Merge pull request #159 from Microsoft/master

merge master

Merge pull request #159 from Microsoft/master
merge master
cf5336d2 · SparkSnail · GitHub · 6af4b864 · d8fd9eda · cf5336d2
Unverified Commit cf5336d2 authored Apr 15, 2019 by SparkSnail Committed by GitHub Apr 15, 2019
Show whitespace changes
Inline Side-by-side

Showing with 177 additions and 179 deletions

docs/en_US/NNICTLDOC.md docs/en_US/NNICTLDOC.md +176 -178

test/config_test/tuners/mnist-hyperband.test.yml test/config_test/tuners/mnist-hyperband.test.yml +1 -1

No files found.
--- a/docs/en_US/NNICTLDOC.md
+++ b/docs/en_US/NNICTLDOC.md
@@ -25,22 +25,21 @@ nnictl support commands:
 ### Manage an experiment

 <a name="create"></a>
-
 ![](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. 

  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
  nnictl create [OPTIONS]
  ```

-  * Options
+* Options

  |Name, shorthand|Required|Default|Description|
  |------|------|------|------|
@@ -48,7 +47,7 @@ nnictl support commands:
  |--port, -p|False| |the port of restful server|
  |--debug, -d|False||set debug mode|

-  * Examples
+* Examples

  > create a new experiment with the default port: 8080

@@ -68,26 +67,27 @@ nnictl support commands:
  nnictl create --config nni/examples/trials/mnist/config.yml --port 8088 --debug
  ```

-  Note:
-  ```
-  Debug mode will disable version check function in Trialkeeper.
-  ```
+Note:
+
+```text
+Debug mode will disable version check function in Trialkeeper.
+```

 <a name="resume"></a>

 ![](https://placehold.it/15/1589F0/000000?text=+) `nnictl resume`

-  * Description
+* Description

  You can use this command to resume a stopped experiment.

-  * Usage
+* Usage

  ```bash
  nnictl resume [OPTIONS]
  ```

-  * Options
+* Options

  |Name, shorthand|Required|Default|Description|
  |------|------|------ |------|
@@ -95,7 +95,7 @@ nnictl support commands:
  |--port, -p|  False| |Rest port of the experiment you want to resume|
  |--debug, -d|False||set debug mode|

-  * Example
+* Example

  > resume an experiment with specified port 8088

@@ -104,20 +104,19 @@ nnictl support commands:
  ```

 <a name="stop"></a>
-
 ![](https://placehold.it/15/1589F0/000000?text=+) `nnictl stop`

-  * Description
+* Description

  You can use this command to stop a running experiment or multiple experiments.

-  * Usage
+* Usage

  ```bash
  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.

@@ -125,26 +124,27 @@ nnictl support commands:
      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
      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
      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.
-    6. If the id does not exist but match multiple prefix of the experiment ids, nnictl will give id information.
+
+  1. If the id ends with *, nnictl will stop all experiments whose ids matchs the regular.
+  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>

 ![](https://placehold.it/15/1589F0/000000?text=+) `nnictl update`

-  * __nnictl update searchspace__
+* __nnictl update searchspace__
  * Description

    You can use this command to update an experiment's search space.
@@ -170,7 +170,8 @@ nnictl support commands:
    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.
@@ -196,7 +197,7 @@ nnictl support commands:
    nnictl update concurrency [experiment_id] --value [concurrency_number]
    ```

-  * __nnictl update duration__  
+* __nnictl update duration__  

  * Description

@@ -223,7 +224,7 @@ nnictl support commands:
    nnictl update duration [experiment_id] --value [duration]
    ```

-  * __nnictl update trialnum__  
+* __nnictl update trialnum__  
  * Description

    You can use this command to update an experiment's maxtrialnum.
@@ -250,10 +251,9 @@ nnictl support commands:
    ```

 <a name="trial"></a>
-
 ![](https://placehold.it/15/1589F0/000000?text=+) `nnictl trial`

-  * __nnictl trial ls__
+* __nnictl trial ls__

  * Description

@@ -271,7 +271,7 @@ nnictl support commands:
  |------|------|------ |------|
  |id|  False| |ID of the experiment you want to set|

-  * __nnictl trial kill__
+* __nnictl trial kill__

  * Description

@@ -298,14 +298,17 @@ nnictl support commands:
    nnictl trial [trial_id] --vexperiment [experiment_id]
    ```

-  * __nnictl trial export__
+* __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]
    ```
+
  * Options

  |Name, shorthand|Required|Default|Description|
@@ -313,22 +316,21 @@ nnictl support commands:
  |id|  False| |ID of the experiment    |
  |--file|  True| |File path of the output csv file     |

-
 <a name="top"></a>

 ![](https://placehold.it/15/1589F0/000000?text=+) `nnictl top`

-  * Description
+* Description

  Monitor all of running experiments.

-  * Usage
+* Usage

  ```bash
  nnictl top
  ```

-  * Options  
+* Options  

  |Name, shorthand|Required|Default|Description|
  |------|------|------ |------|
@@ -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.|

 <a name="experiment"></a>
-
 ![](https://placehold.it/15/1589F0/000000?text=+) `Manage experiment information`

 * __nnictl experiment show__
@@ -388,14 +389,13 @@ nnictl support commands:
    ```

 <a name="config"></a>
-
 ![](https://placehold.it/15/1589F0/000000?text=+) `nnictl config show`

-  * Description
+* Description

  Display the current context information.

-  * Usage
+* Usage

  ```bash
  nnictl config show
@@ -474,13 +474,11 @@ nnictl support commands:
  |--experiment, -E|  False| |Experiment ID of the trial, required when id is not empty.|

 <a name="webui"></a>
-
 ![](https://placehold.it/15/1589F0/000000?text=+) `Manage webui`

 * __nnictl webui url__

 <a name="tensorboard"></a>
-
 ![](https://placehold.it/15/1589F0/000000?text=+) `Manage tensorboard`

 * __nnictl tensorboard start__

--- a/test/config_test/tuners/mnist-hyperband.test.yml
+++ b/test/config_test/tuners/mnist-hyperband.test.yml
@@ -16,7 +16,7 @@ assessor:
  classArgs:
    optimize_mode: maximize
 trial:
-  codeDir: ../../../examples/trials/mnist-hyperband
+  codeDir: ../../../examples/trials/mnist-advisor
  command: python3 mnist.py
  gpuNum: 0