experiment_config.rst 12.4 KB
Newer Older
liuzhe-lz's avatar
liuzhe-lz committed
1
2
3
4
5
6
7
===========================
Experiment Config Reference
===========================

Notes
=====

liuzhe-lz's avatar
liuzhe-lz committed
8
9
1. This document list field names is ``camelCase``.
   They need to be converted to ``snake_case`` for Python library ``nni.experiment``.
liuzhe-lz's avatar
liuzhe-lz committed
10

liuzhe-lz's avatar
liuzhe-lz committed
11
2. In this document type of fields are formatted as `Python type hint <https://docs.python.org/3.10/library/typing.html>`__.
liuzhe-lz's avatar
liuzhe-lz committed
12
13
   Therefore JSON objects are called `dict` and arrays are called `list`.

liuzhe-lz's avatar
liuzhe-lz committed
14
.. _path:
liuzhe-lz's avatar
liuzhe-lz committed
15
16

3. Some fields take a path to file or directory.
liuzhe-lz's avatar
liuzhe-lz committed
17
   Unless otherwise noted, both absolute path and relative path are supported, and ``~`` will be expanded to home directory.
liuzhe-lz's avatar
liuzhe-lz committed
18
19
20
21
22
23
24

   - When written in YAML file, relative paths are relative to the directory containing that file.
   - When assigned in Python code, relative paths are relative to current working directory.
   - All relative paths are converted to absolute when loading YAML file into Python class, and when saving Python class to YAML file.

4. Setting a field to ``None`` or ``null`` is equivalent to not setting the field.

liuzhe-lz's avatar
liuzhe-lz committed
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
Examples
========

Local Mode
^^^^^^^^^^

.. code-block:: yaml

    experimentName: MNIST
    searchSpaceFile: search_space.json
    trialCommand: python mnist.py
    trialCodeDirectory: .
    trialGpuNumber: 1
    maxExperimentDuration: 24h
    maxTrialNumber: 100
    tuner:
      name: TPE
      classArgs:
        optimize_mode: maximize
    trainingService:
      platform: local
      useActiveGpu: True

Local Mode (Inline Search Space)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: yaml

    searchSpace:
      batch_size:
        _type: choice
        _value: [16, 32, 64]
      learning_rate:
        _type: loguniform
        _value: [0.0001, 0.1]
    trialCommand: python mnist.py
    trialGpuNumber: 1
    tuner:
      name: TPE
      classArgs:
        optimize_mode: maximize
    trainingService:
      platform: local
      useActiveGpu: True

Remote Mode
^^^^^^^^^^^

.. code-block:: yaml

    experimentName: MNIST
    searchSpaceFile: search_space.json
    trialCommand: python mnist.py
    trialCodeDirectory: .
    trialGpuNumber: 1
    maxExperimentDuration: 24h
    maxTrialNumber: 100
    tuner:
      name: TPE
      classArgs:
        optimize_mode: maximize
    trainingService:
      platform: remote
      machineList:
        - host: 11.22.33.44
          user: alice
          password: xxxxx
        - host: my.domain.com
          user: bob
          sshKeyFile: ~/.ssh/id_rsa

Reference
=========

liuzhe-lz's avatar
liuzhe-lz committed
99
ExperimentConfig
liuzhe-lz's avatar
liuzhe-lz committed
100
^^^^^^^^^^^^^^^^
liuzhe-lz's avatar
liuzhe-lz committed
101

liuzhe-lz's avatar
liuzhe-lz committed
102
103
experimentName
--------------
liuzhe-lz's avatar
liuzhe-lz committed
104
105
106
107
108
109

Mnemonic name of the experiment. This will be shown in web UI and nnictl.

type: ``Optional[str]``


liuzhe-lz's avatar
liuzhe-lz committed
110
111
searchSpaceFile
---------------
liuzhe-lz's avatar
liuzhe-lz committed
112
113
114
115
116

Path_ to a JSON file containing the search space.

type: ``Optional[str]``

