Skip to content
This repository has been archived by the owner on Sep 18, 2024. It is now read-only.

Commit

Permalink
Fix Hybrid mode doc (#3600)
Browse files Browse the repository at this point in the history
  • Loading branch information
SparkSnail authored May 10, 2021
1 parent 3a1416c commit 9b845fc
Showing 1 changed file with 18 additions and 33 deletions.
51 changes: 18 additions & 33 deletions docs/en_US/TrainingService/HybridMode.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,40 +15,25 @@ Use ``examples/trials/mnist-tfv1`` as an example. The NNI config YAML file's con

.. code-block:: yaml
authorName: default
experimentName: example_mnist
experimentName: MNIST
searchSpaceFile: search_space.json
trialCommand: python3 mnist.py
trialCodeDirectory: .
trialConcurrency: 2
maxExecDuration: 1h
maxTrialNum: 10
trainingServicePlatform: hybrid
searchSpacePath: search_space.json
#choice: true, false
useAnnotation: false
trialGpuNumber: 0
maxExperimentDuration: 24h
maxTrialNumber: 100
tuner:
builtinTunerName: TPE
name: TPE
classArgs:
#choice: maximize, minimize
optimize_mode: maximize
trial:
command: python3 mnist.py
codeDir: .
gpuNum: 1
hybridConfig:
trainingServicePlatforms:
- local
- remote
remoteConfig:
reuse: true
machineList:
- ip: 10.1.1.1
username: bob
passwd: bob123
Configurations for hybrid mode:

hybridConfig:

* trainingServicePlatforms. required key. This field specify the platforms used in hybrid mode, the values using yaml list format. NNI support setting ``local``, ``remote``, ``aml``, ``pai`` in this field.


.. Note:: If setting a platform in trainingServicePlatforms mode, users should also set the corresponding configuration for the platform. For example, if set ``remote`` as one of the platform, should also set ``machineList`` and ``remoteConfig`` configuration.
trainingService:
- platform: remote
machineList:
- host: 127.0.0.1
user: bob
password: bob
- platform: local
To use hybrid training services, users should set training service configurations as a list in `trainingService` field.
Currently, hybrid support setting `local`, `remote`, `pai` and `aml` training services.

0 comments on commit 9b845fc

Please sign in to comment.