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.

IQPlotter.expected_supplementary_data_keys

classmethod IQPlotter.expected_supplementary_data_keys()

Returns the expected figures data keys supported by this plotter.

Data Keys:

• discriminator – A trained discriminator that classifies IQ points. If provided, the predictions of the discriminator will be sampled to generate a background image, indicating the regions for each predicted outcome. The predictions are assumed to be series names (Union[str, int, float]). The generated image allows viewers to see how well the discriminator classifies the provided series data. Must be a subclass of BaseDiscriminator. See options for ways to control the generation of the discriminator prediction image.

• fidelity – A float representing the fidelity of the discrimination.

Return type:

List[str]