liuzhe-lz's avatar
liuzhe-lz committed
117
Search space format is determined by tuner. Common format for built-in tuners is documeted `here <../Tutorial/SearchSpaceSpec.rst>`__.
liuzhe-lz's avatar
liuzhe-lz committed
118

liuzhe-lz's avatar
liuzhe-lz committed
119
Mutually exclusive to `searchSpace`_.
liuzhe-lz's avatar
liuzhe-lz committed
120
121


liuzhe-lz's avatar
liuzhe-lz committed
122
123
searchSpace
-----------
liuzhe-lz's avatar
liuzhe-lz committed
124
125
126

Search space object.

liuzhe-lz's avatar
liuzhe-lz committed
127
type: ``Optional[JSON]``
liuzhe-lz's avatar
liuzhe-lz committed
128

liuzhe-lz's avatar
liuzhe-lz committed
129
The format is determined by tuner. Common format for built-in tuners is documented `here <../Tutorial/SearchSpaceSpec.rst>`__.
liuzhe-lz's avatar
liuzhe-lz committed
130
131
132

Note that ``None`` means "no such field" so empty search space should be written as ``{}``.

liuzhe-lz's avatar
liuzhe-lz committed
133
Mutually exclusive to `searchSpaceFile`_.
liuzhe-lz's avatar
liuzhe-lz committed
134
135


liuzhe-lz's avatar
liuzhe-lz committed
136
137
trialCommand
------------
liuzhe-lz's avatar
liuzhe-lz committed
138

liuzhe-lz's avatar
liuzhe-lz committed
139
Command to launch trial.
liuzhe-lz's avatar
liuzhe-lz committed
140
141
142

type: ``str``

liuzhe-lz's avatar
liuzhe-lz committed
143
The command will be executed in bash on Linux and macOS, and in PowerShell on Windows.
liuzhe-lz's avatar
liuzhe-lz committed
144
145


liuzhe-lz's avatar
liuzhe-lz committed
146
147
trialCodeDirectory
------------------
liuzhe-lz's avatar
liuzhe-lz committed
148
149
150
151
152
153
154

`Path`_ to the directory containing trial source files.

type: ``str``

default: ``"."``

liuzhe-lz's avatar
liuzhe-lz committed
155
156
All files in this directory will be sent to training machine, unless there is a ``.nniignore`` file.
(See nniignore section of `quick start guide <../Tutorial/QuickStart.rst>`__ for details.)
liuzhe-lz's avatar
liuzhe-lz committed
157
158


liuzhe-lz's avatar
liuzhe-lz committed
159
160
trialConcurrency
----------------
liuzhe-lz's avatar
liuzhe-lz committed
161
162
163
164
165
166
167
168

Specify how many trials should be run concurrently.

type: ``int``

The real concurrency also depends on hardware resources and may be less than this value.


liuzhe-lz's avatar
liuzhe-lz committed
169
170
trialGpuNumber
--------------
liuzhe-lz's avatar
liuzhe-lz committed
171
172
173
174
175

Number of GPUs used by each trial.

type: ``Optional[int]``

liuzhe-lz's avatar
liuzhe-lz committed
176
177
178
This field might have slightly different meaning for various training services,
especially when set to ``0`` or ``None``.
See training service's document for details.
liuzhe-lz's avatar
liuzhe-lz committed
179

liuzhe-lz's avatar
liuzhe-lz committed
180
181
182
In local mode, setting the field to zero will prevent trials from accessing GPU (by empty ``CUDA_VISIBLE_DEVICES``).
And when set to ``None``, trials will be created and scheduled as if they did not use GPU,
but they can still use all GPU resources if they want.
liuzhe-lz's avatar
liuzhe-lz committed
183
184


liuzhe-lz's avatar
liuzhe-lz committed
185
186
maxExperimentDuration
---------------------
liuzhe-lz's avatar
liuzhe-lz committed
187
188
189
190
191
192
193
194
195
196
197
198

Limit the duration of this experiment if specified.

type: ``Optional[str]``

format: ``number + s|m|h|d``

examples: ``"10m"``, ``"0.5h"``

