swarmauri.core.experiment_stores package

Submodules

• swarmauri.core.experiment_stores.IExperimentStore module
  • IExperimentStore
    • IExperimentStore.add_experiment()
    • IExperimentStore.add_experiments()
    • IExperimentStore.delete_experiment()
    • IExperimentStore.get_all_experiments()
    • IExperimentStore.get_experiment()
    • IExperimentStore.update_experiment()

Module contents

class swarmauri.core.experiment_stores.IExperimentStore

Bases: ABC

Interface for an Experiment Store that manages experimental documents and supports operations related to experimenting, evaluating, testing, and benchmarking.

abstract add_experiment(experiment)

Stores a single experiment in the experiment store.

Parameters: - experiment (IExperimentDocument): The experimental document to be stored.

Return type:

None

abstract add_experiments(experiments)

Stores multiple experiments in the experiment store.

Parameters: - experiments (List[IExperimentDocument]): The list of experimental documents to be stored.

Return type:

None

abstract benchmark_experiments(benchmarking_data)

Benchmarks the experiments against each other or predefined standards.

Parameters: - benchmarking_data (Dict[str, Any]): Data and parameters for benchmarking the experiments.

Returns: - Any: The benchmark results, which may vary depending on the benchmarking methodology.

Return type:

Any

abstract delete_experiment(experiment_id)

Deletes an experimental document from the experiment store by its ID.

Parameters: - id (str): The unique identifier of the experimental document to be deleted.

Return type:

None

abstract evaluate_experiments(evaluation_criteria)

Evaluates the experiments stored in the experiment store based on given criteria and metrics.

Parameters: - evaluation_criteria (Dict[str, Any]): The criteria and metrics to evaluate the experiments.

Returns: - Any: The evaluation results, which may vary depending on the evaluation criteria.

Return type:

Any

abstract get_all_experiments()

Retrieves all experimental documents stored in the experiment store.

Returns: - List[IExperimentDocument]: A list of all experimental documents.

Return type:

List[IExperimentDocument]

abstract get_experiment(experiment_id)

Retrieves an experimental document by its ID.

Parameters: - id (str): The unique identifier of the experiment.

Returns: - Union[IExperimentDocument, None]: The requested experimental document, or None if not found.

Return type:

Optional[IExperimentDocument]

abstract update_experiment(experiment_id, updated_experiment)

Updates an experimental document in the experiment store.

Parameters: - id (str): The unique identifier of the experiment to update. - updated_experiment (IExperimentDocument): The updated experimental document.

Return type:

None