diff --git a/master/API-Doc.html b/master/API-Doc.html index 22fdcfe0..2e5221d4 100644 --- a/master/API-Doc.html +++ b/master/API-Doc.html @@ -12,7 +12,7 @@ - + @@ -171,7 +171,7 @@
A collection-like object containing a set of hyperparameter definitions and conditions.
A configuration space organizes all hyperparameters and its conditions as well as its forbidden clauses. Configurations can be sampled from @@ -190,7 +190,7 @@
Add a condition to the configuration space. Check if adding the condition is legal:
Add a list of conditions to the configuration space.
They must be legal. Take a look at
add_condition()
.
Combine two configuration space by adding one the other configuration
space. The contents of the configuration space, which should be added,
are renamed to prefix
+ delimiter
+ old_name.
Add a forbidden clause to the configuration space.
Add a list of forbidden clauses to the configuration space.
Add a hyperparameter to the configuration space.
Add hyperparameters to the configuration space.
Check if a configuration is legal. Raises an error if not.
Raise error if configuration in vector representation is not legal.
Generate UniformFloatHyperparameter
from a list containing lists with lower and upper bounds. The generated
hyperparameters are added to the configuration space.
Return a set of active hyperparameter for a given configuration.
Return a list with conditions of all children of a given
hyperparameter referenced by its name
.
Return a list with all children of a given hyperparameter.
Gives the hyperparameter from the configuration space given its name.
Return the name of a hyperparameter from the configuration space given its id.
Return an OrderedDict with all the (name, Hyperparameter)
contained in
the configuration space object.
Return the id of a hyperparameter by its name
.
Return a list with conditions of all parents of a given hyperparameter.
Return the parent hyperparameters of a given hyperparameter.
Sample size
configurations from the configuration space object.
Set the random seed to a number.
Class for a single configuration.
The Configuration
object holds
for all active hyperparameters a value. While the
@@ -690,7 +690,7 @@
Return for a given hyperparameter name item
the value of this
hyperparameter. default
if the hyperparameter name
doesn’t exist.
Return a representation of the
Configuration
in dictionary
form.
An integer hyperparameter.
Its values are sampled from a uniform distribution
with bounds lower
and upper
.
An integer hyperparameter.
Its values are sampled from a normal distribution \(\mathcal{N}(\mu, \sigma^2)\).
@@ -848,7 +848,7 @@A float hyperparameter.
Its values are sampled from a uniform distribution with values
from lower
to upper
.
A float hyperparameter.
Its values are sampled from a normal distribution \(\mathcal{N}(\mu, \sigma^2)\).
@@ -919,7 +919,7 @@A categorical hyperparameter.
Its values are sampled from a set of values
.
None
is a forbidden value, please use a string constant instead and parse
@@ -954,7 +954,7 @@
An ordinal hyperparameter.
Its values are sampled form a sequence
of values.
The sequence of values from a ordinal hyperparameter is ordered.
Representing a constant hyperparameter in the configuration space.
By sampling from the configuration space each time only a single,
constant value
will be drawn from this hyperparameter.
Hyperparameter child
is conditional on the parent
hyperparameter
being equal to value
.
Example
@@ -1052,7 +1052,7 @@Hyperparameter child
is conditional on the parent
hyperparameter
being not equal to value
.
Example
@@ -1089,7 +1089,7 @@Hyperparameter child
is conditional on the parent
hyperparameter
being less than value
.
Example
@@ -1125,7 +1125,7 @@Hyperparameter child
is conditional on the parent
hyperparameter
being greater than value
.
Example
@@ -1161,7 +1161,7 @@Hyperparameter child
is conditional on the parent
hyperparameter
being in a set of values
.
Example
@@ -1197,7 +1197,7 @@By using the AndConjunction, constraints can easily be connected.
Example
The following example shows how two constraints with an @@ -1230,7 +1230,7 @@
Similar to the AndConjunction, constraints can be combined by using the OrConjunction.
Example
@@ -1271,7 +1271,7 @@A ForbiddenEqualsClause
It forbids a value from the value range of a hyperparameter to be
equal to value
.
A ForbiddenInClause.
It forbids a value from the value range of a hyperparameter to be
in a collection of values
.
A ForbiddenAndConjunction.
The ForbiddenAndConjunction combines forbidden-clauses, which allows to build powerful constraints.
@@ -1775,7 +1775,7 @@
© Copyright 2014-2021, Matthias Feurer, Katharina Eggensperger, Syed Mohsin Ali, Christina Hernandez Wunsch, Julien-Charles Levesque, Jost Tobias Springenberg, Philipp Mueller, Marius Lindauer, Jorn Tuyls.
- Created using Sphinx 4.2.0.
+ Created using Sphinx 4.3.0.
© Copyright 2014-2021, Matthias Feurer, Katharina Eggensperger, Syed Mohsin Ali, Christina Hernandez Wunsch, Julien-Charles Levesque, Jost Tobias Springenberg, Philipp Mueller, Marius Lindauer, Jorn Tuyls.
- Created using Sphinx 4.2.0.
+ Created using Sphinx 4.3.0.
© Copyright 2014-2021, Matthias Feurer, Katharina Eggensperger, Syed Mohsin Ali, Christina Hernandez Wunsch, Julien-Charles Levesque, Jost Tobias Springenberg, Philipp Mueller, Marius Lindauer, Jorn Tuyls.
- Created using Sphinx 4.2.0.
+ Created using Sphinx 4.3.0.
© Copyright 2014-2021, Matthias Feurer, Katharina Eggensperger, Syed Mohsin Ali, Christina Hernandez Wunsch, Julien-Charles Levesque, Jost Tobias Springenberg, Philipp Mueller, Marius Lindauer, Jorn Tuyls.
- Created using Sphinx 4.2.0.
+ Created using Sphinx 4.3.0.
© Copyright 2014-2021, Matthias Feurer, Katharina Eggensperger, Syed Mohsin Ali, Christina Hernandez Wunsch, Julien-Charles Levesque, Jost Tobias Springenberg, Philipp Mueller, Marius Lindauer, Jorn Tuyls.
- Created using Sphinx 4.2.0.
+ Created using Sphinx 4.3.0.
© Copyright 2014-2021, Matthias Feurer, Katharina Eggensperger, Syed Mohsin Ali, Christina Hernandez Wunsch, Julien-Charles Levesque, Jost Tobias Springenberg, Philipp Mueller, Marius Lindauer, Jorn Tuyls.
- Created using Sphinx 4.2.0.
+ Created using Sphinx 4.3.0.
© Copyright 2014-2021, Matthias Feurer, Katharina Eggensperger, Syed Mohsin Ali, Christina Hernandez Wunsch, Julien-Charles Levesque, Jost Tobias Springenberg, Philipp Mueller, Marius Lindauer, Jorn Tuyls.
- Created using Sphinx 4.2.0.
+ Created using Sphinx 4.3.0.