When time runs out, the experiment will stop creating trials but continue to serve web UI.


liuzhe-lz's avatar
liuzhe-lz committed
199
200
maxTrialNumber
--------------
liuzhe-lz's avatar
liuzhe-lz committed
201
202
203
204
205
206
207
208

Limit the number of trials to create if specified.

type: ``Optional[int]``

When the budget runs out, the experiment will stop creating trials but continue to serve web UI.


liuzhe-lz's avatar
liuzhe-lz committed
209
210
nniManagerIp
------------
liuzhe-lz's avatar
liuzhe-lz committed
211
212
213
214
215

IP of current machine, used by training machines to access NNI manager. Not used in local mode.

type: ``Optional[str]``

liuzhe-lz's avatar
liuzhe-lz committed
216
If not specified, IPv4 address of ``eth0`` will be used.
liuzhe-lz's avatar
liuzhe-lz committed
217

liuzhe-lz's avatar
liuzhe-lz committed
218
Must be set on Windows and systems using predictable network interface name, except for local mode.
liuzhe-lz's avatar
liuzhe-lz committed
219
220


liuzhe-lz's avatar
liuzhe-lz committed
221
222
223
224
useAnnotation
-------------

Enable `annotation <../Tutorial/AnnotationSpec.rst>`__.
liuzhe-lz's avatar
liuzhe-lz committed
225
226
227
228
229

type: ``bool``

default: ``False``

liuzhe-lz's avatar
liuzhe-lz committed
230
When using annotation, `searchSpace`_ and `searchSpaceFile`_ should not be specified manually.
liuzhe-lz's avatar
liuzhe-lz committed
231
232
233
234
235
236
237
238
239
240
241
242
243
244


debug
-----

Enable debug mode.

type: ``bool``

default: ``False``

When enabled, logging will be more verbose and some internal validation will be loosen.


liuzhe-lz's avatar
liuzhe-lz committed
245
246
logLevel
--------
liuzhe-lz's avatar
liuzhe-lz committed
247
248
249
250
251
252
253
254
255
256
257
258
259

Set log level of whole system.

type: ``Optional[str]``

values: ``"trace"``, ``"debug"``, ``"info"``, ``"warning"``, ``"error"``, ``"fatal"``

Defaults to "info" or "debug", depending on `debug`_ option.

Most modules of NNI will be affected by this value, including NNI manager, tuner, training service, etc.

The exception is trial, whose logging level is directly managed by trial code.

liuzhe-lz's avatar
liuzhe-lz committed
260
For Python modules, "trace" acts as logging level 0 and "fatal" acts as ``logging.CRITICAL``.
liuzhe-lz's avatar
liuzhe-lz committed
261
262


liuzhe-lz's avatar
liuzhe-lz committed
263
264
experimentWorkingDirectory
--------------------------
liuzhe-lz's avatar
liuzhe-lz committed
265

liuzhe-lz's avatar
liuzhe-lz committed
266
Specify the `directory <path>`_ to place log, checkpoint, metadata, and other run-time stuff.
liuzhe-lz's avatar
liuzhe-lz committed
267
268
269
270
271
272
273
274

type: ``Optional[str]``

By default uses ``~/nni-experiments``.

NNI will create a subdirectory named by experiment ID, so it is safe to use same directory for multiple experiments.


liuzhe-lz's avatar
liuzhe-lz committed
275
276
tunerGpuIndices
---------------
liuzhe-lz's avatar
liuzhe-lz committed
277
278
279

Limit the GPUs visible to tuner, assessor, and advisor.

liuzhe-lz's avatar
liuzhe-lz committed
280
type: ``Optional[list[int] | str]``
liuzhe-lz's avatar
liuzhe-lz committed
281
282
283
284
285
286
287
288
289

This will be the ``CUDA_VISIBLE_DEVICES`` environment variable of tuner process.

Because tuner, assessor, and advisor run in same process, this option will affect them all.


tuner
-----

liuzhe-lz's avatar
liuzhe-lz committed
290
Specify the tuner.
liuzhe-lz's avatar
liuzhe-lz committed
291
292
293
294
295
296
297

