Skip to content

Dataclasses

smac.runhistory.dataclasses #

InstanceSeedBudgetKey dataclass #

InstanceSeedBudgetKey(
    instance: str | None = None,
    seed: int | None = None,
    budget: float | None = None,
)

Key for instance, seed and budget.

Parameters#

instance : str | None, defaults to None seed : int | None, defaults to None budget : float | None, defaults to None

get_instance_seed_key #

get_instance_seed_key() -> InstanceSeedKey

Returns the instance-seed key. The budget is omitted.

Source code in smac/runhistory/dataclasses.py 
70
71
72
def get_instance_seed_key(self) -> InstanceSeedKey:
    """Returns the instance-seed key. The budget is omitted."""
    return InstanceSeedKey(instance=self.instance, seed=self.seed)

InstanceSeedKey dataclass #

InstanceSeedKey(
    instance: str | None = None, seed: int | None = None
)

Key for instance and seed.

Parameters#

instance : str | None, defaults to None seed : int | None, defaults to None

TrajectoryItem dataclass #

TrajectoryItem(
    config_ids: list[int],
    costs: list[float | list[float]],
    trial: int,
    walltime: float,
)

Item of a trajectory.

Parameters#

config_ids : list[int] Configuration ids of the current incumbents. costs : list[float | list[float]] Costs of the current incumbents. In case of multi-objective, this is a list of lists. trial : int How many trials have been evaluated so far. walltime : float How much walltime has been used so far.

TrialInfo dataclass #

TrialInfo(
    config: Configuration,
    instance: str | None = None,
    seed: int | None = None,
    budget: float | None = None,
)

Information about a trial.

Parameters#

config : Configuration instance : str | None, defaults to None seed : int | None, defaults to None budget : float | None, defaults to None

get_instance_seed_budget_key #

get_instance_seed_budget_key() -> InstanceSeedBudgetKey

Instantiates and returns an InstanceSeedBudgetKey object.

Source code in smac/runhistory/dataclasses.py 
139
140
141
def get_instance_seed_budget_key(self) -> InstanceSeedBudgetKey:
    """Instantiates and returns an InstanceSeedBudgetKey object."""
    return InstanceSeedBudgetKey(instance=self.instance, seed=self.seed, budget=self.budget)

get_instance_seed_key #

get_instance_seed_key() -> InstanceSeedKey

Instantiates and returns an InstanceSeedKey object

Source code in smac/runhistory/dataclasses.py 
135
136
137
def get_instance_seed_key(self) -> InstanceSeedKey:
    """Instantiates and returns an InstanceSeedKey object"""
    return InstanceSeedKey(instance=self.instance, seed=self.seed)

TrialKey dataclass #

TrialKey(
    config_id: int,
    instance: str | None = None,
    seed: int | None = None,
    budget: float | None = None,
)

Key of a trial.

Parameters#

config_id : int instance : str | None, defaults to None seed : int | None, defaults to None budget : float | None, defaults to None

TrialValue dataclass #

TrialValue(
    cost: float | list[float],
    time: float = 0.0,
    cpu_time: float = 0.0,
    status: StatusType = SUCCESS,
    starttime: float = 0.0,
    endtime: float = 0.0,
    additional_info: dict[str, Any] = dict(),
)

Values of a trial.

Parameters#

cost : float | list[float] time : float, defaults to 0.0 cpu_time : float, defaults to 0.0 Describes the amount of time the trial spend on hardware. status : StatusType, defaults to StatusType.SUCCESS starttime : float, defaults to 0.0 endtime : float, defaults to 0.0 additional_info : dict[str, Any], defaults to {}