User Guide¶

In this user guide, the concepts of using different hyperparameters, applying conditions and forbidden clauses to a configuration space are explained.

These concepts will be introduced by defining a more complex configuration space for a support vector machine.

1st Example: Integer hyperparameters and float hyperparameters¶

Assume that we want to use a support vector machine (=SVM) for classification tasks and therefore, we want to optimize its hyperparameters:

• $$\mathcal{C}$$: regularization constant with $$\mathcal{C} \in \mathbb{R}$$

• max_iter: the maximum number of iterations within the solver with $$max_iter \in \mathbb{N}$$

The implementation of the classifier is out of scope and thus not shown. But for further reading about support vector machines and the meaning of its hyperparameter, you can continue reading here or in the scikit-learn documentation.

The first step is always to create a ConfigurationSpace object. All the hyperparameters and constraints will be added to this object.

>>> import ConfigSpace as CS
>>> cs = CS.ConfigurationSpace(seed=1234)


Now, we have to define the hyperparameters $$\mathcal{C}$$ and max_iter. To restrict the search space, we choose $$\mathcal{C}$$ to be a UniformFloatHyperparameter between -1 and 1. Furthermore, we choose max_iter to be an UniformIntegerHyperparameter .

>>> import ConfigSpace.hyperparameters as CSH
>>> c = CSH.UniformFloatHyperparameter(name='C', lower=-1, upper=1)
>>> max_iter = CSH.UniformIntegerHyperparameter(name='max_iter', lower=10, upper=100)


As last step, we need to add them to the ConfigurationSpace. For demonstration purpose, we sample a configuration from it.

>>> cs.add_hyperparameters([c, max_iter])
[C, Type: UniformFloat, Range: [-1.0, 1.0], Default: 0.0, max_iter, Type: ...]
>>> cs.sample_configuration()
Configuration(values={
'C': -0.6169610992422154,
'max_iter': 66,
})


Now, the ConfigurationSpace object cs contains definitions of the hyperparameters $$\mathcal{C}$$ and max_iter with their value-ranges.

Sampled instances from a ConfigurationSpace are called Configuration. In a Configuration object, the value of a parameter can be accessed or modified similar to a python dictionary.

>>> conf = cs.sample_configuration()
>>> conf['max_iter'] = 42
>>> conf['max_iter']
42


2nd Example: Categorical hyperparameters and conditions¶

The scikit-learn SVM supports different kernels, such as an RBF, a sigmoid, a linear or a polynomial kernel. We want to include them in the configuration space. Since this new hyperparameter has a finite number of values, we use a CategoricalHyperparameter.

• kernel_type: with values ‘linear’, ‘poly’, ‘rbf’, ‘sigmoid’.

Taking a look at the SVM documentation, we observe that if the kernel type is chosen to be ‘poly’, another hyperparameter degree must be specified. Also, for the kernel types ‘poly’ and ‘sigmoid’, there is an additional hyperparameter coef0. As well as the hyperparameter gamma for the kernel types ‘rbf’, ‘poly’ and ‘sigmoid’.

• degree: the degree of a polynomial kernel function, being $$\in \mathbb{N}$$

• coef0: Independent term in kernel function. It is only significant in ‘poly’ and ‘sigmoid’.

• gamma: Kernel coefficient for ‘rbf’, ‘poly’ and ‘sigmoid’.

To realize the different hyperparameter for the kernels, we use Conditions.

Even in simple examples, the configuration space grows easily very fast and with it the number of possible configurations. It makes sense to limit the search space for hyperparameter optimizations in order to quickly find good configurations. For conditional hyperparameters (= hyperparameters which only take a value if some condition is met), ConfigSpace achieves this by sampling those hyperparameters from the configuration space only if their condition is met.

To add conditions on hyperparameters to the configuration space, we first have to insert the new hyperparameters in the ConfigSpace and in a second step, the conditions on them.

