Add docs for Multi Parameters

titu1994 · Oct 27, 2018 · e252c23 · e252c23
1 parent 12bbe5c
commit e252c23
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -64,6 +64,20 @@ pip install -r "doc_requirements.txt"
 - UniformContinuousHyperParameter
 - NormalContinuousHyperParameter
 
+There are also 3 additional hyper parameters, which are useful when a parameter needs to be sampled multiple times
+for each evaluation :
+
+- [MultiDiscreteHyperParameter](config/hyperparameters.md#multidiscretehyperparameter)
+- [MultiUniformContinuousHyperParameter](config/hyperparameters.md#multiuniformcontinuoushyperparameter)
+- [MultiNormalContinuousHyperParameter](config/hyperparameters.md#multinormalcontinuoushyperparameter)
+
+These multi parameters have an additional argument `sample_count` which can be used to sample multiple times
+per step.
+
+**Note**: The values will be concatenated linearly, so each multi parameter will have a list of values
+returned in the resultant OrderedDict. If you wish to flatten the entire search space, you can
+use `pyshac.flatten_parameters` on this OrderedDict.
+
 ```python
 import pyshac
 

diff --git a/docs/templates/guide.md b/docs/templates/guide.md
@@ -44,6 +44,21 @@ There are 3 available hyper parameters made available :
 - [UniformContinuousHyperParameter](config/hyperparameters.md#uniformcontinuoushyperparameter)
 - [NormalContinuousHyperParameter](config/hyperparameters.md#normalcontinuoushyperparameter)
 
+There are also 3 additional hyper parameters, which are useful when a parameter needs to be sampled multiple times
+for each evaluation :
+
+- [MultiDiscreteHyperParameter](config/hyperparameters.md#multidiscretehyperparameter)
+- [MultiUniformContinuousHyperParameter](config/hyperparameters.md#multiuniformcontinuoushyperparameter)
+- [MultiNormalContinuousHyperParameter](config/hyperparameters.md#multinormalcontinuoushyperparameter)
+
+These multi parameters have an additional argument `sample_count` which can be used to sample multiple times
+per step.
+
+!!!info "Note"
+    The values will be concatenated linearly, so each multi parameter will have a list of values
+    returned in the resultant OrderedDict. If you wish to flatten the entire search space, you can
+    use `pyshac.flatten_parameters` on this OrderedDict.
+
 While these can declare most of the common hyper parameters, if there is a need for custom hyper parameters, then they
 can very easily be added as shown in [Custom Hyper Parameters](custom-hyper-parameters.md).
 

diff --git a/docs/templates/install.md b/docs/templates/install.md
@@ -28,7 +28,7 @@ Once the XGBoost package is installed and verifier, we can simply clone this rep
 ```
 git clone https://github.com/titu1994/pyshac.git
 cd pyshac
-python setup.py install
+pip install .
 ```
 
 ## Installation of External Libraries