update doc for smac tuner (#140)

ad8b0f0c · QuanluZhang · fishyds · 2f7d2287 · ad8b0f0c · ad8b0f0c
Commit ad8b0f0c authored Sep 29, 2018 by QuanluZhang Committed by fishyds Sep 29, 2018
9 changed files
--- a/examples/trials/auto-gbdt/config.yml
+++ b/examples/trials/auto-gbdt/config.yml
@@ -9,7 +9,8 @@ searchSpacePath: search_space.json
 #choice: true, false
 useAnnotation: false
 tuner:
-  #choice: TPE, Random, Anneal, Evolution
+  #choice: TPE, Random, Anneal, Evolution,
+  #SMAC (SMAC should be installed through nnictl)
  builtinTunerName: TPE
  classArgs:
    #choice: maximize, minimize

--- a/examples/trials/mnist-annotation/config.yml
+++ b/examples/trials/mnist-annotation/config.yml
@@ -8,7 +8,8 @@ trainingServicePlatform: local
 #choice: true, false
 useAnnotation: true
 tuner:
-  #choice: TPE, Random, Anneal, Evolution
+  #choice: TPE, Random, Anneal, Evolution,
+  #SMAC (SMAC should be installed through nnictl)
  builtinTunerName: TPE
  classArgs:
    #choice: maximize, minimize

--- a/examples/trials/mnist-batch-tune-keras/config.yml
+++ b/examples/trials/mnist-batch-tune-keras/config.yml
@@ -10,6 +10,7 @@ searchSpacePath: search_space.json
 useAnnotation: false
 tuner:
  #choice: TPE, Random, Anneal, Evolution, BatchTuner
+  #SMAC (SMAC should be installed through nnictl)
  builtinTunerName: BatchTuner
  classArgs:
    #choice: maximize, minimize

--- a/examples/trials/mnist-keras/config.yml
+++ b/examples/trials/mnist-keras/config.yml
@@ -9,7 +9,8 @@ searchSpacePath: search_space.json
 #choice: true, false
 useAnnotation: false
 tuner:
-  #choice: TPE, Random, Anneal, Evolution
+  #choice: TPE, Random, Anneal, Evolution,
+  #SMAC (SMAC should be installed through nnictl)
  builtinTunerName: TPE
  classArgs:
    #choice: maximize, minimize

--- a/examples/trials/mnist-smartparam/config.yml
+++ b/examples/trials/mnist-smartparam/config.yml
@@ -8,7 +8,8 @@ trainingServicePlatform: local
 #choice: true, false
 useAnnotation: true
 tuner:
-  #choice: TPE, Random, Anneal, Evolution
+  #choice: TPE, Random, Anneal, Evolution,
+  #SMAC (SMAC should be installed through nnictl)
  builtinTunerName: TPE
  classArgs:
    #choice: maximize, minimize

--- a/examples/trials/mnist/config.yml
+++ b/examples/trials/mnist/config.yml
@@ -9,7 +9,8 @@ searchSpacePath: search_space.json
 #choice: true, false
 useAnnotation: false
 tuner:
-  #choice: TPE, Random, Anneal, Evolution
+  #choice: TPE, Random, Anneal, Evolution,
+  #SMAC (SMAC should be installed through nnictl)
  builtinTunerName: TPE
  classArgs:
    #choice: maximize, minimize

--- a/examples/trials/mnist/config_assessor.yml
+++ b/examples/trials/mnist/config_assessor.yml
@@ -9,7 +9,8 @@ searchSpacePath: ~/nni/examples/trials/mnist/search_space.json
 #choice: true, false
 useAnnotation: false
 tuner:
-  #choice: TPE, Random, Anneal, Evolution
+  #choice: TPE, Random, Anneal, Evolution,
+  #SMAC (SMAC should be installed through nnictl)
  builtinTunerName: TPE
  classArgs:
    #choice: maximize, minimize

--- a/examples/trials/pytorch_cifar10/config.yml
+++ b/examples/trials/pytorch_cifar10/config.yml
@@ -9,7 +9,8 @@ searchSpacePath: search_space.json
 #choice: true, false
 useAnnotation: false
 tuner:
-  #choice: TPE, Random, Anneal, Evolution
+  #choice: TPE, Random, Anneal, Evolution,
+  #SMAC (SMAC should be installed through nnictl)
  builtinTunerName: TPE
  classArgs:
    #choice: maximize, minimize

--- a/src/sdk/pynni/nni/README.md
+++ b/src/sdk/pynni/nni/README.md
 # How to use Tuner that NNI supports?
-For now, NNI could support tuner algorithms as following:
+For now, NNI has supported the following tuner algorithms. Note that NNI installation only installs a subset of those algorithms, other algorithms should be installed through `nnictl package install` before you use them. For example, for SMAC the installation command is `nnictl package install --name=SMAC`.
 - TPE
 - Random Search
 - Anneal
 - Naive Evolution
- - SMAC
+ - SMAC (to install through `nnictl`)
 - ENAS (ongoing)
 - Batch (ongoing)