>>> kernel_type = CSH.CategoricalHyperparameter(
...         name='kernel_type', choices=['linear', 'poly', 'rbf', 'sigmoid'])
>>> degree = CSH.UniformIntegerHyperparameter(
...         'degree', lower=2, upper=4, default_value=2)
>>> coef0 = CSH.UniformFloatHyperparameter(
...         name='coef0', lower=0, upper=1, default_value=0.0)
>>> gamma = CSH.UniformFloatHyperparameter(
...         name='gamma', lower=1e-5, upper=1e2, default_value=1, log=True)

>>> cs.add_hyperparameters([kernel_type, degree, coef0, gamma])
[kernel_type, Type: Categorical, Choices: {linear, poly, rbf, sigmoid}, ...]


First, we define the conditions. Conditions work by constraining a child hyperparameter (the first argument) on its parent hyperparameter (the second argument) being in a certain relation to a value (the third argument). CS.EqualsCondition(degree, kernel_type, 'poly') expresses that degree is constrained on kernel_type being equal to the value ‘poly’. To express constraints involving multiple parameters or values, we can use conjunctions. In the following example, cond_2 describes that coef0 is a valid hyperparameter, if the kernel_type has either the value ‘poly’ or ‘sigmoid’.

>>> cond_1 = CS.EqualsCondition(degree, kernel_type, 'poly')

>>> cond_2 = CS.OrConjunction(CS.EqualsCondition(coef0, kernel_type, 'poly'),
...                           CS.EqualsCondition(coef0, kernel_type, 'sigmoid'))

>>> cond_3 = CS.OrConjunction(CS.EqualsCondition(gamma, kernel_type, 'rbf'),
...                           CS.EqualsCondition(gamma, kernel_type, 'poly'),
...                           CS.EqualsCondition(gamma, kernel_type, 'sigmoid'))


Again, we add the conditions to the configuration space

>>> cs.add_conditions([cond_1, cond_2, cond_3])
[degree | kernel_type == 'poly', (coef0 | kernel_type == 'poly' || coef0 | ...), ...]


Note

ConfigSpace offers a lot of different condition types. For example the NotEqualsCondition, LessThanCondition, or GreaterThanCondition. To read more about conditions, please take a look at the Conditions.

Note

Don’t use either the EqualsCondition or the InCondition on float hyperparameters. Due to floating-point inaccuracy, it is very unlikely that the EqualsCondition is evaluated to True.

3rd Example: Forbidden clauses¶

It may occur that some states in the configuration space are not allowed. ConfigSpace supports this functionality by offering Forbidden Clauses.

We demonstrate the usage of Forbidden Clauses by defining the configuration space for the linear SVM. Again, we use the sklearn implementation. This implementation has three hyperparameters to tune:

• penalty: Specifies the norm used in the penalization with values ‘l1’ or ‘l2’

• loss: Specifies the loss function with values ‘hinge’ or ‘squared_hinge’

• dual: Solves the optimization problem either in the dual or simple form with values True or False

Because some combinations of penalty, loss and dual just don’t work together, we want to make sure that these combinations are not sampled from the configuration space.

First, we add these three new hyperparameters to the configuration space.

>>> penalty = CSH.CategoricalHyperparameter(
...         name="penalty", choices=["l1", "l2"], default_value="l2")
>>> loss = CSH.CategoricalHyperparameter(
...         name="loss", choices=["hinge", "squared_hinge"], default_value="squared_hinge")
>>> dual = CSH.Constant("dual", "False")
[penalty, Type: Categorical, Choices: {l1, l2}, Default: l2, ...]


Now, we want to forbid the following hyperparameter combinations:

• penalty is ‘l1’ and loss is ‘hinge’

• dual is False and penalty is ‘l2’ and loss is ‘hinge’

• dual is False and penalty is ‘l1’

