smac.callback

Interfaces

class smac.callback.Callback[source]

Bases: object

Callback interface with several methods that are called at different stages of the optimization process.

on_ask_end(smbo, info)[source]

Called after the intensifier is asked for the next trial.

Return type:

None

on_ask_start(smbo)[source]

Called before the intensifier is asked for the next trial.

Return type:

None

on_end(smbo)[source]

Called after the optimization finished.

Return type:

None

on_iteration_end(smbo)[source]

Called after an iteration ended.

Return type:

None

on_iteration_start(smbo)[source]

Called before the next run is sampled.

Return type:

None

on_next_configurations_end(config_selector, config)[source]

Called after the intensification asks for new configurations. Essentially, this callback is called before the surrogate model is trained and before the acquisition function is called.

Return type:

None

on_next_configurations_start(config_selector)[source]

Called before the intensification asks for new configurations. Essentially, this callback is called before the surrogate model is trained and before the acquisition function is called.

Return type:

None

on_start(smbo)[source]

Called before the optimization starts.

Return type:

None

on_tell_end(smbo, info, value)[source]

Called after the stats are updated and the trial is added to the runhistory. Optionally, returns false to gracefully stop the optimization.

Return type:

bool | None

on_tell_start(smbo, info, value)[source]

Called before the stats are updated and the trial is added to the runhistory. Optionally, returns false to gracefully stop the optimization.

Return type:

bool | None

class smac.callback.MetadataCallback(**kwargs)[source]

Bases: Callback

on_start(smbo)[source]

Called before the optimization starts.

Return type:

None

Modules

smac.callback.callback

smac.callback.metadata_callback