306 lines
12 KiB
Plaintext
306 lines
12 KiB
Plaintext
---
|
||
title: QuantumInstance
|
||
description: API reference for qiskit.utils.QuantumInstance
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.utils.QuantumInstance
|
||
---
|
||
|
||
# QuantumInstance
|
||
|
||
<Class id="qiskit.utils.QuantumInstance" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py" signature="QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=None, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, bound_pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None, max_job_retries=50)" modifiers="class">
|
||
Bases: `object`
|
||
|
||
Quantum Backend including execution setting.
|
||
|
||
Quantum Instance holds a Qiskit Terra backend as well as configuration for circuit transpilation and execution. When provided to an Aqua algorithm the algorithm will execute the circuits it needs to run using the instance.
|
||
|
||
**Parameters**
|
||
|
||
* **backend** ([*Backend*](qiskit.providers.Backend "qiskit.providers.Backend")) – Instance of selected backend
|
||
* **shots** (`Optional`\[`int`]) – Number of repetitions of each circuit, for sampling. If None, the shots are extracted from the backend. If the backend has none set, the default is 1024.
|
||
* **seed\_simulator** (`Optional`\[`int`]) – Random seed for simulators
|
||
* **max\_credits** (`Optional`\[`int`]) – DEPRECATED This parameter is deprecated as of Qiskit Terra 0.20.0, and will be removed in a future release. This parameter has no effect on modern IBM Quantum systems, and no alternative is necessary.
|
||
* **basis\_gates** (`Optional`\[`List`\[`str`]]) – List of basis gate names supported by the target. Defaults to basis gates of the backend.
|
||
* **coupling\_map** (*Optional\[Union\['CouplingMap', List\[List]]]*) – Coupling map (perhaps custom) to target in mapping
|
||
* **initial\_layout** (*Optional\[Union\['Layout', Dict, List]]*) – Initial layout of qubits in mapping
|
||
* **pass\_manager** (*Optional\['PassManager']*) – Pass manager to handle how to compile the circuits. To run only this pass manager and not the `bound_pass_manager`, call the [`transpile()`](qiskit.utils.QuantumInstance#transpile "qiskit.utils.QuantumInstance.transpile") method with the argument `pass_manager=quantum_instance.unbound_pass_manager`.
|
||
* **bound\_pass\_manager** (*Optional\['PassManager']*) – A second pass manager to apply on bound circuits only, that is, circuits without any free parameters. To only run this pass manager and not `pass_manager` call the [`transpile()`](qiskit.utils.QuantumInstance#transpile "qiskit.utils.QuantumInstance.transpile") method with the argument `pass_manager=quantum_instance.bound_pass_manager`. manager should also be run.
|
||
* **seed\_transpiler** (`Optional`\[`int`]) – The random seed for circuit mapper
|
||
* **optimization\_level** (`Optional`\[`int`]) – How much optimization to perform on the circuits. Higher levels generate more optimized circuits, at the expense of longer transpilation time.
|
||
* **backend\_options** (`Optional`\[`Dict`]) – All running options for backend, please refer to the provider of the backend for information as to what options it supports.
|
||
* **noise\_model** (*Optional\['NoiseModel']*) – noise model for simulator
|
||
* **timeout** (`Optional`\[`float`]) – Seconds to wait for job. If None, wait indefinitely.
|
||
* **wait** (`float`) – Seconds between queries for job result
|
||
* **skip\_qobj\_validation** (`bool`) – Bypass Qobj validation to decrease circuit processing time during submission to backend.
|
||
* **measurement\_error\_mitigation\_cls** (`Optional`\[`Callable`]) – The approach to mitigate measurement errors. The classes [`CompleteMeasFitter`](qiskit.utils.mitigation.CompleteMeasFitter "qiskit.utils.mitigation.CompleteMeasFitter") or [`TensoredMeasFitter`](qiskit.utils.mitigation.TensoredMeasFitter "qiskit.utils.mitigation.TensoredMeasFitter") from the [`qiskit.utils.mitigation`](utils_mitigation#module-qiskit.utils.mitigation "qiskit.utils.mitigation") module can be used here as exact values, not instances. `TensoredMeasFitter` doesn’t support the `subset_fitter` method.
|
||
* **cals\_matrix\_refresh\_period** (`int`) – How often to refresh the calibration matrix in measurement mitigation. in minutes
|
||
* **measurement\_error\_mitigation\_shots** (`Optional`\[`int`]) – The number of shots number for building calibration matrix. If None, the main shots parameter value is used.
|
||
* **job\_callback** (`Optional`\[`Callable`]) – Optional user supplied callback which can be used to monitor job progress as jobs are submitted for processing by an Aqua algorithm. The callback is provided the following arguments: job\_id, job\_status, queue\_position, job
|
||
* **mit\_pattern** (`Optional`\[`List`\[`List`\[`int`]]]) – Qubits on which to perform the TensoredMeasFitter measurement correction, divided to groups according to tensors. If None and qr is given then assumed to be performed over the entire qr as one group (default None).
|
||
* **max\_job\_retries** (*int*) – positive non-zero number of trials for the job set (-1 for infinite trials) (default: 50)
|
||
|
||
**Raises**
|
||
|
||
* **QiskitError** – the shots exceeds the maximum number of shots
|
||
* **QiskitError** – set noise model but the backend does not support that
|
||
* **QiskitError** – set backend\_options but the backend does not support that
|
||
|
||
## Methods
|
||
|
||
### assemble
|
||
|
||
<Function id="qiskit.utils.QuantumInstance.assemble" signature="QuantumInstance.assemble(circuits)">
|
||
assemble circuits
|
||
|
||
**Return type**
|
||
|
||
[`Qobj`](qiskit.qobj.Qobj "qiskit.qobj.Qobj")
|
||
</Function>
|
||
|
||
### cals\_matrix
|
||
|
||
<Function id="qiskit.utils.QuantumInstance.cals_matrix" signature="QuantumInstance.cals_matrix(qubit_index=None)">
|
||
Get the stored calibration matrices and its timestamp.
|
||
|
||
**Parameters**
|
||
|
||
**qubit\_index** (`Optional`\[`List`\[`int`]]) – the qubit index of corresponding calibration matrix. If None, return all stored calibration matrices.
|
||
|
||
**Return type**
|
||
|
||
`Union`\[`Tuple`\[`ndarray`, `float`], `Dict`\[`str`, `Tuple`\[`ndarray`, `float`]], `None`]
|
||
|
||
**Returns**
|
||
|
||
The calibration matrix and the creation timestamp if qubit\_index is not None otherwise, return all matrices and their timestamp in a dictionary.
|
||
</Function>
|
||
|
||
### execute
|
||
|
||
<Function id="qiskit.utils.QuantumInstance.execute" signature="QuantumInstance.execute(circuits, had_transpiled=False)">
|
||
A wrapper to interface with quantum backend.
|
||
|
||
**Parameters**
|
||
|
||
* **circuits** (*Union\['QuantumCircuit', List\['QuantumCircuit']]*) – circuits to execute
|
||
* **had\_transpiled** (`bool`) – whether or not circuits had been transpiled
|
||
|
||
**Raises**
|
||
|
||
* **QiskitError** – Invalid error mitigation fitter class
|
||
* **QiskitError** – TensoredMeasFitter class doesn’t support subset fitter
|
||
* **MissingOptionalLibraryError** – Ignis not installed
|
||
|
||
**Returns**
|
||
|
||
result object
|
||
|
||
**Return type**
|
||
|
||
[Result](qiskit.result.Result "qiskit.result.Result")
|
||
|
||
#### TODO: Maybe we can combine the circuits for the main ones and calibration circuits before
|
||
|
||
assembling to the qobj.
|
||
</Function>
|
||
|
||
### maybe\_refresh\_cals\_matrix
|
||
|
||
<Function id="qiskit.utils.QuantumInstance.maybe_refresh_cals_matrix" signature="QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)">
|
||
Calculate the time difference from the query of last time.
|
||
|
||
**Parameters**
|
||
|
||
**timestamp** (`Optional`\[`float`]) – timestamp
|
||
|
||
**Return type**
|
||
|
||
`bool`
|
||
|
||
**Returns**
|
||
|
||
Whether or not refresh the cals\_matrix
|
||
</Function>
|
||
|
||
### reset\_execution\_results
|
||
|
||
<Function id="qiskit.utils.QuantumInstance.reset_execution_results" signature="QuantumInstance.reset_execution_results()">
|
||
Reset execution results
|
||
|
||
**Return type**
|
||
|
||
`None`
|
||
</Function>
|
||
|
||
### set\_config
|
||
|
||
<Function id="qiskit.utils.QuantumInstance.set_config" signature="QuantumInstance.set_config(**kwargs)">
|
||
Set configurations for the quantum instance.
|
||
</Function>
|
||
|
||
### transpile
|
||
|
||
<Function id="qiskit.utils.QuantumInstance.transpile" signature="QuantumInstance.transpile(circuits, pass_manager=None)">
|
||
A wrapper to transpile circuits to allow algorithm access the transpiled circuits.
|
||
|
||
**Parameters**
|
||
|
||
* **circuits** (*Union\['QuantumCircuit', List\['QuantumCircuit']]*) – circuits to transpile
|
||
* **pass\_manager** (*Optional\['PassManager']*) – A pass manager to transpile the circuits. If none is given, but either `pass_manager` or `bound_pass_manager` has been set in the initializer, these are run. If none has been provided there either, the backend and compile configs from the initializer are used.
|
||
|
||
**Returns**
|
||
|
||
**The transpiled circuits, it is always a list even though**
|
||
|
||
the length is one.
|
||
|
||
**Return type**
|
||
|
||
List\[‘QuantumCircuit’]
|
||
</Function>
|
||
|
||
## Attributes
|
||
|
||
### backend
|
||
|
||
<Attribute id="qiskit.utils.QuantumInstance.backend">
|
||
Return Backend backend object.
|
||
</Attribute>
|
||
|
||
### backend\_config
|
||
|
||
<Attribute id="qiskit.utils.QuantumInstance.backend_config">
|
||
Getter of backend\_config.
|
||
</Attribute>
|
||
|
||
### backend\_name
|
||
|
||
<Attribute id="qiskit.utils.QuantumInstance.backend_name">
|
||
Return backend name.
|
||
</Attribute>
|
||
|
||
### backend\_options
|
||
|
||
<Attribute id="qiskit.utils.QuantumInstance.backend_options">
|
||
Getter of backend\_options.
|
||
</Attribute>
|
||
|
||
### bound\_pass\_manager
|
||
|
||
<Attribute id="qiskit.utils.QuantumInstance.bound_pass_manager">
|
||
Return the pass manager for designated for bound circuits.
|
||
|
||
**Returns**
|
||
|
||
The pass manager for bound circuits, if it has been set.
|
||
|
||
**Return type**
|
||
|
||
Optional\[‘PassManager’]
|
||
</Attribute>
|
||
|
||
### cals\_matrix\_refresh\_period
|
||
|
||
<Attribute id="qiskit.utils.QuantumInstance.cals_matrix_refresh_period">
|
||
returns matrix refresh period
|
||
</Attribute>
|
||
|
||
### circuit\_summary
|
||
|
||
<Attribute id="qiskit.utils.QuantumInstance.circuit_summary">
|
||
Getter of circuit summary.
|
||
</Attribute>
|
||
|
||
### compile\_config
|
||
|
||
<Attribute id="qiskit.utils.QuantumInstance.compile_config">
|
||
Getter of compile\_config.
|
||
</Attribute>
|
||
|
||
### is\_local
|
||
|
||
<Attribute id="qiskit.utils.QuantumInstance.is_local">
|
||
Return True if backend is a local backend.
|
||
</Attribute>
|
||
|
||
### is\_simulator
|
||
|
||
<Attribute id="qiskit.utils.QuantumInstance.is_simulator">
|
||
Return True if backend is a simulator.
|
||
</Attribute>
|
||
|
||
### is\_statevector
|
||
|
||
<Attribute id="qiskit.utils.QuantumInstance.is_statevector">
|
||
Return True if backend is a statevector-type simulator.
|
||
</Attribute>
|
||
|
||
### max\_job\_retries
|
||
|
||
<Attribute id="qiskit.utils.QuantumInstance.max_job_retries">
|
||
Getter of max tries
|
||
</Attribute>
|
||
|
||
### measurement\_error\_mitigation\_cls
|
||
|
||
<Attribute id="qiskit.utils.QuantumInstance.measurement_error_mitigation_cls">
|
||
returns measurement error mitigation cls
|
||
</Attribute>
|
||
|
||
### measurement\_error\_mitigation\_shots
|
||
|
||
<Attribute id="qiskit.utils.QuantumInstance.measurement_error_mitigation_shots">
|
||
returns measurement error mitigation shots
|
||
</Attribute>
|
||
|
||
### noise\_config
|
||
|
||
<Attribute id="qiskit.utils.QuantumInstance.noise_config">
|
||
Getter of noise\_config.
|
||
</Attribute>
|
||
|
||
### qjob\_config
|
||
|
||
<Attribute id="qiskit.utils.QuantumInstance.qjob_config">
|
||
Getter of qjob\_config.
|
||
</Attribute>
|
||
|
||
### run\_config
|
||
|
||
<Attribute id="qiskit.utils.QuantumInstance.run_config">
|
||
Getter of run\_config.
|
||
</Attribute>
|
||
|
||
### skip\_qobj\_validation
|
||
|
||
<Attribute id="qiskit.utils.QuantumInstance.skip_qobj_validation">
|
||
checks if skip qobj validation
|
||
</Attribute>
|
||
|
||
### time\_taken
|
||
|
||
<Attribute id="qiskit.utils.QuantumInstance.time_taken">
|
||
Accumulated time taken for execution.
|
||
|
||
**Return type**
|
||
|
||
`float`
|
||
</Attribute>
|
||
|
||
### unbound\_pass\_manager
|
||
|
||
<Attribute id="qiskit.utils.QuantumInstance.unbound_pass_manager">
|
||
Return the pass manager for designated for unbound circuits.
|
||
|
||
**Returns**
|
||
|
||
The pass manager for unbound circuits, if it has been set.
|
||
|
||
**Return type**
|
||
|
||
Optional\[‘PassManager’]
|
||
</Attribute>
|
||
</Class>
|
||
|