type: Optional `AlgorithmConfig`_


assessor
--------

liuzhe-lz's avatar
liuzhe-lz committed
298
Specify the assessor.
liuzhe-lz's avatar
liuzhe-lz committed
299
300
301
302
303
304
305

type: Optional `AlgorithmConfig`_


advisor
-------

liuzhe-lz's avatar
liuzhe-lz committed
306
Specify the advisor.
liuzhe-lz's avatar
liuzhe-lz committed
307
308
309
310

type: Optional `AlgorithmConfig`_


liuzhe-lz's avatar
liuzhe-lz committed
311
312
trainingService
---------------
liuzhe-lz's avatar
liuzhe-lz committed
313

liuzhe-lz's avatar
liuzhe-lz committed
314
Specify `training service <../TrainingService/Overview.rst>`__.
liuzhe-lz's avatar
liuzhe-lz committed
315
316
317
318
319

type: `TrainingServiceConfig`_


AlgorithmConfig
liuzhe-lz's avatar
liuzhe-lz committed
320
321
322
323
324
325
326
327
328
^^^^^^^^^^^^^^^

``AlgorithmConfig`` describes a tuner / assessor / advisor algorithm.

For custom algorithms, there are two ways to describe them:

  1. `Register the algorithm <../Tuner/InstallCustomizedTuner.rst>`__ to use it like built-in. (preferred)

  2. Specify code directory and class name directly.
liuzhe-lz's avatar
liuzhe-lz committed
329
330
331
332
333


name
----

liuzhe-lz's avatar
liuzhe-lz committed
334
Name of built-in or registered algorithm.
liuzhe-lz's avatar
liuzhe-lz committed
335

liuzhe-lz's avatar
liuzhe-lz committed
336
type: ``str`` for built-in and registered algorithm, ``None`` for other custom algorithm
liuzhe-lz's avatar
liuzhe-lz committed
337
338


liuzhe-lz's avatar
liuzhe-lz committed
339
340
className
---------
liuzhe-lz's avatar
liuzhe-lz committed
341

liuzhe-lz's avatar
liuzhe-lz committed
342
Qualified class name of not registered custom algorithm.
liuzhe-lz's avatar
liuzhe-lz committed
343

liuzhe-lz's avatar
liuzhe-lz committed
344
type: ``None`` for built-in and registered algorithm, ``str`` for other custom algorithm
liuzhe-lz's avatar
liuzhe-lz committed
345
346
347
348

example: ``"my_tuner.MyTuner"``


liuzhe-lz's avatar
liuzhe-lz committed
349
350
codeDirectory
-------------
liuzhe-lz's avatar
liuzhe-lz committed
351
352
353

`Path`_ to directory containing the custom algorithm class.

liuzhe-lz's avatar
liuzhe-lz committed
354
type: ``None`` for built-in and registered algorithm, ``str`` for other custom algorithm
liuzhe-lz's avatar
liuzhe-lz committed
355
356


liuzhe-lz's avatar
liuzhe-lz committed
357
358
classArgs
---------
liuzhe-lz's avatar
liuzhe-lz committed
359
360
361
362
363
364
365
366
367

Keyword arguments passed to algorithm class' constructor.

type: ``Optional[dict[str, Any]]``

See algorithm's document for supported value.


TrainingServiceConfig
liuzhe-lz's avatar
liuzhe-lz committed
368
^^^^^^^^^^^^^^^^^^^^^
liuzhe-lz's avatar
liuzhe-lz committed
369
370
371

One of following:

liuzhe-lz's avatar
liuzhe-lz committed
372
373
374
375
376
377
- `LocalConfig`_
- `RemoteConfig`_
- `OpenpaiConfig <openpai-class>`_
- `AmlConfig`_

For other training services, we suggest to use `v1 config schema <../Tutorial/ExperimentConfig.rst>`_ for now.
liuzhe-lz's avatar
liuzhe-lz committed
378
379
380


