Q-CTRL Performance Management API reference
Qiskit Functions — pre-built tools created by partner organizations — abstract away parts of the software development workflow to simplify and accelerate utility-scale algorithm discovery and application development. Click to view the guide for this Qiskit Function.
Performance Management Qiskit Function guide
Fire Opal Performance Management accepts abstract circuits, in contrast to the native IBM Quantum primitives, which only accept circuits that are written in the target backend's Instruction Set Architecture (ISA). For best results, do not transpile circuits before submitting via the Performance Management function.
Estimator inputs
QctrlEstimatorPubLike components (derived from the Quantum Compute PUB definition):
- A single circuit defined as a
QuantumCircuitor in OpenQASM 2.0 or 3.0 string format. - One or more observables that specify the expectation values to estimate, in any of the formats denoted in the list "Supported observables formats".
- (Optional) A collection of parameter values to bind the circuit against, which follow the same array broadcasting rules as the
QiskitRuntimeprimitives. - (Optional) A target precision for expectation values to estimate.
- (Optional) A real number representing the precision, or a dictionary of run options containing the shot count. For example:
{"shots": <int>}.
Supported observables formats:
- Any one of the
ObservablesArrayLikeformats, such asPauli,SparsePauliOp,PauliList, orstr - A Pauli string:
"XY" - A dictionary - Pauli strings with coefficients:
{"XY": 0.5, "YZ": 0.3} - A list of Pauli strings:
["XY", "YZ", "ZX"] - A list of Pauli strings with coefficients:
[("XY", 0.5), ("YZ", 0.3)] - A nested list of Pauli strings:
[["XY", "YZ"], ["ZX", "XX"]] - A nested list of Pauli strings with coefficients:
[[("XY", 0.1), ("YZ", 0.2)], [("ZX", 0.3), ("XX", 0.4)]]
pubs
유형: `QctrlEstimatorPubLike` or `list[QctrlEstimatorPubLike]`
기본값: N/A
One or more tuples containing the inputs listed under EstimatorPubLike components
- Required: Yes
- Example:
(circuit, observables, parameter_values)
backend_name
유형: `str`
기본값: The least busy backend that your instance has access to
The name of the backend
- Required: No
- Example:
"ibm_fez"
Options
유형: `dict`
기본값: See Options section for more details
Input options for this function are specified as a nested dictionary. See the full list of options and their default values.
- Required: No
- Example:
{"default_shots": 2048}
Options list
session_id
유형: `str`
An existing IBM Quantum Compute Service session ID
- Example:
"cw4r3je6f0t010870y3g"
default_shots
유형: `int`
기본값: `2048`
The number of shots to use for each circuit
default_precision
유형: `float`
The target precision for expectation values to estimate for each circuit
- Example:
0.015625
job_tags
유형: `list[str]`
기본값: `[]`
A list of job tags
Estimator outputs
유형: `PrimitiveResult`
The PrimitiveResult corresponding to the list of input PUBs
- Example:
PubResult(data=DataBin(evs=[0.1234], stds=[0.1]))
Sampler inputs
QctrlSamplerPubLike components (derived from the Quantum Compute PUB definition):
- A single circuit defined as a
QuantumCircuitor in OpenQASM 2.0 or 3.0 string format. - (Optional) A collection of parameter values to bind the circuit against.
- (Optional) An integer representing the shot count, or a dictionary of runtime options containing the shot count. For example:
(circ, None, 123)or(circ, None, {"shots": 123}).
pubs
유형: `QctrlSamplerPubLike` or `list[QctrlSamplerPubLike]`
One or more tuples containing the inputs listed under SamplerPubLike components
- Required: Yes
- Example:
(circuit, parameter_values)
backend_name
유형: `str`
기본값: The least busy backend that your instance has access to
The name of the backend
- Required: No
- Example:
"ibm_fez"
Options
유형: `dict`
기본값: See the Options section for details
Input options for this function are specified as a nested dictionary. See the full list of options and their default values.
- Required: No
- Example:
{"default_shots": 2048}
Options list
session_id
유형: `str`
An existing Quantum Compute session ID
- Example:
"cw4r3je6f0t010870y3g"
default_shots
유형: `int`
기본값: `2048`
The number of shots to use for each circuit
job_tags
유형: `list[str]`
기본값: `[]`
The list of desired job tags
Sampler outputs
유형: `PrimitiveResult`
The PrimitiveResult corresponding to the list of input PUBs
- Example:
PrimitiveResult([PubResult(data=DataBin(c=BitArray(<shape=(), num_shots=2048, num_bits=35>)), metadata={'shots': 2048})], metadata={provider_job_ids: 1234678})