__init__#

ExperimentAnalysis.__init__(experiment_checkpoint_path: str | PathLike, *, storage_filesystem: FileSystem | None = None, trials: List[Trial] | None = None, default_metric: str | None = None, default_mode: str | None = None)[source]#

Initialize an ExperimentAnalysis.

Parameters:
  • experiment_checkpoint_path (str | PathLike) – Path to an experiment_state.json file, or a directory that contains an experiment_state.json file.

  • storage_filesystem (FileSystem | None) – A custom pyarrow.fs.FileSystem corresponding to experiment_checkpoint_path. This may be necessary if the original experiment used a custom filesystem.

  • trials (List[Trial] | None) – List of trials that can be accessed via analysis.trials.

  • default_metric (str | None) – Default metric for comparing results. Can be overwritten with the metric parameter in the respective functions.

  • default_mode (str | None) – Default mode for comparing results. Has to be one of [min, max]. Can be overwritten with the mode parameter in the respective functions.