LocalConfig
liuzhe-lz's avatar
liuzhe-lz committed
381
^^^^^^^^^^^
liuzhe-lz's avatar
liuzhe-lz committed
382

liuzhe-lz's avatar
liuzhe-lz committed
383
Detailed `here <../TrainingService/LocalMode.rst>`__.
liuzhe-lz's avatar
liuzhe-lz committed
384
385
386
387
388
389
390

platform
--------

Constant string ``"local"``.


liuzhe-lz's avatar
liuzhe-lz committed
391
392
useActiveGpu
------------
liuzhe-lz's avatar
liuzhe-lz committed
393
394
395

Specify whether NNI should submit trials to GPUs occupied by other tasks.

liuzhe-lz's avatar
liuzhe-lz committed
396
type: ``Optional[bool]``
liuzhe-lz's avatar
liuzhe-lz committed
397

liuzhe-lz's avatar
liuzhe-lz committed
398
Must be set when `trialGpuNumber` greater than zero.
liuzhe-lz's avatar
liuzhe-lz committed
399

liuzhe-lz's avatar
liuzhe-lz committed
400
If your are using desktop system with GUI, set this to ``True``.
liuzhe-lz's avatar
liuzhe-lz committed
401
402


liuzhe-lz's avatar
liuzhe-lz committed
403
404
maxTrialNumberPerGpu
---------------------
liuzhe-lz's avatar
liuzhe-lz committed
405
406
407
408
409
410
411
412

Specify how many trials can share one GPU.

type: ``int``

default: ``1``


liuzhe-lz's avatar
liuzhe-lz committed
413
414
gpuIndices
----------
liuzhe-lz's avatar
liuzhe-lz committed
415
416
417

Limit the GPUs visible to trial processes.

liuzhe-lz's avatar
liuzhe-lz committed
418
type: ``Optional[list[int] | str]``
liuzhe-lz's avatar
liuzhe-lz committed
419

liuzhe-lz's avatar
liuzhe-lz committed
420
If `trialGpuNumber`_ is less than the length of this value, only a subset will be visible to each trial.
liuzhe-lz's avatar
liuzhe-lz committed
421
422
423
424
425

This will be used as ``CUDA_VISIBLE_DEVICES`` environment variable.


RemoteConfig
liuzhe-lz's avatar
liuzhe-lz committed
426
^^^^^^^^^^^^
liuzhe-lz's avatar
liuzhe-lz committed
427

liuzhe-lz's avatar
liuzhe-lz committed
428
Detailed `here <../TrainingService/RemoteMachineMode.rst>`__.
liuzhe-lz's avatar
liuzhe-lz committed
429
430
431
432
433
434
435

platform
--------

Constant string ``"remote"``.


liuzhe-lz's avatar
liuzhe-lz committed
436
437
machineList
-----------
liuzhe-lz's avatar
liuzhe-lz committed
438
439
440
441
442
443

List of training machines.

type: list of `RemoteMachineConfig`_


liuzhe-lz's avatar
liuzhe-lz committed
444
445
reuseMode
---------
liuzhe-lz's avatar
liuzhe-lz committed
446

liuzhe-lz's avatar
liuzhe-lz committed
447
Enable reuse `mode <../Tutorial/ExperimentConfig.rst#reuse>`__.
liuzhe-lz's avatar
liuzhe-lz committed
448

liuzhe-lz's avatar
liuzhe-lz committed
449
type: ``bool``
liuzhe-lz's avatar
liuzhe-lz committed
450
451
452


RemoteMachineConfig
liuzhe-lz's avatar
liuzhe-lz committed
453
^^^^^^^^^^^^^^^^^^^
liuzhe-lz's avatar
liuzhe-lz committed
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469

host
----

IP or hostname (domain name) of the machine.

type: ``str``


port
----

SSH service port.

type: ``int``

liuzhe-lz's avatar
liuzhe-lz committed
470
default: ``22``
liuzhe-lz's avatar
liuzhe-lz committed
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487


user
----

Login user name.

type: ``str``


password
--------

Login password.

type: ``Optional[str]``

