Core#

Core modules provide internal functionality for ablate, such as (grouped) run types.

Types#

Types define the basic data structures used throughout ablate.

class ablate.core.types.Run(id, params, metrics, temporal=None)[source]#

A single run of an experiment.

Parameters:
  • id (str) – Unique identifier for the run.

  • params (Dict[str, Any]) – Parameters used for the run.

  • metrics (Dict[str, float]) – Metrics recorded during the run.

  • temporal (Optional[Dict[str, list[Tuple[int, float]]]]) – Temporal data recorded during the run. If None, an empty dictionary is used. Defaults to None.

class ablate.core.types.GroupedRun(key, value, runs)[source]#

A collection of runs grouped by a key-value pair.

Parameters:
  • key (str) – Key used to group the runs.

  • value (str) – Value used to group the runs.

  • runs (List[Run]) – List of runs that belong to this group.