smac.runhistory.dataclasses

Classes

InstanceSeedBudgetKey([instance, seed, budget])

Key for instance, seed and budget.

InstanceSeedKey([instance, seed])

Key for instance and seed.

TrajectoryItem(config_ids, costs, trial, ...)

Item of a trajectory.

TrialInfo(config[, instance, seed, budget])

Information about a trial.

TrialKey(config_id[, instance, seed, budget])

Key of a trial.

TrialValue(cost[, time, status, starttime, ...])

Values of a trial.

Interfaces

class smac.runhistory.dataclasses.InstanceSeedBudgetKey(instance=None, seed=None, budget=None)[source]

Bases: object

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()[source]

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

Return type:

InstanceSeedKey

class smac.runhistory.dataclasses.InstanceSeedKey(instance=None, seed=None)[source]

Bases: object

Key for instance and seed.

Parameters:
  • instance (str | None, defaults to None)

  • seed (int | None, defaults to None)

class smac.runhistory.dataclasses.TrajectoryItem(config_ids, costs, trial, walltime)[source]

Bases: object

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.

class smac.runhistory.dataclasses.TrialInfo(config, instance=None, seed=None, budget=None)[source]

Bases: object

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()[source]

Instantiates and returns an InstanceSeedBudgetKey object.

Return type:

InstanceSeedBudgetKey

get_instance_seed_key()[source]

Instantiates and returns an InstanceSeedKey object

Return type:

InstanceSeedKey

class smac.runhistory.dataclasses.TrialKey(config_id, instance=None, seed=None, budget=None)[source]

Bases: object

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)

class smac.runhistory.dataclasses.TrialValue(cost, time=0.0, status=StatusType.SUCCESS, starttime=0.0, endtime=0.0, additional_info=<factory>)[source]

Bases: object

Values of a trial.

Parameters:
  • cost (float | list[float])

  • time (float, defaults to 0.0)

  • 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 {})