liuzhe-lz's avatar
liuzhe-lz committed
488
If not specified, `sshKeyFile`_ will be used instead.
liuzhe-lz's avatar
liuzhe-lz committed
489
490


liuzhe-lz's avatar
liuzhe-lz committed
491
492
sshKeyFile
----------
liuzhe-lz's avatar
liuzhe-lz committed
493

liuzhe-lz's avatar
liuzhe-lz committed
494
`Path`_ to sshKeyFile (identity file).
liuzhe-lz's avatar
liuzhe-lz committed
495

liuzhe-lz's avatar
liuzhe-lz committed
496
type: ``Optional[str]``
liuzhe-lz's avatar
liuzhe-lz committed
497
498
499
500

Only used when `password`_ is not specified.


liuzhe-lz's avatar
liuzhe-lz committed
501
502
sshPassphrase
-------------
liuzhe-lz's avatar
liuzhe-lz committed
503
504
505
506
507
508

Passphrase of SSH identity file.

type: ``Optional[str]``


liuzhe-lz's avatar
liuzhe-lz committed
509
510
useActiveGpu
------------
liuzhe-lz's avatar
liuzhe-lz committed
511
512
513
514
515

Specify whether NNI should submit trials to GPUs occupied by other tasks.

type: ``bool``

liuzhe-lz's avatar
liuzhe-lz committed
516
517
default: ``False``

liuzhe-lz's avatar
liuzhe-lz committed
518

liuzhe-lz's avatar
liuzhe-lz committed
519
520
maxTrialNumberPerGpu
--------------------
liuzhe-lz's avatar
liuzhe-lz committed
521
522
523
524
525
526
527
528

Specify how many trials can share one GPU.

type: ``int``

default: ``1``


liuzhe-lz's avatar
liuzhe-lz committed
529
530
gpuIndices
----------
liuzhe-lz's avatar
liuzhe-lz committed
531
532
533

Limit the GPUs visible to trial processes.

liuzhe-lz's avatar
liuzhe-lz committed
534
type: ``Optional[list[int] | str]``
liuzhe-lz's avatar
liuzhe-lz committed
535

liuzhe-lz's avatar
liuzhe-lz committed
536
If `trialGpuNumber`_ is less than the length of this value, only a subset will be visible to each trial.
liuzhe-lz's avatar
liuzhe-lz committed
537
538
539
540

This will be used as ``CUDA_VISIBLE_DEVICES`` environment variable.


liuzhe-lz's avatar
liuzhe-lz committed
541
542
trialPrepareCommand
-------------------
liuzhe-lz's avatar
liuzhe-lz committed
543
544
545
546
547
548
549

Command(s) to run before launching each trial.

type: ``Optional[str]``

This is useful if preparing steps vary for different machines.

liuzhe-lz's avatar
liuzhe-lz committed
550
.. _openpai-class:
liuzhe-lz's avatar
liuzhe-lz committed
551

liuzhe-lz's avatar
liuzhe-lz committed
552
553
OpenpaiConfig
^^^^^^^^^^^^^
liuzhe-lz's avatar
liuzhe-lz committed
554

liuzhe-lz's avatar
liuzhe-lz committed
555
Detailed `here <../TrainingService/PaiMode.rst>`__.
liuzhe-lz's avatar
liuzhe-lz committed
556
557
558
559
560
561
562
563
564
565
566
567
568
569

platform
--------

Constant string ``"openpai"``.


host
----

Hostname of OpenPAI service.

type: ``str``

liuzhe-lz's avatar
liuzhe-lz committed
570
571
572
573
This may includes ``https://`` or ``http://`` prefix.

HTTPS will be used by default.

liuzhe-lz's avatar
liuzhe-lz committed
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592

username
--------

OpenPAI user name.

type: ``str``


token
-----

OpenPAI user token.

type: ``str``

This can be found in your OpenPAI user settings page.


liuzhe-lz's avatar
liuzhe-lz committed
593
594
dockerImage
-----------
liuzhe-lz's avatar
liuzhe-lz committed
595

