braket.tasks.gate_model_quantum_task_result module¶
-
class
braket.tasks.gate_model_quantum_task_result.
GateModelQuantumTaskResult
(measurements: numpy.ndarray, measurement_counts: Counter, measurement_probabilities: Dict[str, float], measurements_copied_from_device: bool, measurement_counts_copied_from_device: bool, measurement_probabilities_copied_from_device: bool, task_metadata: Dict[str, Any], state_vector: Optional[Dict[str, complex]] = None)[source]¶ Bases:
object
Result of a gate model quantum task execution. This class is intended to be initialized by a QuantumTask class.
- Parameters
measurements (numpy.ndarray) – 2d array - row is shot, column is qubit.
measurement_counts (Counter) – A Counter of measurements. Key is the measurements in a big endian binary string. Value is the number of times that measurement occurred.
measurement_probabilities (Dict[str, float]) – A dictionary of probabilistic results. Key is the measurements in a big endian binary string. Value is the probability the measurement occurred.
measurements_copied_from_device (bool) – flag whether
measurements
were copied from device. If false,measurements
are calculated from device data.measurement_counts_copied_from_device (bool) – flag whether
measurement_counts
were copied from device. If false,measurement_counts
are calculated from device data.measurement_probabilities_copied_from_device (bool) – flag whether
measurement_probabilities
were copied from device. If false,measurement_probabilities
are calculated from device data.task_metadata (Dict[str, Any]) – Dictionary of task metadata.
state_vector (Dict[str, complex]) – Dictionary where Key is state and Value is amplitude.
-
measurements
: np.ndarray = None¶
-
measurement_counts
: Counter = None¶
-
measurement_probabilities
: Dict[str, float] = None¶
-
measurements_copied_from_device
: bool = None¶
-
measurement_counts_copied_from_device
: bool = None¶
-
measurement_probabilities_copied_from_device
: bool = None¶
-
task_metadata
: Dict[str, Any] = None¶
-
state_vector
: Dict[str, complex] = None¶
-
static
measurement_counts_from_measurements
(measurements: numpy.ndarray) → Counter[source]¶ Creates measurement counts from measurements
- Parameters
measurements (numpy.ndarray) – 2d array - row is shot, column is qubit.
- Returns
Counter –
- A Counter of measurements. Key is the measurements in a big endian binary
string. Value is the number of times that measurement occurred.
-
static
measurement_probabilities_from_measurement_counts
(measurement_counts: Counter) → Dict[str, float][source]¶ Creates measurement probabilities from measurement counts
- Parameters
measurement_counts (Counter) – A Counter of measurements. Key is the measurements in a big endian binary string. Value is the number of times that measurement occurred.
- Returns
Dict[str, float] –
- A dictionary of probabilistic results. Key is the measurements
in a big endian binary string. Value is the probability the measurement occurred.
-
static
measurements_from_measurement_probabilities
(measurement_probabilities: Dict[str, float], shots: int) → numpy.ndarray[source]¶ Creates measurements from measurement probabilities
- Parameters
measurement_probabilities (Dict[str, float]) – A dictionary of probabilistic results. Key is the measurements in a big endian binary string. Value is the probability the measurement occurred.
shots (int) – number of iterations on device
- Returns
Dict[str, float] –
- A dictionary of probabilistic results.
Key is the measurements in a big endian binary string. Value is the probability the measurement occurred.
-
static
from_dict
(result: Dict[str, Any])[source]¶ Create GateModelQuantumTaskResult from dict.
- Parameters
result (Dict[str, Any]) – Results dict with GateModelQuantumTaskResult attributes as keys
- Returns
GateModelQuantumTaskResult – A GateModelQuantumTaskResult based on the given dict
- Raises
ValueError – If neither “Measurements” nor “MeasurementProbabilities” is a key
in the result dict –
Note
For the “StateVector” key, the value should be of type Dict[str, complex]; each bitstring’s amplitude is a Python complex number.
-
static
from_string
(result: str) → braket.tasks.gate_model_quantum_task_result.GateModelQuantumTaskResult[source]¶ Create GateModelQuantumTaskResult from string.
- Parameters
result (str) – JSON object string, with GateModelQuantumTaskResult attributes as keys.
- Returns
GateModelQuantumTaskResult – A GateModelQuantumTaskResult based on the given string
- Raises
ValueError – If neither “Measurements” nor “MeasurementProbabilities” is a key
in the result dict –
Note
For the “StateVector” key, the value should be of type Dict[str, List[float, float]]; each bitstring’s amplitude is represented by a two-element list, with first element the real component and second element the imaginary component.