swarmauri.core.documents.IExperimentDocument module

class swarmauri.core.documents.IExperimentDocument.IExperimentDocument[source]

Bases: IDocument, ABC

Interface for an Experiment Document, extending the general IDocument interface with additional properties and methods specific to experimental data.

abstract property artifacts: List[str]: A list of paths or identifiers for any artifacts generated by the experiment, such as models, charts, or data dumps.

abstract property datetime_completed: datetime | None: Timestamp of when the experiment was completed. None if the experiment is still running.

abstract property datetime_created: datetime: Timestamp marking when the experiment was initiated or created.

abstract property feature_set: List[Any]: Description of the set of features or data used in the experiment.

abstract property instruction: str: An instructional or descriptive text about what the experiment aims to achieve or how.

abstract property parameters: Dict[str, Any]: Get the parameters used in the experiment.

abstract property results: Dict[str, Any]: Get the results obtained from the experiment.

abstract property version: str: The version of the experiment, useful for tracking iterations and changes over time.