Nnictl.md 17.6 KB
Newer Older
QuanluZhang's avatar
QuanluZhang committed
1
# nnictl
Chi Song's avatar
Chi Song committed
2

QuanluZhang's avatar
QuanluZhang committed
3
## Introduction
Chi Song's avatar
Chi Song committed
4

QuanluZhang's avatar
QuanluZhang committed
5
6
7
__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
Chi Song's avatar
Chi Song committed
8

QuanluZhang's avatar
QuanluZhang committed
9
nnictl support commands:
Chi Song's avatar
Chi Song committed
10

11
12
* [nnictl create](#create)
* [nnictl resume](#resume)
SparkSnail's avatar
SparkSnail committed
13
* [nnictl view](#view)
14
15
16
17
18
* [nnictl stop](#stop)
* [nnictl update](#update)
* [nnictl trial](#trial)
* [nnictl top](#top)
* [nnictl experiment](#experiment)
SparkSnail's avatar
SparkSnail committed
19
* [nnictl platform](#platform)
20
21
22
23
24
25
* [nnictl config](#config)
* [nnictl log](#log)
* [nnictl webui](#webui)
* [nnictl tensorboard](#tensorboard)
* [nnictl package](#package)
* [nnictl --version](#version)
Chi Song's avatar
Chi Song committed
26

Yan Ni's avatar
Yan Ni committed
27
### Manage an experiment
28

Yan Ni's avatar
Yan Ni committed
29
<a name="create"></a>
30
![](https://placehold.it/15/1589F0/000000?text=+) `nnictl create`
31

32
* Description
33

34
  You can use this command to create a new experiment, using the configuration specified in config file.
35

36
  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).
37

38
* Usage
39

40
41
42
  ```bash
  nnictl create [OPTIONS]
  ```
43

44
* Options
45

Chi Song's avatar
Chi Song committed
46
47
48
49
  |Name, shorthand|Required|Default|Description|
  |------|------|------|------|
  |--config, -c|  True| |YAML configure file of the experiment|
  |--port, -p|False| |the port of restful server|
50
51
  |--debug, -d|False||set debug mode|

52
* Examples
53

54
  > create a new experiment with the default port: 8080
55

56
57
58
  ```bash
  nnictl create --config nni/examples/trials/mnist/config.yml
  ```
59

60
  > create a new experiment with specified port 8088
61

62
63
64
  ```bash
  nnictl create --config nni/examples/trials/mnist/config.yml --port 8088
  ```
65

66
  > create a new experiment with specified port 8088 and debug mode
67

68
69
  ```bash
  nnictl create --config nni/examples/trials/mnist/config.yml --port 8088 --debug
70
  ```
71

72
73
74
75
76
77
Note:

```text
Debug mode will disable version check function in Trialkeeper.
```

Yan Ni's avatar
Yan Ni committed
78
<a name="resume"></a>
79
80

![](https://placehold.it/15/1589F0/000000?text=+) `nnictl resume`
QuanluZhang's avatar
QuanluZhang committed
81

82
* Description
Chi Song's avatar
Chi Song committed
83

84
  You can use this command to resume a stopped experiment.
Chi Song's avatar
Chi Song committed
85

86
* Usage
Chi Song's avatar
Chi Song committed
87

88
89
90
  ```bash
  nnictl resume [OPTIONS]
  ```
Chi Song's avatar
Chi Song committed
91

92
* Options
93

Chi Song's avatar
Chi Song committed
94
95
  |Name, shorthand|Required|Default|Description|
  |------|------|------ |------|
96
  |id|  True| |The id of the experiment you want to resume|
Chi Song's avatar
Chi Song committed
97
  |--port, -p|  False| |Rest port of the experiment you want to resume|
98
  |--debug, -d|False||set debug mode|
Chi Song's avatar
Chi Song committed
99

100
* Example
101

102
  > resume an experiment with specified port 8088
103

104
105
106
  ```bash
  nnictl resume [experiment_id] --port 8088
  ```
107

SparkSnail's avatar
SparkSnail committed
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
<a name="view"></a>

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

* Description

  You can use this command to view a stopped experiment.

* Usage

  ```bash
  nnictl view [OPTIONS]
  ```

* Options

  |Name, shorthand|Required|Default|Description|
  |------|------|------ |------|
  |id|  True| |The id of the experiment you want to view|
  |--port, -p|  False| |Rest port of the experiment you want to view|

* Example

  > view an experiment with specified port 8088

  ```bash
  nnictl view [experiment_id] --port 8088
  ```

Yan Ni's avatar
Yan Ni committed
137
<a name="stop"></a>
138
![](https://placehold.it/15/1589F0/000000?text=+) `nnictl stop`
139

140
* Description
Chi Song's avatar
Chi Song committed
141

142
  You can use this command to stop a running experiment or multiple experiments.
Chi Song's avatar
Chi Song committed
143

144
* Usage
Chi Song's avatar
Chi Song committed
145

146
  ```bash
147
  nnictl stop [Options]
148
  ```
149

150
151
152
153
154
155
* Options

  |Name, shorthand|Required|Default|Description|
  |------|------|------ |------|
  |id|  False| |The id of the experiment you want to stop|
  |--port, -p|  False| |Rest port of the experiment you want to stop|
156
  |--all, -a|  False| |Stop all of experiments|
157

158
* Details & Examples
159

160
  1. If there is no id specified, and there is an experiment running, stop the running experiment, or print error message.
161
162
163
164
165

      ```bash
      nnictl stop
      ```

166
  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.
167
168
169
170
171

      ```bash
      nnictl stop [experiment_id]
      ```

172
173
174
175
176
177
  3. If there is a port specified, and an experiment is running on that port, the experiment will be stopped.

      ```bash
      nnictl stop --port 8080
      ```

178
  4. Users could use 'nnictl stop --all' to stop all experiments.
179
180

      ```bash
181
      nnictl stop --all
182
      ```
183

184
185
186
  5. If the id ends with *, nnictl will stop all experiments whose ids matchs the regular.
  6. If the id does not exist but match the prefix of an experiment id, nnictl will stop the matched experiment.
  7. If the id does not exist but match multiple prefix of the experiment ids, nnictl will give id information.
187

Yan Ni's avatar
Yan Ni committed
188
<a name="update"></a>
189
190

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

192
193
* __nnictl update searchspace__
  * Description
194

195
    You can use this command to update an experiment's search space.
196

197
  * Usage
198

199
200
201
    ```bash
    nnictl update searchspace [OPTIONS]
    ```
202

203
  * Options
204

205
206
207
208
  |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|
209

210
  * Example
211

212
    `update experiment's new search space with file dir 'examples/trials/mnist/search_space.json'`
213

214
    ```bash
215
    nnictl update searchspace [experiment_id] --filename examples/trials/mnist/search_space.json
216
    ```
217

218
* __nnictl update concurrency__
219

220
  * Description
221

222
     You can use this command to update an experiment's concurrency.
223

224
  * Usage
225

226
227
228
    ```bash
    nnictl update concurrency [OPTIONS]
    ```
229

230
  * Options
231

232
233
234
235
  |Name, shorthand|Required|Default|Description|
  |------|------|------ |------|
  |id|  False| |ID of the experiment you want to set|
  |--value, -v|  True| |the number of allowed concurrent trials|
236

237
  * Example
238

239
    > update experiment's concurrency
240

241
242
243
    ```bash
    nnictl update concurrency [experiment_id] --value [concurrency_number]
    ```
244

245
* __nnictl update duration__
246

247
  * Description
248

249
    You can use this command to update an experiment's duration.
250

251
  * Usage
252

253
254
255
    ```bash
    nnictl update duration [OPTIONS]
    ```
256

257
  * Options
258

259
260
261
262
  |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.|
263

264
  * Example
265

266
    > update experiment's duration
267

268
269
270
    ```bash
    nnictl update duration [experiment_id] --value [duration]
    ```
271

272
* __nnictl update trialnum__
273
  * Description
274

275
    You can use this command to update an experiment's maxtrialnum.
276

277
  * Usage
278

279
280
281
    ```bash
    nnictl update trialnum [OPTIONS]
    ```
282

283
  * Options
284

285
286
287
288
  |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|
289

290
  * Example
291

292
    > update experiment's trial num
293

294
295
296
    ```bash
    nnictl update trialnum --id [experiment_id] --value [trial_num]
    ```
297

298
<a name="trial"></a>
299
![](https://placehold.it/15/1589F0/000000?text=+) `nnictl trial`
Chi Song's avatar
Chi Song committed
300

301
* __nnictl trial ls__
Chi Song's avatar
Chi Song committed
302

303
  * Description
Chi Song's avatar
Chi Song committed
304

305
    You can use this command to show trial's information.
Chi Song's avatar
Chi Song committed
306

307
  * Usage
308

309
310
311
    ```bash
    nnictl trial ls
    ```
QuanluZhang's avatar
QuanluZhang committed
312

313
  * Options
Chi Song's avatar
Chi Song committed
314

315
316
317
  |Name, shorthand|Required|Default|Description|
  |------|------|------ |------|
  |id|  False| |ID of the experiment you want to set|
SparkSnail's avatar
SparkSnail committed
318

319
* __nnictl trial kill__
320

321
  * Description
322

323
    You can use this command to kill a trial job.
324

325
  * Usage
326

327
328
329
    ```bash
    nnictl trial kill [OPTIONS]
    ```
330

331
  * Options
332

333
334
  |Name, shorthand|Required|Default|Description|
  |------|------|------ |------|
335
336
  |id|  False| |Experiment ID of the trial|
  |--trial_id, -T|  True| |ID of the trial you want to kill.|
337

338
  * Example
339

340
    > kill trail job
341

342
    ```bash
Chi Song's avatar
Chi Song committed
343
    nnictl trial [trial_id] --experiment [experiment_id]
344
345
    ```

Yan Ni's avatar
Yan Ni committed
346
<a name="top"></a>
347
348

![](https://placehold.it/15/1589F0/000000?text=+) `nnictl top`
SparkSnail's avatar
SparkSnail committed
349

350
* Description
351

352
  Monitor all of running experiments.
353

354
* Usage
355

356
357
358
  ```bash
  nnictl top
  ```
359

360
* Options
361

Chi Song's avatar
Chi Song committed
362
363
364
365
  |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.|
366

Yan Ni's avatar
Yan Ni committed
367
<a name="experiment"></a>
368
![](https://placehold.it/15/1589F0/000000?text=+) `Manage experiment information`
QuanluZhang's avatar
QuanluZhang committed
369
370

* __nnictl experiment show__
Chi Song's avatar
Chi Song committed
371

QuanluZhang's avatar
QuanluZhang committed
372
  * Description
SparkSnail's avatar
SparkSnail committed
373

Chi Song's avatar
Chi Song committed
374
375
376
377
378
379
380
381
    Show the information of experiment.

  * Usage

    ```bash
    nnictl experiment show
    ```

382
  * Options
Chi Song's avatar
Chi Song committed
383

Chi Song's avatar
Chi Song committed
384
385
386
  |Name, shorthand|Required|Default|Description|
  |------|------|------ |------|
  |id|  False| |ID of the experiment you want to set|
SparkSnail's avatar
SparkSnail committed
387
388

* __nnictl experiment status__
Chi Song's avatar
Chi Song committed
389

SparkSnail's avatar
SparkSnail committed
390
391
  * Description

Chi Song's avatar
Chi Song committed
392
393
394
395
396
397
398
399
    Show the status of experiment.

  * Usage

    ```bash
    nnictl experiment status
    ```

400
  * Options
Chi Song's avatar
Chi Song committed
401

Chi Song's avatar
Chi Song committed
402
403
404
  |Name, shorthand|Required|Default|Description|
  |------|------|------ |------|
  |id|  False| |ID of the experiment you want to set|
SparkSnail's avatar
SparkSnail committed
405
406

* __nnictl experiment list__
407

SparkSnail's avatar
SparkSnail committed
408
  * Description
QuanluZhang's avatar
QuanluZhang committed
409

Chi Song's avatar
Chi Song committed
410
411
412
    Show the information of all the (running) experiments.

  * Usage
413

Chi Song's avatar
Chi Song committed
414
    ```bash
SparkSnail's avatar
SparkSnail committed
415
    nnictl experiment list [OPTIONS]
Chi Song's avatar
Chi Song committed
416
    ```
SparkSnail's avatar
SparkSnail committed
417
418
419
420
421
422
  
  * Options

  |Name, shorthand|Required|Default|Description|
  |------|------|------ |------|
  |--all|  False| |list all of experiments|
Chi Song's avatar
Chi Song committed
423

SparkSnail's avatar
SparkSnail committed
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
* __nnictl experiment delete__

  * Description

    Delete one or all experiments, it includes log, result, environment information and cache. It uses to delete useless experiment result, or save disk space.

  * Usage

    ```bash
    nnictl experiment delete [OPTIONS]
    ```
  
  * Options

  |Name, shorthand|Required|Default|Description|
  |------|------|------ |------|
  |id|  False| |ID of the experiment|
SparkSnail's avatar
SparkSnail committed
441
  |--all|  False| |delete all of experiments|
SparkSnail's avatar
SparkSnail committed
442
443
444



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
<a name="export"></a>

* __nnictl experiment export__
  * Description

    You can use this command to export reward & hyper-parameter of trial jobs to a csv file.

  * Usage

    ```bash
    nnictl experiment export [OPTIONS]
    ```

  * Options

  |Name, shorthand|Required|Default|Description|
  |------|------|------ |------|
  |id|  False| |ID of the experiment    |
463
  |--filename, -f|  True| |File path of the output file     |
464
465
466
467
468
469
470
  |--type|  True| |Type of output file, only support "csv" and "json"|

  * Examples

  > export all trial data in an experiment as json format

  ```bash
471
  nnictl experiment export [experiment_id] --filename [file_path] --type json
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
  ```

* __nnictl experiment import__
  * Description

    You can use this command to import several prior or supplementary trial hyperparameters & results for NNI hyperparameter tuning. The data are fed to the tuning algorithm (e.g., tuner or advisor).

  * Usage

    ```bash
    nnictl experiment import [OPTIONS]
    ```

  * Options

  |Name, shorthand|Required|Default|Description|
  |------|------|------|------|
  |id|  False| |The id of the experiment you want to import data into|
490
  |--filename, -f|  True| |a file with data you want to import in json format|
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507

  * Details

    NNI supports users to import their own data, please express the data in the correct format. An example is shown below:

    ```json
    [
      {"parameter": {"x": 0.5, "y": 0.9}, "value": 0.03},
      {"parameter": {"x": 0.4, "y": 0.8}, "value": 0.05},
      {"parameter": {"x": 0.3, "y": 0.7}, "value": 0.04}
    ]
    ```

    Every element in the top level list is a sample. For our built-in tuners/advisors, each sample should have at least two keys: `parameter` and `value`. The `parameter` must match this experiment's search space, that is, all the keys (or hyperparameters) in `parameter` must match the keys in the search space. Otherwise, tuner/advisor may have unpredictable behavior. `Value` should follow the same rule of the input in `nni.report_final_result`, that is, either a number or a dict with a key named `default`. For your customized tuner/advisor, the file could have any json content depending on how you implement the corresponding methods (e.g., `import_data`).

    You also can use [nnictl experiment export](#export) to export a valid json file including previous experiment trial hyperparameters and results.

Chi Song's avatar
Chi Song committed
508
    Currently, following tuner and advisor support import data:
509

510
    ```yaml
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
    builtinTunerName: TPE, Anneal, GridSearch, MetisTuner
    builtinAdvisorName: BOHB
    ```

    *If you want to import data to BOHB advisor, user are suggested to add "TRIAL_BUDGET" in parameter as NNI do, otherwise, BOHB will use max_budget as "TRIAL_BUDGET". Here is an example:*

    ```json
    [
      {"parameter": {"x": 0.5, "y": 0.9, "TRIAL_BUDGET": 27}, "value": 0.03}
    ]
    ```

  * Examples

    > import data to a running experiment

    ```bash
528
    nnictl experiment import [experiment_id] -f experiment_data.json
529
530
    ```

SparkSnail's avatar
SparkSnail committed
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
<a name="platform"></a>
![](https://placehold.it/15/1589F0/000000?text=+) `Manage platform information`

* __nnictl platform clean__

  * Description

    It uses to clean up disk on a target platform. The provided YAML file includes the information of target platform, and it follows the same schema as the NNI configuration file.

  * Note
   
    if the target platform is being used by other users, it may cause unexpected errors to others.

  * Usage

    ```bash
    nnictl platform clean [OPTIONS]
    ```

  * Options

  |Name, shorthand|Required|Default|Description|
  |------|------|------ |------|
  |--config|  True| |the path of yaml config file used when create an experiment|


Yan Ni's avatar
Yan Ni committed
557
<a name="config"></a>
558
![](https://placehold.it/15/1589F0/000000?text=+) `nnictl config show`
559

560
* Description
561

562
  Display the current context information.
563

564
* Usage
565

566
567
568
  ```bash
  nnictl config show
  ```
569

Yan Ni's avatar
Yan Ni committed
570
<a name="log"></a>
571
572

![](https://placehold.it/15/1589F0/000000?text=+) `Manage log`
Chi Song's avatar
Chi Song committed
573

QuanluZhang's avatar
QuanluZhang committed
574
* __nnictl log stdout__
Chi Song's avatar
Chi Song committed
575
576
577
578
579
580
581
582
583
584
585

  * Description

    Show the stdout log content.

  * Usage

    ```bash
    nnictl log stdout [options]
    ```

586
  * Options
Chi Song's avatar
Chi Song committed
587

Chi Song's avatar
Chi Song committed
588
589
590
591
592
593
  |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|
Chi Song's avatar
Chi Song committed
594

595
596
597
598
599
600
601
602
  * Example

    > Show the tail of stdout log content

    ```bash
    nnictl log stdout [experiment_id] --tail [lines_number]
    ```

QuanluZhang's avatar
QuanluZhang committed
603
604
* __nnictl log stderr__
  * Description
Chi Song's avatar
Chi Song committed
605
606

    Show the stderr log content.
607

QuanluZhang's avatar
QuanluZhang committed
608
  * Usage
Chi Song's avatar
Chi Song committed
609
610
611
612
613

    ```bash
    nnictl log stderr [options]
    ```

614
  * Options
Chi Song's avatar
Chi Song committed
615

Chi Song's avatar
Chi Song committed
616
617
618
619
620
621
  |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|
622
623

* __nnictl log trial__
624

625
  * Description
626

Chi Song's avatar
Chi Song committed
627
    Show trial log path.
628

629
  * Usage
SparkSnail's avatar
SparkSnail committed
630

631
    ```bash
632
633
634
635
636
    nnictl log trial [options]
    ```

  * Options

Chi Song's avatar
Chi Song committed
637
638
  |Name, shorthand|Required|Default|Description|
  |------|------|------ |------|
639
640
  |id|  False| |Experiment ID of the trial|
  |--trial_id, -T|  False| |ID of the trial to be found the log path, required when id is not empty.|
641

Yan Ni's avatar
Yan Ni committed
642
<a name="webui"></a>
643
![](https://placehold.it/15/1589F0/000000?text=+) `Manage webui`
Chi Song's avatar
Chi Song committed
644

SparkSnail's avatar
SparkSnail committed
645
* __nnictl webui url__
SparkSnail's avatar
SparkSnail committed
646

Yan Ni's avatar
Yan Ni committed
647
<a name="tensorboard"></a>
648
![](https://placehold.it/15/1589F0/000000?text=+) `Manage tensorboard`
Chi Song's avatar
Chi Song committed
649

SparkSnail's avatar
SparkSnail committed
650
* __nnictl tensorboard start__
Chi Song's avatar
Chi Song committed
651
652
653
654

  * Description

    Start the tensorboard process.
655

Chi Song's avatar
Chi Song committed
656
657
658
659
660
661
  * Usage

    ```bash
    nnictl tensorboard start
    ```

662
  * Options
Chi Song's avatar
Chi Song committed
663

Chi Song's avatar
Chi Song committed
664
665
666
  |Name, shorthand|Required|Default|Description|
  |------|------|------ |------|
  |id|  False| |ID of the experiment you want to set|
667
  |--trial_id, -T|  False| |ID of the trial|
Chi Song's avatar
Chi Song committed
668
  |--port|  False| 6006|The port of the tensorboard process|
Chi Song's avatar
Chi Song committed
669
670
671

  * Detail

672
673
    1. NNICTL support tensorboard function in local and remote platform for the moment, other platforms will be supported later.
    2. If you want to use tensorboard, you need to write your tensorboard log data to environment variable [NNI_OUTPUT_DIR] path.
Chi Song's avatar
Chi Song committed
674
675
    3. In local mode, nnictl will set --logdir=[NNI_OUTPUT_DIR] directly and start a tensorboard process.
    4. 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.
676
    5. If there is only one trial job, you don't need to set trial id. If there are multiple trial jobs running, you should set the trial id, or you could use [nnictl tensorboard start --trial_id all] to map --logdir to all trial log paths.
SparkSnail's avatar
SparkSnail committed
677
678

* __nnictl tensorboard stop__
679
680
  * Description

681
    Stop all of the tensorboard process.
682
683
684
685
686
687
688
689
690

  * Usage

    ```bash
    nnictl tensorboard stop
    ```

  * Options

Chi Song's avatar
Chi Song committed
691
692
693
  |Name, shorthand|Required|Default|Description|
  |------|------|------ |------|
  |id|  False| |ID of the experiment you want to set|
Yan Ni's avatar
Yan Ni committed
694
695

<a name="package"></a>
696
697

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

Yan Ni's avatar
Yan Ni committed
699
* __nnictl package install__
700
701
702
703
704
705
706
707
708
709
710
711
  * Description

    Install the packages needed in nni experiments.

  * Usage

    ```bash
    nnictl package install [OPTIONS]
    ```

  * Options

Chi Song's avatar
Chi Song committed
712
713
714
  |Name, shorthand|Required|Default|Description|
  |------|------|------ |------|
  |--name|  True| |The name of package to be installed|
Yan Ni's avatar
Yan Ni committed
715

716
717
718
719
720
721
722
723
  * Example

    > Install the packages needed in tuner SMAC

    ```bash
    nnictl package install --name=SMAC
    ```

Yan Ni's avatar
Yan Ni committed
724
* __nnictl package show__
725
726
727
728
729
730
731
732
733
734
735
736

  * Description

    List the packages supported.

  * Usage

    ```bash
    nnictl package show
    ```

<a name="version"></a>
737
738

![](https://placehold.it/15/1589F0/000000?text=+) `Check NNI version`
739
740
741
742
743
744
745
746
747
748
749

* __nnictl --version__

  * Description

    Describe the current version of NNI installed.

  * Usage

    ```bash
    nnictl --version
750
    ```
751