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.

AnalysisConfig

class AnalysisConfig(cls=None, args=<factory>, kwargs=<factory>, options=<factory>, version='0.9.0')

Store configuration settings for an Analysis class.

This stores the current configuration of a BaseAnalysis and can be used to reconstruct the analysis class using either the analysis() property if the analysis 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]

options: Dict[str, Any]

Methods

analysis()

Return the analysis class constructed from this config.

Returns:

The analysis reconstructed from the config.

Return type:

BaseAnalysis

Raises:

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