CADETProcess.optimization.OptimizationProblem.add_callback

CADETProcess.optimization.OptimizationProblem.add_callback#

OptimizationProblem.add_callback(callback, name=None, evaluation_objects=-1, requires=None, frequency=1, callbacks_dir=None, keep_progress=False, *args, **kwargs)[source]#

Add callback function for processing (intermediate) results.

Parameters:
callbackcallable

Callback function.

namestr, optional

Name of the callback.

evaluation_objects{EvaluationObject, None, -1, list}

EvaluationObjects which are evaluated by objective. If None, no EvaluationObject is used. If -1, all EvaluationObjects are used.

requires{None, Evaluator, list}, optional

Evaluators used for preprocessing. If None, no preprocessing is required. The default is None.

frequencyint, optional

Number of generations after which callback is evaluated. The default is 1.

callbacks_dirPath, optional

Dicretory to store results. If None, folder in working directory is created.

argstuple, optional

Additional arguments for callback function.

kwargsdict, optional

Additional keyword arguments for callback function.

Raises:
TypeError

If callback is not callable.

CADETProcessError

If EvaluationObject is not found. If Evaluator is not found.

Warning

If callback with same name already exists.