meticulous.experiments¶

class meticulous.experiments.ExperimentReader(curexpdir: str)[source]¶

Class to read an experiment folder

__init__(curexpdir: str)[source]¶

Read experiment data from curexpdir. Reads metadata.json, args.json, default_args.json, STATUS and summary.json.

Parameters: curexpdir – The experiment directory to read

curexpdir¶

Path to the directory for the current experiment

Type: str

expid¶

experiment id

Type: str

metadata¶

loaded from metadata.json

Type: dict

args¶

loaded from args.json

Type: dict

default_args¶

loaded from default_args.json

Type: dict

summary¶

loaded from summary.json

Type: dict

open(*args, **kwargs)[source]¶: wrapper around the function open to redirect to experiment directory

refresh_status()[source]¶: Read STATUS file

refresh_summary()[source]¶: Read summary.json

class meticulous.experiments.Experiments(project_directory: str = '', experiments_directory: str = None, reader=<class 'meticulous.experiments.ExperimentReader'>)[source]¶

Class to load an experiments folder

__init__(project_directory: str = '', experiments_directory: str = None, reader=<class 'meticulous.experiments.ExperimentReader'>)[source]¶

Load the repo from project_directory and experiments from expdir using ExperimentReader class.

Parameters

project_directory – Path to the project directory, should be part of a git repo.
experiments_directory – Path to the directory that stores experiments. If a relative path is specified then it is relative to the project directory. Created if it doesn’t exist.
reader – To allow overriding with a user defined version of ExperimentReader class.

experiments¶

experiment ids mapped to respective ExperimentReader objects

Type: Dict[ExperimentReader]

refresh_experiments()[source]¶: Read experiments from the file system

as_dataframe()[source]¶: Returns all experiment data as a pandas dataframe