Class swarmauri_core.documents.IExperimentDocument.IExperimentDocument
Bases: IDocument, ABC
Interface for an Experiment Document, extending the general IDocument interface with additional properties and methods specific to experimental data.
abstractmethod
property
writable
parameters
Get the parameters used in the experiment.
abstractmethod
property
writable
results
Get the results obtained from the experiment.
abstractmethod
property
writable
instruction
An instructional or descriptive text about what the experiment aims to achieve or how.
abstractmethod
property
writable
feature_set
Description of the set of features or data used in the experiment.
abstractmethod
property
writable
version
The version of the experiment, useful for tracking iterations and changes over time.
abstractmethod
property
writable
artifacts
A list of paths or identifiers for any artifacts generated by the experiment, such as models, charts, or data dumps.
abstractmethod
property
writable
datetime_created
Timestamp marking when the experiment was initiated or created.
abstractmethod
property
writable
datetime_completed
Timestamp of when the experiment was completed. None if the experiment is still running.