diff --git a/docs/api/qiskit-ibm-runtime/dev/_toc.json b/docs/api/qiskit-ibm-runtime/dev/_toc.json index 378278229b08..8da93c8a34bb 100644 --- a/docs/api/qiskit-ibm-runtime/dev/_toc.json +++ b/docs/api/qiskit-ibm-runtime/dev/_toc.json @@ -608,6 +608,11 @@ "url": "/docs/api/qiskit-ibm-runtime/dev/options-layer-noise-learning-options", "untranslatable": true }, + { + "title": "LegacySimulatorOptions", + "url": "/docs/api/qiskit-ibm-runtime/dev/options-legacy-simulator-options", + "untranslatable": true + }, { "title": "MeasureNoiseLearningOptions", "url": "/docs/api/qiskit-ibm-runtime/dev/options-measure-noise-learning-options", @@ -638,11 +643,6 @@ "url": "/docs/api/qiskit-ibm-runtime/dev/options-sampler-options", "untranslatable": true }, - { - "title": "SimulatorOptions", - "url": "/docs/api/qiskit-ibm-runtime/dev/options-simulator-options", - "untranslatable": true - }, { "title": "TwirlingOptions", "url": "/docs/api/qiskit-ibm-runtime/dev/options-twirling-options", diff --git a/docs/api/qiskit-ibm-runtime/dev/options-estimator-options.mdx b/docs/api/qiskit-ibm-runtime/dev/options-estimator-options.mdx index 6c4dcb50d579..0a6ee4601280 100644 --- a/docs/api/qiskit-ibm-runtime/dev/options-estimator-options.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/options-estimator-options.mdx @@ -20,7 +20,7 @@ python_api_name: qiskit_ibm_runtime.options.EstimatorOptions * **\_VERSION** (*int*) * **max\_execution\_time** (*UnsetType | int*) * **environment** ([*EnvironmentOptions*](options-environment-options "qiskit_ibm_runtime.options.environment_options.EnvironmentOptions") *| Dict*) - * **simulator** ([*SimulatorOptions*](options-simulator-options "qiskit_ibm_runtime.options.simulator_options.SimulatorOptions") *| Dict*) + * **simulator** ([*LegacySimulatorOptions*](options-legacy-simulator-options "qiskit_ibm_runtime.options.simulator_options.LegacySimulatorOptions") *| Dict*) * **default\_precision** (*UnsetType | float*) * **default\_shots** (*UnsetType | int | None*) * **resilience\_level** (*UnsetType | int*) @@ -125,7 +125,7 @@ python_api_name: qiskit_ibm_runtime.options.EstimatorOptions ### simulator - + ### twirling diff --git a/docs/api/qiskit-ibm-runtime/dev/options-simulator-options.mdx b/docs/api/qiskit-ibm-runtime/dev/options-legacy-simulator-options.mdx similarity index 53% rename from docs/api/qiskit-ibm-runtime/dev/options-simulator-options.mdx rename to docs/api/qiskit-ibm-runtime/dev/options-legacy-simulator-options.mdx index bf11cb8af3c4..a6e2b051ee2b 100644 --- a/docs/api/qiskit-ibm-runtime/dev/options-simulator-options.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/options-legacy-simulator-options.mdx @@ -1,14 +1,14 @@ --- -title: SimulatorOptions (dev version) -description: API reference for qiskit_ibm_runtime.options.SimulatorOptions in the dev version of qiskit-ibm-runtime +title: LegacySimulatorOptions (dev version) +description: API reference for qiskit_ibm_runtime.options.LegacySimulatorOptions in the dev version of qiskit-ibm-runtime in_page_toc_min_heading_level: 1 python_api_type: class -python_api_name: qiskit_ibm_runtime.options.SimulatorOptions +python_api_name: qiskit_ibm_runtime.options.LegacySimulatorOptions --- -# SimulatorOptions +# LegacySimulatorOptions - + Bases: `object` Simulator options. @@ -26,7 +26,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions ### basis\_gates - + List of basis gate names to unroll to. For example, `['u1', 'u2', 'u3', 'cx']`. Unrolling is not done if not set. @@ -36,7 +36,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions ### coupling\_map - + Directed coupling map to target in mapping. If the coupling map is symmetric, both directions need to be specified. Each entry in the list specifies a directed two-qubit interaction, e.g: `[[0, 1], [0, 3], [1, 2], [1, 5], [2, 5], [4, 1], [5, 3]]`. @@ -46,7 +46,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions ### noise\_model - + Noise model for the simulator. This option is only supported in local testing mode. @@ -56,7 +56,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions ### seed\_simulator - + Random seed to control sampling. Default: `None`. @@ -66,7 +66,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions ### set\_backend - + Set backend for simulation. This method changes noise\_model, coupling\_map, basis\_gates according to given backend. diff --git a/docs/api/qiskit-ibm-runtime/dev/options-models-executor-options.mdx b/docs/api/qiskit-ibm-runtime/dev/options-models-executor-options.mdx index 5cffcf983df0..c5ac3b142949 100644 --- a/docs/api/qiskit-ibm-runtime/dev/options-models-executor-options.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/options-models-executor-options.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit_ibm_runtime.options_models.ExecutorOptions # qiskit\_ibm\_runtime.options\_models.ExecutorOptions - + Bases: `BaseOptionsModel` Options for the executor. @@ -38,6 +38,14 @@ python_api_name: qiskit_ibm_runtime.options_models.ExecutorOptions Experimental options that are passed to the executor. + ### simulator + + + Simulator options. + + These options are used when an executor is initialized with a backend that is a simulator, and they are ignored otherwise. + + ### update diff --git a/docs/api/qiskit-ibm-runtime/dev/options-noise-learner-options.mdx b/docs/api/qiskit-ibm-runtime/dev/options-noise-learner-options.mdx index 355fdd813e09..ccdf4a156225 100644 --- a/docs/api/qiskit-ibm-runtime/dev/options-noise-learner-options.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/options-noise-learner-options.mdx @@ -30,7 +30,7 @@ python_api_name: qiskit_ibm_runtime.options.NoiseLearnerOptions * **\_VERSION** (*int*) * **max\_execution\_time** (*UnsetType | int*) * **environment** ([*EnvironmentOptions*](options-environment-options "qiskit_ibm_runtime.options.environment_options.EnvironmentOptions") *| Dict*) - * **simulator** ([*SimulatorOptions*](options-simulator-options "qiskit_ibm_runtime.options.simulator_options.SimulatorOptions") *| Dict*) + * **simulator** ([*LegacySimulatorOptions*](options-legacy-simulator-options "qiskit_ibm_runtime.options.simulator_options.LegacySimulatorOptions") *| Dict*) * **max\_layers\_to\_learn** (*UnsetType | int | None*) * **shots\_per\_randomization** (*UnsetType | int*) * **num\_randomizations** (*UnsetType | int*) @@ -88,7 +88,7 @@ python_api_name: qiskit_ibm_runtime.options.NoiseLearnerOptions ### simulator - + ### twirling\_strategy diff --git a/docs/api/qiskit-ibm-runtime/dev/options-sampler-options.mdx b/docs/api/qiskit-ibm-runtime/dev/options-sampler-options.mdx index 47b16b537ec8..d1a7403f4dd7 100644 --- a/docs/api/qiskit-ibm-runtime/dev/options-sampler-options.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/options-sampler-options.mdx @@ -20,7 +20,7 @@ python_api_name: qiskit_ibm_runtime.options.SamplerOptions * **\_VERSION** (*int*) * **max\_execution\_time** (*UnsetType | int*) * **environment** ([*EnvironmentOptions*](options-environment-options "qiskit_ibm_runtime.options.environment_options.EnvironmentOptions") *| Dict*) - * **simulator** ([*SimulatorOptions*](options-simulator-options "qiskit_ibm_runtime.options.simulator_options.SimulatorOptions") *| Dict*) + * **simulator** ([*LegacySimulatorOptions*](options-legacy-simulator-options "qiskit_ibm_runtime.options.simulator_options.LegacySimulatorOptions") *| Dict*) * **default\_shots** (*UnsetType | int*) * **dynamical\_decoupling** ([*DynamicalDecouplingOptions*](options-dynamical-decoupling-options "qiskit_ibm_runtime.options.dynamical_decoupling_options.DynamicalDecouplingOptions") *| Dict*) * **execution** ([*SamplerExecutionOptionsV2*](options-sampler-execution-options-v2 "qiskit_ibm_runtime.options.sampler_execution_options.SamplerExecutionOptionsV2") *| Dict*) @@ -65,7 +65,7 @@ python_api_name: qiskit_ibm_runtime.options.SamplerOptions ### simulator - + ### twirling diff --git a/docs/api/qiskit-ibm-runtime/dev/options.mdx b/docs/api/qiskit-ibm-runtime/dev/options.mdx index f8dc402fac50..0200f0f8d0e6 100644 --- a/docs/api/qiskit-ibm-runtime/dev/options.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/options.mdx @@ -70,5 +70,5 @@ Refer to [`qiskit_ibm_runtime.options.SamplerOptions`](/docs/api/qiskit-ibm-runt | [`ExecutionOptionsV2`](/docs/api/qiskit-ibm-runtime/dev/options-execution-options-v2 "qiskit_ibm_runtime.options.ExecutionOptionsV2") | Execution options for V2 primitives. | | [`SamplerExecutionOptionsV2`](/docs/api/qiskit-ibm-runtime/dev/options-sampler-execution-options-v2 "qiskit_ibm_runtime.options.SamplerExecutionOptionsV2") | Extends [`ExecutionOptionsV2`](/docs/api/qiskit-ibm-runtime/dev/options-execution-options-v2 "qiskit_ibm_runtime.options.ExecutionOptionsV2") for the sampler primitive. | | [`EnvironmentOptions`](/docs/api/qiskit-ibm-runtime/dev/options-environment-options "qiskit_ibm_runtime.options.EnvironmentOptions") | Options related to the execution environment. | -| [`SimulatorOptions`](/docs/api/qiskit-ibm-runtime/dev/options-simulator-options "qiskit_ibm_runtime.options.SimulatorOptions") | Simulator options. | +| [`LegacySimulatorOptions`](/docs/api/qiskit-ibm-runtime/dev/options-legacy-simulator-options "qiskit_ibm_runtime.options.LegacySimulatorOptions") | Simulator options. | diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit-runtime-service.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit-runtime-service.mdx index 40b0c608c652..2c012ff4aba3 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit-runtime-service.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit-runtime-service.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService # QiskitRuntimeService - + Bases: `object` Class for interacting with the IBM Quantum Compute (formerly Qiskit Runtime) service. @@ -105,7 +105,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### active\_account - + Return the IBM Quantum account currently in use for the session. **Returns** @@ -119,7 +119,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### active\_instance - + Return the crn of the current active instance. **Return type** @@ -129,7 +129,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### backend - + Return a single backend matching the specified filtering. Note that backend availability is only verified upon circuit submission. To check the backend status ahead of time, use the [`status()`](ibm-backend#status "qiskit_ibm_runtime.IBMBackend.status") method on the backend object: @@ -167,7 +167,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### backends - + Return all backends accessible via this account, subject to optional filtering. **Parameters** @@ -232,7 +232,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### delete\_account - + Delete a saved account from disk. **Parameters** @@ -252,7 +252,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### delete\_job - + Delete a IBM Quantum Compute job. Note that this operation cannot be reversed. @@ -273,7 +273,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### instances - + Return a list of instances available for the active account. Return a list that contains a series of dictionaries with the following instance identifiers per instance: “crn”, “plan”, “name”. @@ -289,7 +289,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### job - + Retrieve a IBM Quantum Compute job. **Parameters** @@ -312,7 +312,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### jobs - + Retrieve all IBM Quantum Compute jobs, subject to optional filtering. **Parameters** @@ -344,7 +344,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### least\_busy - + Return the least busy available backend. **Parameters** @@ -382,7 +382,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### save\_account - + Save the account to disk for future use. **Parameters** @@ -409,7 +409,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### saved\_accounts - + List the accounts saved on disk. **Parameters** @@ -434,7 +434,7 @@ python_api_name: qiskit_ibm_runtime.QiskitRuntimeService ### usage - + Return usage information for the current active instance. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/runtime-decoder.mdx b/docs/api/qiskit-ibm-runtime/dev/runtime-decoder.mdx index 145a2040e9f9..65c7af1196fb 100644 --- a/docs/api/qiskit-ibm-runtime/dev/runtime-decoder.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/runtime-decoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder # RuntimeDecoder - + Bases: `JSONDecoder` JSON Decoder used by IBM Quantum Compute service. @@ -34,7 +34,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder ### decode - + Return the Python representation of a string `s` containing a JSON document. Applies additional conversion for executor program and NLV3’s `params`, preserving the superclass `decode()` output in all other cases. @@ -50,7 +50,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeDecoder ### object\_hook - + Called to decode object. **Parameters** diff --git a/docs/api/qiskit-ibm-runtime/dev/runtime-encoder.mdx b/docs/api/qiskit-ibm-runtime/dev/runtime-encoder.mdx index a292235bc715..bb378b3de0ec 100644 --- a/docs/api/qiskit-ibm-runtime/dev/runtime-encoder.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/runtime-encoder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder # RuntimeEncoder - + Bases: `JSONEncoder` JSON Encoder used by IBM Quantum Compute service. @@ -45,7 +45,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeEncoder ### default - + Return a serializable object for `obj`. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.mdx index 155710fd0a36..fe0371bd574f 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.mdx @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.QuantumCircuit # [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") class - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object) Core Qiskit representation of a quantum circuit. @@ -646,7 +646,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### copy - + Copy the circuit. **Parameters** @@ -666,7 +666,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### copy\_empty\_like - + Return a copy of self with the same structure but empty. That structure includes: @@ -738,7 +738,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_file - + Read an OpenQASM 2.0 program from a file and convert to an instance of [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). **Parameters** @@ -760,7 +760,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### from\_qasm\_str - + Convert a string containing an OpenQASM 2.0 program to a [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). **Parameters** @@ -802,7 +802,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### add\_bits - + Add Bits to the circuit. @@ -822,7 +822,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### add\_register - + Add registers. @@ -1014,7 +1014,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### find\_bit - + Find locations in the circuit which can be used to reference a given [`Bit`](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit"). In particular, this function can find the integer index of a qubit, which corresponds to its hardware index for a transpiled circuit. @@ -1103,7 +1103,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### assign\_parameters - + Assign parameters to new parameters or values. If `parameters` is passed as a dictionary, the keys should be [`Parameter`](/docs/api/qiskit/dev/qiskit.circuit.Parameter "qiskit.circuit.Parameter") instances in the current circuit. The values of the dictionary can either be numeric values or new parameter objects. @@ -1919,7 +1919,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### barrier - + Apply `Barrier`. If `qargs` is empty, applies to all qubits in the circuit. **Parameters** @@ -1938,7 +1938,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### ccx - + Apply [`CCXGate`](/docs/api/qiskit/dev/qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1962,7 +1962,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### ccz - + Apply [`CCZGate`](/docs/api/qiskit/dev/qiskit.circuit.library.CCZGate "qiskit.circuit.library.CCZGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1986,7 +1986,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### ch - + Apply [`CHGate`](/docs/api/qiskit/dev/qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2009,7 +2009,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### cp - + Apply [`CPhaseGate`](/docs/api/qiskit/dev/qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2033,7 +2033,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### crx - + Apply [`CRXGate`](/docs/api/qiskit/dev/qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2057,7 +2057,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### cry - + Apply [`CRYGate`](/docs/api/qiskit/dev/qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2081,7 +2081,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### crz - + Apply [`CRZGate`](/docs/api/qiskit/dev/qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2105,7 +2105,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### cs - + Apply [`CSGate`](/docs/api/qiskit/dev/qiskit.circuit.library.CSGate "qiskit.circuit.library.CSGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2128,7 +2128,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### csdg - + Apply [`CSdgGate`](/docs/api/qiskit/dev/qiskit.circuit.library.CSdgGate "qiskit.circuit.library.CSdgGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2151,7 +2151,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### cswap - + Apply [`CSwapGate`](/docs/api/qiskit/dev/qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2175,7 +2175,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### csx - + Apply [`CSXGate`](/docs/api/qiskit/dev/qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2198,7 +2198,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### cu - + Apply [`CUGate`](/docs/api/qiskit/dev/qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2225,7 +2225,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### cx - + Apply [`CXGate`](/docs/api/qiskit/dev/qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2248,7 +2248,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### cy - + Apply [`CYGate`](/docs/api/qiskit/dev/qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2271,7 +2271,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### cz - + Apply [`CZGate`](/docs/api/qiskit/dev/qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2294,7 +2294,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### dcx - + Apply [`DCXGate`](/docs/api/qiskit/dev/qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2316,7 +2316,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### delay - + Apply [`Delay`](circuit#qiskit.circuit.Delay "qiskit.circuit.Delay"). If qarg is `None`, applies to all qubits. When applying to multiple qubits, delays with the same duration will be created. **Parameters** @@ -2340,7 +2340,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### ecr - + Apply [`ECRGate`](/docs/api/qiskit/dev/qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2362,7 +2362,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### h - + Apply [`HGate`](/docs/api/qiskit/dev/qiskit.circuit.library.HGate "qiskit.circuit.library.HGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2383,7 +2383,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### id - + Apply [`IGate`](/docs/api/qiskit/dev/qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2404,7 +2404,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### initialize - + Initialize qubits in a specific state. Qubit initialization is done by first resetting the qubits to $|0\rangle$ followed by calling [`StatePreparation`](/docs/api/qiskit/dev/qiskit.circuit.library.StatePreparation "qiskit.circuit.library.StatePreparation") class to prepare the qubits in a specified state. Both these steps are included in the [`Initialize`](/docs/api/qiskit/dev/qiskit.circuit.library.Initialize "qiskit.circuit.library.Initialize") instruction. @@ -2493,7 +2493,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### iswap - + Apply [`iSwapGate`](/docs/api/qiskit/dev/qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2515,7 +2515,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### mcp - + Apply [`MCPhaseGate`](/docs/api/qiskit/dev/qiskit.circuit.library.MCPhaseGate "qiskit.circuit.library.MCPhaseGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2539,7 +2539,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### mcrx - + Apply Multiple-Controlled X rotation gate **Parameters** @@ -2552,7 +2552,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### mcry - + Apply Multiple-Controlled Y rotation gate **Parameters** @@ -2567,7 +2567,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### mcrz - + Apply Multiple-Controlled Z rotation gate **Parameters** @@ -2580,7 +2580,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### mcx - + Apply [`MCXGate`](/docs/api/qiskit/dev/qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). The multi-cX gate can be implemented using different techniques, which use different numbers of ancilla qubits and have varying circuit depth. These modes are: @@ -2621,7 +2621,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### measure - + Measure a quantum bit (`qubit`) in the Z basis into a classical bit (`cbit`). When a quantum state is measured, a qubit is projected in the computational (Pauli Z) basis to either $\lvert 0 \rangle$ or $\lvert 1 \rangle$. The classical bit `cbit` indicates the result of that projection as a `0` or a `1` respectively. This operation is non-reversible. @@ -2697,7 +2697,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### ms - + Apply [`MSGate`](/docs/api/qiskit/dev/qiskit.circuit.library.MSGate "qiskit.circuit.library.MSGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2719,7 +2719,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### p - + Apply [`PhaseGate`](/docs/api/qiskit/dev/qiskit.circuit.library.PhaseGate "qiskit.circuit.library.PhaseGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2741,7 +2741,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### pauli - + Apply [`PauliGate`](/docs/api/qiskit/dev/qiskit.circuit.library.PauliGate "qiskit.circuit.library.PauliGate"). **Parameters** @@ -2761,7 +2761,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### prepare\_state - + Prepare qubits in a specific state. This class implements a state preparing unitary. Unlike [`initialize()`](#qiskit.circuit.QuantumCircuit.initialize "qiskit.circuit.QuantumCircuit.initialize") it does not reset the qubits first. @@ -2856,7 +2856,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### r - + Apply [`RGate`](/docs/api/qiskit/dev/qiskit.circuit.library.RGate "qiskit.circuit.library.RGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2879,7 +2879,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### rcccx - + Apply [`RC3XGate`](/docs/api/qiskit/dev/qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2903,7 +2903,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### rccx - + Apply [`RCCXGate`](/docs/api/qiskit/dev/qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2926,7 +2926,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### reset - + Reset the quantum bit(s) to their default state. **Parameters** @@ -2944,7 +2944,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### rv - + Apply [`RVGate`](/docs/api/qiskit/dev/qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2970,7 +2970,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### rx - + Apply [`RXGate`](/docs/api/qiskit/dev/qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2992,7 +2992,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### rxx - + Apply [`RXXGate`](/docs/api/qiskit/dev/qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -3015,7 +3015,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### ry - + Apply [`RYGate`](/docs/api/qiskit/dev/qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -3037,7 +3037,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### ryy - + Apply [`RYYGate`](/docs/api/qiskit/dev/qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -3060,7 +3060,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### rz - + Apply [`RZGate`](/docs/api/qiskit/dev/qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -3082,7 +3082,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### rzx - + Apply [`RZXGate`](/docs/api/qiskit/dev/qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -3105,7 +3105,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### rzz - + Apply [`RZZGate`](/docs/api/qiskit/dev/qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -3128,7 +3128,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### s - + Apply [`SGate`](/docs/api/qiskit/dev/qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -3149,7 +3149,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### sdg - + Apply [`SdgGate`](/docs/api/qiskit/dev/qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -3170,7 +3170,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### store - + Store the result of the given real-time classical expression `rvalue` in the memory location defined by `lvalue`. Typically `lvalue` will be a [`Var`](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") node and `rvalue` will be some [`Expr`](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") to write into it, but anything that [`expr.lift()`](circuit_classical#qiskit.circuit.classical.expr.lift "qiskit.circuit.classical.expr.lift") can raise to an [`Expr`](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") is permissible in both places, and it will be called on them. @@ -3197,7 +3197,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### swap - + Apply [`SwapGate`](/docs/api/qiskit/dev/qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -3219,7 +3219,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### sx - + Apply [`SXGate`](/docs/api/qiskit/dev/qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -3240,7 +3240,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### sxdg - + Apply [`SXdgGate`](/docs/api/qiskit/dev/qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -3261,7 +3261,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### t - + Apply [`TGate`](/docs/api/qiskit/dev/qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -3282,7 +3282,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### tdg - + Apply [`TdgGate`](/docs/api/qiskit/dev/qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -3303,7 +3303,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### u - + Apply [`UGate`](/docs/api/qiskit/dev/qiskit.circuit.library.UGate "qiskit.circuit.library.UGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -3327,7 +3327,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### unitary - + Apply unitary gate specified by `obj` to `qubits`. **Parameters** @@ -3361,7 +3361,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### x - + Apply [`XGate`](/docs/api/qiskit/dev/qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -3382,7 +3382,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### y - + Apply [`YGate`](/docs/api/qiskit/dev/qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -3403,7 +3403,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### z - + Apply [`ZGate`](/docs/api/qiskit/dev/qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -3453,7 +3453,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### box - + Create a `box` of operations on this circuit that are treated atomically in the greater context. A “box” is a control-flow construct that is entered unconditionally. The contents of the box behave somewhat as if the start and end of the box were barriers (see [`barrier()`](#qiskit.circuit.QuantumCircuit.barrier "qiskit.circuit.QuantumCircuit.barrier")), except it is permissible to commute operations “all the way” through the box. The box is also an explicit scope for the purposes of variables, stretches and compiler passes. @@ -3517,7 +3517,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### break\_loop - + Apply [`BreakLoopOp`](/docs/api/qiskit/dev/qiskit.circuit.BreakLoopOp "qiskit.circuit.BreakLoopOp"). @@ -3539,7 +3539,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### continue\_loop - + Apply [`ContinueLoopOp`](/docs/api/qiskit/dev/qiskit.circuit.ContinueLoopOp "qiskit.circuit.ContinueLoopOp"). @@ -3561,7 +3561,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### for\_loop - + Create a `for` loop on this circuit. There are two forms for calling this function. If called with all its arguments (with the possible exception of `label`), it will create a [`ForLoopOp`](/docs/api/qiskit/dev/qiskit.circuit.ForLoopOp "qiskit.circuit.ForLoopOp") with the given `body`. If `body` (and `qubits` and `clbits`) are *not* passed, then this acts as a context manager, which, when entered, provides a loop variable (unless one is given, in which case it will be reused) and will automatically build a [`ForLoopOp`](/docs/api/qiskit/dev/qiskit.circuit.ForLoopOp "qiskit.circuit.ForLoopOp") when the scope finishes. In this form, you do not need to keep track of the qubits or clbits you are using, because the scope will handle it for you. @@ -3613,7 +3613,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### if\_else - + Apply [`IfElseOp`](/docs/api/qiskit/dev/qiskit.circuit.IfElseOp "qiskit.circuit.IfElseOp"). @@ -3657,7 +3657,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### if\_test - + Create an `if` statement on this circuit. There are two forms for calling this function. If called with all its arguments (with the possible exception of `label`), it will create a [`IfElseOp`](/docs/api/qiskit/dev/qiskit.circuit.IfElseOp "qiskit.circuit.IfElseOp") with the given `true_body`, and there will be no branch for the `false` condition (see also the [`if_else()`](#qiskit.circuit.QuantumCircuit.if_else "qiskit.circuit.QuantumCircuit.if_else") method). However, if `true_body` (and `qubits` and `clbits`) are *not* passed, then this acts as a context manager, which can be used to build `if` statements. The return value of the `with` statement is a chainable context manager, which can be used to create subsequent `else` blocks. In this form, you do not need to keep track of the qubits or clbits you are using, because the scope will handle it for you. @@ -3711,7 +3711,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### switch - + Create a `switch`/`case` structure on this circuit. There are two forms for calling this function. If called with all its arguments (with the possible exception of `label`), it will create a [`SwitchCaseOp`](/docs/api/qiskit/dev/qiskit.circuit.SwitchCaseOp "qiskit.circuit.SwitchCaseOp") with the given case structure. If `cases` (and `qubits` and `clbits`) are *not* passed, then this acts as a context manager, which will automatically build a [`SwitchCaseOp`](/docs/api/qiskit/dev/qiskit.circuit.SwitchCaseOp "qiskit.circuit.SwitchCaseOp") when the scope finishes. In this form, you do not need to keep track of the qubits or clbits you are using, because the scope will handle it for you. @@ -3758,7 +3758,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### while\_loop - + Create a `while` loop on this circuit. There are two forms for calling this function. If called with all its arguments (with the possible exception of `label`), it will create a `WhileLoopOp` with the given `body`. If `body` (and `qubits` and `clbits`) are *not* passed, then this acts as a context manager, which will automatically build a `WhileLoopOp` when the scope finishes. In this form, you do not need to keep track of the qubits or clbits you are using, because the scope will handle it for you. @@ -3799,7 +3799,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### noop - + Mark the given qubit(s) as used within the current scope, without adding an operation. This has no effect (other than raising an exception on invalid input) when called in the top scope of a [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). Within a control-flow builder, this causes the qubit to be “used” by the control-flow block, if it wouldn’t already be used, without adding any additional operations on it. @@ -3831,7 +3831,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### has\_control\_flow\_op - + Checks whether the circuit has an instance of [`ControlFlowOp`](/docs/api/qiskit/dev/qiskit.circuit.ControlFlowOp "qiskit.circuit.ControlFlowOp") present amongst its operations. **Return type** @@ -3845,7 +3845,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### to\_instruction - + Create an [`Instruction`](/docs/api/qiskit/dev/qiskit.circuit.Instruction "qiskit.circuit.Instruction") out of this circuit. @@ -3872,7 +3872,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### to\_gate - + Create a [`Gate`](/docs/api/qiskit/dev/qiskit.circuit.Gate "qiskit.circuit.Gate") out of this circuit. The circuit must act only on qubits and contain only unitary operations. @@ -3899,7 +3899,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### to\_dag - + Convert this circuit to a [`DAGCircuit`](/docs/api/qiskit/dev/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit"). This is a simple wrapper around [`circuit_to_dag()`](converters#qiskit.converters.circuit_to_dag "qiskit.converters.circuit_to_dag"). @@ -3923,7 +3923,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### measure\_active - + Adds measurement to all non-idle qubits. Creates a new ClassicalRegister with a size equal to the number of non-idle qubits being measured. Returns a new circuit with measurements if inplace=False. @@ -3943,7 +3943,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### measure\_all - + Adds measurement to all qubits. By default, adds new classical bits in a [`ClassicalRegister`](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") to store these measurements. If `add_bits=False`, the results of the measurements will instead be stored in the already existing classical bits, with qubit `n` being measured into classical bit `n`. @@ -3972,7 +3972,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### clear - + Clear all instructions in self. Clearing the circuits will keep the metadata. @@ -3990,7 +3990,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### remove\_final\_measurements - + Removes final measurements and barriers on all qubits if they are present. Deletes the classical registers that were used to store the values from these measurements that become idle as a result of this operation, and deletes classical bits that are referenced only by removed registers, or that aren’t referenced at all but have become idle as a result of this operation. Measurements and barriers are considered final if they are followed by no other operations (aside from other measurements or barriers.) @@ -4095,7 +4095,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### count\_ops - + Count each operation kind in the circuit. **Returns** @@ -4109,7 +4109,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### depth - + Return circuit depth (i.e., length of critical path). The depth of a quantum circuit is a measure of how many “layers” of quantum gates, executed in parallel, it takes to complete the computation defined by the circuit. Because quantum gates take time to implement, the depth of a circuit roughly corresponds to the amount of time it takes the quantum computer to execute the circuit. @@ -4153,7 +4153,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### get\_instructions - + Get instructions matching name. **Parameters** @@ -4171,7 +4171,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### num\_connected\_components - + How many non-entangled subcircuits can the circuit be factored to. **Parameters** @@ -4189,7 +4189,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### num\_nonlocal\_gates - + Return number of non-local gates (i.e. involving 2+ qubits). Conditional nonlocal gates are also included. @@ -4201,7 +4201,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### num\_tensor\_factors - + Computes the number of tensor factors in the unitary (quantum) part of the circuit only. **Notes** @@ -4215,7 +4215,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### num\_unitary\_factors - + Computes the number of tensor factors in the unitary (quantum) part of the circuit only. **Return type** @@ -4225,7 +4225,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### size - + Returns total number of instructions in circuit. **Parameters** @@ -4243,7 +4243,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### width - + Return number of qubits plus clbits in circuit. **Returns** @@ -4261,7 +4261,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### estimate\_duration - + Estimate the duration of a scheduled circuit This method computes the estimate of the circuit duration by finding the longest duration path in the circuit based on the durations provided by a given target. This method only works for simple circuits that have no control flow or other classical feed-forward operations. @@ -4286,7 +4286,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### qubit\_duration - + Return the duration between the start and stop time of the first and last instructions, excluding delays, over the supplied qubits. Its time unit is `self.unit`. **Parameters** @@ -4304,7 +4304,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### qubit\_start\_time - + Return the start time of the first instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. Return 0 if there are no instructions over qubits @@ -4329,7 +4329,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### qubit\_stop\_time - + Return the stop time of the last instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. Return 0 if there are no instructions over qubits @@ -4396,7 +4396,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### estimate\_fidelity - + Estimate the fidelity of a physical circuit. This function will compute the product of the error rates for each gate in the circuit to estimate the fidelity of the circuit: @@ -4604,7 +4604,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### draw - + Draw the quantum circuit. Use the output parameter to choose the drawing format: **`text`** @@ -4720,7 +4720,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ### decompose - + Call a decomposition pass on this circuit, to decompose one level (shallow decompose). **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.StatePreparation.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.StatePreparation.mdx index b2bde363c7f4..209b6eddbaf8 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.StatePreparation.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.StatePreparation.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.StatePreparation # StatePreparation - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Complex amplitude state preparation. @@ -125,7 +125,7 @@ python_api_name: qiskit.circuit.library.StatePreparation ### broadcast\_arguments - + Validation and handling of the arguments and its relationship. For example, `cx([q[0],q[1]], q[2])` means `cx(q[0], q[2]); cx(q[1], q[2])`. This method yields the arguments in the right grouping. In the given example: @@ -219,7 +219,7 @@ python_api_name: qiskit.circuit.library.StatePreparation ### inverse - + Return inverted StatePreparation **Parameters** @@ -340,7 +340,7 @@ python_api_name: qiskit.circuit.library.StatePreparation ### validate\_parameter - + StatePreparation instruction parameter can be str, int, float, and complex. diff --git a/public/docs/api/qiskit-ibm-runtime/dev/objects.inv b/public/docs/api/qiskit-ibm-runtime/dev/objects.inv index 3c67dd9b5fef..4d3e9aac12af 100644 Binary files a/public/docs/api/qiskit-ibm-runtime/dev/objects.inv and b/public/docs/api/qiskit-ibm-runtime/dev/objects.inv differ diff --git a/public/docs/images/api/qiskit-ibm-runtime/dev/fake_provider-2.avif b/public/docs/images/api/qiskit-ibm-runtime/dev/fake_provider-2.avif index 829abcfb3bc1..414af0faae8d 100644 Binary files a/public/docs/images/api/qiskit-ibm-runtime/dev/fake_provider-2.avif and b/public/docs/images/api/qiskit-ibm-runtime/dev/fake_provider-2.avif differ diff --git a/public/docs/images/api/qiskit-ibm-runtime/dev/fake_provider-3.avif b/public/docs/images/api/qiskit-ibm-runtime/dev/fake_provider-3.avif index 09a01dbdb5ad..a4f315ea11dd 100644 Binary files a/public/docs/images/api/qiskit-ibm-runtime/dev/fake_provider-3.avif and b/public/docs/images/api/qiskit-ibm-runtime/dev/fake_provider-3.avif differ diff --git a/public/docs/images/api/qiskit-ibm-runtime/dev/twirling_strategy_options.avif b/public/docs/images/api/qiskit-ibm-runtime/dev/twirling_strategy_options.avif index 2101da829edb..5680837b8e57 100644 Binary files a/public/docs/images/api/qiskit-ibm-runtime/dev/twirling_strategy_options.avif and b/public/docs/images/api/qiskit-ibm-runtime/dev/twirling_strategy_options.avif differ diff --git a/public/docs/images/api/qiskit/dev/circuit_random-1.avif b/public/docs/images/api/qiskit/dev/circuit_random-1.avif index 1d9a573c26ee..4f71e2ca5a14 100644 Binary files a/public/docs/images/api/qiskit/dev/circuit_random-1.avif and b/public/docs/images/api/qiskit/dev/circuit_random-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/circuit_random-3.avif b/public/docs/images/api/qiskit/dev/circuit_random-3.avif index 540c4f0afca7..7ac7183b9d40 100644 Binary files a/public/docs/images/api/qiskit/dev/circuit_random-3.avif and b/public/docs/images/api/qiskit/dev/circuit_random-3.avif differ diff --git a/public/docs/images/api/qiskit/dev/providers_fake_provider-1_01.avif b/public/docs/images/api/qiskit/dev/providers_fake_provider-1_01.avif index a2d5bd1ad5d9..91b18ac11930 100644 Binary files a/public/docs/images/api/qiskit/dev/providers_fake_provider-1_01.avif and b/public/docs/images/api/qiskit/dev/providers_fake_provider-1_01.avif differ diff --git a/public/docs/images/api/qiskit/dev/providers_fake_provider-1_02.avif b/public/docs/images/api/qiskit/dev/providers_fake_provider-1_02.avif index 8aaab4e74d6d..f3494c01994c 100644 Binary files a/public/docs/images/api/qiskit/dev/providers_fake_provider-1_02.avif and b/public/docs/images/api/qiskit/dev/providers_fake_provider-1_02.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-ControlledGate-2.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-ControlledGate-2.avif index 9a929edf1153..ec6ac9c6f7d0 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-ControlledGate-2.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-ControlledGate-2.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-Parameter-1_00.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-Parameter-1_00.avif index d88623a09c67..3baa4f365dc7 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-Parameter-1_00.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-Parameter-1_00.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-31.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-31.avif index 425cb94980a7..48cc42f34198 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-31.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-31.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-AndGate-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-AndGate-1.avif index 679d51fbe31c..20ea93750d8b 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-AndGate-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-AndGate-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-AndGate-2.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-AndGate-2.avif index 3e5cb82d4a19..19b428d2374a 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-AndGate-2.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-AndGate-2.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-BitwiseXorGate-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-BitwiseXorGate-1.avif index f2a9694b48c2..ce6828304c66 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-BitwiseXorGate-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-BitwiseXorGate-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-InnerProductGate-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-InnerProductGate-1.avif index b05f74b82dcc..3d75561e788a 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-InnerProductGate-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-InnerProductGate-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-OrGate-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-OrGate-1.avif index 7d94c44e1b3f..8f900e0c6b8a 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-OrGate-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-OrGate-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-OrGate-2.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-OrGate-2.avif index 8a1371292396..256a9ea5295d 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-OrGate-2.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-OrGate-2.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-PermutationGate-2.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-PermutationGate-2.avif index 686323b9e89f..477f0bcfb675 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-PermutationGate-2.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-PermutationGate-2.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-PhaseEstimation-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-PhaseEstimation-1.avif index 181130499e6f..f038b883d712 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-PhaseEstimation-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-PhaseEstimation-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-random_iqp-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-random_iqp-1.avif index 3f7d1daffac2..655dc7c461ba 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-random_iqp-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-random_iqp-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-unitary_overlap-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-unitary_overlap-1.avif index 0f1c1f91f358..efc2f6bbeb63 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-unitary_overlap-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-unitary_overlap-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-quantum_info-Statevector-1.avif b/public/docs/images/api/qiskit/dev/qiskit-quantum_info-Statevector-1.avif index 398592d403e9..0cc48a06e322 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-quantum_info-Statevector-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-quantum_info-Statevector-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-FilterOpNodes-1.avif b/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-FilterOpNodes-1.avif index 7d25146ebb4a..31fcf98e2f53 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-FilterOpNodes-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-FilterOpNodes-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-RemoveBarriers-1.avif b/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-RemoveBarriers-1.avif index 1d8352f18ec4..1bc3185fcd99 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-RemoveBarriers-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-RemoveBarriers-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-TwoQubitPeepholeOptimization-1.avif b/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-TwoQubitPeepholeOptimization-1.avif index 622467136968..2609efacae13 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-TwoQubitPeepholeOptimization-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-TwoQubitPeepholeOptimization-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-circuit_drawer-1.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-circuit_drawer-1.avif index 04dce7086278..53e76bccf4ff 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-circuit_drawer-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-circuit_drawer-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_error_map-1.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_error_map-1.avif index d51c9286b8bc..0752a74a8c96 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_error_map-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_error_map-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_histogram-1_01.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_histogram-1_01.avif index 6fdfe71912de..a86ed76372fa 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_histogram-1_01.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_histogram-1_01.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_hinton-1.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_hinton-1.avif index 0bbc2b05a9b0..64d1f877b01a 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_hinton-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_hinton-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-1.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-1.avif index 41c9e81d3715..1c6d6eee9d18 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-2.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-2.avif index 8411698ea32c..98eaa02053f1 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-2.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-2.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-3.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-3.avif index ec5e9c9512e0..d72a65d52dff 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-3.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-3.avif differ diff --git a/public/docs/images/api/qiskit/dev/transpiler-10.avif b/public/docs/images/api/qiskit/dev/transpiler-10.avif index 097e2c7d993d..5342e1ee0e81 100644 Binary files a/public/docs/images/api/qiskit/dev/transpiler-10.avif and b/public/docs/images/api/qiskit/dev/transpiler-10.avif differ diff --git a/public/docs/images/api/qiskit/dev/transpiler-9.avif b/public/docs/images/api/qiskit/dev/transpiler-9.avif index a65fa2e9f9c4..9e665da877f1 100644 Binary files a/public/docs/images/api/qiskit/dev/transpiler-9.avif and b/public/docs/images/api/qiskit/dev/transpiler-9.avif differ diff --git a/public/docs/images/api/qiskit/dev/visualization-1.avif b/public/docs/images/api/qiskit/dev/visualization-1.avif index 090bfd02e0ea..b9b279364dbd 100644 Binary files a/public/docs/images/api/qiskit/dev/visualization-1.avif and b/public/docs/images/api/qiskit/dev/visualization-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/visualization-3.avif b/public/docs/images/api/qiskit/dev/visualization-3.avif index a6e86ae6590f..3fa5a171f6fd 100644 Binary files a/public/docs/images/api/qiskit/dev/visualization-3.avif and b/public/docs/images/api/qiskit/dev/visualization-3.avif differ diff --git a/scripts/config/api-html-artifacts.json b/scripts/config/api-html-artifacts.json index 52019d7ee533..16c06536f8d5 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/8687727244/zip", + "dev": "https://api.github.com/repos/Qiskit/qiskit/actions/artifacts/8767252030/zip", "2.5": "https://ibm.box.com/shared/static/ff4svnqi3krdcpk0idw4yomnb4559707.zip", "2.4": "https://ibm.box.com/shared/static/8dug8a79f1xdohccyasfaazxn0tejzg9.zip", "2.3": "https://ibm.box.com/shared/static/hu6gvj4857vb5sew5k98rr9yd7pxasqy.zip", @@ -37,7 +37,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/8704421298/zip", + "dev": "https://api.github.com/repos/Qiskit/qiskit-ibm-runtime/actions/artifacts/8771652726/zip", "0.48": "https://ibm.box.com/shared/static/w5yy54rxg8zspe8bxueknastn9cw8nfe.zip", "0.47": "https://ibm.box.com/shared/static/68x7u8qpr72id254w6hnjbgo7317hwjk.zip", "0.46": "https://ibm.box.com/shared/static/p2jntzpdwqa75i75d0sm5ltzbaaw5ksa.zip", diff --git a/scripts/config/historical-pages-to-latest.json b/scripts/config/historical-pages-to-latest.json index 22f8c0e58939..65119948112c 100644 --- a/scripts/config/historical-pages-to-latest.json +++ b/scripts/config/historical-pages-to-latest.json @@ -1536,7 +1536,8 @@ "ibm-quantum-schemas-common-compressed-qpy-data-model": "/", "ibm-quantum-schemas-common-compressed-tensor-model": "/", "ibm-quantum-schemas-common-f-64-compressed-tensor-model": "/", - "ibm-quantum-schemas-common-open-qasm-3-data-model": "/" + "ibm-quantum-schemas-common-open-qasm-3-data-model": "/", + "options-legacy-simulator-options": "/" } }, "qiskit-ibm-transpiler": {