liuzhe-lz's avatar
liuzhe-lz committed
596
Name and tag of docker image to run the trials.
liuzhe-lz's avatar
liuzhe-lz committed
597

liuzhe-lz's avatar
liuzhe-lz committed
598
type: ``str``
liuzhe-lz's avatar
liuzhe-lz committed
599

liuzhe-lz's avatar
liuzhe-lz committed
600
default: ``"msranni/nni:latest"``
liuzhe-lz's avatar
liuzhe-lz committed
601
602


liuzhe-lz's avatar
liuzhe-lz committed
603
604
nniManagerStorageMountPoint
---------------------------
liuzhe-lz's avatar
liuzhe-lz committed
605

liuzhe-lz's avatar
liuzhe-lz committed
606
`Mount point <path>`_ of storage service (typically NFS) on current machine.
liuzhe-lz's avatar
liuzhe-lz committed
607
608
609
610

type: ``str``


liuzhe-lz's avatar
liuzhe-lz committed
611
612
containerStorageMountPoint
--------------------------
liuzhe-lz's avatar
liuzhe-lz committed
613

liuzhe-lz's avatar
liuzhe-lz committed
614
Mount point of storage service (typically NFS) in docker container.
liuzhe-lz's avatar
liuzhe-lz committed
615
616
617

type: ``str``

liuzhe-lz's avatar
liuzhe-lz committed
618
This must be an absolute path.
liuzhe-lz's avatar
liuzhe-lz committed
619
620


liuzhe-lz's avatar
liuzhe-lz committed
621
622
reuseMode
---------
liuzhe-lz's avatar
liuzhe-lz committed
623

liuzhe-lz's avatar
liuzhe-lz committed
624
Enable reuse `mode <../Tutorial/ExperimentConfig.rst#reuse>`__.
liuzhe-lz's avatar
liuzhe-lz committed
625
626
627
628
629
630

type: ``bool``

default: ``False``


liuzhe-lz's avatar
liuzhe-lz committed
631
632
openpaiConfig
-------------
liuzhe-lz's avatar
liuzhe-lz committed
633

liuzhe-lz's avatar
liuzhe-lz committed
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
Embedded OpenPAI config file.

type: ``Optional[JSON]``


openpaiConfigFile
-----------------

`Path`_ to OpenPAI config file.

type: ``Optional[str]``

An example can be found `here <https://github.com/microsoft/pai/blob/master/docs/manual/cluster-user/examples/hello-world-job.yaml>`__


AmlConfig
^^^^^^^^^

Detailed `here <../TrainingService/AMLMode.rst>`__.


platform
--------

Constant string ``"aml"``.


dockerImage
-----------

Name and tag of docker image to run the trials.
liuzhe-lz's avatar
liuzhe-lz committed
665
666
667

type: ``str``

liuzhe-lz's avatar
liuzhe-lz committed
668
default: ``"msranni/nni:latest"``
liuzhe-lz's avatar
liuzhe-lz committed
669
670


liuzhe-lz's avatar
liuzhe-lz committed
671
672
673
674
subscriptionId
--------------

Azure subscription ID.
liuzhe-lz's avatar
liuzhe-lz committed
675
676
677
678

type: ``str``


liuzhe-lz's avatar
liuzhe-lz committed
679
680
681
682
resourceGroup
-------------

Azure resource group name.
liuzhe-lz's avatar
liuzhe-lz committed
683

liuzhe-lz's avatar
liuzhe-lz committed
684
type: ``str``
liuzhe-lz's avatar
liuzhe-lz committed
685
686


liuzhe-lz's avatar
liuzhe-lz committed
687
688
workspaceName
-------------
liuzhe-lz's avatar
liuzhe-lz committed
689

liuzhe-lz's avatar
liuzhe-lz committed
690
691
692
Azure workspace name.

type: ``str``
liuzhe-lz's avatar
liuzhe-lz committed
693
694


liuzhe-lz's avatar
liuzhe-lz committed
695
696
697
698
699
700
computeTarget
-------------

AML compute cluster name.

type: ``str``