blackboxopt.base

MultiObjectiveOptimizer

get_evaluation_specification(self) inherited

Get next configuration and settings to evaluate.

Exceptions:

Type	Description
OptimizationComplete	When the optimization run is finished, e.g. when the budget has been exhausted.
OptimizerNotReady	When the optimizer is not ready to propose a new evaluation specification.

Source code in blackboxopt/base.py

@abc.abstractmethod
def get_evaluation_specification(self) -> EvaluationSpecification:
    """Get next configuration and settings to evaluate.

    Raises:
        OptimizationComplete: When the optimization run is finished, e.g. when the
            budget has been exhausted.
        OptimizerNotReady: When the optimizer is not ready to propose a new
            evaluation specification.
    """

report_evaluation(self, evaluation)

Report an evaluated evaluation specification.

NOTE: Not all optimizers support reporting results for evaluation specifications that were not proposed by the optimizer.

Parameters:

Name	Type	Description	Default
evaluation	Evaluation	An evaluated evaluation specification.	required

Source code in blackboxopt/base.py

def report_evaluation(self, evaluation: Evaluation) -> None:
    raise_on_unknown_or_incomplete_objectives(
        known_objectives=self.objectives,
        reported_objectives=evaluation.objectives,
    )

    super().report_evaluation(evaluation)

Objective dataclass

Objective(name: str, greater_is_better: bool)

ObjectivesError

Raised on incomplete or missing objectives.

OptimizationComplete

Exception that is raised when the optimization run is finished, e.g. when the budget has been exhausted.

Optimizer

Abstract base class for blackbox optimizer implementations.

get_evaluation_specification(self)

Get next configuration and settings to evaluate.

Exceptions:

Type	Description
OptimizationComplete	When the optimization run is finished, e.g. when the budget has been exhausted.
OptimizerNotReady	When the optimizer is not ready to propose a new evaluation specification.

Source code in blackboxopt/base.py

@abc.abstractmethod
def get_evaluation_specification(self) -> EvaluationSpecification:
    """Get next configuration and settings to evaluate.

    Raises:
        OptimizationComplete: When the optimization run is finished, e.g. when the
            budget has been exhausted.
        OptimizerNotReady: When the optimizer is not ready to propose a new
            evaluation specification.
    """

report_evaluation(self, evaluation)

Report an evaluated evaluation specification.

NOTE: Not all optimizers support reporting results for evaluation specifications that were not proposed by the optimizer.

Parameters:

Name	Type	Description	Default
evaluation	Evaluation	An evaluated evaluation specification.	required

Source code in blackboxopt/base.py

@abc.abstractmethod
def report_evaluation(self, evaluation: Evaluation) -> None:
    """Report an evaluated evaluation specification.

    NOTE: Not all optimizers support reporting results for evaluation specifications
    that were not proposed by the optimizer.

    Args:
        evaluation: An evaluated evaluation specification.
    """

OptimizerNotReady

Exception that is raised when the optimizer is not ready to propose a new evaluation specification.

SingleObjectiveOptimizer

get_evaluation_specification(self) inherited

Get next configuration and settings to evaluate.

Exceptions:

Type	Description
OptimizationComplete	When the optimization run is finished, e.g. when the budget has been exhausted.
OptimizerNotReady	When the optimizer is not ready to propose a new evaluation specification.

Source code in blackboxopt/base.py

@abc.abstractmethod
def get_evaluation_specification(self) -> EvaluationSpecification:
    """Get next configuration and settings to evaluate.

    Raises:
        OptimizationComplete: When the optimization run is finished, e.g. when the
            budget has been exhausted.
        OptimizerNotReady: When the optimizer is not ready to propose a new
            evaluation specification.
    """

report_evaluation(self, evaluation)

Report an evaluated evaluation specification.

NOTE: Not all optimizers support reporting results for evaluation specifications that were not proposed by the optimizer.

Parameters:

Name	Type	Description	Default
evaluation	Evaluation	An evaluated evaluation specification.	required

Source code in blackboxopt/base.py

def report_evaluation(self, evaluation: Evaluation) -> None:
    raise_on_unknown_or_incomplete_objectives(
        known_objectives=[self.objective],
        reported_objectives=evaluation.objectives,
    )

    super().report_evaluation(evaluation)