Skip to content

GitLab

"docs/git@developer.sourcefind.cn:OpenDAS/nni.git" did not exist on "95338ef04ae58e01259eb6c1a4ddc1cb5e61d470"
Commit d5f808b0 authored by Chi Song's avatar Chi Song Committed by fishyds
Browse files

Doc typo and format fixes (#560) 

* fix incorrect document

* fix doc format and typo
parent 37354dff
Hide whitespace changes
Inline Side-by-side
Showing with 49 additions and 38 deletions
docs/ExperimentConfig.md
View file @ d5f808b0
...@@ -5,6 +5,7 @@ The config file is written in yaml format, and need to be written correctly. ...@@ -5,6 +5,7 @@ The config file is written in yaml format, and need to be written correctly.
This document describes the rule to write config file, and will provide some examples and templates. This document describes the rule to write config file, and will provide some examples and templates.
## Template ## Template
* __light weight(without Annotation and Assessor)__ * __light weight(without Annotation and Assessor)__
``` ```
authorName: authorName:
experimentName: experimentName:
...@@ -34,7 +35,9 @@ machineList: ...@@ -34,7 +35,9 @@ machineList:
username: username:
passwd: passwd:
``` ```
* __Use Assessor__ * __Use Assessor__
``` ```
authorName: authorName:
experimentName: experimentName:
...@@ -71,7 +74,9 @@ machineList: ...@@ -71,7 +74,9 @@ machineList:
username: username:
passwd: passwd:
``` ```
* __Use Annotation__ * __Use Annotation__
``` ```
authorName: authorName:
experimentName: experimentName:
...@@ -107,6 +112,7 @@ machineList: ...@@ -107,6 +112,7 @@ machineList:
username: username:
passwd: passwd:
``` ```
## Configuration ## Configuration
* __authorName__ * __authorName__
* Description * Description
...@@ -123,9 +129,9 @@ machineList: ...@@ -123,9 +129,9 @@ machineList:
* __trialConcurrency__ * __trialConcurrency__
* Description * Description
__trialConcurrency__ specifies the max num of trial jobs run simultaneously. __trialConcurrency__ specifies the max num of trial jobs run simultaneously.
Note: if trialGpuNum is bigger than the free gpu numbers, and the trial jobs running simultaneously can not reach trialConcurrency number, some trial jobs will be put into a queue to wait for gpu allocation. Note: if trialGpuNum is bigger than the free gpu numbers, and the trial jobs running simultaneously can not reach trialConcurrency number, some trial jobs will be put into a queue to wait for gpu allocation.
* __maxExecDuration__ * __maxExecDuration__
* Description * Description
...@@ -155,22 +161,22 @@ machineList: ...@@ -155,22 +161,22 @@ machineList:
* __searchSpacePath__ * __searchSpacePath__
* Description * Description
__searchSpacePath__ specifies the path of search space file, which should be a valid path in the local linux machine. __searchSpacePath__ specifies the path of search space file, which should be a valid path in the local linux machine.
Note: if set useAnnotation=True, the searchSpacePath field should be removed. Note: if set useAnnotation=True, the searchSpacePath field should be removed.
* __useAnnotation__ * __useAnnotation__
* Description * Description
__useAnnotation__ use annotation to analysis trial code and generate search space. __useAnnotation__ use annotation to analysis trial code and generate search space.
Note: if set useAnnotation=True, the searchSpacePath field should be removed. Note: if set useAnnotation=True, the searchSpacePath field should be removed.
* __nniManagerIp__ * __nniManagerIp__
* Description * Description
__nniManagerIp__ set the IP address of the machine on which nni manager process runs. This field is optional, and if it's not set, eth0 device IP will be used instead. __nniManagerIp__ set the IP address of the machine on which nni manager process runs. This field is optional, and if it's not set, eth0 device IP will be used instead.
Note: run ifconfig on NNI manager's machine to check if eth0 device exists. If not, we recommend to set nnimanagerIp explicitly. Note: run ifconfig on NNI manager's machine to check if eth0 device exists. If not, we recommend to set nnimanagerIp explicitly.
* __tuner__ * __tuner__
...@@ -181,68 +187,68 @@ machineList: ...@@ -181,68 +187,68 @@ machineList:
* __builtinTunerName__ * __builtinTunerName__
__builtinTunerName__ specifies the name of system tuner, nni sdk provides four kinds of tuner, including {__TPE__, __Random__, __Anneal__, __Evolution__, __BatchTuner__, __GridSearch__} __builtinTunerName__ specifies the name of system tuner, nni sdk provides four kinds of tuner, including {__TPE__, __Random__, __Anneal__, __Evolution__, __BatchTuner__, __GridSearch__}
* __classArgs__ * __classArgs__
__classArgs__ specifies the arguments of tuner algorithm. If the __builtinTunerName__ is in {__TPE__, __Random__, __Anneal__, __Evolution__}, user should set __optimize_mode__. __classArgs__ specifies the arguments of tuner algorithm. If the __builtinTunerName__ is in {__TPE__, __Random__, __Anneal__, __Evolution__}, user should set __optimize_mode__.
* __codeDir__, __classFileName__, __className__ and __classArgs__ * __codeDir__, __classFileName__, __className__ and __classArgs__
* __codeDir__ * __codeDir__
__codeDir__ specifies the directory of tuner code. __codeDir__ specifies the directory of tuner code.
* __classFileName__ * __classFileName__
__classFileName__ specifies the name of tuner file. __classFileName__ specifies the name of tuner file.
* __className__ * __className__
__className__ specifies the name of tuner class. __className__ specifies the name of tuner class.
* __classArgs__ * __classArgs__
__classArgs__ specifies the arguments of tuner algorithm. __classArgs__ specifies the arguments of tuner algorithm.
* __gpuNum__ * __gpuNum__
__gpuNum__ specifies the gpu number to run the tuner process. The value of this field should be a positive number. __gpuNum__ specifies the gpu number to run the tuner process. The value of this field should be a positive number.
Note: users could only specify one way to set tuner, for example, set {tunerName, optimizationMode} or {tunerCommand, tunerCwd}, and could not set them both. Note: users could only specify one way to set tuner, for example, set {tunerName, optimizationMode} or {tunerCommand, tunerCwd}, and could not set them both.
* __assessor__ * __assessor__
* Description * Description
__assessor__ specifies the assessor algorithm to run an experiment, there are two kinds of ways to set assessor. One way is to use assessor provided by nni sdk, users need to set __builtinAssessorName__ and __classArgs__. Another way is to use users' own tuner file, and need to set __codeDirectory__, __classFileName__, __className__ and __classArgs__. __assessor__ specifies the assessor algorithm to run an experiment, there are two kinds of ways to set assessor. One way is to use assessor provided by nni sdk, users need to set __builtinAssessorName__ and __classArgs__. Another way is to use users' own assessor file, and need to set __codeDirectory__, __classFileName__, __className__ and __classArgs__.
* __builtinAssessorName__ and __classArgs__ * __builtinAssessorName__ and __classArgs__
* __builtinAssessorName__ * __builtinAssessorName__
__builtinAssessorName__ specifies the name of system assessor, nni sdk provides four kinds of tuner, including {__TPE__, __Random__, __Anneal__, __Evolution__} __builtinAssessorName__ specifies the name of system assessor, nni sdk provides one kind of assessor {__Medianstop__}
* __classArgs__ * __classArgs__
__classArgs__ specifies the arguments of tuner algorithm __classArgs__ specifies the arguments of assessor algorithm
* __codeDir__, __classFileName__, __className__ and __classArgs__ * __codeDir__, __classFileName__, __className__ and __classArgs__
* __codeDir__ * __codeDir__
__codeDir__ specifies the directory of tuner code. __codeDir__ specifies the directory of assessor code.
* __classFileName__ * __classFileName__
__classFileName__ specifies the name of tuner file. __classFileName__ specifies the name of assessor file.
* __className__ * __className__
__className__ specifies the name of tuner class. __className__ specifies the name of assessor class.
* __classArgs__ * __classArgs__
__classArgs__ specifies the arguments of tuner algorithm. __classArgs__ specifies the arguments of assessor algorithm.
* __gpuNum__ * __gpuNum__
__gpuNum__ specifies the gpu number to run the assessor process. The value of this field should be a positive number. __gpuNum__ specifies the gpu number to run the assessor process. The value of this field should be a positive number.
Note: users' could only specify one way to set assessor, for example,set {assessorName, optimizationMode} or {assessorCommand, assessorCwd}, and users could not set them both.If users do not want to use assessor, assessor fileld should leave to empty. Note: users' could only specify one way to set assessor, for example,set {assessorName, optimizationMode} or {assessorCommand, assessorCwd}, and users could not set them both.If users do not want to use assessor, assessor fileld should leave to empty.
* __trial(local, remote)__ * __trial(local, remote)__
* __command__ * __command__
__command__ specifies the command to run trial process. __command__ specifies the command to run trial process.
* __codeDir__ * __codeDir__
__codeDir__ specifies the directory of your own trial file. __codeDir__ specifies the directory of your own trial file.
* __gpuNum__ * __gpuNum__
__gpuNum__ specifies the num of gpu to run the trial process. Default value is 0. __gpuNum__ specifies the num of gpu to run the trial process. Default value is 0.
* __trial(pai)__ * __trial(pai)__
* __command__ * __command__
...@@ -250,7 +256,7 @@ machineList: ...@@ -250,7 +256,7 @@ machineList:
__command__ specifies the command to run trial process. __command__ specifies the command to run trial process.
* __codeDir__ * __codeDir__
__codeDir__ specifies the directory of the own trial file. __codeDir__ specifies the directory of the own trial file.
* __gpuNum__ * __gpuNum__
__gpuNum__ specifies the num of gpu to run the trial process. Default value is 0. __gpuNum__ specifies the num of gpu to run the trial process. Default value is 0.
...@@ -306,7 +312,7 @@ machineList: ...@@ -306,7 +312,7 @@ machineList:
* __image__ * __image__
__iamge__ set the image to be used in __ps__. __image__ set the image to be used in __ps__.
* __worker__ * __worker__
...@@ -333,7 +339,7 @@ machineList: ...@@ -333,7 +339,7 @@ machineList:
* __image__ * __image__
__iamge__ set the image to be used in __worker__. __image__ set the image to be used in __worker__.
...@@ -347,7 +353,7 @@ machineList: ...@@ -347,7 +353,7 @@ machineList:
__port__ is the ssh port to be used to connect machine. __port__ is the ssh port to be used to connect machine.
Note: if users set port empty, the default value will be 22. Note: if users set port empty, the default value will be 22.
* __username__ * __username__
__username__ is the account of remote machine. __username__ is the account of remote machine.
...@@ -359,7 +365,7 @@ machineList: ...@@ -359,7 +365,7 @@ machineList:
If users use ssh key to login remote machine, could set __sshKeyPath__ in config file. __sshKeyPath__ is the path of ssh key file, which should be valid. If users use ssh key to login remote machine, could set __sshKeyPath__ in config file. __sshKeyPath__ is the path of ssh key file, which should be valid.
Note: if users set passwd and sshKeyPath simultaneously, nni will try passwd. Note: if users set passwd and sshKeyPath simultaneously, nni will try passwd.
* __passphrase__ * __passphrase__
...@@ -426,6 +432,7 @@ machineList: ...@@ -426,6 +432,7 @@ machineList:
* __local mode__ * __local mode__
If users want to run trial jobs in local machine, and use annotation to generate search space, could use the following config: If users want to run trial jobs in local machine, and use annotation to generate search space, could use the following config:
``` ```
authorName: test authorName: test
experimentName: test_experiment experimentName: test_experiment
...@@ -450,6 +457,7 @@ trial: ...@@ -450,6 +457,7 @@ trial:
``` ```
Could add assessor configuration in config file if set assessor. Could add assessor configuration in config file if set assessor.
``` ```
authorName: test authorName: test
experimentName: test_experiment experimentName: test_experiment
...@@ -482,6 +490,7 @@ trial: ...@@ -482,6 +490,7 @@ trial:
``` ```
Or you could specify your own tuner and assessor file as following: Or you could specify your own tuner and assessor file as following:
``` ```
authorName: test authorName: test
experimentName: test_experiment experimentName: test_experiment
...@@ -518,6 +527,7 @@ trial: ...@@ -518,6 +527,7 @@ trial:
* __remote mode__ * __remote mode__
If run trial jobs in remote machine, users could specify the remote mahcine information as fllowing format: If run trial jobs in remote machine, users could specify the remote mahcine information as fllowing format:
``` ```
authorName: test authorName: test
experimentName: test_experiment experimentName: test_experiment
...@@ -596,7 +606,6 @@ paiConfig: ...@@ -596,7 +606,6 @@ paiConfig:
passWord: test passWord: test
#The host of restful server of pai #The host of restful server of pai
host: 10.10.10.10 host: 10.10.10.10
``` ```
* __kubeflow mode__ * __kubeflow mode__
...@@ -635,7 +644,9 @@ kubeflowConfig: ...@@ -635,7 +644,9 @@ kubeflowConfig:
server: 10.10.10.10 server: 10.10.10.10
path: /var/nfs/general path: /var/nfs/general
``` ```
kubeflow use azure storage kubeflow use azure storage
``` ```
authorName: default authorName: default
experimentName: example_mni experimentName: example_mni
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment