Skip to content
Crystallize Documentation

Artifacts

module crystallize.plugins.artifacts

Section titled “module crystallize.plugins.artifacts”

Global Variables

Section titled “Global Variables”
  • BASELINE_CONDITION

function load_metrics

Section titled “function load_metrics”
load_metrics(
    exp_dir: 'Path',
    version: 'int | None' = None
) → Tuple[int, dict[str, Any], dict[str, dict[str, Any]]]

Load metrics from results.json files for version.

Parameters ---------- exp_dir: Base directory of the experiment. version: Version number to load from. If None, the latest version is used. Returns ------- Tuple of the loaded version number, baseline metrics and a mapping of treatment name to metrics in stable order.

function load_all_metrics

Section titled “function load_all_metrics”
load_all_metrics(
    exp_dir: 'Path',
    version: 'int | None' = None
) → Tuple[int, dict[str, Any], dict[str, Tuple[int, dict[str, Any]]]]

Load metrics for all treatments across versions.

Parameters ---------- exp_dir: Base directory of the experiment. version: Latest version to consider. If None the newest version on disk is used.

Returns ------- Tuple of the latest version number, baseline metrics from that version and a mapping of treatment name to a tuple of (version, metrics) where version indicates which artifact version the metrics were loaded from.