Note

This is the documentation for the current state of the development branch of Qiskit Experiments. The documentation or APIs here can change prior to being released.

ArtifactData¶

class ArtifactData(name, data, artifact_id=<factory>, experiment_id=None, experiment=None, device_components=<factory>, created_time=<factory>)[source]¶

A dataclass for non-analysis result payloads in ExperimentData objects.

This class can convert results generated by the analysis class into a payload for saving and retrieving to and from the experiments service, which stores this as artifacts. Types of objects that may be converted to artifacts include fitted and raw data, fit status, and any other JSON-based data needed to serialize experiments and experiment data.

name¶

The name of the artifact. When saved to the cloud service, this will be the name of the zipfile this artifact object is stored in.

Type:: str

data¶

The artifact payload.

Type:: Any

artifact_id¶

Artifact ID. Must be unique inside an ExperimentData object.

Type:: str | None

experiment_id¶

Experiment ID that the artifact is associated with.

Type:: str | None

experiment¶

The name of the experiment.

Type:: str | None

device_components¶

The device components of the experiment.

Type:: List

created_time¶

Time when the artifact was created.

Type:: datetime.datetime | None

Attributes

dtype¶: Data type of the payload.