dacapo.store.stats_store

Classes

StatsStore

Base class for statistics stores.

Module Contents

class dacapo.store.stats_store.StatsStore

Base class for statistics stores.

store_training_stats(run_name, training_stats): Store the training stats of a given run.

retrieve_training_stats(run_name): Retrieve the training stats for a given run.

store_validation_iteration_scores(run_name, validation_scores): Store the validation iteration scores of a given run.

retrieve_validation_iteration_scores(run_name): Retrieve the validation iteration scores for a given run.

delete_training_stats(run_name): Delete the training stats associated with a specific run.

abstract store_training_stats(run_name: str, training_stats: dacapo.experiments.training_stats.TrainingStats)

Store training stats of a given run.

Parameters:

run_name (str) – The name of the run.
training_stats (TrainingStats) – The training stats to store.

Raises:

ValueError – If the training stats are already stored.

Examples

>>> store = StatsStore()
>>> run_name = 'run_0'
>>> training_stats = TrainingStats()
>>> store.store_training_stats(run_name, training_stats)

abstract retrieve_training_stats(run_name: str) → dacapo.experiments.training_stats.TrainingStats

Retrieve the training stats for a given run.

Parameters:: run_name (str) – The name of the run.
Returns:: The training stats for the given run.
Return type:: TrainingStats
Raises:: ValueError – If the training stats are not available.

Examples

>>> store = StatsStore()
>>> run_name = 'run_0'
>>> store.retrieve_training_stats(run_name)

abstract store_validation_iteration_scores(run_name: str, validation_scores: dacapo.experiments.validation_scores.ValidationScores)

Store the validation iteration scores of a given run.

Parameters:

run_name (str) – The name of the run.
validation_scores (ValidationScores) – The validation scores to store.

Raises:

ValueError – If the validation iteration scores are already stored.

Examples

>>> store = StatsStore()
>>> run_name = 'run_0'
>>> validation_scores = ValidationScores()
>>> store.store_validation_iteration_scores(run_name, validation_scores)

abstract retrieve_validation_iteration_scores(run_name: str) → List[dacapo.experiments.validation_scores.ValidationIterationScores]

Retrieve the validation iteration scores for a given run.

Parameters:: run_name (str) – The name of the run.
Returns:: The validation iteration scores for the given run.
Return type:: List[ValidationIterationScores]
Raises:: ValueError – If the validation iteration scores are not available.

Examples

>>> store = StatsStore()
>>> run_name = 'run_0'
>>> store.retrieve_validation_iteration_scores(run_name)

abstract delete_training_stats(run_name: str) → None

Deletes the training statistics for a given run.

Parameters:: run_name (str) – The name of the run.
Raises:: ValueError – If the training stats are not available.

Example

>>> store = StatsStore()
>>> run_name = 'run_0'
>>> store.delete_training_stats(run_name)