--- title: Q-CTRL Performance Management API reference description: API reference for Performance Management, A Qiskit Function by Q-CTRL Fire Opal source: https://eu-de.quantum.cloud.ibm.com/docs/en/api/functions/q-ctrl-performance-management --- # Q-CTRL Performance Management API reference - [**Qiskit Functions**](/docs/guides/q-ctrl-performance-management) — 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. > **Caution** > > 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](/docs/guides/primitive-input-output#estimator-pub)):** - A single circuit defined as a `QuantumCircuit` or 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](/docs/guides/primitive-input-output#broadcasting-rules) as the `QiskitRuntime` primitives. - (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": }`. **Supported observables formats:** - Any one of the `ObservablesArrayLike` formats, such as `Pauli`, `SparsePauliOp`, `PauliList`, or `str` - 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` Type: `` `QctrlEstimatorPubLike` or `list[QctrlEstimatorPubLike]` `` Default value: `N/A` One or more tuples containing the inputs listed under `EstimatorPubLike` components - Required: Yes - Example: `(circuit, observables, parameter_values)` ### `backend_name` Type: `` `str` `` Default value: `The least busy backend that your instance has access to` The name of the backend - Required: No - Example: `"ibm_fez"` ### Options Type: `` `dict` `` Default value: `See Options section for more details` Input options for this function are specified as a nested dictionary. See the full [list of options](#est-options) and their default values. - Required: No - Example: `{"default_shots": 2048}` #### Options list ##### `session_id` Type: `` `str` `` An existing IBM Quantum Compute Service session ID - Example: `"cw4r3je6f0t010870y3g"` ##### `default_shots` Type: `` `int` `` Default value: `` `2048` `` The number of shots to use for each circuit ##### `default_precision` Type: `` `float` `` The target precision for expectation values to estimate for each circuit - Example: `0.015625` ##### `job_tags` Type: `` `list[str]` `` Default value: `` `[]` `` A list of job tags ## Estimator outputs Type: `` `PrimitiveResult` `` The [`PrimitiveResult`](/docs/api/qiskit/qiskit.primitives.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](/docs/guides/primitive-input-output#sampler-pub)):** - A single circuit defined as a `QuantumCircuit` or 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` Type: `` `QctrlSamplerPubLike` or `list[QctrlSamplerPubLike]` `` One or more tuples containing the inputs listed under `SamplerPubLike` components - Required: Yes - Example: `(circuit, parameter_values)` ### `backend_name` Type: `` `str` `` Default value: `The least busy backend that your instance has access to` The name of the backend - Required: No - Example: `"ibm_fez"` ### Options Type: `` `dict` `` Default value: `See the Options section for details` Input options for this function are specified as a nested dictionary. See the full [list of options](#sam-options) and their default values. - Required: No - Example: `{"default_shots": 2048}` #### Options list ##### `session_id` Type: `` `str` `` An existing Quantum Compute session ID - Example: `"cw4r3je6f0t010870y3g"` ##### `default_shots` Type: `` `int` `` Default value: `` `2048` `` The number of shots to use for each circuit ##### `job_tags` Type: `` `list[str]` `` Default value: `` `[]` `` The list of desired job tags ## Sampler outputs Type: `` `PrimitiveResult` `` The [`PrimitiveResult`](/docs/api/qiskit/qiskit.primitives.PrimitiveResult) corresponding to the list of input PUBs - Example: `PrimitiveResult([PubResult(data=DataBin(c=BitArray()), metadata={'shots': 2048})], metadata={`provider\_job\_ids`: 1234678})`