Skip to content

Commit

Permalink
Add documentation about using external controllers
Browse files Browse the repository at this point in the history
  • Loading branch information
charmasaur committed Jan 12, 2021
1 parent bf6e27d commit 37868d8
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ The shell interface is for experiments that can be run through a command execute
Controllers
===========

There are currently five controller types supported: 'gaussian_process', 'neural_net', 'differential_evolution', 'nelder_mead', and 'random'.
The default is 'gaussian_process'.
You can set which interface you want to use with the option::
There are currently five built-in controller types: 'gaussian_process', 'neural_net', 'differential_evolution', 'nelder_mead', and 'random'.
The default controller is 'gaussian_process'.
You can set which controller you want to use with the option::

controller_type = [name]

Expand All @@ -50,6 +50,8 @@ Each of the controllers and their specific options are described below. There is
.. include:: ../examples/controller_config.txt
:literal:

In addition to the built-in controllers, you can also use controllers provided by external Python packages. In this case, you can set ``controller_type`` to ``'module_name:controller_name'``, where ``module_name`` is the name of the Python module containing the controller and ``controller_name`` is the name of the controller class (or the function that creates the controller object). The parameters for such controllers should be documented by the corresponding external packages.

Gaussian process
----------------

Expand Down

0 comments on commit 37868d8

Please sign in to comment.