blackboxopt.evaluation

Evaluation dataclass

An evaluated specification with a timestamp indicating the time of the evaluation, and a result dictionary for all objective values.

NOTE: NaN is not allowed as an objective value, use None instead.

get(self, key, default=None) inherited

D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

Source code in blackboxopt/evaluation.py

def get(self, key, default=None):
    'D.get(k[,d]) -> D[k] if k in D, else d.  d defaults to None.'
    try:
        return self[key]
    except KeyError:
        return default

get_evaluation(self, objectives, user_info=None, stacktrace=None, finished_unixtime=None) inherited

Create blackboxopt.Evaluation based on this evaluation specification.

Source code in blackboxopt/evaluation.py

def get_evaluation(
    self,
    objectives: Dict[str, Optional[float]],
    user_info: Optional[dict] = None,
    stacktrace: Optional[str] = None,
    finished_unixtime: Optional[float] = None,
):
    """Create blackboxopt.Evaluation based on this evaluation specification."""
    evaluation = Evaluation(
        objectives=objectives, user_info=user_info, stacktrace=stacktrace, **self
    )

    if finished_unixtime is not None:
        evaluation.finished_unixtime = finished_unixtime

    return evaluation

get_specification(self, reset_created_unixtime=False)

Get the evaluation specifiation for which this result was evaluated.

Source code in blackboxopt/evaluation.py

def get_specification(
    self, reset_created_unixtime: bool = False
) -> EvaluationSpecification:
    """Get the evaluation specifiation for which this result was evaluated."""
    eval_spec_kwargs = deepcopy(
        dict(
            configuration=self.configuration,
            settings=self.settings,
            optimizer_info=self.optimizer_info,
        )
    )

    if reset_created_unixtime:
        return EvaluationSpecification(
            created_unixtime=time.time(), **eval_spec_kwargs
        )

    return EvaluationSpecification(
        created_unixtime=self.created_unixtime, **eval_spec_kwargs
    )

items(self) inherited

D.items() -> a set-like object providing a view on D's items

Source code in blackboxopt/evaluation.py

def items(self):
    "D.items() -> a set-like object providing a view on D's items"
    return ItemsView(self)

keys(self) inherited

D.keys() -> a set-like object providing a view on D's keys

Source code in blackboxopt/evaluation.py

def keys(self):
    return self.__dataclass_fields__.keys()  # pylint: disable=no-member

values(self) inherited

D.values() -> an object providing a view on D's values

Source code in blackboxopt/evaluation.py

def values(self):
    "D.values() -> an object providing a view on D's values"
    return ValuesView(self)

EvaluationSpecification dataclass

EvaluationSpecification(args, *kwds)

get(self, key, default=None) inherited

D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

Source code in blackboxopt/evaluation.py

def get(self, key, default=None):
    'D.get(k[,d]) -> D[k] if k in D, else d.  d defaults to None.'
    try:
        return self[key]
    except KeyError:
        return default

get_evaluation(self, objectives, user_info=None, stacktrace=None, finished_unixtime=None)

Create blackboxopt.Evaluation based on this evaluation specification.

Source code in blackboxopt/evaluation.py

def get_evaluation(
    self,
    objectives: Dict[str, Optional[float]],
    user_info: Optional[dict] = None,
    stacktrace: Optional[str] = None,
    finished_unixtime: Optional[float] = None,
):
    """Create blackboxopt.Evaluation based on this evaluation specification."""
    evaluation = Evaluation(
        objectives=objectives, user_info=user_info, stacktrace=stacktrace, **self
    )

    if finished_unixtime is not None:
        evaluation.finished_unixtime = finished_unixtime

    return evaluation

items(self) inherited

D.items() -> a set-like object providing a view on D's items

Source code in blackboxopt/evaluation.py

def items(self):
    "D.items() -> a set-like object providing a view on D's items"
    return ItemsView(self)

keys(self)

D.keys() -> a set-like object providing a view on D's keys

Source code in blackboxopt/evaluation.py

def keys(self):
    return self.__dataclass_fields__.keys()  # pylint: disable=no-member

values(self) inherited

D.values() -> an object providing a view on D's values

Source code in blackboxopt/evaluation.py

def values(self):
    "D.values() -> an object providing a view on D's values"
    return ValuesView(self)

EvaluationWithConstraints dataclass

EvaluationWithConstraints(args, *kwds)

get(self, key, default=None) inherited

D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

Source code in blackboxopt/evaluation.py

def get(self, key, default=None):
    'D.get(k[,d]) -> D[k] if k in D, else d.  d defaults to None.'
    try:
        return self[key]
    except KeyError:
        return default

get_evaluation(self, objectives, user_info=None, stacktrace=None, finished_unixtime=None) inherited

Create blackboxopt.Evaluation based on this evaluation specification.

Source code in blackboxopt/evaluation.py

def get_evaluation(
    self,
    objectives: Dict[str, Optional[float]],
    user_info: Optional[dict] = None,
    stacktrace: Optional[str] = None,
    finished_unixtime: Optional[float] = None,
):
    """Create blackboxopt.Evaluation based on this evaluation specification."""
    evaluation = Evaluation(
        objectives=objectives, user_info=user_info, stacktrace=stacktrace, **self
    )

    if finished_unixtime is not None:
        evaluation.finished_unixtime = finished_unixtime

    return evaluation

get_specification(self, reset_created_unixtime=False) inherited

Get the evaluation specifiation for which this result was evaluated.

Source code in blackboxopt/evaluation.py

def get_specification(
    self, reset_created_unixtime: bool = False
) -> EvaluationSpecification:
    """Get the evaluation specifiation for which this result was evaluated."""
    eval_spec_kwargs = deepcopy(
        dict(
            configuration=self.configuration,
            settings=self.settings,
            optimizer_info=self.optimizer_info,
        )
    )

    if reset_created_unixtime:
        return EvaluationSpecification(
            created_unixtime=time.time(), **eval_spec_kwargs
        )

    return EvaluationSpecification(
        created_unixtime=self.created_unixtime, **eval_spec_kwargs
    )

items(self) inherited

D.items() -> a set-like object providing a view on D's items

Source code in blackboxopt/evaluation.py

def items(self):
    "D.items() -> a set-like object providing a view on D's items"
    return ItemsView(self)

keys(self) inherited

D.keys() -> a set-like object providing a view on D's keys

Source code in blackboxopt/evaluation.py

def keys(self):
    return self.__dataclass_fields__.keys()  # pylint: disable=no-member

values(self) inherited

D.values() -> an object providing a view on D's values

Source code in blackboxopt/evaluation.py

def values(self):
    "D.values() -> an object providing a view on D's values"
    return ValuesView(self)