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.

ExperimentConfig

class ExperimentConfig(cls=None, args=<factory>, kwargs=<factory>, experiment_options=<factory>, transpile_options=<factory>, run_options=<factory>, version='0.9.0')

Store configuration settings for an Experiment class.

This stores the current configuration of a BaseExperiment and can be used to reconstruct the experiment using either the experiment() property if the experiment class type is currently stored, or the from_config() class method of the appropriate experiment.

Attributes

version: str = '0.9.0'

args: Tuple[Any]

kwargs: Dict[str, Any]

experiment_options: Dict[str, Any]

transpile_options: Dict[str, Any]

run_options: Dict[str, Any]

Methods

experiment()

Return the experiment constructed from this config.

Returns:

The experiment reconstructed from the config.

Return type:

BaseExperiment

Raises:

QiskitError – If the experiment class is not stored, was not successful deserialized, or reconstruction of the experiment fails.