Update config v2 doc #3711
Update config v2 doc #3711
Conversation
|
|
||
| 3. Some fields take a path to file or directory. | ||
| Unless otherwise noted, both absolute path and relative path are supported, and ``~`` will be expanded to home directory. | ||
| .. _path: |
There was a problem hiding this comment.
what is this .. _path: used for?
There was a problem hiding this comment.
An anchor, to show the meaning of the path. When quoted below, users can jump directly, like these:
Path_ to the JSON file containing the search space
Specify the :ref:`directory <path>` to place log, checkpoint, metadata, and other run-time stuff.
| Experiment Config Reference | ||
| =========================== | ||
| ============================== | ||
| Experiment Config V2 Reference |
|
|
||
| A config file is needed when creating an experiment. The path of the config file is provided to ``nnictl``. | ||
| The config file is in YAML format. | ||
| This document describes the rules to write the config file, and provides some examples and templates. | ||
|
|
||
| .. Note:: This experiment config is still supported for now, but will be migrated to new `Experiment Config <../reference/experiment_config.rst>`_ in NNI v. |
There was a problem hiding this comment.
@liuzhe-lz when not support config v1?
There was a problem hiding this comment.
there has been no plan to stop the support of v1
|
|
||
| - `LocalConfig`_ | ||
| - `RemoteConfig`_ | ||
| - `OpenpaiConfig <openpai-class>`_ | ||
| - :ref:`OpenpaiConfig <openpai-class>` |
There was a problem hiding this comment.
why OpenpaiConfig is different?
|
|
||
| `Mount point <path>`_ of storage service (typically NFS) on current machine. | ||
| :ref:`Mount point <path>` of storage service (typically NFS) on current machine. |
There was a problem hiding this comment.
what is the rendering result of ":ref:Mount point <path>"?
There was a problem hiding this comment.
here #3711 (comment)
(..path)
| @@ -638,15 +676,15 @@ default: ``False`` | |||
|
|
|||
|
|
|||
| openpaiConfig | |||
There was a problem hiding this comment.
Because OpenPai training service has a config field named openpaiConfig, and the headers are not case sensitive. Just use openpaiConfig can not link to the correct section, and old anchor is invalid, so I use :ref
|
|
||
| Specify whether NNI should submit trials to GPUs occupied by other tasks. | ||
|
|
||
| type: ``Optional[bool]`` | ||
|
|
||
| Must be set when `trialGpuNumber` greater than zero. | ||
|
|
||
| If your are using desktop system with GUI, set this to ``True``. | ||
| If you are using the desktop system with GUI, set this to ``True``. |
There was a problem hiding this comment.
Please add these detail info:
Following processes can make GPU "active":
- non-NNI CUDA programs
- graphical desktop
- trials submitted by other NNI instances, if you have more than one NNI experiments running at same time
- other users' CUDA programs, if you are using a shared server
Therefore, if you are using graphical OS like Windows 10 or Ubuntu desktop and useActiveGpu is set to False, the GUI will prevent NNI from launching any trial.
If you creates multiple NNI experiments and useActiveGpu is set to True, they will submit multiple trials to one GPU.
There was a problem hiding this comment.
... and useActiveGpu is set to False, the GUI will prevent NNI from launching any trial?
There was a problem hiding this comment.
some questions
- If I create multiple NNI experiments and
useActiveGpuis set toTrue, only use one GPU, instead of related togpuIndices? - In OpenPAI and AML, when I want to use GPU, what should I do?
- the type of
tunerGpuIndicesandgpuIndicescan be set toint?
There was a problem hiding this comment.
- Assume there is only one GPU on the machine, then each experiment will submit one trial to that GPU. The GPU will have 2 trials run concurrently.
- Set
trialGpuNumber, that's all. Generally you should not need fine-grained control likeuseActiveGpuon "managed" platforms. - Yes,
gpuIndices: 0,1,2is string,gpuIndices: 1,2is string, butgpuIndices: 2is int.
cannot find OpenPAI config reference link