conf.py

claesenm · May 16, 2015 · 9d2b083 · 9d2b083
1 parent ba8745e
commit 9d2b083
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 6 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -105,7 +105,8 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+#html_theme = 'default'
+html_theme = 'alabaster'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

diff --git a/docs/user/solvers.rst b/docs/user/solvers.rst
@@ -23,7 +23,11 @@ The following solvers are available in Optunity:
     /user/solvers/TPE
     /user/solvers/sobol
 
+Optunity's default solver is |pso|.
+
 |gridsearch|, |randomsearch| and |sobol| are completely undirected algorithms and consequently not very efficient. 
-Of these three, |sobol| is most efficient as uses a low-discrepancy quasirandom sequence. |nelder-mead| works well for objective functions that
-are smooth, unimodal and not too noisy (it is good for local search when you have a good idea about optimal regions for your hyperparameters). For general
-searches, |pso| and |cmaes| are most robust. The |tpe| solver is a thin wrapper, exposing Hyperopt's TPE solver in Optunity's familiar API.
+Of these three, |sobol| is most efficient as uses a low-discrepancy quasirandom sequence. 
+
+|nelder-mead| works well for objective functions that are smooth, unimodal and not too noisy (it is good for local search when you have a good idea about optimal regions for your hyperparameters). 
+
+For general searches, |pso| and |cmaes| are most robust. Finally, the |tpe| solver exposes Hyperopt's TPE solver in Optunity's familiar API.
diff --git a/optunity/solvers/TPE.py b/optunity/solvers/TPE.py
@@ -68,7 +68,7 @@ def __init__(self, num_evals=100, seed=None, **kwargs):
         :param num_evals: number of permitted function evaluations
         :type num_evals: int
         :param seed: the random seed to be used
-        :type num_evals: double
+        :type seed: double
         :param kwargs: box constraints for each hyperparameter
         :type kwargs: {'name': [lb, ub], ...}
 

diff --git a/optunity/solvers/__init__.py b/optunity/solvers/__init__.py
@@ -55,4 +55,5 @@
 from .NelderMead import NelderMead
 from .ParticleSwarm import ParticleSwarm
 from .CMAES import CMA_ES
-#from .TPE import TPE
+from .TPE import TPE
+from .Sobol import Sobol