diff --git a/docs/api/qiskit-ibm-runtime/_toc.json b/docs/api/qiskit-ibm-runtime/_toc.json index 03539a40204..71b17bcb038 100644 --- a/docs/api/qiskit-ibm-runtime/_toc.json +++ b/docs/api/qiskit-ibm-runtime/_toc.json @@ -62,6 +62,27 @@ } ] }, + { + "title": "qiskit_ibm_runtime.debug_tools", + "children": [ + { + "title": "Module overview", + "url": "/api/qiskit-ibm-runtime/debug_tools" + }, + { + "title": "Neat", + "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.debug_tools.Neat" + }, + { + "title": "NeatPubResult", + "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.debug_tools.NeatPubResult" + }, + { + "title": "NeatResult", + "url": "/api/qiskit-ibm-runtime/qiskit_ibm_runtime.debug_tools.NeatResult" + } + ] + }, { "title": "qiskit_ibm_runtime.execution_span", "children": [ diff --git a/docs/api/qiskit-ibm-runtime/debug_tools.mdx b/docs/api/qiskit-ibm-runtime/debug_tools.mdx new file mode 100644 index 00000000000..9bfae74d34d --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/debug_tools.mdx @@ -0,0 +1,26 @@ +--- +title: debug_tools +description: API reference for qiskit_ibm_runtime.debug_tools +in_page_toc_min_heading_level: 2 +python_api_type: module +python_api_name: qiskit_ibm_runtime.debug_tools +--- + + + + + +# Debugging tools + +`qiskit_ibm_runtime.debug_tools` + +The tools for debugging and analyzing qiskit-ibm-runtime jobs. + +## Classes + +| | | +| -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | +| [`Neat`](qiskit_ibm_runtime.debug_tools.Neat "qiskit_ibm_runtime.debug_tools.Neat")(backend\[, noise\_model]) | A class to help understand the expected performance of estimator jobs. | +| [`NeatResult`](qiskit_ibm_runtime.debug_tools.NeatResult "qiskit_ibm_runtime.debug_tools.NeatResult")(pub\_results) | A container for multiple [`NeatPubResult`](qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.NeatPubResult") objects. | +| [`NeatPubResult`](qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.NeatPubResult")(vals) | A class to store the PUB results of `Neat`. | + diff --git a/docs/api/qiskit-ibm-runtime/dev/_toc.json b/docs/api/qiskit-ibm-runtime/dev/_toc.json index ea08ecb1cd7..09b931e25ae 100644 --- a/docs/api/qiskit-ibm-runtime/dev/_toc.json +++ b/docs/api/qiskit-ibm-runtime/dev/_toc.json @@ -62,6 +62,27 @@ } ] }, + { + "title": "qiskit_ibm_runtime.debug_tools", + "children": [ + { + "title": "Module overview", + "url": "/api/qiskit-ibm-runtime/dev/debug_tools" + }, + { + "title": "Neat", + "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.debug_tools.Neat" + }, + { + "title": "NeatPubResult", + "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.debug_tools.NeatPubResult" + }, + { + "title": "NeatResult", + "url": "/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.debug_tools.NeatResult" + } + ] + }, { "title": "qiskit_ibm_runtime.execution_span", "children": [ diff --git a/docs/api/qiskit-ibm-runtime/dev/debug_tools.mdx b/docs/api/qiskit-ibm-runtime/dev/debug_tools.mdx new file mode 100644 index 00000000000..9bfae74d34d --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/debug_tools.mdx @@ -0,0 +1,26 @@ +--- +title: debug_tools +description: API reference for qiskit_ibm_runtime.debug_tools +in_page_toc_min_heading_level: 2 +python_api_type: module +python_api_name: qiskit_ibm_runtime.debug_tools +--- + + + + + +# Debugging tools + +`qiskit_ibm_runtime.debug_tools` + +The tools for debugging and analyzing qiskit-ibm-runtime jobs. + +## Classes + +| | | +| -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | +| [`Neat`](qiskit_ibm_runtime.debug_tools.Neat "qiskit_ibm_runtime.debug_tools.Neat")(backend\[, noise\_model]) | A class to help understand the expected performance of estimator jobs. | +| [`NeatResult`](qiskit_ibm_runtime.debug_tools.NeatResult "qiskit_ibm_runtime.debug_tools.NeatResult")(pub\_results) | A container for multiple [`NeatPubResult`](qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.NeatPubResult") objects. | +| [`NeatPubResult`](qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.NeatPubResult")(vals) | A class to store the PUB results of `Neat`. | + diff --git a/docs/api/qiskit-ibm-runtime/dev/index.mdx b/docs/api/qiskit-ibm-runtime/dev/index.mdx index 9b94f073619..1a96e625b79 100644 --- a/docs/api/qiskit-ibm-runtime/dev/index.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/index.mdx @@ -13,5 +13,6 @@ description: API documentation for the qiskit-ibm-runtime client * [Transpiler scheduling passes (`qiskit_ibm_runtime.transpiler.passes.scheduling`)](qiskit_ibm_runtime.transpiler.passes.scheduling) * [Fake Provider (`qiskit_ibm_runtime.fake_provider`)](fake_provider) * [Execution Spans (`qiskit_ibm_runtime.execution_span`)](execution_span) +* [Debugging tools (`qiskit_ibm_runtime.debug_tools`)](debug_tools) * [Visualization (`qiskit_ibm_runtime.visualization`)](visualization) diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Estimator.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Estimator.mdx index a0ffb699faa..adcff6a2993 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Estimator.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Estimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Estimator # Estimator - + alias of [`EstimatorV2`](qiskit_ibm_runtime.EstimatorV2 "qiskit_ibm_runtime.estimator.EstimatorV2") diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV2.mdx index 08c625b853a..aed60da8c32 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.EstimatorV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2 # EstimatorV2 - + Class for interacting with Qiskit Runtime Estimator primitive service. Qiskit Runtime Estimator primitive service estimates expectation values of quantum circuits and observables. @@ -65,10 +65,6 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2 * **options** (`Union`\[`Dict`, [`EstimatorOptions`](qiskit_ibm_runtime.options.EstimatorOptions "qiskit_ibm_runtime.options.estimator_options.EstimatorOptions"), `None`]) – Estimator options, see `EstimatorOptions` for detailed description. - **Raises** - - **NotImplementedError** – If “q-ctrl” channel strategy is used. - ## Attributes ### mode @@ -103,7 +99,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2 ### run - + Submit a request to the estimator primitive. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.QiskitRuntimeService.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.QiskitRuntimeService.mdx index 7b0fe772993..e47ca47e92a 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.QiskitRuntimeService.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.QiskitRuntimeService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService # QiskitRuntimeService - + Class for interacting with the Qiskit Runtime service. QiskitRuntimeService constructor @@ -35,7 +35,6 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService * **instance** (`Optional`\[`str`]) – The service instance to use. For `ibm_cloud` runtime, this is the Cloud Resource Name (CRN) or the service name. For `ibm_quantum` runtime, this is the hub/group/project in that format. * **proxies** (`Optional`\[`dict`]) – Proxy configuration. Supported optional keys are `urls` (a dictionary mapping protocol or protocol and host to the URL of the proxy, documented at [https://docs.python-requests.org/en/latest/api/#requests.Session.proxies](https://docs.python-requests.org/en/latest/api/#requests.Session.proxies)), `username_ntlm`, `password_ntlm` (username and password to enable NTLM user authentication) * **verify** (`Optional`\[`bool`]) – Whether to verify the server’s TLS certificate. - * **channel\_strategy** (`Optional`\[`str`]) – (DEPRECATED) Error mitigation strategy. * **private\_endpoint** (`Optional`\[`bool`]) – Connect to private API URL. * **url\_resolver** (`Optional`\[`Callable`\[\[`str`, `str`, `Optional`\[`bool`]], `str`]]) – Function used to resolve the runtime url. @@ -71,7 +70,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### active\_account - + Return the IBM Quantum account currently in use for the session. **Return type** @@ -85,7 +84,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### backend - + Return a single backend matching the specified filtering. **Parameters** @@ -109,7 +108,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### backends - + Return all backends accessible via this account, subject to optional filtering. **Parameters** @@ -170,7 +169,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### check\_pending\_jobs - + Check the number of pending jobs and wait for the oldest pending job if the maximum number of pending jobs has been reached. **Return type** @@ -180,7 +179,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### delete\_account - + Delete a saved account from disk. **Parameters** @@ -200,7 +199,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### delete\_job - + Delete a runtime job. Note that this operation cannot be reversed. @@ -221,7 +220,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### instances - + Return the IBM Quantum instances list currently in use for the session. **Return type** @@ -235,7 +234,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### job - + Retrieve a runtime job. **Parameters** @@ -258,7 +257,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### jobs - + Retrieve all runtime jobs, subject to optional filtering. **Parameters** @@ -290,7 +289,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### least\_busy - + Return the least busy available backend. **Parameters** @@ -322,7 +321,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### save\_account - + Save the account to disk for future use. **Parameters** @@ -336,7 +335,6 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService * **proxies** (`Optional`\[`dict`]) – Proxy configuration. Supported optional keys are `urls` (a dictionary mapping protocol or protocol and host to the URL of the proxy, documented at [https://docs.python-requests.org/en/latest/api/#requests.Session.proxies](https://docs.python-requests.org/en/latest/api/#requests.Session.proxies)), `username_ntlm`, `password_ntlm` (username and password to enable NTLM user authentication) * **verify** (`Optional`\[`bool`]) – Verify the server’s TLS certificate. * **overwrite** (`Optional`\[`bool`]) – `True` if the existing account is to be overwritten. - * **channel\_strategy** (`Optional`\[`str`]) – (DEPRECATED) Error mitigation strategy. * **set\_as\_default** (`Optional`\[`bool`]) – If `True`, the account is saved in filename, as the default account. * **private\_endpoint** (`Optional`\[`bool`]) – Connect to private API URL. @@ -347,7 +345,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### saved\_accounts - + List the accounts saved on disk. **Parameters** @@ -372,7 +370,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### usage - + Return monthly open plan usage information. **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Sampler.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Sampler.mdx index f4432dfd554..c03c2bd6613 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Sampler.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Sampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.Sampler # Sampler - + alias of [`SamplerV2`](qiskit_ibm_runtime.SamplerV2 "qiskit_ibm_runtime.sampler.SamplerV2") diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV2.mdx index 266fb794ce4..ee08e49434a 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.SamplerV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.SamplerV2 # SamplerV2 - + Class for interacting with Qiskit Runtime Sampler primitive service. This class supports version 2 of the Sampler interface, which uses different input and output formats than version 1. @@ -33,10 +33,6 @@ python_api_name: qiskit_ibm_runtime.SamplerV2 * **options** (`Union`\[`Dict`, [`SamplerOptions`](qiskit_ibm_runtime.options.SamplerOptions "qiskit_ibm_runtime.options.sampler_options.SamplerOptions"), `None`]) – Sampler options, see `SamplerOptions` for detailed description. - **Raises** - - **NotImplementedError** – If “q-ctrl” channel strategy is used. - ## Attributes ### mode @@ -71,7 +67,7 @@ python_api_name: qiskit_ibm_runtime.SamplerV2 ### run - + Submit a request to the sampler primitive. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.debug_tools.Neat.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.debug_tools.Neat.mdx new file mode 100644 index 00000000000..1d79bc63635 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.debug_tools.Neat.mdx @@ -0,0 +1,119 @@ +--- +title: Neat +description: API reference for qiskit_ibm_runtime.debug_tools.Neat +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.debug_tools.Neat +--- + +# Neat + + + A class to help understand the expected performance of estimator jobs. + + The “Noisy Estimator Analyzer Tool” (or “NEAT”) is a convenience tool that users of the `Estimator` primitive can employ to analyze and predict the performance of their queries. Its simulate method uses `qiskit-aer` to simulate the estimation task classically efficiently, either in ideal conditions or in the presence of noise. The simulations’ results can be compared with other simulation results or with primitive results results to draw custom figures of merit. + + **Parameters** + + * **backend** ([`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)")) – A backend. + * **noise\_model** (`Optional`\[[`NoiseModel`](https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.noise.NoiseModel.html#qiskit_aer.noise.NoiseModel "(in Qiskit Aer v0.15.0)")]) – A noise model for the operations of the given backend. If `None`, it defaults to the noise model generated by `NoiseModel.from_backend()`. + + ## Attributes + + ### noise\_model + + + The noise model used by this analyzer tool for the noisy simulations. + + **Return type** + + [`NoiseModel`](https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.noise.NoiseModel.html#qiskit_aer.noise.NoiseModel "(in Qiskit Aer v0.15.0)") + + + ## Methods + + ### backend + + + The backend used by this analyzer tool. + + **Return type** + + [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)") + + + ### ideal\_sim + + + Perform an ideal, noiseless simulation of the estimator task specified by `pubs`. + + This function uses `qiskit-aer`’s `Estimator` class to simulate the estimation task classically. + + + To ensure scalability, every circuit in `pubs` is required to be a Clifford circuit, so that it can be simulated efficiently regardless of its size. For estimation tasks that involve non-Clifford circuits, the recommended workflow consists of mapping the non-Clifford circuits to the nearest Clifford circuits using the `ConvertISAToClifford` transpiler pass, or equivalently, to use the Neat’s [`to_clifford()`](#qiskit_ibm_runtime.debug_tools.Neat.to_clifford "qiskit_ibm_runtime.debug_tools.Neat.to_clifford") convenience method. Alternatively, setting `cliffordize` to `True` ensures that the [`to_clifford()`](#qiskit_ibm_runtime.debug_tools.Neat.to_clifford "qiskit_ibm_runtime.debug_tools.Neat.to_clifford") method is applied automatically to the given `pubs` prior to the simulation. + + + **Parameters** + + * **pubs** (`Sequence`\[`Union`\[`EstimatorPub`, `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.2)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]], `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.2)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]], `Mapping`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`, `Tuple`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`], `...`]], `Union`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `str`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]]], `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.2)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]], `Mapping`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`, `Tuple`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`], `...`]], `Union`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `str`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]], `Real`]]]) – The PUBs specifying the estimation task of interest. + * **cliffordize** (`bool`) – Whether or not to automatically apply the `ConvertISAToClifford` transpiler pass to the given `pubs` before performing the simulations. + * **seed\_simulator** (`Optional`\[`int`]) – A seed for the simulator. + * **precision** (`float`) – The target precision for the estimates of each expectation value in the returned results. + + **Return type** + + [`NeatResult`](qiskit_ibm_runtime.debug_tools.NeatResult "qiskit_ibm_runtime.debug_tools.neat_results.NeatResult") + + **Returns** + + The results of the simulation. + + + ### noisy\_sim + + + Perform a noisy simulation of the estimator task specified by `pubs`. + + This function uses `qiskit-aer`’s `Estimator` class to simulate the estimation task classically. + + + To ensure scalability, every circuit in `pubs` is required to be a Clifford circuit, so that it can be simulated efficiently regardless of its size. For estimation tasks that involve non-Clifford circuits, the recommended workflow consists of mapping the non-Clifford circuits to the nearest Clifford circuits using the `ConvertISAToClifford` transpiler pass, or equivalently, to use the Neat’s [`to_clifford()`](#qiskit_ibm_runtime.debug_tools.Neat.to_clifford "qiskit_ibm_runtime.debug_tools.Neat.to_clifford") convenience method. Alternatively, setting `cliffordize` to `True` ensures that the [`to_clifford()`](#qiskit_ibm_runtime.debug_tools.Neat.to_clifford "qiskit_ibm_runtime.debug_tools.Neat.to_clifford") method is applied automatically to the given `pubs` prior to the simulation. + + + **Parameters** + + * **pubs** (`Sequence`\[`Union`\[`EstimatorPub`, `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.2)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]], `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.2)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]], `Mapping`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`, `Tuple`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`], `...`]], `Union`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `str`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]]], `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.2)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]], `Mapping`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`, `Tuple`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`], `...`]], `Union`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `str`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]], `Real`]]]) – The PUBs specifying the estimation task of interest. + * **cliffordize** (`bool`) – Whether or not to automatically apply the `ConvertISAToClifford` transpiler pass to the given `pubs` before performing the simulations. + * **seed\_simulator** (`Optional`\[`int`]) – A seed for the simulator. + * **precision** (`float`) – The target precision for the estimates of each expectation value in the returned results. + + **Return type** + + [`NeatResult`](qiskit_ibm_runtime.debug_tools.NeatResult "qiskit_ibm_runtime.debug_tools.neat_results.NeatResult") + + **Returns** + + The results of the simulation. + + + ### to\_clifford + + + Return the cliffordized version of the given `pubs`. + + This convenience method runs the `ConvertISAToClifford` transpiler pass on the PUBs’ circuits. + + **Parameters** + + **pubs** (`Sequence`\[`Union`\[`EstimatorPub`, `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.2)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]], `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.2)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]], `Mapping`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`, `Tuple`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`], `...`]], `Union`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `str`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]]], `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.2)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]], `Mapping`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`, `Tuple`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`], `...`]], `Union`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `str`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]], `Real`]]]) – The PUBs to turn into Clifford PUBs. + + **Return type** + + `list`\[`EstimatorPub`] + + **Returns** + + The Clifford PUBs. + + + diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.debug_tools.NeatPubResult.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.debug_tools.NeatPubResult.mdx new file mode 100644 index 00000000000..963f5013297 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.debug_tools.NeatPubResult.mdx @@ -0,0 +1,42 @@ +--- +title: NeatPubResult +description: API reference for qiskit_ibm_runtime.debug_tools.NeatPubResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.debug_tools.NeatPubResult +--- + +# NeatPubResult + + + A class to store the PUB results of `Neat`. + + It allows performing mathematical operations (`+`, `-`, `*`, `/`, `abs`, and `**`) with other objects of type `NeatPubResultLike` and with scalars. + + **Parameters** + + **vals** (`Union`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `str`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]) – The values in this `NeatPubResult`. + + ## Attributes + + ### vals + + + The values in this result. + + **Return type** + + [`ndarray`](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)") + + + ## Methods + + ### \_\_mul\_\_ + + + **Return type** + + [`NeatPubResult`](#qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.neat_results.NeatPubResult") + + + diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.debug_tools.NeatResult.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.debug_tools.NeatResult.mdx new file mode 100644 index 00000000000..217b6649823 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.debug_tools.NeatResult.mdx @@ -0,0 +1,36 @@ +--- +title: NeatResult +description: API reference for qiskit_ibm_runtime.debug_tools.NeatResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.debug_tools.NeatResult +--- + +# NeatResult + + + A container for multiple [`NeatPubResult`](qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.NeatPubResult") objects. + + **Parameters** + + **pub\_results** (`Iterable`\[[`NeatPubResult`](qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.neat_results.NeatPubResult")]) – An iterable of [`NeatPubResult`](qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.NeatPubResult") objects. + + ## Methods + + ### \_\_getitem\_\_ + + + **Return type** + + [`NeatPubResult`](qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.neat_results.NeatPubResult") + + + ### \_\_len\_\_ + + + **Return type** + + `int` + + + diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx index c18e1ea73d0..4c0efa53d5e 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.DynamicalDecouplingOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.DynamicalDecouplingOptions # DynamicalDecouplingOptions - + Options for dynamical decoupling (DD). ## Attributes @@ -59,6 +59,16 @@ python_api_name: qiskit_ibm_runtime.options.DynamicalDecouplingOptions `tau/2 - (+X) - tau - (+Y) - tau (-X) - tau - (-Y) - tau/2` + ### skip\_reset\_qubits + + + Whether to insert DD on idle periods that immediately follow initialized/reset qubits. + + Since qubits in the ground state are less susceptible to decoherence, it can be beneficial to let them be while they are known to be in this state. + + Default: False. + + ## Methods diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.utils.noise_learner_result.LayerError.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.utils.noise_learner_result.LayerError.mdx index e0c1a9da907..bf0ac6d50a5 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.utils.noise_learner_result.LayerError.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.utils.noise_learner_result.LayerError.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.utils.noise_learner_result.LayerError # LayerError - + The error channel (in Pauli-Lindblad format) of a single layer of instructions. **Parameters** @@ -87,21 +87,47 @@ python_api_name: qiskit_ibm_runtime.utils.noise_learner_result.LayerError ### draw\_map - + Draw a map view of a this layer error. **Parameters** * **embedding** (`Union`\[`Embedding`, [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)")]) – An `Embedding` object containing the coordinates and coupling map to draw the layer error on, or a backend to generate an `Embedding` for. + * **colorscale** (`str`) – The colorscale used to show the rates of this layer error. + * **color\_no\_data** (`str`) – The color used for qubits and edges for which no data is available. + + * **color\_out\_of\_scale** (`str`) – The color used for rates with value greater than `highest_rate`. + * **num\_edge\_segments** (`int`) – The number of equal-sized segments that edges are made of. + * **edge\_width** (`float`) – The line width of the edges in pixels. + * **height** (`int`) – The height of the returned figure. + + * **highest\_rate** (`Optional`\[`float`]) – The highest rate, used to normalize all other rates before choosing their colors. If `None`, it defaults to the highest value found in the `layer_error`. + * **background\_color** (`str`) – The background color. + * **radius** (`float`) – The radius of the pie charts representing the qubits. + * **width** (`int`) – The width of the returned figure. + * **code:** (*..*) – + + python: from qiskit import QuantumCircuit from qiskit.quantum\_info import PauliList from qiskit\_ibm\_runtime.utils.embeddings import Embedding from qiskit\_ibm\_runtime.utils.noise\_learner\_result import LayerError, PauliLindbladError + + \# A five-qubit 1-D embedding with nearest neighbouring connectivity coordinates1 = \[(0, 0), (0, 1), (0, 2), (0, 3), (0, 4), (0, 5)] coupling\_map1 = \[(0, 1), (1, 2), (2, 3), (3, 4), (4, 5)] embedding1 = Embedding(coordinates1, coupling\_map1) + + \# A six-qubit horseshoe-shaped embedding with nearest neighbouring connectivity coordinates2 = \[(0, 0), (0, 1), (0, 2), (1, 0), (1, 1), (1, 2)] coupling\_map2 = \[(0, 1), (1, 2), (0, 3), (3, 4), (4, 5)] embedding2 = Embedding(coordinates2, coupling\_map2) + + \# A LayerError object circuit = QuantumCircuit(4) qubits = \[1, 2, 3, 4] generators = PauliList(\[“IIIX”, “IIXI”, “IXII”, “YIII”, “ZIII”, “XXII”, “ZZII”]) rates = \[0.01, 0.01, 0.01, 0.005, 0.02, 0.01, 0.01] error = PauliLindbladError(generators, rates) layer\_error = LayerError(circuit, qubits, error) + + \# Draw the layer error on embedding1 layer\_error.draw\_map(embedding1) + + \# Draw the layer error on embedding2 layer\_error.draw\_map(embedding2) + **Return type** `Figure` diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.visualization.draw_layer_error_map.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.visualization.draw_layer_error_map.mdx index c8ae23f7bdb..1ed7b7ddc88 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.visualization.draw_layer_error_map.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.visualization.draw_layer_error_map.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.visualization.draw_layer_error_map # draw\_layer\_error\_map - + Draw a map view of a [`LayerError`](qiskit_ibm_runtime.utils.noise_learner_result.LayerError "qiskit_ibm_runtime.utils.noise_learner_result.LayerError"). **Parameters** @@ -19,9 +19,11 @@ python_api_name: qiskit_ibm_runtime.visualization.draw_layer_error_map * **embedding** (`Union`\[`Embedding`, [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)")]) – An `Embedding` object containing the coordinates and coupling map to draw the layer error on, or a backend to generate an `Embedding` for. * **colorscale** (`str`) – The colorscale used to show the rates of `layer_error`. * **color\_no\_data** (`str`) – The color used for qubits and edges for which no data is available. + * **color\_out\_of\_scale** (`str`) – The color used for rates with value greater than `highest_rate`. * **num\_edge\_segments** (`int`) – The number of equal-sized segments that edges are made of. * **edge\_width** (`float`) – The line width of the edges in pixels. * **height** (`int`) – The height of the returned figure. + * **highest\_rate** (`Optional`\[`float`]) – The highest rate, used to normalize all other rates before choosing their colors. If `None`, it defaults to the highest value found in the `layer_error`. * **background\_color** (`str`) – The background color. * **radius** (`float`) – The radius of the pie charts representing the qubits. * **width** (`int`) – The width of the returned figure. diff --git a/docs/api/qiskit-ibm-runtime/index.mdx b/docs/api/qiskit-ibm-runtime/index.mdx index 9b94f073619..1a96e625b79 100644 --- a/docs/api/qiskit-ibm-runtime/index.mdx +++ b/docs/api/qiskit-ibm-runtime/index.mdx @@ -13,5 +13,6 @@ description: API documentation for the qiskit-ibm-runtime client * [Transpiler scheduling passes (`qiskit_ibm_runtime.transpiler.passes.scheduling`)](qiskit_ibm_runtime.transpiler.passes.scheduling) * [Fake Provider (`qiskit_ibm_runtime.fake_provider`)](fake_provider) * [Execution Spans (`qiskit_ibm_runtime.execution_span`)](execution_span) +* [Debugging tools (`qiskit_ibm_runtime.debug_tools`)](debug_tools) * [Visualization (`qiskit_ibm_runtime.visualization`)](visualization) diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.debug_tools.Neat.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.debug_tools.Neat.mdx new file mode 100644 index 00000000000..42088766f7a --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.debug_tools.Neat.mdx @@ -0,0 +1,119 @@ +--- +title: Neat +description: API reference for qiskit_ibm_runtime.debug_tools.Neat +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.debug_tools.Neat +--- + +# Neat + + + A class to help understand the expected performance of estimator jobs. + + The “Noisy Estimator Analyzer Tool” (or “NEAT”) is a convenience tool that users of the `Estimator` primitive can employ to analyze and predict the performance of their queries. Its simulate method uses `qiskit-aer` to simulate the estimation task classically efficiently, either in ideal conditions or in the presence of noise. The simulations’ results can be compared with other simulation results or with primitive results results to draw custom figures of merit. + + **Parameters** + + * **backend** ([`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)")) – A backend. + * **noise\_model** (`Optional`\[[`NoiseModel`](https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.noise.NoiseModel.html#qiskit_aer.noise.NoiseModel "(in Qiskit Aer v0.15.0)")]) – A noise model for the operations of the given backend. If `None`, it defaults to the noise model generated by `NoiseModel.from_backend()`. + + ## Attributes + + ### noise\_model + + + The noise model used by this analyzer tool for the noisy simulations. + + **Return type** + + [`NoiseModel`](https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.noise.NoiseModel.html#qiskit_aer.noise.NoiseModel "(in Qiskit Aer v0.15.0)") + + + ## Methods + + ### backend + + + The backend used by this analyzer tool. + + **Return type** + + [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)") + + + ### ideal\_sim + + + Perform an ideal, noiseless simulation of the estimator task specified by `pubs`. + + This function uses `qiskit-aer`’s `Estimator` class to simulate the estimation task classically. + + + To ensure scalability, every circuit in `pubs` is required to be a Clifford circuit, so that it can be simulated efficiently regardless of its size. For estimation tasks that involve non-Clifford circuits, the recommended workflow consists of mapping the non-Clifford circuits to the nearest Clifford circuits using the `ConvertISAToClifford` transpiler pass, or equivalently, to use the Neat’s [`to_clifford()`](#qiskit_ibm_runtime.debug_tools.Neat.to_clifford "qiskit_ibm_runtime.debug_tools.Neat.to_clifford") convenience method. Alternatively, setting `cliffordize` to `True` ensures that the [`to_clifford()`](#qiskit_ibm_runtime.debug_tools.Neat.to_clifford "qiskit_ibm_runtime.debug_tools.Neat.to_clifford") method is applied automatically to the given `pubs` prior to the simulation. + + + **Parameters** + + * **pubs** (`Sequence`\[`Union`\[`EstimatorPub`, `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.2)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]], `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.2)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]], `Mapping`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`, `Tuple`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`], `...`]], `Union`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `str`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]]], `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.2)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]], `Mapping`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`, `Tuple`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`], `...`]], `Union`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `str`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]], `Real`]]]) – The PUBs specifying the estimation task of interest. + * **cliffordize** (`bool`) – Whether or not to automatically apply the `ConvertISAToClifford` transpiler pass to the given `pubs` before performing the simulations. + * **seed\_simulator** (`Optional`\[`int`]) – A seed for the simulator. + * **precision** (`float`) – The target precision for the estimates of each expectation value in the returned results. + + **Return type** + + [`NeatResult`](qiskit_ibm_runtime.debug_tools.NeatResult "qiskit_ibm_runtime.debug_tools.neat_results.NeatResult") + + **Returns** + + The results of the simulation. + + + ### noisy\_sim + + + Perform a noisy simulation of the estimator task specified by `pubs`. + + This function uses `qiskit-aer`’s `Estimator` class to simulate the estimation task classically. + + + To ensure scalability, every circuit in `pubs` is required to be a Clifford circuit, so that it can be simulated efficiently regardless of its size. For estimation tasks that involve non-Clifford circuits, the recommended workflow consists of mapping the non-Clifford circuits to the nearest Clifford circuits using the `ConvertISAToClifford` transpiler pass, or equivalently, to use the Neat’s [`to_clifford()`](#qiskit_ibm_runtime.debug_tools.Neat.to_clifford "qiskit_ibm_runtime.debug_tools.Neat.to_clifford") convenience method. Alternatively, setting `cliffordize` to `True` ensures that the [`to_clifford()`](#qiskit_ibm_runtime.debug_tools.Neat.to_clifford "qiskit_ibm_runtime.debug_tools.Neat.to_clifford") method is applied automatically to the given `pubs` prior to the simulation. + + + **Parameters** + + * **pubs** (`Sequence`\[`Union`\[`EstimatorPub`, `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.2)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]], `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.2)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]], `Mapping`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`, `Tuple`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`], `...`]], `Union`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `str`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]]], `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.2)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]], `Mapping`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`, `Tuple`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`], `...`]], `Union`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `str`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]], `Real`]]]) – The PUBs specifying the estimation task of interest. + * **cliffordize** (`bool`) – Whether or not to automatically apply the `ConvertISAToClifford` transpiler pass to the given `pubs` before performing the simulations. + * **seed\_simulator** (`Optional`\[`int`]) – A seed for the simulator. + * **precision** (`float`) – The target precision for the estimates of each expectation value in the returned results. + + **Return type** + + [`NeatResult`](qiskit_ibm_runtime.debug_tools.NeatResult "qiskit_ibm_runtime.debug_tools.neat_results.NeatResult") + + **Returns** + + The results of the simulation. + + + ### to\_clifford + + + Return the cliffordized version of the given `pubs`. + + This convenience method runs the `ConvertISAToClifford` transpiler pass on the PUBs’ circuits. + + **Parameters** + + **pubs** (`Sequence`\[`Union`\[`EstimatorPub`, `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.2)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]], `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.2)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]], `Mapping`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`, `Tuple`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`], `...`]], `Union`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `str`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]]], `Tuple`\[[`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), `Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)"), [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "(in Qiskit v1.2)"), `Mapping`\[`Union`\[`str`, [`Pauli`](/api/qiskit/qiskit.quantum_info.Pauli "(in Qiskit v1.2)")], `float`], `_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]], `Mapping`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`, `Tuple`\[`Union`\[[`Parameter`](/api/qiskit/qiskit.circuit.Parameter "(in Qiskit v1.2)"), `str`], `...`]], `Union`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `str`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]], `Real`]]]) – The PUBs to turn into Clifford PUBs. + + **Return type** + + `list`\[`EstimatorPub`] + + **Returns** + + The Clifford PUBs. + + + diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.debug_tools.NeatPubResult.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.debug_tools.NeatPubResult.mdx new file mode 100644 index 00000000000..544ead60137 --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.debug_tools.NeatPubResult.mdx @@ -0,0 +1,42 @@ +--- +title: NeatPubResult +description: API reference for qiskit_ibm_runtime.debug_tools.NeatPubResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.debug_tools.NeatPubResult +--- + +# NeatPubResult + + + A class to store the PUB results of `Neat`. + + It allows performing mathematical operations (`+`, `-`, `*`, `/`, `abs`, and `**`) with other objects of type `NeatPubResultLike` and with scalars. + + **Parameters** + + **vals** (`Union`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]], `_NestedSequence`\[`_SupportsArray`\[[`dtype`](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.1)")\[`Any`]]], `bool`, `int`, `float`, `complex`, `str`, `bytes`, `_NestedSequence`\[`Union`\[`bool`, `int`, `float`, `complex`, `str`, `bytes`]]]) – The values in this `NeatPubResult`. + + ## Attributes + + ### vals + + + The values in this result. + + **Return type** + + [`ndarray`](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)") + + + ## Methods + + ### \_\_mul\_\_ + + + **Return type** + + [`NeatPubResult`](#qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.neat_results.NeatPubResult") + + + diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.debug_tools.NeatResult.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.debug_tools.NeatResult.mdx new file mode 100644 index 00000000000..c5f6bd9daec --- /dev/null +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.debug_tools.NeatResult.mdx @@ -0,0 +1,36 @@ +--- +title: NeatResult +description: API reference for qiskit_ibm_runtime.debug_tools.NeatResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_runtime.debug_tools.NeatResult +--- + +# NeatResult + + + A container for multiple [`NeatPubResult`](qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.NeatPubResult") objects. + + **Parameters** + + **pub\_results** (`Iterable`\[[`NeatPubResult`](qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.neat_results.NeatPubResult")]) – An iterable of [`NeatPubResult`](qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.NeatPubResult") objects. + + ## Methods + + ### \_\_getitem\_\_ + + + **Return type** + + [`NeatPubResult`](qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.neat_results.NeatPubResult") + + + ### \_\_len\_\_ + + + **Return type** + + `int` + + + diff --git a/docs/api/qiskit/dev/circuit_library.mdx b/docs/api/qiskit/dev/circuit_library.mdx index 68dca3de60d..9525b9f9554 100644 --- a/docs/api/qiskit/dev/circuit_library.mdx +++ b/docs/api/qiskit/dev/circuit_library.mdx @@ -323,7 +323,15 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_2a\_1 - + + Template 2a\_1: + + ```python + ┌───┐┌───┐ + q_0: ┤ X ├┤ X ├ + └───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -335,7 +343,16 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_2a\_2 - + + Template 2a\_2: + + ```python + q_0: ──■────■── + ┌─┴─┐┌─┴─┐ + q_1: ┤ X ├┤ X ├ + └───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -347,7 +364,18 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_2a\_3 - + + Template 2a\_3: + + ```python + q_0: ──■────■── + │ │ + q_1: ──■────■── + ┌─┴─┐┌─┴─┐ + q_2: ┤ X ├┤ X ├ + └───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -359,7 +387,22 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_4a\_1 - + + Template 4a\_1: + + ```python + q_0: ───────■─────────■── + │ │ + q_1: ──■────┼────■────┼── + │ │ │ │ + q_2: ──■────■────■────■── + │ ┌─┴─┐ │ ┌─┴─┐ + q_3: ──┼──┤ X ├──┼──┤ X ├ + ┌─┴─┐└───┘┌─┴─┐└───┘ + q_4: ┤ X ├─────┤ X ├───── + └───┘ └───┘ + ``` + **Returns** template as a quantum circuit. @@ -371,7 +414,20 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_4a\_2 - + + Template 4a\_2: + + ```python + q_0: ──■─────────■─────── + │ │ + q_1: ──■────■────■────■── + │ ┌─┴─┐ │ ┌─┴─┐ + q_2: ──┼──┤ X ├──┼──┤ X ├ + ┌─┴─┐└───┘┌─┴─┐└───┘ + q_3: ┤ X ├─────┤ X ├───── + └───┘ └───┘ + ``` + **Returns** template as a quantum circuit. @@ -383,7 +439,18 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_4a\_3 - + + Template 4a\_3: + + ```python + q_0: ──■────■────■────■── + │ ┌─┴─┐ │ ┌─┴─┐ + q_1: ──┼──┤ X ├──┼──┤ X ├ + ┌─┴─┐└───┘┌─┴─┐└───┘ + q_2: ┤ X ├─────┤ X ├───── + └───┘ └───┘ + ``` + **Returns** template as a quantum circuit. @@ -395,7 +462,20 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_4b\_1 - + + Template 4b\_1: + + ```python + q_0: ───────■─────────■── + │ │ + q_1: ──■────┼────■────┼── + │ │ │ │ + q_2: ──■────■────■────■── + ┌─┴─┐┌─┴─┐┌─┴─┐┌─┴─┐ + q_3: ┤ X ├┤ X ├┤ X ├┤ X ├ + └───┘└───┘└───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -407,7 +487,18 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_4b\_2 - + + Template 4b\_2: + + ```python + q_0: ──■─────────■─────── + │ │ + q_1: ──■────■────■────■── + ┌─┴─┐┌─┴─┐┌─┴─┐┌─┴─┐ + q_2: ┤ X ├┤ X ├┤ X ├┤ X ├ + └───┘└───┘└───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -419,7 +510,18 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_5a\_1 - + + Template 5a\_1: + + ```python + q_0: ──■────■────■────■────■── + │ ┌─┴─┐ │ ┌─┴─┐ │ + q_1: ──■──┤ X ├──■──┤ X ├──┼── + ┌─┴─┐└───┘┌─┴─┐└───┘┌─┴─┐ + q_2: ┤ X ├─────┤ X ├─────┤ X ├ + └───┘ └───┘ └───┘ + ``` + **Returns** template as a quantum circuit. @@ -431,7 +533,18 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_5a\_2 - + + Template 5a\_2: + + ```python + q_0: ──■─────────■─────────■── + │ ┌───┐ │ ┌───┐ │ + q_1: ──■──┤ X ├──■──┤ X ├──┼── + ┌─┴─┐└───┘┌─┴─┐└───┘┌─┴─┐ + q_2: ┤ X ├─────┤ X ├─────┤ X ├ + └───┘ └───┘ └───┘ + ``` + **Returns** template as a quantum circuit. @@ -443,7 +556,18 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_5a\_3 - + + Template 5a\_3: + + ```python + q_0: ───────■─────────■────■── + ┌─┴─┐ ┌─┴─┐ │ + q_1: ──■──┤ X ├──■──┤ X ├──┼── + ┌─┴─┐└───┘┌─┴─┐└───┘┌─┴─┐ + q_2: ┤ X ├─────┤ X ├─────┤ X ├ + └───┘ └───┘ └───┘ + ``` + **Returns** template as a quantum circuit. @@ -455,7 +579,17 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_5a\_4 - + + Template 5a\_4: + + ```python + ┌───┐ ┌───┐ + q_0: ──■──┤ X ├──■──┤ X ├ + ┌─┴─┐└───┘┌─┴─┐├───┤ + q_1: ┤ X ├─────┤ X ├┤ X ├ + └───┘ └───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -467,7 +601,17 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_6a\_1 - + + Template 6a\_1: + + ```python + ┌───┐ ┌───┐ ┌───┐ + q_0: ──■──┤ X ├──■──┤ X ├──■──┤ X ├ + ┌─┴─┐└─┬─┘┌─┴─┐└─┬─┘┌─┴─┐└─┬─┘ + q_1: ┤ X ├──■──┤ X ├──■──┤ X ├──■── + └───┘ └───┘ └───┘ + ``` + **Returns** template as a quantum circuit. @@ -479,7 +623,18 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_6a\_2 - + + Template 6a\_2: + + ```python + q_0: ──■────■────■────■────■────■── + │ ┌─┴─┐ │ ┌─┴─┐ │ ┌─┴─┐ + q_1: ──■──┤ X ├──■──┤ X ├──■──┤ X ├ + ┌─┴─┐└─┬─┘┌─┴─┐└─┬─┘┌─┴─┐└─┬─┘ + q_2: ┤ X ├──■──┤ X ├──■──┤ X ├──■── + └───┘ └───┘ └───┘ + ``` + **Returns** template as a quantum circuit. @@ -491,7 +646,18 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_6a\_3 - + + Template 6a\_3: + + ```python + q_0: ───────■─────────■────■────■── + ┌─┴─┐ ┌─┴─┐ │ ┌─┴─┐ + q_1: ──■──┤ X ├──■──┤ X ├──■──┤ X ├ + ┌─┴─┐└─┬─┘┌─┴─┐└─┬─┘┌─┴─┐└─┬─┘ + q_2: ┤ X ├──■──┤ X ├──■──┤ X ├──■── + └───┘ └───┘ └───┘ + ``` + **Returns** template as a quantum circuit. @@ -503,7 +669,18 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_6a\_4 - + + Template 6a\_4: + + ```python + q_0: ───────■──────────────■─────── + ┌─┴─┐ ┌───┐ │ ┌───┐ + q_1: ──■──┤ X ├──■──┤ X ├──■──┤ X ├ + ┌─┴─┐└─┬─┘┌─┴─┐└─┬─┘┌─┴─┐└─┬─┘ + q_2: ┤ X ├──■──┤ X ├──■──┤ X ├──■── + └───┘ └───┘ └───┘ + ``` + **Returns** template as a quantum circuit. @@ -515,7 +692,18 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_6b\_1 - + + Template 6b\_1: + + ```python + q_0: ──■─────────■────■─────────■── + │ ┌─┴─┐ │ ┌─┴─┐ + q_1: ──■────■──┤ X ├──■────■──┤ X ├ + ┌─┴─┐┌─┴─┐└─┬─┘┌─┴─┐┌─┴─┐└─┬─┘ + q_2: ┤ X ├┤ X ├──■──┤ X ├┤ X ├──■── + └───┘└───┘ └───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -527,7 +715,18 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_6b\_2 - + + Template 6b\_2: + + ```python + q_0: ───────■────■─────────■────■── + │ ┌─┴─┐ │ ┌─┴─┐ + q_1: ──■────■──┤ X ├──■────■──┤ X ├ + ┌─┴─┐┌─┴─┐└─┬─┘┌─┴─┐┌─┴─┐└─┬─┘ + q_2: ┤ X ├┤ X ├──■──┤ X ├┤ X ├──■── + └───┘└───┘ └───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -539,7 +738,18 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_6c\_1 - + + Template 6c\_1: + + ```python + q_0: ──■─────────■─────────■────■── + │ ┌───┐ │ ┌───┐ │ ┌─┴─┐ + q_1: ──■──┤ X ├──■──┤ X ├──■──┤ X ├ + ┌─┴─┐└─┬─┘┌─┴─┐└─┬─┘┌─┴─┐└─┬─┘ + q_2: ┤ X ├──■──┤ X ├──■──┤ X ├──■── + └───┘ └───┘ └───┘ + ``` + **Returns** template as a quantum circuit. @@ -551,7 +761,19 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_7a\_1 - + + Template 7a\_1: + + ```python + ┌───┐ ┌───┐ + q_0: ┤ X ├──■─────────■────■──┤ X ├──■── + └─┬─┘┌─┴─┐ │ ┌─┴─┐└─┬─┘ │ + q_1: ──■──┤ X ├──■────■──┤ X ├──■────■── + └───┘┌─┴─┐┌─┴─┐└───┘ ┌─┴─┐ + q_2: ──────────┤ X ├┤ X ├──────────┤ X ├ + └───┘└───┘ └───┘ + ``` + **Returns** template as a quantum circuit. @@ -563,7 +785,19 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_7b\_1 - + + Template 7b\_1: + + ```python + ┌───┐ ┌───┐ + q_0: ┤ X ├──■─────────■────■──┤ X ├──■── + └───┘┌─┴─┐ │ ┌─┴─┐└───┘ │ + q_1: ─────┤ X ├──■────■──┤ X ├───────■── + └───┘┌─┴─┐┌─┴─┐└───┘ ┌─┴─┐ + q_2: ──────────┤ X ├┤ X ├──────────┤ X ├ + └───┘└───┘ └───┘ + ``` + **Returns** template as a quantum circuit. @@ -575,7 +809,19 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_7c\_1 - + + Template 7c\_1: + + ```python + ┌───┐ ┌───┐ + q_0: ┤ X ├──■─────────■────■──┤ X ├──■── + └───┘┌─┴─┐ │ ┌─┴─┐└───┘ │ + q_1: ─────┤ X ├──■────■──┤ X ├───────■── + └─┬─┘┌─┴─┐┌─┴─┐└─┬─┘ ┌─┴─┐ + q_2: ───────■──┤ X ├┤ X ├──■───────┤ X ├ + └───┘└───┘ └───┘ + ``` + **Returns** template as a quantum circuit. @@ -587,7 +833,19 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_7d\_1 - + + Template 7d\_1: + + ```python + ┌───┐ ┌───┐ + q_0: ┤ X ├──■─────────■────■──┤ X ├──■── + └─┬─┘┌─┴─┐ │ ┌─┴─┐└─┬─┘ │ + q_1: ──■──┤ X ├──■────■──┤ X ├──■────■── + └─┬─┘┌─┴─┐┌─┴─┐└─┬─┘ ┌─┴─┐ + q_2: ───────■──┤ X ├┤ X ├──■───────┤ X ├ + └───┘└───┘ └───┘ + ``` + **Returns** template as a quantum circuit. @@ -599,7 +857,19 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_7e\_1 - + + Template 7e\_1: + + ```python + ┌───┐ ┌───┐ + q_0: ┤ X ├──■─────────■────■──┤ X ├──■── + └───┘┌─┴─┐ │ ┌─┴─┐└───┘ │ + q_1: ─────┤ X ├───────┼──┤ X ├───────┼── + └─┬─┘┌───┐┌─┴─┐└─┬─┘ ┌─┴─┐ + q_2: ───────■──┤ X ├┤ X ├──■───────┤ X ├ + └───┘└───┘ └───┘ + ``` + **Returns** template as a quantum circuit. @@ -611,7 +881,19 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_9a\_1 - + + Template 9a\_1: + + ```python + ┌───┐ ┌───┐ ┌───┐ + q_0: ┤ X ├──■──┤ X ├──■────■──┤ X ├──■── + └─┬─┘┌─┴─┐└─┬─┘┌─┴─┐┌─┴─┐└─┬─┘┌─┴─┐ + q_1: ──■──┤ X ├──■──┤ X ├┤ X ├──■──┤ X ├ + └─┬─┘ │ ├───┤└─┬─┘┌───┐└─┬─┘ + q_2: ───────■────■──┤ X ├──■──┤ X ├──■── + └───┘ └───┘ + ``` + **Returns** template as a quantum circuit. @@ -623,7 +905,17 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_9c\_1 - + + Template 9c\_1: + + ```python + ┌───┐ ┌───┐┌───┐ ┌───┐ ┌───┐ + q_0: ┤ X ├──■──┤ X ├┤ X ├─────┤ X ├──■───────┤ X ├ + └─┬─┘┌─┴─┐└───┘└─┬─┘┌───┐└─┬─┘┌─┴─┐┌───┐└─┬─┘ + q_1: ──■──┤ X ├───────■──┤ X ├──■──┤ X ├┤ X ├──■── + └───┘ └───┘ └───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -635,7 +927,18 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_9c\_2 - + + Template 9c\_2: + + ```python + q_0: ───────■────■──────────────■────■─────────■── + ┌───┐ │ ┌─┴─┐┌───┐ ┌─┴─┐ │ ┌─┴─┐ + q_1: ┤ X ├──■──┤ X ├┤ X ├─────┤ X ├──■───────┤ X ├ + └─┬─┘┌─┴─┐└───┘└─┬─┘┌───┐└─┬─┘┌─┴─┐┌───┐└─┬─┘ + q_2: ──■──┤ X ├───────■──┤ X ├──■──┤ X ├┤ X ├──■── + └───┘ └───┘ └───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -647,7 +950,18 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_9c\_3 - + + Template 9c\_3: + + ```python + q_0: ───────■────────────────────────■──────────── + ┌───┐ │ ┌───┐┌───┐ ┌───┐ │ ┌───┐ + q_1: ┤ X ├──■──┤ X ├┤ X ├─────┤ X ├──■───────┤ X ├ + └─┬─┘┌─┴─┐└───┘└─┬─┘┌───┐└─┬─┘┌─┴─┐┌───┐└─┬─┘ + q_2: ──■──┤ X ├───────■──┤ X ├──■──┤ X ├┤ X ├──■── + └───┘ └───┘ └───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -659,7 +973,18 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_9c\_4 - + + Template 9c\_4: + + ```python + q_0: ──■────■─────────■──────────────■──────────── + ┌─┴─┐ │ ┌───┐┌─┴─┐ ┌───┐ │ ┌───┐ + q_1: ┤ X ├──■──┤ X ├┤ X ├─────┤ X ├──■───────┤ X ├ + └─┬─┘┌─┴─┐└───┘└─┬─┘┌───┐└─┬─┘┌─┴─┐┌───┐└─┬─┘ + q_2: ──■──┤ X ├───────■──┤ X ├──■──┤ X ├┤ X ├──■── + └───┘ └───┘ └───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -671,7 +996,18 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_9c\_5 - + + Template 9c\_5: + + ```python + q_0: ────────────■─────────■──────────────■─────── + ┌───┐ ┌─┴─┐┌───┐ │ ┌───┐ │ ┌───┐ + q_1: ┤ X ├──■──┤ X ├┤ X ├──┼──┤ X ├──■────┼──┤ X ├ + └─┬─┘┌─┴─┐└───┘└─┬─┘┌─┴─┐└─┬─┘┌─┴─┐┌─┴─┐└─┬─┘ + q_2: ──■──┤ X ├───────■──┤ X ├──■──┤ X ├┤ X ├──■── + └───┘ └───┘ └───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -683,7 +1019,18 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_9c\_6 - + + Template 9c\_6: + + ```python + q_0: ───────■────■─────────■─────────■────■─────── + ┌───┐ │ ┌─┴─┐┌───┐ │ ┌───┐ │ │ ┌───┐ + q_1: ┤ X ├──■──┤ X ├┤ X ├──┼──┤ X ├──■────┼──┤ X ├ + └─┬─┘┌─┴─┐└───┘└─┬─┘┌─┴─┐└─┬─┘┌─┴─┐┌─┴─┐└─┬─┘ + q_2: ──■──┤ X ├───────■──┤ X ├──■──┤ X ├┤ X ├──■── + └───┘ └───┘ └───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -695,7 +1042,18 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_9c\_7 - + + Template 9c\_7: + + ```python + q_0: ──■────■────■────■────■─────────■────■─────── + ┌─┴─┐ │ ┌─┴─┐┌─┴─┐ │ ┌───┐ │ │ ┌───┐ + q_1: ┤ X ├──■──┤ X ├┤ X ├──┼──┤ X ├──■────┼──┤ X ├ + └─┬─┘┌─┴─┐└───┘└─┬─┘┌─┴─┐└─┬─┘┌─┴─┐┌─┴─┐└─┬─┘ + q_2: ──■──┤ X ├───────■──┤ X ├──■──┤ X ├┤ X ├──■── + └───┘ └───┘ └───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -707,7 +1065,18 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_9c\_8 - + + Template 9c\_8: + + ```python + q_0: ──■─────────■────■─────────■──────────────■── + ┌─┴─┐ ┌─┴─┐┌─┴─┐ ┌─┴─┐ ┌─┴─┐ + q_1: ┤ X ├──■──┤ X ├┤ X ├─────┤ X ├──■───────┤ X ├ + └─┬─┘┌─┴─┐└───┘└─┬─┘┌───┐└─┬─┘┌─┴─┐┌───┐└─┬─┘ + q_2: ──■──┤ X ├───────■──┤ X ├──■──┤ X ├┤ X ├──■── + └───┘ └───┘ └───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -719,7 +1088,18 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_9c\_9 - + + Template 9c\_9: + + ```python + q_0: ──■────■────■────■─────────■────■─────────■── + ┌─┴─┐ │ ┌─┴─┐┌─┴─┐ ┌─┴─┐ │ ┌─┴─┐ + q_1: ┤ X ├──■──┤ X ├┤ X ├─────┤ X ├──■───────┤ X ├ + └─┬─┘┌─┴─┐└───┘└─┬─┘┌───┐└─┬─┘┌─┴─┐┌───┐└─┬─┘ + q_2: ──■──┤ X ├───────■──┤ X ├──■──┤ X ├┤ X ├──■── + └───┘ └───┘ └───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -731,7 +1111,18 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_9c\_10 - + + Template 9c\_10: + + ```python + q_0: ──■─────────■────■────■────■─────────■────■── + ┌─┴─┐ ┌─┴─┐┌─┴─┐ │ ┌─┴─┐ │ ┌─┴─┐ + q_1: ┤ X ├──■──┤ X ├┤ X ├──┼──┤ X ├──■────┼──┤ X ├ + └─┬─┘┌─┴─┐└───┘└─┬─┘┌─┴─┐└─┬─┘┌─┴─┐┌─┴─┐└─┬─┘ + q_2: ──■──┤ X ├───────■──┤ X ├──■──┤ X ├┤ X ├──■── + └───┘ └───┘ └───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -743,7 +1134,18 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_9c\_11 - + + Template 9c\_11: + + ```python + q_0: ───────■────■─────────■────■────■────■────■── + ┌───┐ │ ┌─┴─┐┌───┐ │ ┌─┴─┐ │ │ ┌─┴─┐ + q_1: ┤ X ├──■──┤ X ├┤ X ├──┼──┤ X ├──■────┼──┤ X ├ + └─┬─┘┌─┴─┐└───┘└─┬─┘┌─┴─┐└─┬─┘┌─┴─┐┌─┴─┐└─┬─┘ + q_2: ──■──┤ X ├───────■──┤ X ├──■──┤ X ├┤ X ├──■── + └───┘ └───┘ └───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -755,7 +1157,18 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_9c\_12 - + + Template 9c\_12: + + ```python + q_0: ──■────■────■────■────■────■────■────■────■── + ┌─┴─┐ │ ┌─┴─┐┌─┴─┐ │ ┌─┴─┐ │ │ ┌─┴─┐ + q_1: ┤ X ├──■──┤ X ├┤ X ├──┼──┤ X ├──■────┼──┤ X ├ + └─┬─┘┌─┴─┐└───┘└─┬─┘┌─┴─┐└─┬─┘┌─┴─┐┌─┴─┐└─┬─┘ + q_2: ──■──┤ X ├───────■──┤ X ├──■──┤ X ├┤ X ├──■── + └───┘ └───┘ └───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -767,7 +1180,17 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_9d\_1 - + + Template 9d\_1: + + ```python + ┌───┐ ┌───┐ ┌───┐ + q_0: ──■───────┤ X ├───────■──┤ X ├───────■──┤ X ├ + ┌─┴─┐┌───┐└─┬─┘┌───┐┌─┴─┐└─┬─┘┌───┐┌─┴─┐└─┬─┘ + q_1: ┤ X ├┤ X ├──■──┤ X ├┤ X ├──■──┤ X ├┤ X ├──■── + └───┘└───┘ └───┘└───┘ └───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -779,7 +1202,18 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_9d\_2 - + + Template 9d\_2: + + ```python + q_0: ──■────■────■──────────────■──────────────■── + │ │ ┌─┴─┐ ┌─┴─┐ ┌─┴─┐ + q_1: ──■────┼──┤ X ├───────■──┤ X ├───────■──┤ X ├ + ┌─┴─┐┌─┴─┐└─┬─┘┌───┐┌─┴─┐└─┬─┘┌───┐┌─┴─┐└─┬─┘ + q_2: ┤ X ├┤ X ├──■──┤ X ├┤ X ├──■──┤ X ├┤ X ├──■── + └───┘└───┘ └───┘└───┘ └───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -791,7 +1225,18 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_9d\_3 - + + Template 9d\_3: + + ```python + q_0: ──■────■───────────────────■───────────────── + │ │ ┌───┐ ┌─┴─┐ ┌───┐ + q_1: ──■────┼──┤ X ├───────■──┤ X ├───────■──┤ X ├ + ┌─┴─┐┌─┴─┐└─┬─┘┌───┐┌─┴─┐└─┬─┘┌───┐┌─┴─┐└─┬─┘ + q_2: ┤ X ├┤ X ├──■──┤ X ├┤ X ├──■──┤ X ├┤ X ├──■── + └───┘└───┘ └───┘└───┘ └───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -803,7 +1248,18 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_9d\_4 - + + Template 9d\_4: + + ```python + q_0: ───────■─────────■──────────────■──────────── + │ ┌───┐ │ ┌───┐ │ ┌───┐ + q_1: ──■────┼──┤ X ├──┼────■──┤ X ├──┼────■──┤ X ├ + ┌─┴─┐┌─┴─┐└─┬─┘┌─┴─┐┌─┴─┐└─┬─┘┌─┴─┐┌─┴─┐└─┬─┘ + q_2: ┤ X ├┤ X ├──■──┤ X ├┤ X ├──■──┤ X ├┤ X ├──■── + └───┘└───┘ └───┘└───┘ └───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -815,7 +1271,18 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_9d\_5 - + + Template 9d\_5: + + ```python + q_0: ──■────■─────────■─────────■────■──────────── + │ │ ┌───┐ │ ┌─┴─┐ │ ┌───┐ + q_1: ──■────┼──┤ X ├──┼────■──┤ X ├──┼────■──┤ X ├ + ┌─┴─┐┌─┴─┐└─┬─┘┌─┴─┐┌─┴─┐└─┬─┘┌─┴─┐┌─┴─┐└─┬─┘ + q_2: ┤ X ├┤ X ├──■──┤ X ├┤ X ├──■──┤ X ├┤ X ├──■── + └───┘└───┘ └───┘└───┘ └───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -827,7 +1294,18 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_9d\_6 - + + Template 9d\_6: + + ```python + q_0: ──■────■──────────────■────■─────────■─────── + │ │ ┌───┐ │ ┌─┴─┐ │ ┌───┐ + q_1: ──■────┼──┤ X ├───────■──┤ X ├───────■──┤ X ├ + ┌─┴─┐┌─┴─┐└─┬─┘┌───┐┌─┴─┐└─┬─┘┌───┐┌─┴─┐└─┬─┘ + q_2: ┤ X ├┤ X ├──■──┤ X ├┤ X ├──■──┤ X ├┤ X ├──■── + └───┘└───┘ └───┘└───┘ └───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -839,7 +1317,18 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_9d\_7 - + + Template 9d\_7: + + ```python + q_0: ──■────■─────────■────■────■────■────■─────── + │ │ ┌───┐ │ │ ┌─┴─┐ │ │ ┌───┐ + q_1: ──■────┼──┤ X ├──┼────■──┤ X ├──┼────■──┤ X ├ + ┌─┴─┐┌─┴─┐└─┬─┘┌─┴─┐┌─┴─┐└─┬─┘┌─┴─┐┌─┴─┐└─┬─┘ + q_2: ┤ X ├┤ X ├──■──┤ X ├┤ X ├──■──┤ X ├┤ X ├──■── + └───┘└───┘ └───┘└───┘ └───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -851,7 +1340,18 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_9d\_8 - + + Template 9d\_8: + + ```python + q_0: ──■────■────■────■─────────■────■─────────■── + │ │ ┌─┴─┐ │ ┌─┴─┐ │ ┌─┴─┐ + q_1: ──■────┼──┤ X ├──┼────■──┤ X ├──┼────■──┤ X ├ + ┌─┴─┐┌─┴─┐└─┬─┘┌─┴─┐┌─┴─┐└─┬─┘┌─┴─┐┌─┴─┐└─┬─┘ + q_2: ┤ X ├┤ X ├──■──┤ X ├┤ X ├──■──┤ X ├┤ X ├──■── + └───┘└───┘ └───┘└───┘ └───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -863,7 +1363,18 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_9d\_9 - + + Template 9d\_9: + + ```python + q_0: ──■────■────■─────────■────■─────────■────■── + │ │ ┌─┴─┐ │ ┌─┴─┐ │ ┌─┴─┐ + q_1: ──■────┼──┤ X ├───────■──┤ X ├───────■──┤ X ├ + ┌─┴─┐┌─┴─┐└─┬─┘┌───┐┌─┴─┐└─┬─┘┌───┐┌─┴─┐└─┬─┘ + q_2: ┤ X ├┤ X ├──■──┤ X ├┤ X ├──■──┤ X ├┤ X ├──■── + └───┘└───┘ └───┘└───┘ └───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -875,7 +1386,18 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib #### template\_nct\_9d\_10 - + + Template 9d\_10: + + ```python + q_0: ──■────■────■────■────■────■────■────■────■── + │ │ ┌─┴─┐ │ │ ┌─┴─┐ │ │ ┌─┴─┐ + q_1: ──■────┼──┤ X ├──┼────■──┤ X ├──┼────■──┤ X ├ + ┌─┴─┐┌─┴─┐└─┬─┘┌─┴─┐┌─┴─┐└─┬─┘┌─┴─┐┌─┴─┐└─┬─┘ + q_2: ┤ X ├┤ X ├──■──┤ X ├┤ X ├──■──┤ X ├┤ X ├──■── + └───┘└───┘ └───┘└───┘ └───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -891,7 +1413,15 @@ Template circuits over Clifford gates. #### clifford\_2\_1 - + + Clifford template 2\_1: + + ```python + q_0: ─■──■─ + │ │ + q_1: ─■──■─ + ``` + **Returns** template as a quantum circuit. @@ -903,7 +1433,16 @@ Template circuits over Clifford gates. #### clifford\_2\_2 - + + Clifford template 2\_2: + + ```python + q_0: ──■────■── + ┌─┴─┐┌─┴─┐ + q_1: ┤ X ├┤ X ├ + └───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -915,7 +1454,15 @@ Template circuits over Clifford gates. #### clifford\_2\_3 - + + Clifford template 2\_3: + + ```python + ┌───┐┌───┐ + q_0: ┤ H ├┤ H ├ + └───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -927,7 +1474,15 @@ Template circuits over Clifford gates. #### clifford\_2\_4 - + + Clifford template 2\_4: + + ```python + q_0: ─X──X─ + │ │ + q_1: ─X──X─ + ``` + **Returns** template as a quantum circuit. @@ -939,7 +1494,15 @@ Template circuits over Clifford gates. #### clifford\_3\_1 - + + Clifford template 3\_1: + + ```python + ┌───┐┌───┐┌───┐ + q_0: ┤ S ├┤ S ├┤ Z ├ + └───┘└───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -951,7 +1514,17 @@ Template circuits over Clifford gates. #### clifford\_4\_1 - + + Clifford template 4\_1: + + ```python + ┌───┐ + q_0: ──■──┤ X ├──■───X─ + ┌─┴─┐└─┬─┘┌─┴─┐ │ + q_1: ┤ X ├──■──┤ X ├─X─ + └───┘ └───┘ + ``` + **Returns** template as a quantum circuit. @@ -963,7 +1536,16 @@ Template circuits over Clifford gates. #### clifford\_4\_2 - + + Clifford template 4\_2: + + ```python + q_0: ───────■────────■─ + ┌───┐┌─┴─┐┌───┐ │ + q_1: ┤ H ├┤ X ├┤ H ├─■─ + └───┘└───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -975,7 +1557,17 @@ Template circuits over Clifford gates. #### clifford\_4\_3 - + + Clifford template 4\_3: + + ```python + ┌───┐ ┌─────┐ + q_0: ┤ S ├──■──┤ SDG ├──■── + └───┘┌─┴─┐└─────┘┌─┴─┐ + q_1: ─────┤ X ├───────┤ X ├ + └───┘ └───┘ + ``` + **Returns** template as a quantum circuit. @@ -987,7 +1579,16 @@ Template circuits over Clifford gates. #### clifford\_4\_4 - + + Clifford template 4\_4: + + ```python + ┌───┐ ┌─────┐ + q_0: ┤ S ├─■─┤ SDG ├─■─ + └───┘ │ └─────┘ │ + q_1: ──────■─────────■─ + ``` + **Returns** template as a quantum circuit. @@ -999,7 +1600,18 @@ Template circuits over Clifford gates. #### clifford\_5\_1 - + + Clifford template 5\_1: + + > ```python + > q_0: ──■─────────■─────────■── + > ┌─┴─┐ ┌─┴─┐ │ + > q_1: ┤ X ├──■──┤ X ├──■────┼── + > └───┘┌─┴─┐└───┘┌─┴─┐┌─┴─┐ + > q_2: ─────┤ X ├─────┤ X ├┤ X ├ + > └───┘ └───┘└───┘ + > ``` + **Returns** template as a quantum circuit. @@ -1011,7 +1623,17 @@ Template circuits over Clifford gates. #### clifford\_6\_1 - + + Clifford template 6\_1: + + > ```python + > ┌───┐ ┌───┐┌───┐ + > q_0: ┤ H ├──■──┤ H ├┤ X ├ + > ├───┤┌─┴─┐├───┤└─┬─┘ + > q_1: ┤ H ├┤ X ├┤ H ├──■── + > └───┘└───┘└───┘ + > ``` + **Returns** template as a quantum circuit. @@ -1023,7 +1645,17 @@ Template circuits over Clifford gates. #### clifford\_6\_2 - + + Clifford template 6\_2: + + > ```python + > ┌───┐ + > q_0: ┤ S ├──■───────────■───■─ + > ├───┤┌─┴─┐┌─────┐┌─┴─┐ │ + > q_1: ┤ S ├┤ X ├┤ SDG ├┤ X ├─■─ + > └───┘└───┘└─────┘└───┘ + > ``` + **Returns** template as a quantum circuit. @@ -1035,7 +1667,17 @@ Template circuits over Clifford gates. #### clifford\_6\_3 - + + Clifford template 6\_3: + + ```python + ┌───┐ ┌───┐ + q_0: ─X──■─┤ H ├──■──┤ X ├───── + │ │ └───┘┌─┴─┐└─┬─┘┌───┐ + q_1: ─X──■──────┤ X ├──■──┤ H ├ + └───┘ └───┘ + ``` + **Returns** template as a quantum circuit. @@ -1047,7 +1689,15 @@ Template circuits over Clifford gates. #### clifford\_6\_4 - + + Clifford template 6\_4: + + ```python + ┌───┐┌───┐┌───┐┌───┐┌───┐┌───┐ + q_0: ┤ S ├┤ H ├┤ S ├┤ H ├┤ S ├┤ H ├ + └───┘└───┘└───┘└───┘└───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -1059,7 +1709,17 @@ Template circuits over Clifford gates. #### clifford\_6\_5 - + + Clifford template 6\_5: + + ```python + ┌───┐ + q_0: ─■───■───┤ S ├───■─────── + │ ┌─┴─┐┌┴───┴┐┌─┴─┐┌───┐ + q_1: ─■─┤ X ├┤ SDG ├┤ X ├┤ S ├ + └───┘└─────┘└───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -1071,7 +1731,17 @@ Template circuits over Clifford gates. #### clifford\_8\_1 - + + Clifford template 8\_1: + + ```python + ┌───┐ ┌───┐ ┌───┐┌─────┐ + q_0: ──■───────┤ X ├─┤ S ├─┤ X ├┤ SDG ├ + ┌─┴─┐┌───┐└─┬─┘┌┴───┴┐└─┬─┘└┬───┬┘ + q_1: ┤ X ├┤ H ├──■──┤ SDG ├──■───┤ H ├─ + └───┘└───┘ └─────┘ └───┘ + ``` + **Returns** template as a quantum circuit. @@ -1083,7 +1753,17 @@ Template circuits over Clifford gates. #### clifford\_8\_2 - + + Clifford template 8\_2: + + ```python + ┌───┐ + q_0: ──■─────────■───┤ S ├───■──────────── + ┌─┴─┐┌───┐┌─┴─┐┌┴───┴┐┌─┴─┐┌───┐┌───┐ + q_1: ┤ X ├┤ H ├┤ X ├┤ SDG ├┤ X ├┤ S ├┤ H ├ + └───┘└───┘└───┘└─────┘└───┘└───┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -1095,7 +1775,16 @@ Template circuits over Clifford gates. #### clifford\_8\_3 - + + Clifford template 8\_3: + + ```python + q_0: ─────────────────■───────────────────────■── + ┌───┐┌───┐┌───┐┌─┴─┐┌─────┐┌───┐┌─────┐┌─┴─┐ + q_1: ┤ S ├┤ H ├┤ S ├┤ X ├┤ SDG ├┤ H ├┤ SDG ├┤ X ├ + └───┘└───┘└───┘└───┘└─────┘└───┘└─────┘└───┘ + ``` + **Returns** template as a quantum circuit. @@ -1111,37 +1800,110 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui #### rzx\_yz - - Template for CX - RYGate - CX. + + RZX-based template for CX - RYGate - CX. + + ```python + ┌────────┐ ┌─────────┐┌─────────┐┌──────────┐ + q_0: ──■──┤ RY(-ϴ) ├──■──┤ RX(π/2) ├┤0 ├┤ RX(-π/2) ├ + ┌─┴─┐└────────┘┌─┴─┐└─────────┘│ RZX(ϴ) │└──────────┘ + q_1: ┤ X ├──────────┤ X ├───────────┤1 ├──────────── + └───┘ └───┘ └─────────┘ + ``` #### rzx\_xz - - Template for CX - RXGate - CX. + + RZX-based template for CX - RXGate - CX. + + ```python + ┌───┐ ┌───┐┌─────────┐┌─────────┐┌─────────┐┌──────────┐» + q_0: ┤ X ├─────────┤ X ├┤ RZ(π/2) ├┤ RX(π/2) ├┤ RZ(π/2) ├┤0 ├» + └─┬─┘┌───────┐└─┬─┘└─────────┘└─────────┘└─────────┘│ RZX(-ϴ) │» + q_1: ──■──┤ RX(ϴ) ├──■───────────────────────────────────┤1 ├» + └───────┘ └──────────┘» + « ┌─────────┐┌─────────┐┌─────────┐ + «q_0: ┤ RZ(π/2) ├┤ RX(π/2) ├┤ RZ(π/2) ├ + « └─────────┘└─────────┘└─────────┘ + «q_1: ───────────────────────────────── + « + ``` #### rzx\_cy - - Template for CX - RYGate - CX. + + RZX-based template for CX - RYGate - CX. + + ```python + ┌──────────┐ + q_0: ──■─────────────■─────────────────────────────────┤0 ├─────────── + ┌─┴─┐┌───────┐┌─┴─┐┌────────┐┌──────────┐┌───────┐│ RZX(-ϴ) │┌─────────┐ + q_1: ┤ X ├┤ RY(ϴ) ├┤ X ├┤ RY(-ϴ) ├┤ RZ(-π/2) ├┤ RX(ϴ) ├┤1 ├┤ RZ(π/2) ├ + └───┘└───────┘└───┘└────────┘└──────────┘└───────┘└──────────┘└─────────┘ + ``` #### rzx\_zz1 - - Template for CX - RZGate - CX. + + RZX-based template for CX - RZGate - CX. + + ```python + » + q_0: ──■────────────────────────────────────────────■───────────────────────» + ┌─┴─┐┌───────┐┌────┐┌───────┐┌────┐┌────────┐┌─┴─┐┌────────┐┌─────────┐» + q_1: ┤ X ├┤ RZ(ϴ) ├┤ √X ├┤ RZ(π) ├┤ √X ├┤ RZ(3π) ├┤ X ├┤ RZ(-ϴ) ├┤ RZ(π/2) ├» + └───┘└───────┘└────┘└───────┘└────┘└────────┘└───┘└────────┘└─────────┘» + « ┌──────────┐ » + «q_0: ───────────────────────────────┤0 ├──────────────────────» + « ┌─────────┐┌─────────┐┌───────┐│ RZX(-ϴ) │┌─────────┐┌─────────┐» + «q_1: ┤ RX(π/2) ├┤ RZ(π/2) ├┤ RX(ϴ) ├┤1 ├┤ RZ(π/2) ├┤ RX(π/2) ├» + « └─────────┘└─────────┘└───────┘└──────────┘└─────────┘└─────────┘» + « + «q_0: ─────────── + « ┌─────────┐ + «q_1: ┤ RZ(π/2) ├ + « └─────────┘ + ``` #### rzx\_zz2 - - Template for CX - RZGate - CX. + + RZX-based template for CX - PhaseGate - CX. + + ```python + » + q_0: ──■────────────■─────────────────────────────────────────────────────» + ┌─┴─┐┌──────┐┌─┴─┐┌───────┐┌─────────┐┌─────────┐┌─────────┐┌───────┐» + q_1: ┤ X ├┤ P(ϴ) ├┤ X ├┤ P(-ϴ) ├┤ RZ(π/2) ├┤ RX(π/2) ├┤ RZ(π/2) ├┤ RX(ϴ) ├» + └───┘└──────┘└───┘└───────┘└─────────┘└─────────┘└─────────┘└───────┘» + « ┌──────────┐ + «q_0: ┤0 ├───────────────────────────────── + « │ RZX(-ϴ) │┌─────────┐┌─────────┐┌─────────┐ + «q_1: ┤1 ├┤ RZ(π/2) ├┤ RX(π/2) ├┤ RZ(π/2) ├ + « └──────────┘└─────────┘└─────────┘└─────────┘ + ``` #### rzx\_zz3 - - Template for CX - RZGate - CX. + + RZX-based template for CX - RZGate - CX. + + ```python + » + q_0: ──■─────────────■──────────────────────────────────────────────────────» + ┌─┴─┐┌───────┐┌─┴─┐┌────────┐┌─────────┐┌─────────┐┌─────────┐┌───────┐» + q_1: ┤ X ├┤ RZ(ϴ) ├┤ X ├┤ RZ(-ϴ) ├┤ RZ(π/2) ├┤ RX(π/2) ├┤ RZ(π/2) ├┤ RX(ϴ) ├» + └───┘└───────┘└───┘└────────┘└─────────┘└─────────┘└─────────┘└───────┘» + « ┌──────────┐ + «q_0: ┤0 ├───────────────────────────────── + « │ RZX(-ϴ) │┌─────────┐┌─────────┐┌─────────┐ + «q_1: ┤1 ├┤ RZ(π/2) ├┤ RX(π/2) ├┤ RZ(π/2) ├ + « └──────────┘└─────────┘└─────────┘└─────────┘ + ``` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.C3SXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.C3SXGate.mdx index 152b8013282..373fcc458df 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.C3SXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.C3SXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3SXGate # C3SXGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") The 3-qubit controlled sqrt-X gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.C3XGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.C3XGate.mdx index 360cc9d69c2..77f0eed4f05 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.C3XGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.C3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3XGate # C3XGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") The X gate controlled on 3 qubits. @@ -162,7 +162,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### control - + Controlled version of this gate. **Parameters** @@ -183,7 +183,7 @@ python_api_name: qiskit.circuit.library.C3XGate ### inverse - + Invert this gate. The C3X is its own inverse. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.C4XGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.C4XGate.mdx index 843a5ee8832..0ab0e60e957 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.C4XGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.C4XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C4XGate # C4XGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") The 4-qubit controlled X gate. @@ -167,7 +167,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### control - + Controlled version of this gate. **Parameters** @@ -188,7 +188,7 @@ python_api_name: qiskit.circuit.library.C4XGate ### inverse - + Invert this gate. The C4X is its own inverse. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CCXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CCXGate.mdx index d040330c0b6..347f6783e91 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CCXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCXGate # CCXGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") CCX gate, also known as Toffoli gate. @@ -218,7 +218,7 @@ $$ ### control - + Controlled version of this gate. **Parameters** @@ -239,7 +239,7 @@ $$ ### inverse - + Return an inverted CCX gate (also a CCX). **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CHGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CHGate.mdx index 08e3f3ed467..4deca7e59ec 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CHGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CHGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CHGate # CHGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") Controlled-Hadamard gate. @@ -208,7 +208,7 @@ $$ ### inverse - + Return inverted CH gate (itself). diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CRXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CRXGate.mdx index 8be7c891279..8ab64ff6280 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CRXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CRXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRXGate # CRXGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RX gate. @@ -210,7 +210,7 @@ $$ ### inverse - + Return inverse CRX gate (i.e. with the negative rotation angle). **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CRYGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CRYGate.mdx index 36be5661722..f600012e350 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CRYGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CRYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRYGate # CRYGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RY gate. @@ -210,7 +210,7 @@ $$ ### inverse - + Return inverse CRY gate (i.e. with the negative rotation angle) **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CRZGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CRZGate.mdx index dc5e801e738..dc9793a8835 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CRZGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CRZGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRZGate # CRZGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-RZ gate. @@ -212,7 +212,7 @@ $$ ### inverse - + Return inverse CRZ gate (i.e. with the negative rotation angle). **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CSXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CSXGate.mdx index d0e33d774ae..5e32be34e56 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CSXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CSXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSXGate # CSXGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") Controlled-√X gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CU3Gate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CU3Gate.mdx index bd2813de66a..b563d98dabb 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CU3Gate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CU3Gate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU3Gate # CU3Gate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U3 gate (3-parameter two-qubit gate). @@ -226,7 +226,7 @@ $$ ### inverse - + Return inverted CU3 gate. $CU3(\theta,\phi,\lambda)^{\dagger} =CU3(-\theta,-\phi,-\lambda))$ diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CUGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CUGate.mdx index d8cc6e002de..cdd6f779256 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CUGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CUGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CUGate # CUGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Controlled-U gate (4-parameter two-qubit gate). @@ -202,7 +202,7 @@ $$ ### inverse - + Return inverted CU gate. $CU(\theta,\phi,\lambda,\gamma)^{\dagger} = CU(-\theta,-\phi,-\lambda,-\gamma))$ diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CXGate.mdx index 60f60d90ed4..d67e68f5794 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CXGate # CXGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") Controlled-X gate. @@ -214,7 +214,7 @@ $$ ### control - + Return a controlled-X gate with more control lines. **Parameters** @@ -235,7 +235,7 @@ $$ ### inverse - + Return inverted CX gate (itself). **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CYGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CYGate.mdx index 637ac364078..bf53437c129 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CYGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CYGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CYGate # CYGate - + Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") Controlled-Y gate. @@ -206,7 +206,7 @@ $$ ### inverse - + Return inverted CY gate (itself). **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.DCXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.DCXGate.mdx index 63f41dd8076..dda61f5ef67 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.DCXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.DCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DCXGate # DCXGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") Double-CNOT gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.IGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.IGate.mdx index 016b5d4f9ad..d11d457a1ef 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.IGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.IGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IGate # IGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") Identity gate. @@ -145,7 +145,7 @@ $$ ### inverse - + Returne the inverse gate (itself). **Parameters** @@ -165,7 +165,7 @@ $$ ### power - + Raise this gate to the power of `exponent`. Implemented either as a unitary gate (ref. [`UnitaryGate`](qiskit.circuit.library.UnitaryGate "qiskit.circuit.library.UnitaryGate")) or as an annotated operation (ref. [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation")). In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), when the power of a gate can be expressed in terms of another standard gate that is returned directly. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCXGate.mdx index a937c599e2e..2a1c9dbe27c 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGate # MCXGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") The general, multi-controlled X gate. @@ -168,7 +168,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### control - + Return a multi-controlled-X gate with more control lines. **Parameters** @@ -189,7 +189,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits without instantiating the class. This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization. @@ -205,7 +205,7 @@ python_api_name: qiskit.circuit.library.MCXGate ### inverse - + Invert this gate. The MCX is its own inverse. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCXGrayCode.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCXGrayCode.mdx index 0c0ef5d6f4d..04302a0681a 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCXGrayCode.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCXGrayCode.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode # MCXGrayCode - + Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using the Gray code. @@ -170,7 +170,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ### inverse - + Invert this gate. The MCX is its own inverse. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCXRecursive.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCXRecursive.mdx index 9db773d4aed..e95deaa18f2 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCXRecursive.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCXRecursive.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive # MCXRecursive - + Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using recursion. @@ -177,13 +177,13 @@ python_api_name: qiskit.circuit.library.MCXRecursive ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. ### inverse - + Invert this gate. The MCX is its own inverse. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCXVChain.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCXVChain.mdx index 71c63c306de..940c10001f5 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCXVChain.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCXVChain.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCXVChain # MCXVChain - + Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") Implement the multi-controlled X gate using a V-chain of CX gates. @@ -174,13 +174,13 @@ python_api_name: qiskit.circuit.library.MCXVChain ### get\_num\_ancilla\_qubits - + Get the number of required ancilla qubits. ### inverse - + Invert this gate. The MCX is its own inverse. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RC3XGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RC3XGate.mdx index 8611a2bb4e6..8981c2e1825 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RC3XGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RC3XGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RC3XGate # RC3XGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") The simplified 3-controlled Toffoli gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RCCXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RCCXGate.mdx index dfab3a96b88..78aa0a29ec9 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RCCXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RCCXGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RCCXGate # RCCXGate - + Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") The simplified Toffoli gate, also referred to as Margolus gate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RealAmplitudes.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RealAmplitudes.mdx index a2a13780883..b82c5013a6f 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RealAmplitudes.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RealAmplitudes.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes # RealAmplitudes - + Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The real-amplitudes 2-local circuit. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ZZFeatureMap.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.ZZFeatureMap.mdx index ac3942a23f6..b2a5cef52fc 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ZZFeatureMap.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ZZFeatureMap.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap # ZZFeatureMap - + Bases: [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") Second-order Pauli-Z evolution circuit. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx index 96f588ffbe0..42f52246ed8 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers # MergeAdjacentBarriers - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Return a circuit with any adjacent barriers merged together. @@ -102,7 +102,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers ### run - + Run the MergeAdjacentBarriers pass on dag. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.UnitarySynthesis.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.UnitarySynthesis.mdx index d3bc54ee87c..afbe3a46cd1 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.UnitarySynthesis.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.UnitarySynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis # UnitarySynthesis - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Synthesize gates according to their basis gates. @@ -87,7 +87,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis ### run - + Run the UnitarySynthesis pass on `dag`. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.unitary_synthesis.DefaultUnitarySynthesis.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.unitary_synthesis.DefaultUnitarySynthesis.mdx index 094e4a4c7aa..c465476c512 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.unitary_synthesis.DefaultUnitarySynthesis.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.unitary_synthesis.DefaultUnitarySynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.unitary_synthesis.DefaultUni # DefaultUnitarySynthesis - + Bases: [`UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") The default unitary synthesis plugin. @@ -67,7 +67,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.unitary_synthesis.DefaultUni ### run - + Run synthesis for the given unitary matrix **Parameters** diff --git a/docs/api/qiskit/dev/synthesis.mdx b/docs/api/qiskit/dev/synthesis.mdx index 537085a0f16..d8e2c7ca3b4 100644 --- a/docs/api/qiskit/dev/synthesis.mdx +++ b/docs/api/qiskit/dev/synthesis.mdx @@ -395,7 +395,7 @@ python_api_name: qiskit.synthesis ### synth\_clifford\_layers - + Synthesis of a [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") into layers, it provides a similar decomposition to the synthesis described in Lemma 8 of Bravyi and Maslov \[1]. For example, a 5-qubit Clifford circuit is decomposed into the following layers: @@ -440,7 +440,7 @@ python_api_name: qiskit.synthesis ### synth\_clifford\_depth\_lnn - + Synthesis of a [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") into layers for linear-nearest neighbor connectivity. The depth of the synthesized n-qubit circuit is bounded by $7n+2$, which is not optimal. It should be replaced by a better algorithm that provides depth bounded by $7n-4$ \[3]. @@ -549,7 +549,7 @@ python_api_name: qiskit.synthesis ### synth\_stabilizer\_layers - + Synthesis of a stabilizer state into layers. It provides a similar decomposition to the synthesis described in Lemma 8 of reference \[1], without the initial Hadamard-free sub-circuit which do not affect the stabilizer state. @@ -596,7 +596,7 @@ python_api_name: qiskit.synthesis ### synth\_stabilizer\_depth\_lnn - + Synthesis of an n-qubit stabilizer state for linear-nearest neighbor connectivity, in 2-qubit depth $2n+2$ and two distinct CX layers, using [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate")s and phase gates ([`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"), [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate") or [`ZGate`](qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate")). **Parameters** @@ -742,7 +742,7 @@ Decomposition of general $2^n \times 2^n$ unitary matrices for any number of qub ### qs\_decomposition - + Decomposes a unitary matrix into one and two qubit gates using Quantum Shannon Decomposition, This decomposition is described in Shende et al. \[1]. diff --git a/public/api/qiskit-ibm-runtime/dev/objects.inv b/public/api/qiskit-ibm-runtime/dev/objects.inv index fc29e62acd4..e802273f965 100644 Binary files a/public/api/qiskit-ibm-runtime/dev/objects.inv and b/public/api/qiskit-ibm-runtime/dev/objects.inv differ diff --git a/public/api/qiskit-ibm-runtime/objects.inv b/public/api/qiskit-ibm-runtime/objects.inv index 2da91bea724..a31b4e334a7 100644 Binary files a/public/api/qiskit-ibm-runtime/objects.inv and b/public/api/qiskit-ibm-runtime/objects.inv differ diff --git a/public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_02.png b/public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_02.png index f0eac6fbaf8..49b830f0736 100644 Binary files a/public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_02.png and b/public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_02.png differ diff --git a/public/images/api/qiskit-ibm-runtime/fake_provider-1_02.png b/public/images/api/qiskit-ibm-runtime/fake_provider-1_02.png index fb0ee501f4d..8257ae55c65 100644 Binary files a/public/images/api/qiskit-ibm-runtime/fake_provider-1_02.png and b/public/images/api/qiskit-ibm-runtime/fake_provider-1_02.png differ diff --git a/public/images/api/qiskit/dev/circuit-2.png b/public/images/api/qiskit/dev/circuit-2.png index a1c924ae285..fa7b138f2c8 100644 Binary files a/public/images/api/qiskit/dev/circuit-2.png and b/public/images/api/qiskit/dev/circuit-2.png differ diff --git a/public/images/api/qiskit/dev/providers_fake_provider-1_01.png b/public/images/api/qiskit/dev/providers_fake_provider-1_01.png index 012f4882ab3..26865a55ad5 100644 Binary files a/public/images/api/qiskit/dev/providers_fake_provider-1_01.png and b/public/images/api/qiskit/dev/providers_fake_provider-1_01.png differ diff --git a/public/images/api/qiskit/dev/providers_fake_provider-1_02.png b/public/images/api/qiskit/dev/providers_fake_provider-1_02.png index 90c433804ed..f2b8d36e76d 100644 Binary files a/public/images/api/qiskit/dev/providers_fake_provider-1_02.png and b/public/images/api/qiskit/dev/providers_fake_provider-1_02.png differ diff --git a/public/images/api/qiskit/dev/pulse-2.png b/public/images/api/qiskit/dev/pulse-2.png index dd32aba71e2..f4122c6c55e 100644 Binary files a/public/images/api/qiskit/dev/pulse-2.png and b/public/images/api/qiskit/dev/pulse-2.png differ diff --git a/public/images/api/qiskit/dev/pulse-3.png b/public/images/api/qiskit/dev/pulse-3.png index 0153f96ffa8..1a7b2cdc195 100644 Binary files a/public/images/api/qiskit/dev/pulse-3.png and b/public/images/api/qiskit/dev/pulse-3.png differ diff --git a/public/images/api/qiskit/dev/pulse-4.png b/public/images/api/qiskit/dev/pulse-4.png index 8ad95e43771..bac0d6f54d9 100644 Binary files a/public/images/api/qiskit/dev/pulse-4.png and b/public/images/api/qiskit/dev/pulse-4.png differ diff --git a/public/images/api/qiskit/dev/pulse-5.png b/public/images/api/qiskit/dev/pulse-5.png index 04b736eb15f..cc4e641eee8 100644 Binary files a/public/images/api/qiskit/dev/pulse-5.png and b/public/images/api/qiskit/dev/pulse-5.png differ diff --git a/public/images/api/qiskit/dev/pulse-6.png b/public/images/api/qiskit/dev/pulse-6.png index ce17e6a0a2c..b3b696aa4eb 100644 Binary files a/public/images/api/qiskit/dev/pulse-6.png and b/public/images/api/qiskit/dev/pulse-6.png differ diff --git a/public/images/api/qiskit/dev/pulse-7.png b/public/images/api/qiskit/dev/pulse-7.png index 9ee4185f1e6..78f0887b1a6 100644 Binary files a/public/images/api/qiskit/dev/pulse-7.png and b/public/images/api/qiskit/dev/pulse-7.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-ControlledGate-2.png b/public/images/api/qiskit/dev/qiskit-circuit-ControlledGate-2.png index 38ba783e997..9cd5aae04c1 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-ControlledGate-2.png and b/public/images/api/qiskit/dev/qiskit-circuit-ControlledGate-2.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-PermutationGate-2.png b/public/images/api/qiskit/dev/qiskit-circuit-library-PermutationGate-2.png index 71e0b207547..339ba528a1c 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-PermutationGate-2.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-PermutationGate-2.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-PhaseEstimation-1.png b/public/images/api/qiskit/dev/qiskit-circuit-library-PhaseEstimation-1.png index da3ce89c2d7..d0e3f88f9d6 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-PhaseEstimation-1.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-PhaseEstimation-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-plot_circuit_layout-1.png b/public/images/api/qiskit/dev/qiskit-visualization-plot_circuit_layout-1.png index dd84cf8e063..73e6aaebd41 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-plot_circuit_layout-1.png and b/public/images/api/qiskit/dev/qiskit-visualization-plot_circuit_layout-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-plot_error_map-1.png b/public/images/api/qiskit/dev/qiskit-visualization-plot_error_map-1.png index 85c77b6cf10..c5567488aa9 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-plot_error_map-1.png and b/public/images/api/qiskit/dev/qiskit-visualization-plot_error_map-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-1.png b/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-1.png index a21deda8ec6..091c8ec17d7 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-1.png and b/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-2.png b/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-2.png index 06772a17b83..0b753b1abce 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-2.png and b/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-2.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-3.png b/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-3.png index e0d96143c34..2faf303b6ea 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-3.png and b/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-3.png differ diff --git a/public/images/api/qiskit/dev/release_notes-1.png b/public/images/api/qiskit/dev/release_notes-1.png index ecc619edc43..889114d83ca 100644 Binary files a/public/images/api/qiskit/dev/release_notes-1.png and b/public/images/api/qiskit/dev/release_notes-1.png differ diff --git a/public/images/api/qiskit/dev/transpiler-16.png b/public/images/api/qiskit/dev/transpiler-16.png index 1868c84656f..6f715eeabb7 100644 Binary files a/public/images/api/qiskit/dev/transpiler-16.png and b/public/images/api/qiskit/dev/transpiler-16.png differ diff --git a/public/images/api/qiskit/dev/transpiler-17.png b/public/images/api/qiskit/dev/transpiler-17.png index 55f03678d17..4ed1ff5a588 100644 Binary files a/public/images/api/qiskit/dev/transpiler-17.png and b/public/images/api/qiskit/dev/transpiler-17.png differ diff --git a/public/images/api/qiskit/dev/transpiler-5.png b/public/images/api/qiskit/dev/transpiler-5.png index 3f6eb88486e..972614451f9 100644 Binary files a/public/images/api/qiskit/dev/transpiler-5.png and b/public/images/api/qiskit/dev/transpiler-5.png differ diff --git a/scripts/config/api-html-artifacts.json b/scripts/config/api-html-artifacts.json index bbfad6560cd..9542c5345aa 100644 --- a/scripts/config/api-html-artifacts.json +++ b/scripts/config/api-html-artifacts.json @@ -1,6 +1,6 @@ { "qiskit": { - "dev": "https://api.github.com/repos/Qiskit/qiskit/actions/artifacts/2062254897/zip", + "dev": "https://api.github.com/repos/Qiskit/qiskit/actions/artifacts/2083943397/zip", "1.2": "https://ibm.box.com/shared/static/nnao3s3gy1y5hyea506htupby9khrve1.zip", "1.1": "https://ibm.box.com/shared/static/bplxij6mapevjapr8ij7rluiayls982k.zip", "1.0": "https://ibm.box.com/shared/static/9mgo99x54z3rpo8irs23olqsov3uo1ly.zip", @@ -29,7 +29,7 @@ "0.19": "https://ibm.box.com/shared/static/wjoea4x5tnxd0l4lgo2v3kxnx6btxvvl.zip" }, "qiskit-ibm-runtime": { - "dev": "https://api.github.com/repos/Qiskit/qiskit-ibm-runtime/actions/artifacts/2063774491/zip", + "dev": "https://api.github.com/repos/Qiskit/qiskit-ibm-runtime/actions/artifacts/2082018988/zip", "0.31": "https://ibm.box.com/shared/static/z19dt14je6cz69oi4knraitjglzo29w7.zip", "0.30": "https://ibm.box.com/shared/static/f950vkx3uq13o8g017bazpm4o9bcei2i.zip", "0.29": "https://ibm.box.com/shared/static/9n6xf8gkh24xpft2e7zrwgme7jzkh6nu.zip",