>>> penalty_and_loss = CS.ForbiddenAndConjunction(
...         CS.ForbiddenEqualsClause(penalty, "l1"),
...         CS.ForbiddenEqualsClause(loss, "hinge")
...     )
>>> constant_penalty_and_loss = CS.ForbiddenAndConjunction(
...         CS.ForbiddenEqualsClause(dual, "False"),
...         CS.ForbiddenEqualsClause(penalty, "l2"),
...         CS.ForbiddenEqualsClause(loss, "hinge")
...     )
>>> penalty_and_dual = CS.ForbiddenAndConjunction(
...         CS.ForbiddenEqualsClause(dual, "False"),
...         CS.ForbiddenEqualsClause(penalty, "l1")
...     )


In the last step, we add them to the configuration space object:

>>> cs.add_forbidden_clauses([penalty_and_loss,
...                           constant_penalty_and_loss,
...                           penalty_and_dual])
[(Forbidden: penalty == 'l1' && Forbidden: loss == 'hinge'), ...]


4th Example Serialization¶

If you want to use the configuration space in another tool, such as CAVE, it is useful to store it to file. To serialize the ConfigurationSpace, we can choose between different output formats, such as json or pcs.

In this example, we want to store the ConfigurationSpace object as json file

from ConfigSpace.read_and_write import json
with open('configspace.json', 'w') as fh:
fh.write(json.write(cs))


>>> with open('configspace.json', 'r') as fh:


5th Example: Placing priors on the hyperparameters¶

If you want to conduct black-box optimization in SMAC (https://arxiv.org/abs/2109.09831), and you have prior knowledge about the which regions of the search space are more likely to contain the optimum, you may include this knowledge when designing the configuration space. More specifically, you place prior distributions over the optimum on the parameters, either by a (log)-normal or (log)-Beta distribution. SMAC then considers the given priors through the optimization by using PiBO (https://openreview.net/forum?id=MMAeCXIa89).

Consider the case of optimizing the accuracy of an MLP with three hyperparameters: learning rate [1e-5, 1e-1], dropout [0, 0.99] and activation {Tanh, ReLU}. From prior experience, you believe the optimal learning rate to be around 1e-3, a good dropout to be around 0.25, and the optimal activation function to be ReLU about 80% of the time. This can be represented accordingly:

import numpy as np
import ConfigSpace.hyperparameters as CSH
from ConfigSpace.configuration_space import ConfigurationSpace

# convert 10 log to natural log for learning rate, mean 1e-3
logmean = np.log(1e-3)
# two standard deviations on either side of the mean to cover the search space
logstd = np.log(10.0)

learning_rate = CSH.NormalFloatHyperparameter(name='learning_rate', lower=1e-5, upper=1e-1, default_value=1e-3, mu=logmean, sigma=logstd, log=True)
dropout = CSH.BetaFloatHyperparameter(name='dropout', lower=0, upper=0.99, default_value=0.25, alpha=2, beta=4, log=False)
activation = CSH.CategoricalHyperparameter(name='activation', choices=['tanh', 'relu'], weights=[0.2, 0.8])

cs = ConfigurationSpace()

# [learning_rate, Type: NormalFloat, Mu: -6.907755278982137 Sigma: 2.302585092994046, Range: [1e-05, 0.1], Default: 0.001, on log-scale, dropout, Type: BetaFloat, Alpha: 2.0 Beta: 4.0, Range: [0.0, 0.99], Default: 0.25, activation, Type: Categorical, Choices: {tanh, relu}, Default: tanh, Probabilities: (0.2, 0.8)]


To check that your prior makes sense for each hyperparameter, you can easily do so with the __pdf__ method. There, you will see that the probability of the optimal learning rate peaks at 10^-3, and decays as we go further away from it:

test_points = np.logspace(-5, -1, 5)

print(test_points)
# array([1.e-05, 1.e-04, 1.e-03, 1.e-02, 1.e-01])


The pdf function accepts an (N, ) numpy array as input.

test_points_pdf = learning_rate.pdf(test_points)
print(test_points_pdf)
# array([0.02456573, 0.11009594, 0.18151753, 0.11009594, 0.02456573])