From 482b715a5b308a16a4ac7a9b3c83a07697faf5b4 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 3 Dec 2024 01:36:31 +0000 Subject: [PATCH] Sync latest dev docs --- .../qiskit-ibm-runtime/dev/fake_provider.mdx | 14 +- .../dev/qiskit_ibm_runtime.Batch.mdx | 2 +- .../dev/qiskit_ibm_runtime.EstimatorV2.mdx | 4 +- .../dev/qiskit_ibm_runtime.IBMBackend.mdx | 30 +-- .../dev/qiskit_ibm_runtime.RuntimeJob.mdx | 10 +- .../dev/qiskit_ibm_runtime.RuntimeJobV2.mdx | 6 +- .../dev/qiskit_ibm_runtime.SamplerV2.mdx | 2 +- .../qiskit_ibm_runtime.debug_tools.Neat.mdx | 2 +- ..._ibm_runtime.debug_tools.NeatPubResult.mdx | 2 +- ..._ibm_runtime.fake_provider.FakeAlgiers.mdx | 22 +- ...bm_runtime.fake_provider.FakeAlmadenV2.mdx | 22 +- ...ibm_runtime.fake_provider.FakeArmonkV2.mdx | 22 +- ...ibm_runtime.fake_provider.FakeAthensV2.mdx | 22 +- ...ibm_runtime.fake_provider.FakeAuckland.mdx | 22 +- ..._ibm_runtime.fake_provider.FakeBelemV2.mdx | 22 +- ...runtime.fake_provider.FakeBoeblingenV2.mdx | 22 +- ...ibm_runtime.fake_provider.FakeBogotaV2.mdx | 22 +- ...ibm_runtime.fake_provider.FakeBrisbane.mdx | 22 +- ...m_runtime.fake_provider.FakeBrooklynV2.mdx | 22 +- ...runtime.fake_provider.FakeBurlingtonV2.mdx | 22 +- ..._ibm_runtime.fake_provider.FakeCairoV2.mdx | 22 +- ..._runtime.fake_provider.FakeCambridgeV2.mdx | 22 +- ...runtime.fake_provider.FakeCasablancaV2.mdx | 22 +- ...it_ibm_runtime.fake_provider.FakeCusco.mdx | 22 +- ..._ibm_runtime.fake_provider.FakeEssexV2.mdx | 22 +- ...me.fake_provider.FakeFractionalBackend.mdx | 22 +- ...t_ibm_runtime.fake_provider.FakeGeneva.mdx | 22 +- ..._runtime.fake_provider.FakeGuadalupeV2.mdx | 22 +- ..._ibm_runtime.fake_provider.FakeHanoiV2.mdx | 22 +- ...bm_runtime.fake_provider.FakeJakartaV2.mdx | 22 +- ...ntime.fake_provider.FakeJohannesburgV2.mdx | 22 +- ...ibm_runtime.fake_provider.FakeKawasaki.mdx | 22 +- ...bm_runtime.fake_provider.FakeKolkataV2.mdx | 22 +- ...kit_ibm_runtime.fake_provider.FakeKyiv.mdx | 22 +- ...it_ibm_runtime.fake_provider.FakeKyoto.mdx | 22 +- ..._ibm_runtime.fake_provider.FakeLagosV2.mdx | 22 +- ...t_ibm_runtime.fake_provider.FakeLimaV2.mdx | 22 +- ...ibm_runtime.fake_provider.FakeLondonV2.mdx | 22 +- ..._runtime.fake_provider.FakeManhattanV2.mdx | 22 +- ...ibm_runtime.fake_provider.FakeManilaV2.mdx | 22 +- ..._runtime.fake_provider.FakeMelbourneV2.mdx | 22 +- ...m_runtime.fake_provider.FakeMontrealV2.mdx | 22 +- ...ibm_runtime.fake_provider.FakeMumbaiV2.mdx | 22 +- ...bm_runtime.fake_provider.FakeNairobiV2.mdx | 22 +- ...it_ibm_runtime.fake_provider.FakeOsaka.mdx | 22 +- ...kit_ibm_runtime.fake_provider.FakeOslo.mdx | 22 +- ...bm_runtime.fake_provider.FakeOurenseV2.mdx | 22 +- ..._ibm_runtime.fake_provider.FakeParisV2.mdx | 22 +- ...bm_runtime.fake_provider.FakePeekskill.mdx | 22 +- ...it_ibm_runtime.fake_provider.FakePerth.mdx | 22 +- ...ntime.fake_provider.FakePoughkeepsieV2.mdx | 22 +- ...t_ibm_runtime.fake_provider.FakePrague.mdx | 22 +- ...t_ibm_runtime.fake_provider.FakeQuebec.mdx | 22 +- ..._ibm_runtime.fake_provider.FakeQuitoV2.mdx | 22 +- ..._runtime.fake_provider.FakeRochesterV2.mdx | 22 +- ...t_ibm_runtime.fake_provider.FakeRomeV2.mdx | 22 +- ...m_runtime.fake_provider.FakeSantiagoV2.mdx | 22 +- ...m_runtime.fake_provider.FakeSherbrooke.mdx | 22 +- ..._runtime.fake_provider.FakeSingaporeV2.mdx | 22 +- ...ibm_runtime.fake_provider.FakeSydneyV2.mdx | 22 +- ...t_ibm_runtime.fake_provider.FakeTorino.mdx | 22 +- ...bm_runtime.fake_provider.FakeTorontoV2.mdx | 22 +- ...m_runtime.fake_provider.FakeValenciaV2.mdx | 22 +- ...t_ibm_runtime.fake_provider.FakeVigoV2.mdx | 22 +- ...runtime.fake_provider.FakeWashingtonV2.mdx | 22 +- ...m_runtime.fake_provider.FakeYorktownV2.mdx | 22 +- ...ibm_runtime.noise_learner.NoiseLearner.mdx | 4 +- ...t_ibm_runtime.options.SimulatorOptions.mdx | 4 +- ...it_ibm_runtime.options.TwirlingOptions.mdx | 4 +- .../qiskit_ibm_runtime.options.ZneOptions.mdx | 2 +- ...transpiler.passes.ConvertISAToClifford.mdx | 16 +- ...ime.transpiler.passes.ConvertIdToDelay.mdx | 16 +- ...passes.scheduling.ALAPScheduleAnalysis.mdx | 10 +- ...passes.scheduling.ASAPScheduleAnalysis.mdx | 12 +- ...iler.passes.scheduling.BlockBasePadder.mdx | 12 +- ...ing.DynamicCircuitInstructionDurations.mdx | 12 +- ....transpiler.passes.scheduling.PadDelay.mdx | 10 +- ...sses.scheduling.PadDynamicalDecoupling.mdx | 79 +------ ...m_runtime.transpiler.passes.scheduling.mdx | 63 ++--- docs/api/qiskit/dev/assembler.mdx | 6 +- docs/api/qiskit/dev/circuit.mdx | 40 +++- docs/api/qiskit/dev/circuit_classical.mdx | 215 +++++++++++++++++- docs/api/qiskit/dev/circuit_library.mdx | 24 ++ docs/api/qiskit/dev/circuit_singleton.mdx | 6 + docs/api/qiskit/dev/classicalfunction.mdx | 4 +- docs/api/qiskit/dev/converters.mdx | 6 +- docs/api/qiskit/dev/dagcircuit.mdx | 4 + docs/api/qiskit/dev/exceptions.mdx | 25 ++ docs/api/qiskit/dev/passmanager.mdx | 2 + docs/api/qiskit/dev/providers.mdx | 10 + .../qiskit/dev/providers_fake_provider.mdx | 6 + docs/api/qiskit/dev/pulse.mdx | 120 ++++++---- docs/api/qiskit/dev/qasm2.mdx | 22 +- docs/api/qiskit/dev/qasm3.mdx | 24 +- .../dev/qiskit.circuit.AnnotatedOperation.mdx | 4 + .../dev/qiskit.circuit.CommutationChecker.mdx | 10 + .../dev/qiskit.circuit.ControlledGate.mdx | 4 + .../dev/qiskit.circuit.InstructionSet.mdx | 4 + .../qiskit/dev/qiskit.circuit.Parameter.mdx | 5 + .../dev/qiskit.circuit.QuantumCircuit.mdx | 212 ++++++++++------- .../dev/qiskit.circuit.SwitchCaseOp.mdx | 1 + ...it.classicalfunction.BooleanExpression.mdx | 4 + ...ion.ClassicalFunctionCompilerTypeError.mdx | 2 + ...alfunction.ClassicalFunctionParseError.mdx | 2 + ...t.circuit.library.CDKMRippleCarryAdder.mdx | 2 +- .../dev/qiskit.circuit.library.CHGate.mdx | 4 + .../dev/qiskit.circuit.library.CPhaseGate.mdx | 10 + .../dev/qiskit.circuit.library.CRXGate.mdx | 6 + .../dev/qiskit.circuit.library.CRYGate.mdx | 6 + .../dev/qiskit.circuit.library.CRZGate.mdx | 6 + .../dev/qiskit.circuit.library.CU1Gate.mdx | 6 + .../dev/qiskit.circuit.library.CU3Gate.mdx | 8 + .../dev/qiskit.circuit.library.CUGate.mdx | 9 + .../qiskit.circuit.library.DiagonalGate.mdx | 4 + .../qiskit.circuit.library.DraperQFTAdder.mdx | 2 +- .../qiskit.circuit.library.EfficientSU2.mdx | 3 +- ....circuit.library.EvolvedOperatorAnsatz.mdx | 2 +- ...qiskit.circuit.library.ExactReciprocal.mdx | 2 +- ...t.circuit.library.ExcitationPreserving.mdx | 3 +- ...qiskit.circuit.library.FourierChecking.mdx | 2 +- .../qiskit.circuit.library.FullAdderGate.mdx | 1 + ...rcuit.library.FunctionalPauliRotations.mdx | 2 +- .../qiskit/dev/qiskit.circuit.library.GMS.mdx | 2 +- .../qiskit/dev/qiskit.circuit.library.GR.mdx | 2 +- .../qiskit/dev/qiskit.circuit.library.GRX.mdx | 2 +- .../qiskit/dev/qiskit.circuit.library.GRY.mdx | 2 +- .../qiskit/dev/qiskit.circuit.library.GRZ.mdx | 2 +- .../dev/qiskit.circuit.library.GraphState.mdx | 2 +- .../qiskit.circuit.library.GroverOperator.mdx | 2 +- ...ircuit.library.HRSCumulativeMultiplier.mdx | 2 +- .../qiskit.circuit.library.HalfAdderGate.mdx | 1 + ...qiskit.circuit.library.HamiltonianGate.mdx | 4 + ...t.circuit.library.HiddenLinearFunction.mdx | 2 +- .../qiskit.circuit.library.InnerProduct.mdx | 2 +- ...skit.circuit.library.IntegerComparator.mdx | 2 +- ...ircuit.library.LinearAmplitudeFunction.mdx | 2 +- ...t.circuit.library.LinearPauliRotations.mdx | 2 +- .../dev/qiskit.circuit.library.MCMT.mdx | 6 +- .../dev/qiskit.circuit.library.MCMTGate.mdx | 4 + .../dev/qiskit.circuit.library.MCMTVChain.mdx | 12 +- .../qiskit.circuit.library.MCPhaseGate.mdx | 11 + .../dev/qiskit.circuit.library.MCXGate.mdx | 11 + .../qiskit.circuit.library.MCXGrayCode.mdx | 6 + .../qiskit.circuit.library.MCXRecursive.mdx | 11 + .../dev/qiskit.circuit.library.MCXVChain.mdx | 8 + ...iskit.circuit.library.ModularAdderGate.mdx | 1 + .../qiskit.circuit.library.MultiplierGate.mdx | 1 + .../dev/qiskit.circuit.library.NLocal.mdx | 7 +- .../qiskit/dev/qiskit.circuit.library.OR.mdx | 2 +- ...kit.circuit.library.PauliEvolutionGate.mdx | 10 +- ...qiskit.circuit.library.PauliFeatureMap.mdx | 3 +- .../dev/qiskit.circuit.library.PauliGate.mdx | 4 + .../qiskit.circuit.library.PauliTwoDesign.mdx | 3 +- .../qiskit.circuit.library.Permutation.mdx | 2 +- ...qiskit.circuit.library.PermutationGate.mdx | 4 + ...qiskit.circuit.library.PhaseEstimation.mdx | 2 +- .../dev/qiskit.circuit.library.PhaseGate.mdx | 5 + .../qiskit.circuit.library.PhaseOracle.mdx | 2 +- ...kit.circuit.library.PiecewiseChebyshev.mdx | 2 +- ....library.PiecewiseLinearPauliRotations.mdx | 2 +- ...rary.PiecewisePolynomialPauliRotations.mdx | 2 +- ...rcuit.library.PolynomialPauliRotations.mdx | 2 +- .../qiskit.circuit.library.QuantumVolume.mdx | 2 +- ...qiskit.circuit.library.RGQFTMultiplier.mdx | 2 +- .../dev/qiskit.circuit.library.RGate.mdx | 6 + .../dev/qiskit.circuit.library.RVGate.mdx | 4 + .../dev/qiskit.circuit.library.RXGate.mdx | 5 + .../dev/qiskit.circuit.library.RXXGate.mdx | 5 + .../dev/qiskit.circuit.library.RYGate.mdx | 5 + .../dev/qiskit.circuit.library.RYYGate.mdx | 5 + .../dev/qiskit.circuit.library.RZGate.mdx | 5 + .../dev/qiskit.circuit.library.RZXGate.mdx | 5 + .../dev/qiskit.circuit.library.RZZGate.mdx | 5 + .../qiskit.circuit.library.RealAmplitudes.mdx | 3 +- ...iskit.circuit.library.StatePreparation.mdx | 4 + .../dev/qiskit.circuit.library.TwoLocal.mdx | 9 +- .../dev/qiskit.circuit.library.U1Gate.mdx | 5 + .../dev/qiskit.circuit.library.U2Gate.mdx | 6 + .../dev/qiskit.circuit.library.U3Gate.mdx | 7 + .../dev/qiskit.circuit.library.UCGate.mdx | 4 + .../dev/qiskit.circuit.library.UGate.mdx | 7 + .../qiskit.circuit.library.UnitaryGate.mdx | 18 +- ...it.circuit.library.VBERippleCarryAdder.mdx | 2 +- .../qiskit.circuit.library.WeightedAdder.mdx | 2 +- .../qiskit/dev/qiskit.circuit.library.XOR.mdx | 2 +- .../qiskit.circuit.library.ZFeatureMap.mdx | 3 +- .../qiskit.circuit.library.ZZFeatureMap.mdx | 3 +- ...iskit.circuit.library.fourier_checking.mdx | 5 + ...skit.circuit.library.pauli_feature_map.mdx | 12 + .../qiskit.circuit.library.quantum_volume.mdx | 6 + .../qiskit.circuit.library.z_feature_map.mdx | 11 + .../qiskit.circuit.library.zz_feature_map.mdx | 11 + .../dev/qiskit.dagcircuit.DAGDepNode.mdx | 11 + .../qiskit.passmanager.BasePassManager.mdx | 12 + ...skit.passmanager.ConditionalController.mdx | 4 +- .../qiskit.passmanager.DoWhileController.mdx | 4 +- ...iskit.passmanager.FlowControllerLinear.mdx | 3 +- .../qiskit.passmanager.PassManagerState.mdx | 5 + .../dev/qiskit.passmanager.WorkflowStatus.mdx | 6 + .../qiskit.primitives.BackendEstimator.mdx | 2 +- .../dev/qiskit.primitives.BackendSampler.mdx | 2 +- .../dev/qiskit.primitives.BaseEstimator.mdx | 4 +- .../dev/qiskit.primitives.BaseEstimatorV1.mdx | 4 +- .../dev/qiskit.primitives.BaseEstimatorV2.mdx | 4 +- .../dev/qiskit.primitives.BaseSampler.mdx | 4 +- .../dev/qiskit.primitives.BaseSamplerV1.mdx | 4 +- .../dev/qiskit.primitives.BaseSamplerV2.mdx | 4 +- .../qiskit/dev/qiskit.primitives.DataBin.mdx | 8 +- .../dev/qiskit.primitives.Estimator.mdx | 6 +- .../qiskit/dev/qiskit.primitives.Sampler.mdx | 6 +- .../qiskit.primitives.StatevectorSampler.mdx | 4 +- .../qiskit/dev/qiskit.providers.BackendV2.mdx | 12 + .../qiskit.providers.BackendV2Converter.mdx | 16 ++ .../api/qiskit/dev/qiskit.providers.JobV1.mdx | 4 + ...providers.basic_provider.BasicProvider.mdx | 1 + ...ders.basic_provider.BasicProviderError.mdx | 2 + ...viders.basic_provider.BasicProviderJob.mdx | 4 + ...roviders.basic_provider.BasicSimulator.mdx | 20 +- ...oviders.fake_provider.GenericBackendV2.mdx | 16 ++ ...iders.models.PulseBackendConfiguration.mdx | 20 ++ .../qiskit.providers.models.PulseDefaults.mdx | 11 + .../qiskit.pulse.InstructionScheduleMap.mdx | 12 + docs/api/qiskit/dev/qiskit.pulse.Schedule.mdx | 48 ++-- .../qiskit/dev/qiskit.pulse.ScheduleBlock.mdx | 30 +-- ...qiskit.pulse.instructions.TimeBlockade.mdx | 2 +- .../qiskit/dev/qiskit.pulse.library.Cos.mdx | 2 +- .../qiskit.pulse.library.GaussianDeriv.mdx | 2 +- ...iskit.pulse.library.GaussianSquareDrag.mdx | 2 +- .../dev/qiskit.pulse.library.Sawtooth.mdx | 2 +- .../qiskit/dev/qiskit.pulse.library.Sech.mdx | 2 +- .../dev/qiskit.pulse.library.SechDeriv.mdx | 2 +- .../qiskit/dev/qiskit.pulse.library.Sin.mdx | 2 +- .../dev/qiskit.pulse.library.Square.mdx | 2 +- .../qiskit.pulse.library.SymbolicPulse.mdx | 12 +- .../dev/qiskit.pulse.library.Triangle.mdx | 2 +- ...kit.pulse.library.gaussian_square_echo.mdx | 2 +- .../dev/qiskit.pulse.transforms.AlignFunc.mdx | 4 +- .../dev/qiskit.quantum_info.CNOTDihedral.mdx | 22 +- .../qiskit/dev/qiskit.quantum_info.Chi.mdx | 28 ++- .../qiskit/dev/qiskit.quantum_info.Choi.mdx | 28 ++- .../dev/qiskit.quantum_info.Clifford.mdx | 44 ++-- .../dev/qiskit.quantum_info.DensityMatrix.mdx | 66 +++--- .../qiskit/dev/qiskit.quantum_info.Kraus.mdx | 15 ++ .../dev/qiskit.quantum_info.Operator.mdx | 38 ++-- .../qiskit/dev/qiskit.quantum_info.PTM.mdx | 28 ++- .../qiskit/dev/qiskit.quantum_info.Pauli.mdx | 40 ++-- .../dev/qiskit.quantum_info.PauliList.mdx | 56 ++--- .../qiskit.quantum_info.SparseObservable.mdx | 2 + .../dev/qiskit.quantum_info.SparsePauliOp.mdx | 56 ++--- .../qiskit.quantum_info.StabilizerState.mdx | 40 ++-- .../dev/qiskit.quantum_info.Statevector.mdx | 49 ++-- .../dev/qiskit.quantum_info.Stinespring.mdx | 23 +- .../dev/qiskit.quantum_info.SuperOp.mdx | 40 +++- .../dev/qiskit.quantum_info.Z2Symmetries.mdx | 4 + .../qiskit/dev/qiskit.result.ResultError.mdx | 2 + ...it.synthesis.TwoQubitWeylDecomposition.mdx | 18 ++ .../dev/qiskit.synthesis.XXDecomposer.mdx | 4 + .../dev/qiskit.synthesis.unitary.aqc.AQC.mdx | 4 + ...nthesis.unitary.aqc.ApproximateCircuit.mdx | 4 + ....synthesis.unitary.aqc.CNOTUnitCircuit.mdx | 10 +- ...esis.unitary.aqc.FastCNOTUnitObjective.mdx | 8 + ...qiskit.transpiler.InstructionDurations.mdx | 5 + .../qiskit/dev/qiskit.transpiler.Layout.mdx | 4 + .../dev/qiskit.transpiler.PassManager.mdx | 12 + .../qiskit.transpiler.StagedPassManager.mdx | 12 + .../dev/qiskit.transpiler.TranspileLayout.mdx | 8 + ...ranspiler.passes.Commuting2qGateRouter.mdx | 6 +- ...qiskit.transpiler.passes.FilterOpNodes.mdx | 4 + ...r.passes.LinearFunctionsToPermutations.mdx | 4 + .../dev/qiskit.transpiler.passes.PadDelay.mdx | 2 +- ...transpiler.passes.RXCalibrationBuilder.mdx | 16 +- ...iskit.transpiler.passes.RemoveBarriers.mdx | 4 + ...qiskit.transpiler.passes.SolovayKitaev.mdx | 4 +- ...kit.transpiler.passes.Split2QUnitaries.mdx | 4 + ...iskit.transpiler.passes.StarPreRouting.mdx | 5 + ...itaev_synthesis.SolovayKitaevSynthesis.mdx | 4 +- ...s.plugin.PassManagerStagePluginManager.mdx | 6 + ...skit.visualization.pass_manager_drawer.mdx | 2 +- ...t.visualization.plot_bloch_multivector.mdx | 2 +- ...qiskit.visualization.plot_bloch_vector.mdx | 4 +- ...qiskit.visualization.plot_distribution.mdx | 2 +- .../qiskit.visualization.plot_histogram.mdx | 2 +- .../qiskit.visualization.plot_state_city.mdx | 6 +- ...qiskit.visualization.plot_state_hinton.mdx | 6 +- ...skit.visualization.plot_state_paulivec.mdx | 4 +- ...iskit.visualization.plot_state_qsphere.mdx | 4 +- .../qiskit.visualization.timeline_drawer.mdx | 30 +++ docs/api/qiskit/dev/qpy.mdx | 21 +- docs/api/qiskit/dev/quantum_info.mdx | 2 +- docs/api/qiskit/dev/scheduler.mdx | 2 + docs/api/qiskit/dev/synthesis.mdx | 7 + docs/api/qiskit/dev/transpiler.mdx | 40 ++-- docs/api/qiskit/dev/transpiler_plugins.mdx | 2 +- docs/api/qiskit/dev/utils.mdx | 77 +++---- docs/api/qiskit/dev/visualization.mdx | 2 + public/api/qiskit/dev/objects.inv | Bin 76906 -> 76896 bytes ..._provider-1_00.png => fake_provider-1.png} | Bin 13102 -> 13102 bytes .../dev/fake_provider-1_02.png | Bin 12696 -> 0 bytes ..._provider-1_01.png => fake_provider-2.png} | Bin 22140 -> 22140 bytes .../dev/fake_provider-3.png | Bin 0 -> 11625 bytes ...runtime-transpiler-passes-scheduling-1.png | Bin 0 -> 48712 bytes ...untime-transpiler-passes-scheduling-10.png | Bin 0 -> 7599 bytes ...untime-transpiler-passes-scheduling-11.png | Bin 0 -> 8042 bytes ...untime-transpiler-passes-scheduling-12.png | Bin 0 -> 5740 bytes ...untime-transpiler-passes-scheduling-13.png | Bin 0 -> 5585 bytes ...untime-transpiler-passes-scheduling-14.png | Bin 0 -> 5952 bytes ...untime-transpiler-passes-scheduling-15.png | Bin 0 -> 10199 bytes ...untime-transpiler-passes-scheduling-16.png | Bin 0 -> 14958 bytes ...untime-transpiler-passes-scheduling-17.png | Bin 0 -> 10120 bytes ...runtime-transpiler-passes-scheduling-2.png | Bin 0 -> 53611 bytes ...runtime-transpiler-passes-scheduling-3.png | Bin 0 -> 2854 bytes ...runtime-transpiler-passes-scheduling-4.png | Bin 0 -> 17295 bytes ...runtime-transpiler-passes-scheduling-5.png | Bin 0 -> 17295 bytes ...runtime-transpiler-passes-scheduling-6.png | Bin 0 -> 9235 bytes ...runtime-transpiler-passes-scheduling-7.png | Bin 0 -> 6341 bytes ...runtime-transpiler-passes-scheduling-8.png | Bin 0 -> 6871 bytes ...runtime-transpiler-passes-scheduling-9.png | Bin 0 -> 10530 bytes ...es-scheduling-PadDynamicalDecoupling-1.png | Bin 0 -> 27409 bytes ...es-scheduling-PadDynamicalDecoupling-2.png | Bin 0 -> 24585 bytes ...ntime.transpiler.passes.scheduling_0_0.png | Bin 58146 -> 0 bytes ...time.transpiler.passes.scheduling_10_0.png | Bin 9687 -> 0 bytes ...time.transpiler.passes.scheduling_11_0.png | Bin 7004 -> 0 bytes ...time.transpiler.passes.scheduling_12_0.png | Bin 6991 -> 0 bytes ...time.transpiler.passes.scheduling_13_0.png | Bin 7246 -> 0 bytes ...time.transpiler.passes.scheduling_14_0.png | Bin 18297 -> 0 bytes ...time.transpiler.passes.scheduling_15_0.png | Bin 11921 -> 0 bytes ...ntime.transpiler.passes.scheduling_1_0.png | Bin 62086 -> 0 bytes ...ntime.transpiler.passes.scheduling_2_0.png | Bin 3565 -> 0 bytes ...ntime.transpiler.passes.scheduling_3_0.png | Bin 21200 -> 0 bytes ...ntime.transpiler.passes.scheduling_4_0.png | Bin 21200 -> 0 bytes ...ntime.transpiler.passes.scheduling_5_0.png | Bin 11208 -> 0 bytes ...ntime.transpiler.passes.scheduling_6_0.png | Bin 7598 -> 0 bytes ...ntime.transpiler.passes.scheduling_7_0.png | Bin 8263 -> 0 bytes ...ntime.transpiler.passes.scheduling_8_0.png | Bin 12759 -> 0 bytes ...ntime.transpiler.passes.scheduling_9_0.png | Bin 9282 -> 0 bytes .../dev/twirling_strategy_options.png | Bin 0 -> 48615 bytes public/images/api/qiskit/dev/circuit-1.png | Bin 5373 -> 5373 bytes public/images/api/qiskit/dev/circuit-2.png | Bin 9441 -> 0 bytes public/images/api/qiskit/dev/circuit-3.png | Bin 0 -> 8349 bytes .../dev/{circuit-4.png => circuit-5.png} | Bin 13896 -> 13896 bytes .../api/qiskit/dev/circuit_library-1.png | Bin 6289 -> 6289 bytes .../{converters-1.png => converters-3.png} | Bin 8320 -> 8320 bytes .../dev/providers_fake_provider-1_00.png | Bin 13102 -> 13102 bytes .../dev/providers_fake_provider-1_01.png | Bin 22636 -> 22466 bytes .../dev/providers_fake_provider-1_02.png | Bin 11102 -> 10435 bytes public/images/api/qiskit/dev/pulse-1.png | Bin 31312 -> 0 bytes public/images/api/qiskit/dev/pulse-15.png | Bin 0 -> 19163 bytes public/images/api/qiskit/dev/pulse-2.png | Bin 10723 -> 0 bytes public/images/api/qiskit/dev/pulse-3.png | Bin 59790 -> 0 bytes public/images/api/qiskit/dev/pulse-33.png | Bin 0 -> 16506 bytes public/images/api/qiskit/dev/pulse-34.png | Bin 0 -> 11526 bytes public/images/api/qiskit/dev/pulse-35.png | Bin 0 -> 14123 bytes public/images/api/qiskit/dev/pulse-4.png | Bin 19163 -> 0 bytes public/images/api/qiskit/dev/pulse-5.png | Bin 16243 -> 31312 bytes public/images/api/qiskit/dev/pulse-6.png | Bin 11349 -> 10947 bytes public/images/api/qiskit/dev/pulse-7.png | Bin 14173 -> 59850 bytes .../qiskit/dev/{qasm3-1.png => qasm3-2.png} | Bin 25489 -> 25489 bytes .../dev/qiskit-circuit-ControlledGate-1.png | Bin 4578 -> 4578 bytes .../dev/qiskit-circuit-ControlledGate-2.png | Bin 7381 -> 7047 bytes .../qiskit/dev/qiskit-circuit-Operation-1.png | Bin 5879 -> 5879 bytes .../dev/qiskit-circuit-Parameter-1_00.png | Bin 1689 -> 1689 bytes .../dev/qiskit-circuit-Parameter-1_01.png | Bin 5370 -> 5370 bytes ...g => qiskit-circuit-QuantumCircuit-19.png} | Bin 29666 -> 29666 bytes ...g => qiskit-circuit-QuantumCircuit-20.png} | Bin 3214 -> 3214 bytes ...=> qiskit-circuit-QuantumCircuit-4_00.png} | Bin 3661 -> 3661 bytes ...=> qiskit-circuit-QuantumCircuit-4_01.png} | Bin 3635 -> 3635 bytes ...=> qiskit-circuit-QuantumCircuit-5_00.png} | Bin 3585 -> 3585 bytes ...=> qiskit-circuit-QuantumCircuit-5_01.png} | Bin 3913 -> 3913 bytes ...ng => qiskit-circuit-QuantumCircuit-6.png} | Bin 4256 -> 4256 bytes .../dev/qiskit-circuit-library-AND-1.png | Bin 16860 -> 16860 bytes .../dev/qiskit-circuit-library-AND-2.png | Bin 17615 -> 17615 bytes .../dev/qiskit-circuit-library-AndGate-1.png | Bin 13091 -> 12920 bytes .../dev/qiskit-circuit-library-AndGate-2.png | Bin 15197 -> 14965 bytes ...iskit-circuit-library-BitwiseXorGate-1.png | Bin 14239 -> 14093 bytes ...skit-circuit-library-FourierChecking-1.png | Bin 11627 -> 11627 bytes .../dev/qiskit-circuit-library-GMS-1.png | Bin 13316 -> 13316 bytes .../dev/qiskit-circuit-library-GR-1.png | Bin 16936 -> 16936 bytes .../dev/qiskit-circuit-library-GRX-1.png | Bin 16876 -> 16876 bytes .../dev/qiskit-circuit-library-GRY-1.png | Bin 16936 -> 16936 bytes .../dev/qiskit-circuit-library-GRZ-1.png | Bin 12094 -> 12094 bytes .../qiskit-circuit-library-GraphState-1.png | Bin 15678 -> 15678 bytes ...iskit-circuit-library-GraphStateGate-1.png | Bin 8954 -> 8954 bytes ...circuit-library-HiddenLinearFunction-1.png | Bin 13076 -> 13076 bytes .../dev/qiskit-circuit-library-IQP-1.png | Bin 6597 -> 6597 bytes .../dev/qiskit-circuit-library-IQP-2.png | Bin 15203 -> 15203 bytes .../qiskit-circuit-library-InnerProduct-1.png | Bin 14234 -> 14234 bytes ...kit-circuit-library-InnerProductGate-1.png | Bin 14291 -> 14266 bytes .../qiskit-circuit-library-MCMTVChain-1.png | Bin 14771 -> 14771 bytes .../dev/qiskit-circuit-library-OR-1.png | Bin 20577 -> 20577 bytes .../dev/qiskit-circuit-library-OR-2.png | Bin 18664 -> 18664 bytes .../dev/qiskit-circuit-library-OrGate-1.png | Bin 18663 -> 18579 bytes .../dev/qiskit-circuit-library-OrGate-2.png | Bin 16487 -> 16408 bytes ...iskit-circuit-library-PauliTwoDesign-1.png | Bin 10538 -> 10538 bytes .../qiskit-circuit-library-Permutation-1.png | Bin 9030 -> 9030 bytes .../qiskit-circuit-library-Permutation-2.png | Bin 16568 -> 16568 bytes ...skit-circuit-library-PermutationGate-1.png | Bin 7616 -> 7616 bytes ...skit-circuit-library-PermutationGate-2.png | Bin 15991 -> 16032 bytes ...skit-circuit-library-PhaseEstimation-1.png | Bin 12176 -> 12201 bytes ...t-circuit-library-PiecewiseChebyshev-1.png | Bin 7636 -> 7636 bytes .../dev/qiskit-circuit-library-QFT-1.png | Bin 11836 -> 11836 bytes .../dev/qiskit-circuit-library-QFT-2.png | Bin 12001 -> 12001 bytes .../dev/qiskit-circuit-library-QFT-3.png | Bin 12100 -> 12100 bytes ...qiskit-circuit-library-QuantumVolume-1.png | Bin 9389 -> 9389 bytes ...qiskit-circuit-library-QuantumVolume-2.png | Bin 19180 -> 19180 bytes .../dev/qiskit-circuit-library-XOR-1.png | Bin 12259 -> 12259 bytes ...qiskit-circuit-library-efficient_su2-1.png | Bin 12067 -> 12067 bytes ...kit-circuit-library-efficient_su2-2_00.png | Bin 12067 -> 12067 bytes ...kit-circuit-library-efficient_su2-2_01.png | Bin 14753 -> 14753 bytes ...cuit-library-evolved_operator_ansatz-1.png | Bin 15859 -> 15859 bytes ...ircuit-library-excitation_preserving-1.png | Bin 13137 -> 13137 bytes ...uit-library-excitation_preserving-2_00.png | Bin 13137 -> 13137 bytes ...uit-library-excitation_preserving-2_01.png | Bin 8939 -> 8939 bytes ...kit-circuit-library-fourier_checking-1.png | Bin 5145 -> 5145 bytes ...skit-circuit-library-grover_operator-1.png | Bin 8198 -> 8198 bytes ...t-circuit-library-grover_operator-2_00.png | Bin 8198 -> 8198 bytes ...t-circuit-library-grover_operator-2_01.png | Bin 4203 -> 4203 bytes ...t-circuit-library-grover_operator-3_00.png | Bin 8198 -> 8198 bytes ...t-circuit-library-grover_operator-3_01.png | Bin 4203 -> 4203 bytes ...t-circuit-library-grover_operator-3_02.png | Bin 10867 -> 10867 bytes ...t-circuit-library-grover_operator-4_00.png | Bin 8198 -> 8198 bytes ...t-circuit-library-grover_operator-4_01.png | Bin 4203 -> 4203 bytes ...t-circuit-library-grover_operator-4_02.png | Bin 10867 -> 10867 bytes ...t-circuit-library-grover_operator-4_03.png | Bin 7794 -> 7794 bytes ...brary-hamiltonian_variational_ansatz-1.png | Bin 9240 -> 9240 bytes ...brary-hamiltonian_variational_ansatz-2.png | Bin 9114 -> 9114 bytes ...rcuit-library-hidden_linear_function-1.png | Bin 5797 -> 5797 bytes .../qiskit-circuit-library-iqp_function-1.png | Bin 9282 -> 9282 bytes .../qiskit-circuit-library-iqp_function-2.png | Bin 15203 -> 15203 bytes .../dev/qiskit-circuit-library-n_local-1.png | Bin 14266 -> 14266 bytes .../qiskit-circuit-library-n_local-2_00.png | Bin 14266 -> 14266 bytes .../qiskit-circuit-library-n_local-2_01.png | Bin 13690 -> 13690 bytes .../qiskit-circuit-library-n_local-3_00.png | Bin 14266 -> 14266 bytes .../qiskit-circuit-library-n_local-3_01.png | Bin 13690 -> 13690 bytes .../qiskit-circuit-library-n_local-3_02.png | Bin 13539 -> 13539 bytes .../qiskit-circuit-library-n_local-4_00.png | Bin 14266 -> 14266 bytes .../qiskit-circuit-library-n_local-4_01.png | Bin 13690 -> 13690 bytes .../qiskit-circuit-library-n_local-4_02.png | Bin 13539 -> 13539 bytes .../qiskit-circuit-library-n_local-4_03.png | Bin 8584 -> 8584 bytes ...kit-circuit-library-pauli_two_design-1.png | Bin 20859 -> 20859 bytes ...kit-circuit-library-phase_estimation-1.png | Bin 17910 -> 17745 bytes .../qiskit-circuit-library-qaoa_ansatz-1.png | Bin 58349 -> 58349 bytes ...iskit-circuit-library-quantum_volume-1.png | Bin 14587 -> 14587 bytes .../qiskit-circuit-library-random_iqp-1.png | Bin 5488 -> 8434 bytes ...skit-circuit-library-real_amplitudes-1.png | Bin 11554 -> 11554 bytes ...t-circuit-library-real_amplitudes-2_00.png | Bin 11554 -> 11554 bytes ...t-circuit-library-real_amplitudes-2_01.png | Bin 13425 -> 13425 bytes ...t-circuit-library-real_amplitudes-3_00.png | Bin 11554 -> 11554 bytes ...t-circuit-library-real_amplitudes-3_01.png | Bin 13425 -> 13425 bytes ...t-circuit-library-real_amplitudes-3_02.png | Bin 14266 -> 14266 bytes ...t-circuit-library-real_amplitudes-4_00.png | Bin 11554 -> 11554 bytes ...t-circuit-library-real_amplitudes-4_01.png | Bin 13425 -> 13425 bytes ...t-circuit-library-real_amplitudes-4_02.png | Bin 14266 -> 14266 bytes ...t-circuit-library-real_amplitudes-4_03.png | Bin 12896 -> 12896 bytes ...skit-circuit-library-unitary_overlap-1.png | Bin 10862 -> 10916 bytes ...skit-primitives-StatevectorEstimator-1.png | Bin 43580 -> 43580 bytes .../qiskit-pulse-library-SymbolicPulse-1.png | Bin 11401 -> 11401 bytes .../dev/qiskit-quantum_info-Statevector-1.png | Bin 7558 -> 7558 bytes .../qiskit-transpiler-TranspileLayout-1.png | Bin 9589 -> 9589 bytes .../qiskit-transpiler-TranspileLayout-2.png | Bin 5357 -> 5357 bytes .../qiskit-transpiler-TranspileLayout-3.png | Bin 6029 -> 6029 bytes ...spiler-passes-DynamicalDecoupling-1_00.png | Bin 22803 -> 22803 bytes ...spiler-passes-DynamicalDecoupling-1_01.png | Bin 23583 -> 23583 bytes ...skit-transpiler-passes-FilterOpNodes-1.png | Bin 1637 -> 1637 bytes ...ler-passes-PadDynamicalDecoupling-1_00.png | Bin 22803 -> 22803 bytes ...ler-passes-PadDynamicalDecoupling-1_01.png | Bin 23583 -> 23583 bytes ...kit-transpiler-passes-RemoveBarriers-1.png | Bin 1593 -> 1593 bytes ...kit-transpiler-passes-StarPreRouting-1.png | Bin 49789 -> 49789 bytes .../qiskit-visualization-circuit_drawer-1.png | Bin 3214 -> 3214 bytes ...visualization-plot_bloch_multivector-1.png | Bin 97054 -> 97054 bytes ...visualization-plot_bloch_multivector-2.png | Bin 99845 -> 99845 bytes ...skit-visualization-plot_bloch_vector-1.png | Bin 76275 -> 76275 bytes ...skit-visualization-plot_bloch_vector-2.png | Bin 77587 -> 77587 bytes ...it-visualization-plot_circuit_layout-1.png | Bin 10151 -> 10040 bytes ...skit-visualization-plot_coupling_map-1.png | Bin 8007 -> 8007 bytes ...t-visualization-plot_distribution-1_00.png | Bin 14124 -> 14124 bytes ...t-visualization-plot_distribution-1_01.png | Bin 16685 -> 16685 bytes ...t-visualization-plot_distribution-1_02.png | Bin 16681 -> 16681 bytes .../qiskit-visualization-plot_error_map-1.png | Bin 49252 -> 49619 bytes .../qiskit-visualization-plot_gate_map-1.png | Bin 8595 -> 8595 bytes ...skit-visualization-plot_histogram-1_00.png | Bin 10255 -> 10255 bytes ...skit-visualization-plot_histogram-1_01.png | Bin 12587 -> 12587 bytes ...skit-visualization-plot_histogram-1_02.png | Bin 12639 -> 12639 bytes ...qiskit-visualization-plot_state_city-1.png | Bin 115263 -> 115263 bytes ...qiskit-visualization-plot_state_city-2.png | Bin 153769 -> 153769 bytes ...skit-visualization-plot_state_hinton-1.png | Bin 11116 -> 11116 bytes ...it-visualization-plot_state_paulivec-1.png | Bin 17337 -> 17337 bytes ...it-visualization-plot_state_paulivec-2.png | Bin 18522 -> 18522 bytes ...kit-visualization-plot_state_qsphere-1.png | Bin 35058 -> 35058 bytes ...kit-visualization-plot_state_qsphere-2.png | Bin 39591 -> 39591 bytes ...qiskit-visualization-timeline_drawer-1.png | Bin 15785 -> 15705 bytes ...qiskit-visualization-timeline_drawer-2.png | Bin 8273 -> 8252 bytes ...qiskit-visualization-timeline_drawer-3.png | Bin 26160 -> 26802 bytes .../images/api/qiskit/dev/release_notes-1.png | Bin 4046 -> 4046 bytes .../images/api/qiskit/dev/release_notes-2.png | Bin 2801 -> 2801 bytes .../images/api/qiskit/dev/release_notes-3.png | Bin 1454 -> 1454 bytes .../images/api/qiskit/dev/release_notes-4.png | Bin 7971 -> 6490 bytes .../images/api/qiskit/dev/release_notes-5.png | Bin 13722 -> 13722 bytes .../images/api/qiskit/dev/release_notes-6.png | Bin 11731 -> 11731 bytes .../images/api/qiskit/dev/release_notes-7.png | Bin 8695 -> 8695 bytes .../images/api/qiskit/dev/release_notes-8.png | Bin 7530 -> 7530 bytes public/images/api/qiskit/dev/synthesis-1.png | Bin 23473 -> 23473 bytes public/images/api/qiskit/dev/synthesis-2.png | Bin 148257 -> 148257 bytes .../images/api/qiskit/dev/transpiler-10.png | Bin 7413 -> 0 bytes .../images/api/qiskit/dev/transpiler-12.png | Bin 8534 -> 10473 bytes .../images/api/qiskit/dev/transpiler-13.png | Bin 36154 -> 12152 bytes .../images/api/qiskit/dev/transpiler-14.png | Bin 20314 -> 7454 bytes .../images/api/qiskit/dev/transpiler-15.png | Bin 9699 -> 7385 bytes .../images/api/qiskit/dev/transpiler-16.png | Bin 24241 -> 7413 bytes .../images/api/qiskit/dev/transpiler-17.png | Bin 19140 -> 36154 bytes .../images/api/qiskit/dev/transpiler-18.png | Bin 0 -> 8534 bytes .../{transpiler-11.png => transpiler-19.png} | Bin 36154 -> 36154 bytes .../images/api/qiskit/dev/transpiler-20.png | Bin 0 -> 20314 bytes .../images/api/qiskit/dev/transpiler-21.png | Bin 0 -> 9699 bytes .../images/api/qiskit/dev/transpiler-22.png | Bin 0 -> 24210 bytes .../images/api/qiskit/dev/transpiler-23.png | Bin 0 -> 19185 bytes public/images/api/qiskit/dev/transpiler-4.png | Bin 6289 -> 0 bytes public/images/api/qiskit/dev/transpiler-5.png | Bin 20033 -> 0 bytes public/images/api/qiskit/dev/transpiler-6.png | Bin 10473 -> 0 bytes public/images/api/qiskit/dev/transpiler-7.png | Bin 12152 -> 0 bytes public/images/api/qiskit/dev/transpiler-8.png | Bin 7454 -> 6289 bytes public/images/api/qiskit/dev/transpiler-9.png | Bin 7385 -> 20089 bytes .../images/api/qiskit/dev/visualization-1.png | Bin 8219 -> 8219 bytes .../images/api/qiskit/dev/visualization-2.png | Bin 15392 -> 15392 bytes .../images/api/qiskit/dev/visualization-3.png | Bin 7806 -> 7806 bytes .../images/api/qiskit/dev/visualization-4.png | Bin 109432 -> 109432 bytes .../images/api/qiskit/dev/visualization-5.png | Bin 111196 -> 111196 bytes .../images/api/qiskit/dev/visualization-6.png | Bin 111196 -> 111196 bytes scripts/config/api-html-artifacts.json | 4 +- 528 files changed, 2715 insertions(+), 1297 deletions(-) rename public/images/api/qiskit-ibm-runtime/dev/{fake_provider-1_00.png => fake_provider-1.png} (99%) delete mode 100644 public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_02.png rename public/images/api/qiskit-ibm-runtime/dev/{fake_provider-1_01.png => fake_provider-2.png} (99%) create mode 100644 public/images/api/qiskit-ibm-runtime/dev/fake_provider-3.png create mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-1.png create mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-10.png create mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-11.png create mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-12.png create mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-13.png create mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-14.png create mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-15.png create mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-16.png create mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-17.png create mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-2.png create mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-3.png create mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-4.png create mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-5.png create mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-6.png create mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-7.png create mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-8.png create mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-9.png create mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-PadDynamicalDecoupling-1.png create mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-PadDynamicalDecoupling-2.png delete mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_0_0.png delete mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_10_0.png delete mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_11_0.png delete mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_12_0.png delete mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_13_0.png delete mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_14_0.png delete mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_15_0.png delete mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_1_0.png delete mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_2_0.png delete mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_3_0.png delete mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_4_0.png delete mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_5_0.png delete mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_6_0.png delete mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_7_0.png delete mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_8_0.png delete mode 100644 public/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_9_0.png create mode 100644 public/images/api/qiskit-ibm-runtime/dev/twirling_strategy_options.png delete mode 100644 public/images/api/qiskit/dev/circuit-2.png create mode 100644 public/images/api/qiskit/dev/circuit-3.png rename public/images/api/qiskit/dev/{circuit-4.png => circuit-5.png} (99%) rename public/images/api/qiskit/dev/{converters-1.png => converters-3.png} (99%) delete mode 100644 public/images/api/qiskit/dev/pulse-1.png create mode 100644 public/images/api/qiskit/dev/pulse-15.png delete mode 100644 public/images/api/qiskit/dev/pulse-2.png delete mode 100644 public/images/api/qiskit/dev/pulse-3.png create mode 100644 public/images/api/qiskit/dev/pulse-33.png create mode 100644 public/images/api/qiskit/dev/pulse-34.png create mode 100644 public/images/api/qiskit/dev/pulse-35.png delete mode 100644 public/images/api/qiskit/dev/pulse-4.png rename public/images/api/qiskit/dev/{qasm3-1.png => qasm3-2.png} (99%) rename public/images/api/qiskit/dev/{qiskit-circuit-QuantumCircuit-4.png => qiskit-circuit-QuantumCircuit-19.png} (99%) rename public/images/api/qiskit/dev/{qiskit-circuit-QuantumCircuit-5.png => qiskit-circuit-QuantumCircuit-20.png} (98%) rename public/images/api/qiskit/dev/{qiskit-circuit-QuantumCircuit-1_00.png => qiskit-circuit-QuantumCircuit-4_00.png} (98%) rename public/images/api/qiskit/dev/{qiskit-circuit-QuantumCircuit-1_01.png => qiskit-circuit-QuantumCircuit-4_01.png} (98%) rename public/images/api/qiskit/dev/{qiskit-circuit-QuantumCircuit-2_00.png => qiskit-circuit-QuantumCircuit-5_00.png} (98%) rename public/images/api/qiskit/dev/{qiskit-circuit-QuantumCircuit-2_01.png => qiskit-circuit-QuantumCircuit-5_01.png} (98%) rename public/images/api/qiskit/dev/{qiskit-circuit-QuantumCircuit-3.png => qiskit-circuit-QuantumCircuit-6.png} (98%) delete mode 100644 public/images/api/qiskit/dev/transpiler-10.png create mode 100644 public/images/api/qiskit/dev/transpiler-18.png rename public/images/api/qiskit/dev/{transpiler-11.png => transpiler-19.png} (99%) create mode 100644 public/images/api/qiskit/dev/transpiler-20.png create mode 100644 public/images/api/qiskit/dev/transpiler-21.png create mode 100644 public/images/api/qiskit/dev/transpiler-22.png create mode 100644 public/images/api/qiskit/dev/transpiler-23.png delete mode 100644 public/images/api/qiskit/dev/transpiler-4.png delete mode 100644 public/images/api/qiskit/dev/transpiler-5.png delete mode 100644 public/images/api/qiskit/dev/transpiler-6.png delete mode 100644 public/images/api/qiskit/dev/transpiler-7.png diff --git a/docs/api/qiskit-ibm-runtime/dev/fake_provider.mdx b/docs/api/qiskit-ibm-runtime/dev/fake_provider.mdx index 1f7de702cb2..119b9b31cec 100644 --- a/docs/api/qiskit-ibm-runtime/dev/fake_provider.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/fake_provider.mdx @@ -39,11 +39,19 @@ circuit.cx(0,1) circuit.cx(0,2) circuit.measure_all() circuit.draw('mpl', style="iqp") +``` + +![../\_images/fake\_provider-1.png](/images/api/qiskit-ibm-runtime/dev/fake_provider-1.png) +```python # Transpile the ideal circuit to a circuit that can be directly executed by the backend transpiled_circuit = transpile(circuit, backend) transpiled_circuit.draw('mpl', style="iqp") +``` +![../\_images/fake\_provider-2.png](/images/api/qiskit-ibm-runtime/dev/fake_provider-2.png) + +```python # Run the transpiled circuit using the simulated fake backend sampler = SamplerV2(backend) job = sampler.run([transpiled_circuit]) @@ -52,11 +60,7 @@ counts = pub_result.data.meas.get_counts() plot_histogram(counts) ``` -![../\_images/fake\_provider-1\_00.png](/images/api/qiskit-ibm-runtime/dev/fake_provider-1_00.png) - -![../\_images/fake\_provider-1\_01.png](/images/api/qiskit-ibm-runtime/dev/fake_provider-1_01.png) - -![../\_images/fake\_provider-1\_02.png](/images/api/qiskit-ibm-runtime/dev/fake_provider-1_02.png) +![../\_images/fake\_provider-3.png](/images/api/qiskit-ibm-runtime/dev/fake_provider-3.png) Please note that the simulation is done using a noise model generated from system snapshots obtained in the past (sometimes a few years ago) and the results are not representative of the latest behaviours of the real quantum system which the fake backend is mimicking. If you want to run noisy simulations to compare with the real quantum system, you should use the `qiskit_aer` library. After installation, you can follow the steps below to generate a simulator that mimics a real quantum system with the latest calibration results. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Batch.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Batch.mdx index a5279e5129e..30e47875f1c 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Batch.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.Batch.mdx @@ -68,7 +68,7 @@ python_api_name: qiskit_ibm_runtime.Batch **Parameters** - * **backend** ([*BackendV1*](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.2)") *|*[*BackendV2*](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)") *| None*) – Instance of `Backend` class. + * **backend** ([*BackendV1*](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.3)") *|*[*BackendV2*](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.3)") *| None*) – Instance of `Backend` class. * **max\_time** (*int | str | None*) – Maximum amount of time a runtime session can be open before being forcibly closed. Can be specified as seconds (int) or a string like “2h 30m 40s”. This value must be less than the [system imposed maximum](/guides/max-execution-time). **Raises** 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 0d13da16205..282412a9950 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 @@ -9,7 +9,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2 # EstimatorV2 - Bases: `BasePrimitiveV2`\[[`EstimatorOptions`](qiskit_ibm_runtime.options.EstimatorOptions "qiskit_ibm_runtime.options.estimator_options.EstimatorOptions")], `Estimator`, [`BaseEstimatorV2`](/api/qiskit/qiskit.primitives.BaseEstimatorV2 "(in Qiskit v1.2)") + Bases: `BasePrimitiveV2`\[[`EstimatorOptions`](qiskit_ibm_runtime.options.EstimatorOptions "qiskit_ibm_runtime.options.estimator_options.EstimatorOptions")], `Estimator`, [`BaseEstimatorV2`](/api/qiskit/qiskit.primitives.BaseEstimatorV2 "(in Qiskit v1.3)") Class for interacting with Qiskit Runtime Estimator primitive service. @@ -19,7 +19,7 @@ python_api_name: qiskit_ibm_runtime.EstimatorV2 Following construction, an estimator is used by calling its [`run()`](#qiskit_ibm_runtime.EstimatorV2.run "qiskit_ibm_runtime.EstimatorV2.run") method with a list of PUBs (Primitive Unified Blocs). Each PUB contains four values that, together, define a computation unit of work for the estimator to complete: - * a single [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), possibly parametrized, whose final state we define as $\psi(\theta)$, + * a single [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), possibly parametrized, whose final state we define as $\psi(\theta)$, * one or more observables (specified as any `ObservablesArrayLike`, including `Pauli`, `SparsePauliOp`, `str`) that specify which expectation values to estimate, denoted $H_j$, and * a collection parameter value sets to bind the circuit against, $\theta_k$. * an optional target precision for expectation value estimates. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.IBMBackend.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.IBMBackend.mdx index 05f86701790..88771265975 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.IBMBackend.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.IBMBackend.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend # IBMBackend - Bases: [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)") + Bases: [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.3)") Backend class interfacing with an IBM Quantum backend. @@ -33,7 +33,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend > > * num\_qubits: number of qubits. > - > * target: A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + > * target: A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. > > * basis\_gates: list of basis gates names on the backend. > @@ -137,7 +137,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### dt @@ -173,13 +173,17 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -227,7 +231,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -275,7 +279,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Returns** @@ -357,7 +361,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -557,7 +561,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -577,13 +581,13 @@ python_api_name: qiskit_ibm_runtime.IBMBackend **Parameters** - * **circuits** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)") *| str | List\[*[*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)") *| str]*) – An individual or a list of `QuantumCircuit`. + * **circuits** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)") *| str | List\[*[*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)") *| str]*) – An individual or a list of `QuantumCircuit`. * **dynamic** (*bool | None*) – Whether the circuit is dynamic (uses in-circuit conditionals) * **job\_tags** (*List\[str] | None*) – Tags to be assigned to the job. The tags can subsequently be used as a filter in the `jobs()` function call. - * **init\_circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)") *| None*) – A quantum circuit to execute for initializing qubits before each circuit. If specified, `init_num_resets` is ignored. Applicable only if `dynamic=True` is specified. + * **init\_circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)") *| None*) – A quantum circuit to execute for initializing qubits before each circuit. If specified, `init_num_resets` is ignored. Applicable only if `dynamic=True` is specified. * **init\_num\_resets** (*int | None*) – The number of qubit resets to insert before each circuit execution. @@ -684,7 +688,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend ### target\_history - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Returns** @@ -696,7 +700,7 @@ python_api_name: qiskit_ibm_runtime.IBMBackend **Return type** - [*Target*](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") + [*Target*](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJob.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJob.mdx index a7ff7d4f613..b5e1dda2ed2 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJob.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJob.mdx @@ -9,13 +9,13 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob # RuntimeJob - Bases: [`JobV1`](/api/qiskit/qiskit.providers.JobV1 "(in Qiskit v1.2)"), `BaseRuntimeJob` + Bases: [`JobV1`](/api/qiskit/qiskit.providers.JobV1 "(in Qiskit v1.3)"), `BaseRuntimeJob` Representation of a runtime primitive execution. A new `RuntimeJob` instance is returned when you call `QiskitRuntimeService.run` to execute a runtime primitive, or [`QiskitRuntimeService.job`](qiskit_ibm_runtime.QiskitRuntimeService#job "qiskit_ibm_runtime.QiskitRuntimeService.job") to retrieve a previously executed job. - If the primitive execution is successful, you can inspect the job’s status by calling [`status()`](#qiskit_ibm_runtime.RuntimeJob.status "qiskit_ibm_runtime.RuntimeJob.status"). Job status can be one of the [`JobStatus`](/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v1.2)") members. + If the primitive execution is successful, you can inspect the job’s status by calling [`status()`](#qiskit_ibm_runtime.RuntimeJob.status "qiskit_ibm_runtime.RuntimeJob.status"). Job status can be one of the [`JobStatus`](/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v1.3)") members. Some of the methods in this class are blocking, which means control may not be returned immediately. [`result()`](#qiskit_ibm_runtime.RuntimeJob.result "qiskit_ibm_runtime.RuntimeJob.result") is an example of a blocking method: @@ -35,7 +35,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob **Parameters** - * **backend** ([*Backend*](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.2)")) – The backend instance used to run this job. + * **backend** ([*Backend*](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.3)")) – The backend instance used to run this job. * **api\_client** (*RuntimeClient*) – Object for connecting to the server. * **client\_params** (*ClientParameters*) – Parameters used for server connection. * **job\_id** (*str*) – Job ID. @@ -156,7 +156,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob **Return type** - [*Backend*](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.2)") | None + [*Backend*](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.3)") | None ### cancel @@ -398,7 +398,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJob **Return type** - [*JobStatus*](/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v1.2)") + [*JobStatus*](/api/qiskit/qiskit.providers.JobStatus "(in Qiskit v1.3)") ### submit diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJobV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJobV2.mdx index 21cdc457ea7..40529dfc8a1 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJobV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.RuntimeJobV2.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 # RuntimeJobV2 - Bases: [`BasePrimitiveJob`](/api/qiskit/qiskit.primitives.BasePrimitiveJob "(in Qiskit v1.2)")\[[`PrimitiveResult`](/api/qiskit/qiskit.primitives.PrimitiveResult "(in Qiskit v1.2)"), `Literal`\[‘INITIALIZING’, ‘QUEUED’, ‘RUNNING’, ‘CANCELLED’, ‘DONE’, ‘ERROR’]], `BaseRuntimeJob` + Bases: [`BasePrimitiveJob`](/api/qiskit/qiskit.primitives.BasePrimitiveJob "(in Qiskit v1.3)")\[[`PrimitiveResult`](/api/qiskit/qiskit.primitives.PrimitiveResult "(in Qiskit v1.3)"), `Literal`\[‘INITIALIZING’, ‘QUEUED’, ‘RUNNING’, ‘CANCELLED’, ‘DONE’, ‘ERROR’]], `BaseRuntimeJob` Representation of a runtime V2 primitive exeuction. @@ -17,7 +17,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 **Parameters** - * **backend** ([*Backend*](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.2)")) – The backend instance used to run this job. + * **backend** ([*Backend*](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.3)")) – The backend instance used to run this job. * **api\_client** (*RuntimeClient*) – Object for connecting to the server. * **client\_params** (*ClientParameters*) – Parameters used for server connection. * **job\_id** (*str*) – Job ID. @@ -134,7 +134,7 @@ python_api_name: qiskit_ibm_runtime.RuntimeJobV2 **Return type** - [*Backend*](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.2)") | None + [*Backend*](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.3)") | None ### cancel 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 06b4b01554a..d8300ecf7ed 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 @@ -9,7 +9,7 @@ python_api_name: qiskit_ibm_runtime.SamplerV2 # SamplerV2 - Bases: `BasePrimitiveV2`\[[`SamplerOptions`](qiskit_ibm_runtime.options.SamplerOptions "qiskit_ibm_runtime.options.sampler_options.SamplerOptions")], `Sampler`, [`BaseSamplerV2`](/api/qiskit/qiskit.primitives.BaseSamplerV2 "(in Qiskit v1.2)") + Bases: `BasePrimitiveV2`\[[`SamplerOptions`](qiskit_ibm_runtime.options.SamplerOptions "qiskit_ibm_runtime.options.sampler_options.SamplerOptions")], `Sampler`, [`BaseSamplerV2`](/api/qiskit/qiskit.primitives.BaseSamplerV2 "(in Qiskit v1.3)") Class for interacting with Qiskit Runtime Sampler primitive service. 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 index e8004ffaba3..5f2bb0accc2 100644 --- 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 @@ -37,7 +37,7 @@ python_api_name: qiskit_ibm_runtime.debug_tools.Neat **Return type** - [*BackendV2*](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)") + [*BackendV2*](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.3)") ### ideal\_sim 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 index 523dbce864b..0cfc83074b1 100644 --- 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 @@ -34,7 +34,7 @@ python_api_name: qiskit_ibm_runtime.debug_tools.NeatPubResult **Parameters** - **other** (*int | float |* [*NeatPubResult*](#qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.neat_results.NeatPubResult") *|*[*PubResult*](/api/qiskit/qiskit.primitives.PubResult "(in Qiskit v1.2)") *|*[*DataBin*](/api/qiskit/qiskit.primitives.DataBin "(in Qiskit v1.2)")) + **other** (*int | float |* [*NeatPubResult*](#qiskit_ibm_runtime.debug_tools.NeatPubResult "qiskit_ibm_runtime.debug_tools.neat_results.NeatPubResult") *|*[*PubResult*](/api/qiskit/qiskit.primitives.PubResult "(in Qiskit v1.3)") *|*[*DataBin*](/api/qiskit/qiskit.primitives.DataBin "(in Qiskit v1.3)")) **Return type** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx index dd5fd3a27fe..90551fe93c3 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlgiers.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlgiers **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx index 132259a1089..2f56c207e49 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.mdx @@ -38,7 +38,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -74,13 +74,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -118,7 +122,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -150,7 +154,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -214,7 +218,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -356,7 +360,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -389,7 +393,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -397,7 +401,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAlmadenV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx index 12c5d13148d..839310534f0 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeArmonkV2.mdx @@ -32,7 +32,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -68,13 +68,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -112,7 +116,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -144,7 +148,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -208,7 +212,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -350,7 +354,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -383,7 +387,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -391,7 +395,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeArmonkV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx index 32092f8efdc..bcc40b58f6d 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAthensV2.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAthensV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx index 05fc96f66de..7b8aabb6cf8 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeAuckland.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeAuckland **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx index ea72fe09fdb..86a23a26a98 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBelemV2.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBelemV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx index 612d8c40b51..7c4c21b11e4 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.mdx @@ -38,7 +38,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -74,13 +74,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -118,7 +122,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -150,7 +154,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -214,7 +218,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -356,7 +360,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -389,7 +393,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -397,7 +401,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx index 56b6e93b5b8..2b0586b11b9 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBogotaV2.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBogotaV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx index e399b61b840..ced418f5640 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrisbane.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrisbane **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx index 921e5b44651..419ca8bb9cd 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBrooklynV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx index 3690f03fbfd..8ded7d91d6a 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.mdx @@ -34,7 +34,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -70,13 +70,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -114,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -146,7 +150,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -210,7 +214,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -352,7 +356,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -385,7 +389,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -393,7 +397,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx index 26d848f8e32..4e3cc63c3dd 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCairoV2.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCairoV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx index e3b6a8c0ffc..9073336451d 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.mdx @@ -40,7 +40,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -76,13 +76,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -120,7 +124,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -152,7 +156,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -216,7 +220,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -358,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -391,7 +395,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -399,7 +403,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCambridgeV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx index e3a8c52fea0..b3ade08e562 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCasablancaV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx index 8e92988359b..c70be178443 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeCusco.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeCusco **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx index 4dd1df8198b..ec8005a916d 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeEssexV2.mdx @@ -36,7 +36,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -72,13 +72,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -116,7 +120,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -148,7 +152,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -212,7 +216,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -354,7 +358,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -395,7 +399,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeEssexV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.mdx index ebd82c6baca..86185894168 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeFractionalBackend.mdx @@ -35,7 +35,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -71,13 +71,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -115,7 +119,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -147,7 +151,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -211,7 +215,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -353,7 +357,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -386,7 +390,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -394,7 +398,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeFractionalBackend **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx index b7c8b90032c..62f283478dd 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGeneva.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGeneva **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx index fe28ece697e..39e7888c7cc 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx index b3b99196dcb..1990aa68ce7 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeHanoiV2.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeHanoiV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx index 50e3a68d146..dfc069e6bbc 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJakartaV2.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJakartaV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx index c2a68a9656e..19ecc633e4a 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.mdx @@ -38,7 +38,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -74,13 +74,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -118,7 +122,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -150,7 +154,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -214,7 +218,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -356,7 +360,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -389,7 +393,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -397,7 +401,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx index 5c54c25043c..5394e534a98 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKawasaki.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKawasaki **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx index 94b408b5775..aa23dbc7884 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKolkataV2.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKolkataV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx index 2b595116b79..65262083877 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyiv.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyiv **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx index 4ef6d58c1d0..968ff986eaf 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeKyoto.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeKyoto **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx index 8d5c1b1d6c6..802263354ce 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLagosV2.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLagosV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx index c25848b8d5e..6cf8a4d7a74 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLimaV2.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLimaV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx index 0f57852d1a3..358d6a01bde 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeLondonV2.mdx @@ -36,7 +36,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -72,13 +72,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -116,7 +120,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -148,7 +152,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -212,7 +216,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -354,7 +358,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -395,7 +399,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeLondonV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx index b38f5f62e06..39d330a3bc0 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManhattanV2.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManhattanV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx index 4911786d6fe..2cefd790572 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeManilaV2.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeManilaV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx index 99169312374..110ec0f3f53 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMelbourneV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx index 56470a64ae3..cab71f912fd 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMontrealV2.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMontrealV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx index b6ba3c2fd9d..7bbd3091483 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeMumbaiV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx index ab648e0665a..ffa9bbc5698 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeNairobiV2.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeNairobiV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx index 7a125475c73..241bfdb7c31 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOsaka.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOsaka **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx index a1d1b2829ea..625b851dfe8 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOslo.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOslo **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx index be43457200a..470dbf7311f 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeOurenseV2.mdx @@ -34,7 +34,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -70,13 +70,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -114,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -146,7 +150,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -210,7 +214,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -352,7 +356,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -385,7 +389,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -393,7 +397,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeOurenseV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx index 2003bbd5971..1e7b9ee014d 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeParisV2.mdx @@ -40,7 +40,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -76,13 +76,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -120,7 +124,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -152,7 +156,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -216,7 +220,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -358,7 +362,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -391,7 +395,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -399,7 +403,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeParisV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx index 65afd2c74a4..17a85b455cf 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePeekskill.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePeekskill **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePerth.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePerth.mdx index dabe95cca56..a982b02e366 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePerth.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePerth.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePerth **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx index e62a9dac26e..dbf15142573 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePrague.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePrague.mdx index 9d83b9c498a..e239795e65c 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePrague.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakePrague.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakePrague **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx index 8ece30a1713..c75961dca1e 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuebec.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuebec **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx index 74596509788..22072f43aea 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeQuitoV2.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeQuitoV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx index 1c3336ee4a6..2db35874a13 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRochesterV2.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRochesterV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx index 34abd355970..8de849d91a5 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeRomeV2.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeRomeV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx index 1f373f60d39..021a4f54627 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSantiagoV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx index 8fbf6b480fc..0791e166ae7 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSherbrooke.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSherbrooke **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx index 9e28449517d..3b9d57622ed 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.mdx @@ -38,7 +38,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -74,13 +74,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -118,7 +122,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -150,7 +154,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -214,7 +218,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -356,7 +360,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -389,7 +393,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -397,7 +401,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSingaporeV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx index a495b3ea58b..b4dd981759c 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeSydneyV2.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeSydneyV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx index c1dfd4b5e22..680201f2d83 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorino.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorino **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx index dc987a9b15b..224dd498415 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeTorontoV2.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeTorontoV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx index 0ac33f19e3e..992ec2cc903 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeValenciaV2.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeValenciaV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx index 64bcb2ee1e1..4705c38edd4 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeVigoV2.mdx @@ -34,7 +34,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -70,13 +70,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -114,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -146,7 +150,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -210,7 +214,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -352,7 +356,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -385,7 +389,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -393,7 +397,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeVigoV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx index fa9d1ec8dea..d0fa28275df 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -64,13 +64,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -108,7 +112,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -140,7 +144,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -204,7 +208,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -346,7 +350,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -379,7 +383,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeWashingtonV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx index 9d24ed6967e..cd6da1fd1f8 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.fake_provider.FakeYorktownV2.mdx @@ -36,7 +36,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### coupling\_map - Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)") object + Return the [`CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)") object ### defs\_filename @@ -72,13 +72,17 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### instruction\_durations - Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") object. + Return the [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") object. ### instruction\_schedule\_map - Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.2)") for the instructions defined in this backend’s target. + Return the [`InstructionScheduleMap`](/api/qiskit/qiskit.pulse.InstructionScheduleMap "(in Qiskit v1.3)") for the instructions defined in this backend’s target. + + + The property `qiskit.providers.backend.BackendV2.instruction_schedule_map` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend.BackendV2.instruction_schedule_map` will have no alternative in Qiskit. + ### instructions @@ -116,7 +120,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### operations - A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)") instances that the backend supports. + A list of [`Instruction`](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)") instances that the backend supports. ### options @@ -148,7 +152,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 ### target - A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)") object for the backend. + A [`qiskit.transpiler.Target`](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)") object for the backend. **Return type** @@ -212,7 +216,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 **Parameters** - **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – Circuit to check. + **circuit** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)")) – Circuit to check. **Raises** @@ -354,7 +358,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 **Return type** - [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.2)")] + [*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)") | *List*\[[*QubitProperties*](/api/qiskit/qiskit.providers.QubitProperties "(in Qiskit v1.3)")] ### refresh @@ -387,7 +391,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 Run on the fake backend using a simulator. - This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.2)") object. + This method runs circuit jobs (an individual or a list of QuantumCircuit ) and pulse jobs (an individual or a list of Schedule or ScheduleBlock) using BasicSimulator or Aer simulator and returns a [`Job`](/api/qiskit/qiskit.providers.Job "(in Qiskit v1.3)") object. If qiskit-aer is installed, jobs will be run using AerSimulator with noise model of the fake backend. Otherwise, jobs will be run using BasicSimulator without noise. @@ -395,7 +399,7 @@ python_api_name: qiskit_ibm_runtime.fake_provider.FakeYorktownV2 **Parameters** - * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.2)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.2)") objects to run on the backend. + * **run\_input** (*QuantumCircuit or Schedule or ScheduleBlock or list*) – An individual or a list of [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)"), [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "(in Qiskit v1.3)"), or [`Schedule`](/api/qiskit/qiskit.pulse.Schedule "(in Qiskit v1.3)") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.noise_learner.NoiseLearner.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.noise_learner.NoiseLearner.mdx index 5c8d03e7fae..3626df67338 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.noise_learner.NoiseLearner.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.noise_learner.NoiseLearner.mdx @@ -94,7 +94,7 @@ python_api_name: qiskit_ibm_runtime.noise_learner.NoiseLearner **Return type** - [*BackendV2*](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)") + [*BackendV2*](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.3)") ### run @@ -106,7 +106,7 @@ python_api_name: qiskit_ibm_runtime.noise_learner.NoiseLearner **Parameters** - **circuits** (*Iterable\[*[*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)") *| EstimatorPubLike]*) – An iterable of circuits to run the noise learner program for. Alternatively, estimator pub-like (primitive unified bloc) objects can be specified, such as tuples `(circuit, observables)` or `(circuit, observables, parameter_values)`. In this case, the pub-like objects are converted to a list of circuits, and all the other fields (such as `observables` and `parameter_values`) are ignored. + **circuits** (*Iterable\[*[*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.3)") *| EstimatorPubLike]*) – An iterable of circuits to run the noise learner program for. Alternatively, estimator pub-like (primitive unified bloc) objects can be specified, such as tuples `(circuit, observables)` or `(circuit, observables, parameter_values)`. In this case, the pub-like objects are converted to a list of circuits, and all the other fields (such as `observables` and `parameter_values`) are ignored. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SimulatorOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SimulatorOptions.mdx index bb956703bc1..b7684e8e303 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SimulatorOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.SimulatorOptions.mdx @@ -21,7 +21,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions * **noise\_model** (*UnsetType | dict | NoiseModel | None*) * **seed\_simulator** (*UnsetType | int*) - * **coupling\_map** (*UnsetType | List\[List\[int]] |* [*CouplingMap*](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.2)")) + * **coupling\_map** (*UnsetType | List\[List\[int]] |* [*CouplingMap*](/api/qiskit/qiskit.transpiler.CouplingMap "(in Qiskit v1.3)")) * **basis\_gates** (*UnsetType | List\[str]*) ### basis\_gates @@ -65,7 +65,7 @@ python_api_name: qiskit_ibm_runtime.options.SimulatorOptions **Parameters** - **backend** ([*BackendV1*](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.2)") *|*[*BackendV2*](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.2)")) – backend to be set. + **backend** ([*BackendV1*](/api/qiskit/qiskit.providers.BackendV1 "(in Qiskit v1.3)") *|*[*BackendV2*](/api/qiskit/qiskit.providers.BackendV2 "(in Qiskit v1.3)")) – backend to be set. **Raises** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.TwirlingOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.TwirlingOptions.mdx index b141fcb3d5a..7a03706fba6 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.TwirlingOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.TwirlingOptions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.options.TwirlingOptions # TwirlingOptions - + Bases: `object` Twirling options. @@ -84,6 +84,8 @@ python_api_name: qiskit_ibm_runtime.options.TwirlingOptions > * If `"all"` all qubits in the input circuit will be twirled in each twirled layer. > > Default: “active-accum”. + + ![Image illustrating the differences among twirling strategies. If "active", only instruction qubits in each layer will be twirled. If "active-circuit", all instruction qubits in the circuit will be twirled. If "active-accum", the union all instruction qubits in the circuit up to the current twirled layer will be twirled. Finally, if "all", all qubits in the input circuit will be twirled in each twirled layer.](/images/api/qiskit-ibm-runtime/dev/twirling_strategy_options.png) ## Methods diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ZneOptions.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ZneOptions.mdx index 8d76f38eae4..428f90997cf 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ZneOptions.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.options.ZneOptions.mdx @@ -53,7 +53,7 @@ python_api_name: qiskit_ibm_runtime.options.ZneOptions Extrapolator(s) to try (in order) for extrapolating to zero noise. The available options are: - > * `"exponential"`, which fits the data using an exponential decaying function defined as $f(x; A, au) = A e^{-x/ au}$, where $A = f(0; A, au)$ is the value at zero noise ($x=0$) and :math:\` au>0\` is a positive rate. + > * `"exponential"`, which fits the data using an exponential decaying function defined as $f(x; A, \tau) = A e^{-x/\tau}$, where $A = f(0; A, \tau)$ is the value at zero noise ($x=0$) and $\tau>0$ is a positive rate. > * `"double_exponential"`, which uses a sum of two exponential as in Ref. 1. > * `"polynomial_degree_(1 <= k <= 7)"`, which uses a polynomial function defined as $f(x; c_0, c_1, \ldots, c_k) = \sum_{i=0, k} c_i x^i$. > * `"linear"`, which is equivalent to `"polynomial_degree_1"`. diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford.mdx index 516c791fc49..ebc12f4c63f 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford.mdx @@ -9,11 +9,11 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford # ConvertISAToClifford - Bases: [`TransformationPass`](/api/qiskit/qiskit.transpiler.TransformationPass "(in Qiskit v1.2)") + Bases: [`TransformationPass`](/api/qiskit/qiskit.transpiler.TransformationPass "(in Qiskit v1.3)") Convert the gates of an ISA circuit to Clifford gates. - ISA circuits only contain Clifford gates from a restricted set or [`qiskit.circuit.library.RZGate`](/api/qiskit/qiskit.circuit.library.RZGate "(in Qiskit v1.2)")s by arbitrary angles. To convert them to Clifford circuits, this pass rounds the angle of every [`qiskit.circuit.library.RZGate`](/api/qiskit/qiskit.circuit.library.RZGate "(in Qiskit v1.2)") to the closest multiple of pi/2 (or to a random multiple of pi/2 if the angle is unspecified), while it skips every Clifford gate, measurement, and barrier. + ISA circuits only contain Clifford gates from a restricted set or [`qiskit.circuit.library.RZGate`](/api/qiskit/qiskit.circuit.library.RZGate "(in Qiskit v1.3)")s by arbitrary angles. To convert them to Clifford circuits, this pass rounds the angle of every [`qiskit.circuit.library.RZGate`](/api/qiskit/qiskit.circuit.library.RZGate "(in Qiskit v1.3)") to the closest multiple of pi/2 (or to a random multiple of pi/2 if the angle is unspecified), while it skips every Clifford gate, measurement, and barrier. ```python import numpy as np @@ -89,7 +89,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford **Parameters** * **passmanager\_ir** (*Any*) – Qiskit IR to optimize. - * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. + * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")) – State associated with workflow execution by the pass manager itself. * **callback** (*Callable | None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -98,7 +98,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford **Return type** - tuple\[*Any*, [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + tuple\[*Any*, [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")] ### name @@ -118,7 +118,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford **Parameters** - **dag** ([*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)")) – the dag on which the pass is run. + **dag** ([*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.3)")) – the dag on which the pass is run. **Raises** @@ -126,7 +126,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford **Return type** - [*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)") + [*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.3)") ### update\_status @@ -136,7 +136,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford **Parameters** - * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – Pass manager state to update. + * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")) – Pass manager state to update. * **run\_state** (*RunState*) – Completion status of current task. **Returns** @@ -145,7 +145,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.ConvertISAToClifford **Return type** - [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)") + [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)") diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay.mdx index f6d4a98f14c..1aa4e787eb4 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay.mdx @@ -9,11 +9,11 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay # ConvertIdToDelay - Bases: [`TransformationPass`](/api/qiskit/qiskit.transpiler.TransformationPass "(in Qiskit v1.2)") + Bases: [`TransformationPass`](/api/qiskit/qiskit.transpiler.TransformationPass "(in Qiskit v1.3)") Convert `qiskit.circuit.library.standard_gates.IGate` to a delay of the corresponding length. - Convert [`qiskit.circuit.library.IGate`](/api/qiskit/qiskit.circuit.library.IGate "(in Qiskit v1.2)") to a Convert [`qiskit.circuit.Delay`](/api/qiskit/circuit#qiskit.circuit.Delay "(in Qiskit v1.2)"). + Convert [`qiskit.circuit.library.IGate`](/api/qiskit/qiskit.circuit.library.IGate "(in Qiskit v1.3)") to a Convert [`qiskit.circuit.Delay`](/api/qiskit/circuit#qiskit.circuit.Delay "(in Qiskit v1.3)"). **Parameters** @@ -67,7 +67,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay **Parameters** * **passmanager\_ir** (*Any*) – Qiskit IR to optimize. - * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. + * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")) – State associated with workflow execution by the pass manager itself. * **callback** (*Callable | None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -76,7 +76,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay **Return type** - tuple\[*Any*, [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + tuple\[*Any*, [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")] ### name @@ -96,7 +96,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay **Parameters** - **dag** ([*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)")) – the dag on which the pass is run. + **dag** ([*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.3)")) – the dag on which the pass is run. **Raises** @@ -104,7 +104,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay **Return type** - [*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)") + [*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.3)") ### update\_status @@ -114,7 +114,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay **Parameters** - * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – Pass manager state to update. + * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")) – Pass manager state to update. * **run\_state** (*RunState*) – Completion status of current task. **Returns** @@ -123,7 +123,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay **Return type** - [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)") + [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)") diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx index 56710b10c0e..c757bf38f24 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis.mdx @@ -81,7 +81,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAna **Parameters** * **passmanager\_ir** (*Any*) – Qiskit IR to optimize. - * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. + * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")) – State associated with workflow execution by the pass manager itself. * **callback** (*Callable | None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -90,7 +90,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAna **Return type** - tuple\[*Any*, [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + tuple\[*Any*, [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")] ### name @@ -119,7 +119,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAna **Parameters** - **dag** ([*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)")) + **dag** ([*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.3)")) **Return type** @@ -133,7 +133,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAna **Parameters** - * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – Pass manager state to update. + * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")) – Pass manager state to update. * **run\_state** (*RunState*) – Completion status of current task. **Returns** @@ -142,7 +142,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAna **Return type** - [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)") + [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)") diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx index f3ca8e798ae..32517e079dc 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAnalysis.mdx @@ -81,7 +81,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAna **Parameters** * **passmanager\_ir** (*Any*) – Qiskit IR to optimize. - * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. + * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")) – State associated with workflow execution by the pass manager itself. * **callback** (*Callable | None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -90,7 +90,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAna **Return type** - tuple\[*Any*, [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + tuple\[*Any*, [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")] ### name @@ -119,11 +119,11 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAna **Parameters** - **dag** ([*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)")) + **dag** ([*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.3)")) **Return type** - [*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)") + [*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.3)") ### update\_status @@ -133,7 +133,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAna **Parameters** - * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – Pass manager state to update. + * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")) – Pass manager state to update. * **run\_state** (*RunState*) – Completion status of current task. **Returns** @@ -142,7 +142,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.ASAPScheduleAna **Return type** - [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)") + [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)") diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx index 04d9eb177d7..36a2045881b 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder # BlockBasePadder - Bases: [`TransformationPass`](/api/qiskit/qiskit.transpiler.TransformationPass "(in Qiskit v1.2)") + Bases: [`TransformationPass`](/api/qiskit/qiskit.transpiler.TransformationPass "(in Qiskit v1.3)") The base class of padding pass. @@ -71,7 +71,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder **Parameters** * **passmanager\_ir** (*Any*) – Qiskit IR to optimize. - * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. + * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")) – State associated with workflow execution by the pass manager itself. * **callback** (*Callable | None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -80,7 +80,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder **Return type** - tuple\[*Any*, [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + tuple\[*Any*, [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")] ### name @@ -100,7 +100,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder **Parameters** - **dag** ([*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)")) – DAG to be checked. + **dag** ([*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.3)")) – DAG to be checked. **Returns** @@ -122,7 +122,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder **Parameters** - * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – Pass manager state to update. + * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")) – Pass manager state to update. * **run\_state** (*RunState*) – Completion status of current task. **Returns** @@ -131,7 +131,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder **Return type** - [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)") + [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)") diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx index ea50c1be1bc..bf624ad12b8 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI # DynamicCircuitInstructionDurations - Bases: [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") + Bases: [`InstructionDurations`](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") For dynamic circuits the IBM Qiskit backend currently reports instruction durations that differ compared with those required for the legacy Qobj-based path. For now we use this class to report updated InstructionDurations. TODO: This would be mitigated by a specialized Backend/Target for dynamic circuit backends. @@ -19,7 +19,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI **Parameters** - * **instruction\_durations** (*List\[Tuple\[str, Iterable\[int] | None, float, Iterable\[float] | None, str]] | List\[Tuple\[str, Iterable\[int] | None, float, Iterable\[float] | None]] | List\[Tuple\[str, Iterable\[int] | None, float, str]] | List\[Tuple\[str, Iterable\[int] | None, float]] |* [*InstructionDurations*](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") *| None*) + * **instruction\_durations** (*List\[Tuple\[str, Iterable\[int] | None, float, Iterable\[float] | None, str]] | List\[Tuple\[str, Iterable\[int] | None, float, Iterable\[float] | None]] | List\[Tuple\[str, Iterable\[int] | None, float, str]] | List\[Tuple\[str, Iterable\[int] | None, float]] |* [*InstructionDurations*](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") *| None*) * **dt** (*float*) * **enable\_patching** (*bool*) @@ -48,7 +48,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI **Parameters** - **backend** ([*Backend*](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.2)")) + **backend** ([*Backend*](/api/qiskit/qiskit.providers.Backend "(in Qiskit v1.3)")) ### from\_target @@ -66,7 +66,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI **Parameters** - **target** ([*Target*](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.2)")) + **target** ([*Target*](/api/qiskit/qiskit.transpiler.Target "(in Qiskit v1.3)")) ### get @@ -78,7 +78,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI **Parameters** - * **inst** (*str |* [*qiskit.circuit.Instruction*](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.2)")) – An instruction or its name to be queried. + * **inst** (*str |* [*qiskit.circuit.Instruction*](/api/qiskit/qiskit.circuit.Instruction "(in Qiskit v1.3)")) – An instruction or its name to be queried. * **qubits** (*int | list\[int]*) – Qubit indices that the instruction acts on. * **unit** (*str*) – The unit of duration to be returned. It must be ‘s’ or ‘dt’. * **parameters** (*list\[float] | None*) – The value of the parameters of the desired instruction. @@ -117,7 +117,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.DynamicCircuitI **Parameters** - * **inst\_durations** (*List\[Tuple\[str, Iterable\[int] | None, float, Iterable\[float] | None, str]] | List\[Tuple\[str, Iterable\[int] | None, float, Iterable\[float] | None]] | List\[Tuple\[str, Iterable\[int] | None, float, str]] | List\[Tuple\[str, Iterable\[int] | None, float]] |* [*InstructionDurations*](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.2)") *| None*) – Instruction durations to be merged into self (overwriting self). + * **inst\_durations** (*List\[Tuple\[str, Iterable\[int] | None, float, Iterable\[float] | None, str]] | List\[Tuple\[str, Iterable\[int] | None, float, Iterable\[float] | None]] | List\[Tuple\[str, Iterable\[int] | None, float, str]] | List\[Tuple\[str, Iterable\[int] | None, float]] |* [*InstructionDurations*](/api/qiskit/qiskit.transpiler.InstructionDurations "(in Qiskit v1.3)") *| None*) – Instruction durations to be merged into self (overwriting self). * **dt** (*float | None*) – Sampling duration in seconds of the target backend. **Returns** diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx index d8aa998c642..ef88d3a3336 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay.mdx @@ -85,7 +85,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay **Parameters** * **passmanager\_ir** (*Any*) – Qiskit IR to optimize. - * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. + * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")) – State associated with workflow execution by the pass manager itself. * **callback** (*Callable | None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -94,7 +94,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay **Return type** - tuple\[*Any*, [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + tuple\[*Any*, [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")] ### name @@ -114,7 +114,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay **Parameters** - **dag** ([*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)")) – DAG to be checked. + **dag** ([*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.3)")) – DAG to be checked. **Returns** @@ -136,7 +136,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay **Parameters** - * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – Pass manager state to update. + * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")) – Pass manager state to update. * **run\_state** (*RunState*) – Completion status of current task. **Returns** @@ -145,7 +145,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay **Return type** - [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)") + [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)") diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx index 827adb90296..3eb17ea487b 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDec # PadDynamicalDecoupling - + Bases: [`BlockBasePadder`](qiskit_ibm_runtime.transpiler.passes.scheduling.BlockBasePadder "qiskit_ibm_runtime.transpiler.passes.scheduling.block_base_padder.BlockBasePadder") Dynamical decoupling insertion pass for IBM dynamic circuit backends. @@ -36,52 +36,16 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDec ("cx", [1, 2], 200), ("cx", [2, 3], 300), ("x", None, 50), ("measure", None, 1000)] ) - ``` - ```python # balanced X-X sequence on all qubits dd_sequence = [XGate(), XGate()] pm = PassManager([ALAPScheduleAnalysis(durations), PadDynamicalDecoupling(durations, dd_sequence)]) circ_dd = pm.run(circ) - circ_dd.draw() + circ_dd.draw('mpl', style="iqp") ``` - ```python - ┌───┐ ┌───────────────┐ ┌───┐ » - q_0: ──────┤ H ├─────────■──┤ Delay(96[dt]) ├──────┤ X ├──────» - ┌─────┴───┴─────┐ ┌─┴─┐└───────────────┘┌─────┴───┴─────┐» - q_1: ┤ Delay(50[dt]) ├─┤ X ├────────■────────┤ Delay(48[dt]) ├» - ├───────────────┴┐└───┘ ┌─┴─┐ └───────────────┘» - q_2: ┤ Delay(750[dt]) ├───────────┤ X ├──────────────■────────» - ├────────────────┤ └───┘ ┌─┴─┐ » - q_3: ┤ Delay(950[dt]) ├────────────────────────────┤ X ├──────» - └────────────────┘ └───┘ » - meas: 4/═════════════════════════════════════════════════════════» - » - « ┌────────────────┐ ┌───┐ ┌───────────────┐ » - « q_0: ┤ Delay(208[dt]) ├──────┤ X ├──────┤ Delay(96[dt]) ├─────────────────» - « └─────┬───┬──────┘┌─────┴───┴─────┐└─────┬───┬─────┘┌───────────────┐» - « q_1: ──────┤ X ├───────┤ Delay(96[dt]) ├──────┤ X ├──────┤ Delay(56[dt]) ├» - « └───┘ └───────────────┘ └───┘ └───────────────┘» - « q_2: ─────────────────────────────────────────────────────────────────────» - « » - « q_3: ─────────────────────────────────────────────────────────────────────» - « » - «meas: 4/═════════════════════════════════════════════════════════════════════» - « » - « ░ ┌─┐ - « q_0: ─░─┤M├───────── - « ░ └╥┘┌─┐ - « q_1: ─░──╫─┤M├────── - « ░ ║ └╥┘┌─┐ - « q_2: ─░──╫──╫─┤M├─── - « ░ ║ ║ └╥┘┌─┐ - « q_3: ─░──╫──╫──╫─┤M├ - « ░ ║ ║ ║ └╥┘ - «meas: 4/════╩══╩══╩══╩═ - « 0 1 2 3 - ``` + ![../\_images/qiskit\_ibm\_runtime-transpiler-passes-scheduling-PadDynamicalDecoupling-1.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-PadDynamicalDecoupling-1.png) ```python # Uhrig sequence on qubit 0 @@ -100,33 +64,10 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDec ] ) circ_dd = pm.run(circ) - circ_dd.draw() + circ_dd.draw('mpl', style="iqp") ``` - ```python - ┌───┐ ┌────────────────┐ ░ ┌─┐ » - q_0: ──────┤ H ├─────────■──┤ Delay(500[dt]) ├───────────────────░─┤M├──────» - ┌─────┴───┴─────┐ ┌─┴─┐└────────────────┘┌────────────────┐ ░ └╥┘┌─┐ » - q_1: ┤ Delay(50[dt]) ├─┤ X ├────────■─────────┤ Delay(300[dt]) ├─░──╫─┤M├───» - ├───────────────┴┐└───┘ ┌─┴─┐ └────────────────┘ ░ ║ └╥┘┌─┐» - q_2: ┤ Delay(750[dt]) ├───────────┤ X ├───────────────■──────────░──╫──╫─┤M├» - ├────────────────┤ └───┘ ┌─┴─┐ ░ ║ ║ └╥┘» - q_3: ┤ Delay(950[dt]) ├─────────────────────────────┤ X ├────────░──╫──╫──╫─» - └────────────────┘ └───┘ ░ ║ ║ ║ » - meas: 4/═══════════════════════════════════════════════════════════════╩══╩══╩═» - 0 1 2 » - « - « q_0: ─── - « - « q_1: ─── - « - « q_2: ─── - « ┌─┐ - « q_3: ┤M├ - « └╥┘ - «meas: 4/═╩═ - « 3 - ``` + ![../\_images/qiskit\_ibm\_runtime-transpiler-passes-scheduling-PadDynamicalDecoupling-2.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-PadDynamicalDecoupling-2.png) You need to call [`ALAPScheduleAnalysis`](qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis "qiskit_ibm_runtime.transpiler.passes.scheduling.ALAPScheduleAnalysis") before running dynamical decoupling to guarantee your circuit satisfies acquisition alignment constraints for dynamic circuit backends. @@ -222,7 +163,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDec **Parameters** * **passmanager\_ir** (*Any*) – Qiskit IR to optimize. - * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. + * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")) – State associated with workflow execution by the pass manager itself. * **callback** (*Callable | None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -231,7 +172,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDec **Return type** - tuple\[*Any*, [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + tuple\[*Any*, [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")] ### name @@ -251,7 +192,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDec **Parameters** - **dag** ([*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)")) – DAG to be checked. + **dag** ([*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.3)")) – DAG to be checked. **Returns** @@ -273,7 +214,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDec **Parameters** - * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – Pass manager state to update. + * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)")) – Pass manager state to update. * **run\_state** (*RunState*) – Completion status of current task. **Returns** @@ -282,7 +223,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDec **Return type** - [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)") + [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.3)") diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.mdx index b4a9f787a4d..bf30756842b 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.mdx @@ -17,7 +17,7 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling A collection of scheduling passes for working with IBM Quantum’s next-generation backends that support advanced “dynamic circuit” capabilities. Ie., circuits with support for classical control-flow/feedback based off of measurement results. - You should not mix these scheduling passes with Qiskit’s builtin scheduling passes as they will negatively interact with the scheduling routines for dynamic circuits. This includes setting `scheduling_method` in [`transpile()`](/api/qiskit/compiler#qiskit.compiler.transpile "(in Qiskit v1.2)") or [`generate_preset_pass_manager()`](/api/qiskit/transpiler_preset#qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager "(in Qiskit v1.2)"). + You should not mix these scheduling passes with Qiskit’s builtin scheduling passes as they will negatively interact with the scheduling routines for dynamic circuits. This includes setting `scheduling_method` in [`transpile()`](/api/qiskit/compiler#qiskit.compiler.transpile "(in Qiskit v1.3)") or [`generate_preset_pass_manager()`](/api/qiskit/transpiler_preset#qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager "(in Qiskit v1.3)"). ## Classes @@ -80,7 +80,7 @@ scheduled_teleport = pm.run(teleport) scheduled_teleport.draw(output="mpl", style="iqp") ``` -![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_0\_0.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_0_0.png) +![../\_images/qiskit\_ibm\_runtime-transpiler-passes-scheduling-1.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-1.png) Instead of padding with delays we may also insert a dynamical decoupling sequence using the [`PadDynamicalDecoupling`](qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling "qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling") pass as shown below: @@ -105,9 +105,9 @@ dd_teleport = pm.run(teleport) dd_teleport.draw(output="mpl", style="iqp") ``` -![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_1\_0.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_1_0.png) +![../\_images/qiskit\_ibm\_runtime-transpiler-passes-scheduling-2.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-2.png) -When compiling a circuit with Qiskit, it is more efficient and more robust to perform all the transformations in a single transpilation. This has been done above by extending Qiskit’s preset pass managers. For example, Qiskit’s [`transpile()`](/api/qiskit/compiler#qiskit.compiler.transpile "(in Qiskit v1.2)") function internally builds its pass set by using [`generate_preset_pass_manager()`](/api/qiskit/transpiler_preset#qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager "(in Qiskit v1.2)"). This returns instances of [`StagedPassManager`](/api/qiskit/qiskit.transpiler.StagedPassManager "(in Qiskit v1.2)"), which can be extended. +When compiling a circuit with Qiskit, it is more efficient and more robust to perform all the transformations in a single transpilation. This has been done above by extending Qiskit’s preset pass managers. For example, Qiskit’s [`transpile()`](/api/qiskit/compiler#qiskit.compiler.transpile "(in Qiskit v1.3)") function internally builds its pass set by using [`generate_preset_pass_manager()`](/api/qiskit/transpiler_preset#qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager "(in Qiskit v1.3)"). This returns instances of [`StagedPassManager`](/api/qiskit/qiskit.transpiler.StagedPassManager "(in Qiskit v1.3)"), which can be extended. @@ -121,9 +121,9 @@ qc_c_if.x(0).c_if(0, 1) qc_c_if.draw(output="mpl", style="iqp") ``` -![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_2\_0.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_2_0.png) +![../\_images/qiskit\_ibm\_runtime-transpiler-passes-scheduling-3.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-3.png) -The [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") configures a translation plugin `IBMTranslationPlugin` to automatically apply transformations and optimizations for IBM hardware backends when invoking [`transpile()`](/api/qiskit/compiler#qiskit.compiler.transpile "(in Qiskit v1.2)"). This will automatically convert all old style `c_if` conditioned gates to new-style control-flow. We may then schedule the transpiled circuit without further modification. +The [`IBMBackend`](qiskit_ibm_runtime.IBMBackend "qiskit_ibm_runtime.IBMBackend") configures a translation plugin `IBMTranslationPlugin` to automatically apply transformations and optimizations for IBM hardware backends when invoking [`transpile()`](/api/qiskit/compiler#qiskit.compiler.transpile "(in Qiskit v1.3)"). This will automatically convert all old style `c_if` conditioned gates to new-style control-flow. We may then schedule the transpiled circuit without further modification. ```python # Temporary workaround for mock backends. For real backends this is not required. @@ -141,9 +141,9 @@ qc_if_dd = pm.run(qc_c_if, backend) qc_if_dd.draw(output="mpl", style="iqp") ``` -![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_3\_0.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_3_0.png) +![../\_images/qiskit\_ibm\_runtime-transpiler-passes-scheduling-4.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-4.png) -If you are not using the transpiler plugin stages to work around this please manually run the pass [`qiskit.transpiler.passes.ConvertConditionsToIfOps`](/api/qiskit/qiskit.transpiler.passes.ConvertConditionsToIfOps "(in Qiskit v1.2)") prior to your scheduling pass. +If you are not using the transpiler plugin stages to work around this please manually run the pass [`qiskit.transpiler.passes.ConvertConditionsToIfOps`](/api/qiskit/qiskit.transpiler.passes.ConvertConditionsToIfOps "(in Qiskit v1.3)") prior to your scheduling pass. ```python from qiskit.transpiler.passes import ConvertConditionsToIfOps @@ -161,7 +161,7 @@ qc_if_dd = pm.run(qc_c_if) qc_if_dd.draw(output="mpl", style="iqp") ``` -![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_4\_0.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_4_0.png) +![../\_images/qiskit\_ibm\_runtime-transpiler-passes-scheduling-5.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-5.png) @@ -184,7 +184,7 @@ with qc.if_test((1, 1)): qc.draw(output="mpl", style="iqp") ``` -![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_5\_0.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_5_0.png) +![../\_images/qiskit\_ibm\_runtime-transpiler-passes-scheduling-6.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-6.png) The circuit below will not use the fast-path as the conditional gate is on a different qubit than the measurement qubit. @@ -197,7 +197,7 @@ with qc.if_test((0, 1)): qc.draw(output="mpl", style="iqp") ``` -![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_6\_0.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_6_0.png) +![../\_images/qiskit\_ibm\_runtime-transpiler-passes-scheduling-7.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-7.png) Similarly, the circuit below contains gates on multiple qubits and will not be performed using the fast-path. @@ -211,7 +211,7 @@ with qc.if_test((0, 1)): qc.draw(output="mpl", style="iqp") ``` -![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_7\_0.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_7_0.png) +![../\_images/qiskit\_ibm\_runtime-transpiler-passes-scheduling-8.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-8.png) A fast-path block may contain multiple gates as long as they are on the fast-path qubit. If there are multiple fast-path blocks being performed in parallel each block will be padded out to the duration of the longest block. @@ -229,7 +229,7 @@ with qc.if_test((1, 1)): qc.draw(output="mpl", style="iqp") ``` -![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_8\_0.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_8_0.png) +![../\_images/qiskit\_ibm\_runtime-transpiler-passes-scheduling-9.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-9.png) This behavior is also applied to the else condition of a fast-path eligible branch. @@ -246,7 +246,7 @@ with else_: qc.draw(output="mpl", style="iqp") ``` -![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_9\_0.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_9_0.png) +![../\_images/qiskit\_ibm\_runtime-transpiler-passes-scheduling-10.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-10.png) If a single measurement result is used with several conditional blocks, if there is a fast-path eligible block it will be applied followed by the non-fast-path blocks which will execute with the standard higher latency conditional branch. @@ -264,7 +264,7 @@ with qc.if_test((0, 1)): qc.draw(output="mpl", style="iqp") ``` -![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_10\_0.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_10_0.png) +![../\_images/qiskit\_ibm\_runtime-transpiler-passes-scheduling-11.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-11.png) If you wish to prevent the usage of the fast-path you may insert a barrier between the measurement and the conditional branch. @@ -279,7 +279,7 @@ with qc.if_test((0, 1)): qc.draw(output="mpl", style="iqp") ``` -![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_11\_0.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_11_0.png) +![../\_images/qiskit\_ibm\_runtime-transpiler-passes-scheduling-12.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-12.png) Conditional measurements are not eligible for the fast-path. @@ -293,7 +293,7 @@ with qc.if_test((0, 1)): qc.draw(output="mpl", style="iqp") ``` -![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_12\_0.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_12_0.png) +![../\_images/qiskit\_ibm\_runtime-transpiler-passes-scheduling-13.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-13.png) Similarly nested control-flow is not eligible. @@ -309,20 +309,11 @@ with qc.if_test((0, 1)): qc.draw(output="mpl", style="iqp") ``` -![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_13\_0.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_13_0.png) +![../\_images/qiskit\_ibm\_runtime-transpiler-passes-scheduling-14.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-14.png) The scheduler is aware of the fast-path behavior and will not insert delays on idle qubits in blocks that satisfy the fast-path conditions so as to avoid preventing the backend compiler from performing the necessary optimizations to utilize the fast-path. If there are fast-path blocks that will be performed in parallel they currently *will not* be padded out by the scheduler to ensure they are of the same duration in Qiskit ```python -dd_sequence = [XGate(), XGate()] - -pm = PassManager( - [ - ALAPScheduleAnalysis(durations), - PadDynamicalDecoupling(durations, dd_sequence), - ] -) - qc = QuantumCircuit(2, 2) qc.measure(0, 0) qc.measure(1, 1) @@ -337,13 +328,25 @@ with qc.if_test((1, 1)): qc.draw(output="mpl", style="iqp") +``` -qc_dd = pm.run(qc) +![../\_images/qiskit\_ibm\_runtime-transpiler-passes-scheduling-15.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-15.png) +```python +dd_sequence = [XGate(), XGate()] + +pm = PassManager( + [ + ALAPScheduleAnalysis(durations), + PadDynamicalDecoupling(durations, dd_sequence), + ] +) + +qc_dd = pm.run(qc) qc_dd.draw(output="mpl", style="iqp") ``` -![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_14\_0.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_14_0.png) +![../\_images/qiskit\_ibm\_runtime-transpiler-passes-scheduling-16.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-16.png) If there are qubits that are *not* involved in a fast-path decision it is not currently possible to use them in a fast-path branch in parallel with the fast-path qubits resulting from a measurement. This will be revised in the future as we further improve these capabilities. @@ -367,6 +370,6 @@ qc_dd.draw(output="mpl", style="iqp") qc.draw(output="mpl", style="iqp") ``` - ![../\_images/qiskit\_ibm\_runtime.transpiler.passes.scheduling\_15\_0.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling_15_0.png) + ![../\_images/qiskit\_ibm\_runtime-transpiler-passes-scheduling-17.png](/images/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime-transpiler-passes-scheduling-17.png) diff --git a/docs/api/qiskit/dev/assembler.mdx b/docs/api/qiskit/dev/assembler.mdx index bf5eac5aa86..e1cb66bc596 100644 --- a/docs/api/qiskit/dev/assembler.mdx +++ b/docs/api/qiskit/dev/assembler.mdx @@ -20,7 +20,7 @@ python_api_name: qiskit.assembler ### assemble\_circuits - + Assembles a list of circuits into a qobj that can be run on the backend. @@ -65,7 +65,7 @@ python_api_name: qiskit.assembler ### assemble\_schedules - + Assembles a list of schedules into a qobj that can be run on the backend. @@ -131,7 +131,7 @@ python_api_name: qiskit.assembler ### disassemble - + Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header. diff --git a/docs/api/qiskit/dev/circuit.mdx b/docs/api/qiskit/dev/circuit.mdx index ed35078f713..843d07a0da7 100644 --- a/docs/api/qiskit/dev/circuit.mdx +++ b/docs/api/qiskit/dev/circuit.mdx @@ -250,6 +250,8 @@ Qubits and classical bits are represented by a shared base [`Bit`](#qiskit.circu #### Bit + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Implement a generic bit. @@ -290,6 +292,8 @@ A collection bits of the same type can be encapsulated in a register of the matc #### Register + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Implement a generic register. @@ -341,6 +345,11 @@ Each of the defined bit subtypes has an associated register, which have the same Bases: [`Register`](#qiskit.circuit.Register "qiskit.circuit.register.Register") Implement a quantum register. + + **Parameters** + + * **size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – #### ClassicalRegister @@ -349,6 +358,11 @@ Each of the defined bit subtypes has an associated register, which have the same Bases: [`Register`](#qiskit.circuit.Register "qiskit.circuit.register.Register") Implement a classical register. + + **Parameters** + + * **size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – #### AncillaRegister @@ -357,6 +371,11 @@ Each of the defined bit subtypes has an associated register, which have the same Bases: [`QuantumRegister`](#qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") Implement an ancilla register. + + **Parameters** + + * **size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – A common way to instantiate several bits at once is to create a register, such as by `QuantumRegister("my_qreg", 5)`. This has the advantage that you can give that collection of bits a name, which will appear during circuit visualizations ([`QuantumCircuit.draw()`](qiskit.circuit.QuantumCircuit#draw "qiskit.circuit.QuantumCircuit.draw")) and exports to interchange languages (see [`qasm2`](qasm2#module-qiskit.qasm2 "qiskit.qasm2") and [`qasm3`](qasm3#module-qiskit.qasm3 "qiskit.qasm3")). You can also pass a name and a list of pre-constructed bits, but this creates an “aliasing register”, which are very poorly supported on hardware. @@ -432,19 +451,34 @@ The available modifiers for [`AnnotatedOperation`](qiskit.circuit.AnnotatedOpera #### InverseModifier + Bases: `Modifier` + Inverse modifier: specifies that the operation is inverted. #### ControlModifier + Bases: `Modifier` + Control modifier: specifies that the operation is controlled by `num_ctrl_qubits` and has control state `ctrl_state`. + + **Parameters** + + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – #### PowerModifier + Bases: `Modifier` + Power modifier: specifies that the operation is raised to the power `power`. + + **Parameters** + + **power** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – For information on how to create custom gates and instructions, including how to build one-off objects, and re-usable parametric gates via subclassing, see [Creating custom instructions](#circuit-custom-gates) below. The Qiskit circuit library in [`qiskit.circuit.library`](circuit_library#module-qiskit.circuit.library "qiskit.circuit.library") contains many predefined gates and circuits for you to use. @@ -874,7 +908,7 @@ Qiskit also defines a shared global-state object, [`SessionEquivalenceLibrary`]( circ.draw(output='mpl') ``` - ![../\_images/circuit-2.png](/images/api/qiskit/dev/circuit-2.png) + ![../\_images/circuit-3.png](/images/api/qiskit/dev/circuit-3.png) **Parameters** @@ -946,6 +980,8 @@ Almost all circuit functions and methods will raise a [`CircuitError`](#qiskit.c ### CircuitError + Bases: [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + Base class for errors raised while processing a circuit. Set the error message. @@ -991,7 +1027,7 @@ If we draw this circuit, we will see that Qiskit places the zeroth qubit on the qc.draw("mpl") ``` -![../\_images/circuit-4.png](/images/api/qiskit/dev/circuit-4.png) +![../\_images/circuit-5.png](/images/api/qiskit/dev/circuit-5.png) ### Matrix representations diff --git a/docs/api/qiskit/dev/circuit_classical.mdx b/docs/api/qiskit/dev/circuit_classical.mdx index d3f377c48a4..a1a60785b6a 100644 --- a/docs/api/qiskit/dev/circuit_classical.mdx +++ b/docs/api/qiskit/dev/circuit_classical.mdx @@ -47,6 +47,8 @@ The expression system is based on tree representation. All nodes in the tree are #### Expr + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)") + Root base class of all nodes in the expression tree. The base case should never be instantiated directly. This must not be subclassed by users; subclasses form the internal data of the representation of expressions, and it does not make sense to add more outside of Qiskit library code. @@ -61,12 +63,20 @@ The base for dynamic variables is the [`Var`](#qiskit.circuit.classical.expr.Var #### Var + Bases: [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") + A classical variable. These variables take two forms: a new-style variable that owns its storage location and has an associated name; and an old-style variable that wraps a [`Clbit`](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit") or [`ClassicalRegister`](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") instance that is owned by some containing circuit. In general, construction of variables for use in programs should use [`Var.new()`](#qiskit.circuit.classical.expr.Var.new "qiskit.circuit.classical.expr.Var.new") or [`QuantumCircuit.add_var()`](qiskit.circuit.QuantumCircuit#add_var "qiskit.circuit.QuantumCircuit.add_var"). Variables are immutable after construction, so they can be used as dictionary keys. + **Parameters** + + * **var** ([*qiskit.circuit.Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit") *|*[*qiskit.circuit.ClassicalRegister*](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") *|*[*uuid.UUID*](https://docs.python.org/3/library/uuid.html#uuid.UUID "(in Python v3.13)")) – + * **type** ([*types.Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type")) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + ##### name @@ -78,6 +88,11 @@ The base for dynamic variables is the [`Var`](#qiskit.circuit.classical.expr.Var Generate a new named variable that owns its own backing storage. + **Parameters** + + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **type** ([*types.Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type")) – + **Return type** [*Self*](https://docs.python.org/3/library/typing.html#typing.Self "(in Python v3.13)") @@ -95,7 +110,14 @@ Similarly, literals used in expressions (such as integers) should be lifted to [ #### Value + Bases: [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") + A single scalar value. + + **Parameters** + + * **value** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **type** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type")) – The operations traditionally associated with pre-, post- or infix operators in programming are represented by the [`Unary`](#qiskit.circuit.classical.expr.Unary "qiskit.circuit.classical.expr.Unary") and [`Binary`](#qiskit.circuit.classical.expr.Binary "qiskit.circuit.classical.expr.Binary") nodes as appropriate. These each take an operation type code, which are exposed as enumerations inside each class as [`Unary.Op`](#qiskit.circuit.classical.expr.Unary.Op "qiskit.circuit.classical.expr.Unary.Op") and [`Binary.Op`](#qiskit.circuit.classical.expr.Binary.Op "qiskit.circuit.classical.expr.Binary.Op") respectively. @@ -103,6 +125,8 @@ The operations traditionally associated with pre-, post- or infix operators in p #### Unary + Bases: [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") + A unary expression. **Parameters** @@ -114,6 +138,8 @@ The operations traditionally associated with pre-, post- or infix operators in p ##### Op + Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.13)") + Enumeration of the opcodes for unary operations. The bitwise negation [`BIT_NOT`](#qiskit.circuit.classical.expr.Unary.Op.BIT_NOT "qiskit.circuit.classical.expr.Unary.Op.BIT_NOT") takes a single bit or an unsigned integer of known width, and returns a value of the same type. @@ -137,6 +163,8 @@ The operations traditionally associated with pre-, post- or infix operators in p #### Binary + Bases: [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") + A binary expression. **Parameters** @@ -149,6 +177,8 @@ The operations traditionally associated with pre-, post- or infix operators in p ##### Op + Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.13)") + Enumeration of the opcodes for binary operations. The bitwise operations [`BIT_AND`](#qiskit.circuit.classical.expr.Binary.Op.BIT_AND "qiskit.circuit.classical.expr.Binary.Op.BIT_AND"), [`BIT_OR`](#qiskit.circuit.classical.expr.Binary.Op.BIT_OR "qiskit.circuit.classical.expr.Binary.Op.BIT_OR") and [`BIT_XOR`](#qiskit.circuit.classical.expr.Binary.Op.BIT_XOR "qiskit.circuit.classical.expr.Binary.Op.BIT_XOR") apply to two operands of the same type, which must be a single bit or an unsigned integer of fixed width. The resultant type is the same as the two input types. @@ -244,6 +274,8 @@ Bit-like types (unsigned integers) can be indexed by integer types, represented #### Index + Bases: [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") + An indexing expression. **Parameters** @@ -260,7 +292,15 @@ Expressions in this system are defined to act only on certain sets of types. How #### Cast + Bases: [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") + A cast from one type to another, implied by the use of an expression in a different context. + + **Parameters** + + * **operand** ([*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr")) – + * **type** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type")) – + * **implicit** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – @@ -302,6 +342,11 @@ The functions and methods described in this section are a more user-friendly way Value(5, Uint(4)) ``` + **Parameters** + + * **value** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **type** ([*types.Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type") *| None*) – + **Return type** [Expr](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") @@ -327,6 +372,11 @@ You can manually specify casts in cases where the cast is allowed in explicit fo Cast(Value(5, types.Uint(32)), types.Uint(8), implicit=False) ``` + **Parameters** + + * **operand** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **type** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type")) – + **Return type** [*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") @@ -350,6 +400,10 @@ There are helper constructor functions for each of the unary operations. Unary(Unary.Op.BIT_NOT, Var(ClassicalRegister(3, 'c'), Uint(3)), Uint(3)) ``` + **Parameters** + + **operand** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + **Return type** [*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") @@ -371,6 +425,10 @@ There are helper constructor functions for each of the unary operations. Unary(Unary.Op.LOGIC_NOT, Cast(Var(ClassicalRegister(3, 'c'), Uint(3)), Bool(), implicit=True), Bool()) ``` + **Parameters** + + **operand** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + **Return type** [*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") @@ -394,6 +452,11 @@ Similarly, the binary operations and relations have helper functions defined. Binary(Binary.Op.BIT_AND, Var(ClassicalRegister(3, 'c'), Uint(3)), Value(7, Uint(3)), Uint(3)) ``` + **Parameters** + + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + **Return type** [*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") @@ -415,6 +478,11 @@ Similarly, the binary operations and relations have helper functions defined. Binary(Binary.Op.BIT_OR, Var(ClassicalRegister(3, 'c'), Uint(3)), Value(5, Uint(3)), Uint(3)) ``` + **Parameters** + + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + **Return type** [*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") @@ -436,6 +504,11 @@ Similarly, the binary operations and relations have helper functions defined. Binary(Binary.Op.BIT_XOR, Var(ClassicalRegister(3, 'c'), Uint(3)), Value(5, Uint(3)), Uint(3)) ``` + **Parameters** + + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + **Return type** [*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") @@ -457,6 +530,11 @@ Similarly, the binary operations and relations have helper functions defined. Binary(Binary.Op.LOGIC_AND, Var(, Bool()), Var(, Bool()), Bool()) ``` + **Parameters** + + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + **Return type** [*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") @@ -478,6 +556,11 @@ Similarly, the binary operations and relations have helper functions defined. Binary(Binary.Op.LOGIC_OR, Var(, Bool()), Var(, Bool()), Bool()) ``` + **Parameters** + + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + **Return type** [*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") @@ -499,6 +582,11 @@ Similarly, the binary operations and relations have helper functions defined. Binary(Binary.Op.EQUAL, Var(ClassicalRegister(3, "c"), Uint(3)), Value(7, Uint(3)), Uint(3)) ``` + **Parameters** + + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + **Return type** [*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") @@ -520,6 +608,11 @@ Similarly, the binary operations and relations have helper functions defined. Binary(Binary.Op.NOT_EQUAL, Var(ClassicalRegister(3, "c"), Uint(3)), Value(7, Uint(3)), Uint(3)) ``` + **Parameters** + + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + **Return type** [*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") @@ -541,6 +634,11 @@ Similarly, the binary operations and relations have helper functions defined. Binary(Binary.Op.LESS, Var(ClassicalRegister(3, "c"), Uint(3)), Value(5, Uint(3)), Uint(3)) ``` + **Parameters** + + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + **Return type** [*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") @@ -562,6 +660,11 @@ Similarly, the binary operations and relations have helper functions defined. Binary(Binary.Op.LESS_EQUAL, Var(ClassicalRegister(3, "a"), Uint(3)), Var(ClassicalRegister(3, "b"), Uint(3)), Uint(3)) ``` + **Parameters** + + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + **Return type** [*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") @@ -583,6 +686,11 @@ Similarly, the binary operations and relations have helper functions defined. Binary(Binary.Op.GREATER, Var(ClassicalRegister(3, "c"), Uint(3)), Value(5, Uint(3)), Uint(3)) ``` + **Parameters** + + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + **Return type** [*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") @@ -604,6 +712,11 @@ Similarly, the binary operations and relations have helper functions defined. Binary(Binary.Op.GREATER_EQUAL, Var(ClassicalRegister(3, "a"), Uint(3)), Var(ClassicalRegister(3, "b"), Uint(3)), Uint(3)) ``` + **Parameters** + + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + **Return type** [*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") @@ -634,6 +747,12 @@ Similarly, the binary operations and relations have helper functions defined. Binary(Binary.Op.SHIFT_LEFT, Value(3, Uint(16)), Var(, Uint(8), name='a'), Uint(16)) ``` + **Parameters** + + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **type** ([*types.Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type") *| None*) – + **Return type** [Expr](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") @@ -657,6 +776,12 @@ Similarly, the binary operations and relations have helper functions defined. Binary(Binary.Op.SHIFT_RIGHT, Var(ClassicalRegister(8, "a"), Uint(8)), Value(4, Uint(3)), Uint(8)) ``` + **Parameters** + + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **type** ([*types.Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type") *| None*) – + **Return type** [Expr](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") @@ -682,6 +807,11 @@ You can index into unsigned integers and bit-likes using another unsigned intege Index(Var(ClassicalRegister(8, "a"), Uint(8)), Value(3, Uint(2)), Bool()) ``` + **Parameters** + + * **target** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **index** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + **Return type** [*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") @@ -709,6 +839,10 @@ Qiskit’s legacy method for specifying equality conditions for use in condition lifted = expr.lift_legacy_condition(instr.condition) ``` + **Parameters** + + **condition** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*qiskit.circuit.Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit") *|*[*qiskit.circuit.ClassicalRegister*](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – + **Return type** [Expr](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") @@ -721,11 +855,17 @@ A typical consumer of the expression tree wants to recursively walk through the #### ExprVisitor + Bases: [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.13)")\[`_T_co`] + Base class for visitors to the [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") tree. Subclasses should override whichever of the `visit_*` methods that they are able to handle, and should be organized such that non-existent methods will never be called. ##### visit\_binary + **Parameters** + + **node** ([*Binary*](#qiskit.circuit.classical.expr.Binary "qiskit.circuit.classical.expr.expr.Binary")) – + **Return type** *\_T\_co* @@ -734,6 +874,10 @@ A typical consumer of the expression tree wants to recursively walk through the ##### visit\_cast + **Parameters** + + **node** ([*Cast*](#qiskit.circuit.classical.expr.Cast "qiskit.circuit.classical.expr.expr.Cast")) – + **Return type** *\_T\_co* @@ -742,6 +886,10 @@ A typical consumer of the expression tree wants to recursively walk through the ##### visit\_generic + **Parameters** + + **node** ([*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr")) – + **Return type** *\_T\_co* @@ -750,6 +898,10 @@ A typical consumer of the expression tree wants to recursively walk through the ##### visit\_index + **Parameters** + + **node** ([*Index*](#qiskit.circuit.classical.expr.Index "qiskit.circuit.classical.expr.expr.Index")) – + **Return type** *\_T\_co* @@ -758,6 +910,10 @@ A typical consumer of the expression tree wants to recursively walk through the ##### visit\_unary + **Parameters** + + **node** ([*Unary*](#qiskit.circuit.classical.expr.Unary "qiskit.circuit.classical.expr.expr.Unary")) – + **Return type** *\_T\_co* @@ -766,6 +922,10 @@ A typical consumer of the expression tree wants to recursively walk through the ##### visit\_value + **Parameters** + + **node** ([*Value*](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.expr.Value")) – + **Return type** *\_T\_co* @@ -774,6 +934,10 @@ A typical consumer of the expression tree wants to recursively walk through the ##### visit\_var + **Parameters** + + **node** ([*Var*](#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.expr.Var")) – + **Return type** *\_T\_co* @@ -805,6 +969,10 @@ For the convenience of simple visitors that only need to inspect the variables i print(node.var.name) ``` + **Parameters** + + **node** ([*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr")) – + **Return type** [*Iterator*](https://docs.python.org/3/library/typing.html#typing.Iterator "(in Python v3.13)")\[[*Var*](#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.expr.Var")] @@ -898,6 +1066,10 @@ Some expressions have associated memory locations, and others may be purely temp False ``` + **Parameters** + + **node** ([*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr")) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -922,6 +1094,8 @@ All types inherit from an abstract base class: #### Type + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Root base class of all nodes in the type tree. The base case should never be instantiated directly. This must not be subclassed by users; subclasses form the internal data of the representation of expressions, and it does not make sense to add more outside of Qiskit library code. @@ -934,13 +1108,21 @@ The two different types available are for Booleans (corresponding to [`Clbit`](c #### Bool + Bases: [`Type`](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type") + The Boolean type. This has exactly two values: `True` and `False`. #### Uint + Bases: [`Type`](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type") + An unsigned integer of fixed bit width. + + **Parameters** + + **width** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Note that [`Uint`](#qiskit.circuit.classical.types.Uint "qiskit.circuit.classical.types.Uint") defines a family of types parametrized by their width; it is not one single type, which may be slightly different to the ‘classical’ programming languages you are used to. @@ -977,6 +1159,11 @@ The low-level interface to querying the subtyping relationship is the [`order()` Ordering.NONE ``` + **Parameters** + + * **left** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type")) – + * **right** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type")) – + **Return type** [*Ordering*](#qiskit.circuit.classical.types.Ordering "qiskit.circuit.classical.types.ordering.Ordering") @@ -987,6 +1174,8 @@ The return value is an enumeration [`Ordering`](#qiskit.circuit.classical.types. #### Ordering + Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.13)") + Enumeration listing the possible relations between two types. Types only have a partial ordering, so it’s possible for two types to have no sub-typing relationship. Note that the sub-/supertyping relationship is not the same as whether a type can be explicitly cast from one to another. @@ -1018,6 +1207,12 @@ Some helper methods are then defined in terms of this low-level [`order()`](#qis False ``` + **Parameters** + + * **left** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type")) – + * **right** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type")) – + * **strict** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -1047,6 +1242,12 @@ Some helper methods are then defined in terms of this low-level [`order()`](#qis False ``` + **Parameters** + + * **left** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type")) – + * **right** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type")) – + * **strict** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -1065,6 +1266,11 @@ Some helper methods are then defined in terms of this low-level [`order()`](#qis [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.13)") – if there is no ordering relation between the two types. + **Parameters** + + * **left** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type")) – + * **right** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type")) – + **Return type** [*Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type") @@ -1086,7 +1292,7 @@ It is common to need to cast values of one type to another type. The casting rul #### cast\_kind - + Determine the sort of cast that is required to move from the left type to the right type. **Examples** @@ -1103,6 +1309,11 @@ It is common to need to cast values of one type to another type. The casting rul ``` + **Parameters** + + * **from\_** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type")) – + * **to\_** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type")) – + **Return type** [*CastKind*](#qiskit.circuit.classical.types.CastKind "qiskit.circuit.classical.types.ordering.CastKind") @@ -1113,6 +1324,8 @@ The return values from this function are an enumeration explaining the types of #### CastKind + Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.13)") + A return value indicating the type of cast that can occur from one type to another. diff --git a/docs/api/qiskit/dev/circuit_library.mdx b/docs/api/qiskit/dev/circuit_library.mdx index cce8103516b..a10ca9e1a4c 100644 --- a/docs/api/qiskit/dev/circuit_library.mdx +++ b/docs/api/qiskit/dev/circuit_library.mdx @@ -1885,6 +1885,10 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui q_1: ┤ X ├──────────┤ X ├───────────┤1 ├──────────── └───┘ └───┘ └─────────┘ ``` + + **Parameters** + + **theta** (*ParameterValueType | None*) – #### rzx\_xz @@ -1904,6 +1908,10 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui «q_1: ───────────────────────────────── « ``` + + **Parameters** + + **theta** (*ParameterValueType | None*) – #### rzx\_cy @@ -1918,6 +1926,10 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui q_1: ┤ X ├┤ RY(ϴ) ├┤ X ├┤ RY(-ϴ) ├┤ RZ(-π/2) ├┤ RX(ϴ) ├┤1 ├┤ RZ(π/2) ├ └───┘└───────┘└───┘└────────┘└──────────┘└───────┘└──────────┘└─────────┘ ``` + + **Parameters** + + **theta** (*ParameterValueType | None*) – #### rzx\_zz1 @@ -1942,6 +1954,10 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui «q_1: ┤ RZ(π/2) ├ « └─────────┘ ``` + + **Parameters** + + **theta** (*ParameterValueType | None*) – #### rzx\_zz2 @@ -1961,6 +1977,10 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui «q_1: ┤1 ├┤ RZ(π/2) ├┤ RX(π/2) ├┤ RZ(π/2) ├ « └──────────┘└─────────┘└─────────┘└─────────┘ ``` + + **Parameters** + + **theta** (*ParameterValueType | None*) – #### rzx\_zz3 @@ -1980,5 +2000,9 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui «q_1: ┤1 ├┤ RZ(π/2) ├┤ RX(π/2) ├┤ RZ(π/2) ├ « └──────────┘└─────────┘└─────────┘└─────────┘ ``` + + **Parameters** + + **theta** (*ParameterValueType | None*) – diff --git a/docs/api/qiskit/dev/circuit_singleton.mdx b/docs/api/qiskit/dev/circuit_singleton.mdx index 8ed117ae643..0e45a54df6f 100644 --- a/docs/api/qiskit/dev/circuit_singleton.mdx +++ b/docs/api/qiskit/dev/circuit_singleton.mdx @@ -45,6 +45,8 @@ The public classes correspond to the standard classes [`Instruction`](qiskit.cir ### SingletonInstruction + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction"), `_SingletonBase` + A base class to use for [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") objects that by default are singleton instances. This class should be used for instruction classes that have fixed definitions and do not contain any unique state. The canonical example of something like this is [`Measure`](circuit#qiskit.circuit.Measure "qiskit.circuit.Measure") which has an immutable definition and any instance of [`Measure`](circuit#qiskit.circuit.Measure "qiskit.circuit.Measure") is the same. Using singleton instructions as a base class for these types of gate classes provides a large advantage in the memory footprint of multiple instructions. @@ -55,6 +57,8 @@ The public classes correspond to the standard classes [`Instruction`](qiskit.cir ### SingletonGate + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate"), `_SingletonBase` + A base class to use for [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") objects that by default are singleton instances. This class is very similar to [`SingletonInstruction`](#qiskit.circuit.singleton.SingletonInstruction "qiskit.circuit.singleton.SingletonInstruction"), except implies unitary [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") semantics as well. The same caveats around setting attributes in that class apply here as well. @@ -63,6 +67,8 @@ The public classes correspond to the standard classes [`Instruction`](qiskit.cir ### SingletonControlledGate + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate"), `_SingletonBase` + A base class to use for [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") objects that by default are singleton instances This class is very similar to [`SingletonInstruction`](#qiskit.circuit.singleton.SingletonInstruction "qiskit.circuit.singleton.SingletonInstruction"), except implies unitary [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") semantics as well. The same caveats around setting attributes in that class apply here as well. diff --git a/docs/api/qiskit/dev/classicalfunction.mdx b/docs/api/qiskit/dev/classicalfunction.mdx index 5fa7fa63d79..5d1f239dea4 100644 --- a/docs/api/qiskit/dev/classicalfunction.mdx +++ b/docs/api/qiskit/dev/classicalfunction.mdx @@ -30,7 +30,9 @@ The classical function compiler provides the necessary tools to map a classical > > quantum_circuit = grover_oracle.synth(registerless=False) > quantum_circuit.draw('text') +> ``` > +> ```text > a: ──o── > │ > b: ──■── @@ -71,7 +73,7 @@ Decorator for a classical function that returns a ClassicalFunction object. #### classical\_function - + Parses and type checks the callable `func` to compile it into an `ClassicalFunction` that can be synthesized into a `QuantumCircuit`. **Parameters** diff --git a/docs/api/qiskit/dev/converters.mdx b/docs/api/qiskit/dev/converters.mdx index 4b85b1d9387..c6a17410828 100644 --- a/docs/api/qiskit/dev/converters.mdx +++ b/docs/api/qiskit/dev/converters.mdx @@ -22,7 +22,7 @@ python_api_name: qiskit.converters ### circuit\_to\_instruction - + Build an [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). The instruction is anonymous (not tied to a named quantum register), and so can be inserted into another circuit. The instruction will have the same string name as the circuit. @@ -96,7 +96,7 @@ python_api_name: qiskit.converters ### circuit\_to\_dag - + Build a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). **Parameters** @@ -175,7 +175,7 @@ python_api_name: qiskit.converters circuit.draw('mpl') ``` - ![../\_images/converters-1.png](/images/api/qiskit/dev/converters-1.png) + ![../\_images/converters-3.png](/images/api/qiskit/dev/converters-3.png) diff --git a/docs/api/qiskit/dev/dagcircuit.mdx b/docs/api/qiskit/dev/dagcircuit.mdx index ce95f2217da..fb1c03e6139 100644 --- a/docs/api/qiskit/dev/dagcircuit.mdx +++ b/docs/api/qiskit/dev/dagcircuit.mdx @@ -33,6 +33,8 @@ python_api_name: qiskit.dagcircuit ### DAGCircuitError + Bases: [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + Base class for errors raised by the DAGCircuit object. Set the error message. @@ -41,6 +43,8 @@ python_api_name: qiskit.dagcircuit ### DAGDependencyError + Bases: [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + Base class for errors raised by the DAGDependency object. Set the error message. diff --git a/docs/api/qiskit/dev/exceptions.mdx b/docs/api/qiskit/dev/exceptions.mdx index 8efcab8875b..741eaba394a 100644 --- a/docs/api/qiskit/dev/exceptions.mdx +++ b/docs/api/qiskit/dev/exceptions.mdx @@ -23,6 +23,8 @@ All Qiskit-related exceptions raised by Qiskit are subclasses of the base: ### QiskitError + Bases: [`Exception`](https://docs.python.org/3/library/exceptions.html#Exception "(in Python v3.13)") + Base class for errors raised by Qiskit. Set the error message. @@ -39,9 +41,22 @@ Qiskit has several optional features that depend on other packages that are not ### MissingOptionalLibraryError + Bases: [`QiskitError`](#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError"), [`ImportError`](https://docs.python.org/3/library/exceptions.html#ImportError "(in Python v3.13)") + Raised when an optional library is missing. Set the error message. :param libname: Name of missing library :param name: Name of class, function, module that uses this library :param pip\_install: pip install command, if any :param msg: Descriptive message, if any + + **Parameters** + + * **libname** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **pip\_install** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **msg** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + + **Return type** + + None Two more uncommon errors relate to failures in reading user-configuration files, or specifying a filename that cannot be used: @@ -49,6 +64,8 @@ Two more uncommon errors relate to failures in reading user-configuration files, ### QiskitUserConfigError + Bases: [`QiskitError`](#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + Raised when an error is encountered reading a user config file. Set the error message. @@ -57,6 +74,8 @@ Two more uncommon errors relate to failures in reading user-configuration files, ### InvalidFileError + Bases: [`QiskitError`](#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + Raised when the file provided is not valid for the specific task. Set the error message. @@ -69,6 +88,8 @@ Some particular features of Qiskit may raise custom warnings. In general, Qiskit ### QiskitWarning + Bases: [`UserWarning`](https://docs.python.org/3/library/exceptions.html#UserWarning "(in Python v3.13)") + Common subclass of warnings for Qiskit-specific warnings being raised. @@ -77,6 +98,8 @@ Related to [`MissingOptionalLibraryError`](#qiskit.exceptions.MissingOptionalLib ### OptionalDependencyImportWarning + Bases: [`QiskitWarning`](#qiskit.exceptions.QiskitWarning "qiskit.exceptions.QiskitWarning") + Raised when an optional library raises errors during its import. @@ -89,6 +112,8 @@ When experimental features are being used, Qiskit will raise [`ExperimentalWarni ### ExperimentalWarning + Bases: [`QiskitWarning`](#qiskit.exceptions.QiskitWarning "qiskit.exceptions.QiskitWarning") + Raised when an experimental feature is being used. diff --git a/docs/api/qiskit/dev/passmanager.mdx b/docs/api/qiskit/dev/passmanager.mdx index bdad998d399..332bafdd1d9 100644 --- a/docs/api/qiskit/dev/passmanager.mdx +++ b/docs/api/qiskit/dev/passmanager.mdx @@ -161,6 +161,8 @@ With the pass manager framework, a developer can flexibly customize the optimiza #### PassManagerError + Bases: [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + Pass manager error. Set the error message. diff --git a/docs/api/qiskit/dev/providers.mdx b/docs/api/qiskit/dev/providers.mdx index 26e6775e5e8..b57efc249c3 100644 --- a/docs/api/qiskit/dev/providers.mdx +++ b/docs/api/qiskit/dev/providers.mdx @@ -76,6 +76,8 @@ It’s worth pointing out that Qiskit’s version support policy doesn’t mean #### QiskitBackendNotFoundError + Bases: [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + Base class for errors raised while looking for a backend. Set the error message. @@ -84,6 +86,8 @@ It’s worth pointing out that Qiskit’s version support policy doesn’t mean #### BackendPropertyError + Bases: [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + Base class for errors raised while looking for a backend property. Set the error message. @@ -92,6 +96,8 @@ It’s worth pointing out that Qiskit’s version support policy doesn’t mean #### JobError + Bases: [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + Base class for errors raised by Jobs. Set the error message. @@ -100,6 +106,8 @@ It’s worth pointing out that Qiskit’s version support policy doesn’t mean #### JobTimeoutError + Bases: [`JobError`](#qiskit.providers.JobError "qiskit.providers.exceptions.JobError") + Base class for timeout errors raised by jobs. Set the error message. @@ -108,6 +116,8 @@ It’s worth pointing out that Qiskit’s version support policy doesn’t mean #### BackendConfigurationError + Bases: [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + Base class for errors raised by the BackendConfiguration. Set the error message. diff --git a/docs/api/qiskit/dev/providers_fake_provider.mdx b/docs/api/qiskit/dev/providers_fake_provider.mdx index 6ca1a946145..d2557de7820 100644 --- a/docs/api/qiskit/dev/providers_fake_provider.mdx +++ b/docs/api/qiskit/dev/providers_fake_provider.mdx @@ -82,6 +82,8 @@ The V1 fake backends are based on a set of base classes: ### FakeBackend + Bases: [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") + This is a dummy backend just for testing purposes. FakeBackend initializer. @@ -99,6 +101,8 @@ The V1 fake backends are based on a set of base classes: ### FakeQasmBackend + Bases: [`FakeBackend`](#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") + A fake OpenQASM backend. FakeBackend initializer. @@ -116,6 +120,8 @@ The V1 fake backends are based on a set of base classes: ### FakePulseBackend + Bases: [`FakeQasmBackend`](#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") + A fake pulse backend. FakeBackend initializer. diff --git a/docs/api/qiskit/dev/pulse.mdx b/docs/api/qiskit/dev/pulse.mdx index ac5822ca88a..97266eed7fc 100644 --- a/docs/api/qiskit/dev/pulse.mdx +++ b/docs/api/qiskit/dev/pulse.mdx @@ -69,6 +69,8 @@ These are all instances of the same base class: ### Instruction + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)") + The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. Instruction initializer. @@ -162,6 +164,8 @@ All channels are children of the same abstract base class: ### Channel + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Base class of channels. Channels provide a Qiskit-side label for typical quantum control hardware signal channels. The final label -> physical channel mapping is the responsibility of the hardware backend. For instance, `DriveChannel(0)` holds instructions which the backend should map to the signal line driving gate operations on the qubit labeled (indexed) 0. When serialized channels are identified by their serialized name ``. The type of the channel is interpreted from the prefix, and the index often (but not always) maps to the qubit index. All concrete channel classes must have a `prefix` class attribute (and instances of that class have an index attribute). Base classes which have `prefix` set to `None` are prevented from being instantiated. @@ -219,9 +223,15 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls #### AlignmentKind + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)") + An abstract class for schedule alignment. Create new context. + + **Parameters** + + **context\_params** (*Tuple\[ParameterValueType, ...]*) – @@ -232,7 +242,7 @@ The canonicalization transforms convert schedules to a form amenable for executi #### add\_implicit\_acquires - + Return a new schedule with implicit acquires from the measurement mapping replaced by explicit ones. @@ -255,7 +265,7 @@ The canonicalization transforms convert schedules to a form amenable for executi #### align\_measures - + Return new schedules where measurements occur at the same physical time. This transformation will align the first [`Acquire`](qiskit.pulse.instructions.Acquire "qiskit.pulse.instructions.Acquire") on every channel to occur at the same time. @@ -413,7 +423,7 @@ The canonicalization transforms convert schedules to a form amenable for executi #### pad - + Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedule.duration` or `until` if not `None`. **Parameters** @@ -481,7 +491,7 @@ The DAG transforms create DAG representation of input program. This can be used #### block\_to\_dag - + Convert schedule block instruction into DAG. `ScheduleBlock` can be represented as a DAG as needed. For example, equality of two programs are efficiently checked on DAG representation. @@ -593,7 +603,7 @@ with pulse.build(name='pulse_programming_in') as pulse_prog: pulse_prog.draw() ``` -![../\_images/pulse-1.png](/images/api/qiskit/dev/pulse-1.png) +![../\_images/pulse-5.png](/images/api/qiskit/dev/pulse-5.png) To begin pulse programming we must first initialize our program builder context with [`build()`](#qiskit.pulse.builder.build "qiskit.pulse.builder.build"), after which we can begin adding program statements. For example, below we write a simple program that [`play()`](#qiskit.pulse.builder.play "qiskit.pulse.builder.play")s a pulse: @@ -608,7 +618,7 @@ with pulse.build() as pulse_prog: pulse_prog.draw() ``` -![../\_images/pulse-2.png](/images/api/qiskit/dev/pulse-2.png) +![../\_images/pulse-6.png](/images/api/qiskit/dev/pulse-6.png) The builder initializes a [`pulse.Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule"), `pulse_prog` and then begins to construct the program within the context. The output pulse schedule will survive after the context is exited and can be used like a normal Qiskit schedule. @@ -649,7 +659,7 @@ with pulse.build(backend) as decoupled_bell_prep_and_measure: decoupled_bell_prep_and_measure.draw() ``` -![../\_images/pulse-3.png](/images/api/qiskit/dev/pulse-3.png) +![../\_images/pulse-7.png](/images/api/qiskit/dev/pulse-7.png) With the pulse builder we are able to blend programming on qubits and channels. While the pulse schedule is based on instructions that operate on channels, the pulse builder automatically handles the mapping from qubits to channels for you. @@ -762,7 +772,7 @@ The above is just a small taste of what is possible with the builder. See the re ### build - + Create a context manager for launching the imperative pulse builder DSL. To enter a building context and starting building a pulse program: @@ -826,7 +836,7 @@ DriveChannel(0) #### acquire\_channel - + Return `AcquireChannel` for `qubit` on the active builder backend. @@ -849,6 +859,10 @@ DriveChannel(0) Requires the active builder context to have a backend set. + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + **Return type** [*AcquireChannel*](qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") @@ -856,7 +870,7 @@ DriveChannel(0) #### control\_channels - + Return `ControlChannel` for `qubit` on the active builder backend. Return the secondary drive channel for the given qubit – typically utilized for controlling multi-qubit interactions. @@ -895,7 +909,7 @@ DriveChannel(0) #### drive\_channel - + Return `DriveChannel` for `qubit` on the active builder backend. @@ -918,6 +932,10 @@ DriveChannel(0) Requires the active builder context to have a backend set. + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + **Return type** [*DriveChannel*](qiskit.pulse.channels.DriveChannel "qiskit.pulse.channels.DriveChannel") @@ -925,7 +943,7 @@ DriveChannel(0) #### measure\_channel - + Return `MeasureChannel` for `qubit` on the active builder backend. @@ -948,6 +966,10 @@ DriveChannel(0) Requires the active builder context to have a backend set. + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + **Return type** [*MeasureChannel*](qiskit.pulse.channels.MeasureChannel "qiskit.pulse.channels.MeasureChannel") @@ -984,11 +1006,11 @@ with pulse.build(backend) as drive_sched: drive_sched.draw() ``` -![../\_images/pulse-4.png](/images/api/qiskit/dev/pulse-4.png) +![../\_images/pulse-15.png](/images/api/qiskit/dev/pulse-15.png) #### acquire - + Acquire for a `duration` on a `channel` and store the result in a `register`. @@ -1029,7 +1051,7 @@ drive_sched.draw() #### barrier - + Barrier directive for a set of channels and qubits. This directive prevents the compiler from moving instructions across the barrier. Consider the case where we want to enforce that one pulse happens after another on separate channels, this can be done with: @@ -1104,7 +1126,7 @@ drive_sched.draw() #### call - + Call the subroutine within the currently active builder context with arbitrary parameters which will be assigned to the target program. @@ -1277,7 +1299,7 @@ drive_sched.draw() #### delay - + Delay on a `channel` for a `duration`. @@ -1304,7 +1326,7 @@ drive_sched.draw() #### play - + Play a `pulse` on a `channel`. @@ -1331,7 +1353,7 @@ drive_sched.draw() #### reference - + Refer to undefined subroutine by string keys. A [`Reference`](qiskit.pulse.instructions.Reference "qiskit.pulse.instructions.Reference") instruction is implicitly created and a schedule can be separately registered to the reference at a later stage. @@ -1360,7 +1382,7 @@ drive_sched.draw() #### set\_frequency - + Set the `frequency` of a pulse `channel`. @@ -1387,7 +1409,7 @@ drive_sched.draw() #### set\_phase - + Set the `phase` of a pulse `channel`. @@ -1416,7 +1438,7 @@ drive_sched.draw() #### shift\_frequency - + Shift the `frequency` of a pulse `channel`. @@ -1443,7 +1465,7 @@ drive_sched.draw() #### shift\_phase - + Shift the `phase` of a pulse `channel`. @@ -1472,7 +1494,7 @@ drive_sched.draw() #### snapshot - + Simulator snapshot. @@ -1514,11 +1536,11 @@ with pulse.build() as pulse_prog: pulse_prog.draw() ``` -![../\_images/pulse-5.png](/images/api/qiskit/dev/pulse-5.png) +![../\_images/pulse-33.png](/images/api/qiskit/dev/pulse-33.png) #### align\_equispaced - + Equispaced alignment pulse scheduling context. Pulse instructions within this context are scheduled with the same interval spacing such that the total length of the context block is `duration`. If the total free `duration` cannot be evenly divided by the number of instructions within the context, the modulo is split and then prepended and appended to the returned schedule. Delay instructions are automatically inserted in between pulses. @@ -1547,7 +1569,7 @@ pulse_prog.draw() hahn_echo.draw() ``` - ![../\_images/pulse-6.png](/images/api/qiskit/dev/pulse-6.png) + ![../\_images/pulse-34.png](/images/api/qiskit/dev/pulse-34.png) **Parameters** @@ -1568,7 +1590,7 @@ pulse_prog.draw() #### align\_func - + Callback defined alignment pulse scheduling context. Pulse instructions within this context are scheduled at the location specified by arbitrary callback function position that takes integer index and returns the associated fractional location within \[0, 1]. Delay instruction is automatically inserted in between pulses. @@ -1602,7 +1624,7 @@ pulse_prog.draw() udd_sched.draw() ``` - ![../\_images/pulse-7.png](/images/api/qiskit/dev/pulse-7.png) + ![../\_images/pulse-35.png](/images/api/qiskit/dev/pulse-35.png) **Parameters** @@ -1624,7 +1646,7 @@ pulse_prog.draw() #### align\_left - + Left alignment pulse scheduling context. Pulse instructions within this context are scheduled as early as possible by shifting them left to the earliest available time. @@ -1663,7 +1685,7 @@ pulse_prog.draw() #### align\_right - + Right alignment pulse scheduling context. Pulse instructions within this context are scheduled as late as possible by shifting them right to the latest available time. @@ -1702,7 +1724,7 @@ pulse_prog.draw() #### align\_sequential - + Sequential alignment pulse scheduling context. Pulse instructions within this context are scheduled sequentially in time such that no two instructions will be played at the same time. @@ -1741,7 +1763,7 @@ pulse_prog.draw() #### frequency\_offset - + Shift the frequency of inputs channels on entry into context and undo on exit. @@ -1791,7 +1813,7 @@ pulse_prog.draw() #### phase\_offset - + Shift the phase of input channels on entry into context and undo on exit. @@ -1849,7 +1871,7 @@ MemorySlot(0) #### measure - + Measure a qubit within the currently active builder context. At the pulse level a measurement is composed of both a stimulus pulse and an acquisition instruction which tells the systems measurement unit to acquire data and process it. We provide this measurement macro to automate the process for you, but if desired full control is still available with [`acquire()`](#qiskit.pulse.builder.acquire "qiskit.pulse.builder.acquire") and [`play()`](#qiskit.pulse.builder.play "qiskit.pulse.builder.play"). @@ -1908,7 +1930,7 @@ MemorySlot(0) #### measure\_all - + Measure all qubits within the currently active builder context. A simple macro function to measure all of the qubits in the device at the same time. This is useful for handling device `meas_map` and single measurement constraints. @@ -1945,7 +1967,7 @@ MemorySlot(0) #### delay\_qubits - + Insert delays on all the `channels.Channel`s that correspond to the input `qubits` at the same time. @@ -2006,7 +2028,7 @@ There are 1e-06 seconds in 4500 samples. #### active\_backend - + Get the backend of the currently active builder context. @@ -2030,7 +2052,7 @@ There are 1e-06 seconds in 4500 samples. #### num\_qubits - + Return number of qubits in the currently active backend. @@ -2064,7 +2086,7 @@ There are 1e-06 seconds in 4500 samples. #### qubit\_channels - + Returns the set of channels associated with a qubit. @@ -2095,6 +2117,10 @@ There are 1e-06 seconds in 4500 samples. A channel may still be associated with another qubit in this list such as in the case where significant crosstalk exists. + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + **Return type** [set](https://docs.python.org/3/library/stdtypes.html#set "(in Python v3.13)")\[[qiskit.pulse.channels.Channel](#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] @@ -2102,7 +2128,7 @@ There are 1e-06 seconds in 4500 samples. #### samples\_to\_seconds - + Obtain the time in seconds that will elapse for the input number of samples on the active backend. @@ -2124,7 +2150,7 @@ There are 1e-06 seconds in 4500 samples. #### seconds\_to\_samples - + Obtain the number of samples that will elapse in `seconds` on the active backend. Rounds down. @@ -2157,6 +2183,8 @@ There are 1e-06 seconds in 4500 samples. ### PulseError + Bases: [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + Errors raised by the pulse module. Set the error message. @@ -2169,6 +2197,8 @@ There are 1e-06 seconds in 4500 samples. ### BackendNotSet + Bases: [`PulseError`](#qiskit.pulse.PulseError "qiskit.pulse.exceptions.PulseError") + Raised if the builder context does not have a backend. Set the error message. @@ -2181,6 +2211,8 @@ There are 1e-06 seconds in 4500 samples. ### NoActiveBuilder + Bases: [`PulseError`](#qiskit.pulse.PulseError "qiskit.pulse.exceptions.PulseError") + Raised if no builder context is active. Set the error message. @@ -2193,6 +2225,8 @@ There are 1e-06 seconds in 4500 samples. ### UnassignedDurationError + Bases: [`PulseError`](#qiskit.pulse.PulseError "qiskit.pulse.exceptions.PulseError") + Raised if instruction duration is unassigned. Set the error message. @@ -2205,6 +2239,8 @@ There are 1e-06 seconds in 4500 samples. ### UnassignedReferenceError + Bases: [`PulseError`](#qiskit.pulse.PulseError "qiskit.pulse.exceptions.PulseError") + Raised if subroutine is unassigned. Set the error message. diff --git a/docs/api/qiskit/dev/qasm2.mdx b/docs/api/qiskit/dev/qasm2.mdx index f67c0c13b6c..195f07100b5 100644 --- a/docs/api/qiskit/dev/qasm2.mdx +++ b/docs/api/qiskit/dev/qasm2.mdx @@ -30,7 +30,7 @@ This module contains two public functions, both of which create a [`QuantumCircu ### load - + Parse an OpenQASM 2 program from a file into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). The given path should be ASCII or UTF-8 encoded, and contain the OpenQASM 2 program. **Parameters** @@ -53,7 +53,7 @@ This module contains two public functions, both of which create a [`QuantumCircu ### loads - + Parse an OpenQASM 2 program from a string into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). **Parameters** @@ -84,6 +84,8 @@ You can extend the quantum components of the OpenQASM 2 language by passing an i #### CustomInstruction + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Information about a custom instruction that should be defined during the parse. The `name`, `num_params` and `num_qubits` fields are self-explanatory. The `constructor` field should be a callable object with signature `*args -> Instruction`, where each of the `num_params` `args` is a floating-point value. Most of the built-in Qiskit gate classes have this form. @@ -118,6 +120,14 @@ You can extend the quantum components of the OpenQASM 2 language by passing an i loaded = qasm2.loads(dumped, custom_instructions=custom) ``` + + **Parameters** + + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **num\_params** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **constructor** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.13)")*\[\[...],* [*Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction")*]*) – + * **builtin** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – This can be particularly useful when trying to resolve ambiguities in the global-phase conventions of an OpenQASM 2 program. See [OpenQASM 2 Phase Conventions](#qasm2-phase-conventions) for more details. @@ -131,6 +141,8 @@ Similar to the quantum extensions above, you can also extend the processing done #### CustomClassical + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Information about a custom classical function that should be defined in mathematical expressions. The given callable must be a Python function that takes num\_params floats, and returns a float. The name is the identifier that refers to it in the OpenQASM 2 program. This cannot clash with any defined gates. @@ -192,6 +204,8 @@ This module defines a generic error type that derives from [`QiskitError`](excep ### QASM2Error + Bases: [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + A general error raised by the OpenQASM 2 interoperation layer. Set the error message. @@ -202,6 +216,8 @@ In cases where the lexer or parser fails due to an invalid OpenQASM 2 file, the ### QASM2ParseError + Bases: [`QASM2Error`](#qiskit.qasm2.QASM2Error "qiskit.qasm2.exceptions.QASM2Error") + An error raised because of a failure to parse an OpenQASM 2 file. Set the error message. @@ -212,6 +228,8 @@ When the exporters fail to export a circuit, likely because it has structure tha ### QASM2ExportError + Bases: [`QASM2Error`](#qiskit.qasm2.QASM2Error "qiskit.qasm2.exceptions.QASM2Error") + An error raised because of a failure to convert a Qiskit object to an OpenQASM 2 form. Set the error message. diff --git a/docs/api/qiskit/dev/qasm3.mdx b/docs/api/qiskit/dev/qasm3.mdx index 73529c8cf3b..0e469d8c959 100644 --- a/docs/api/qiskit/dev/qasm3.mdx +++ b/docs/api/qiskit/dev/qasm3.mdx @@ -24,7 +24,7 @@ The high-level functions are simply [`dump()`](#qiskit.qasm3.dump "qiskit.qasm3. ### dump - + Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object as an OpenQASM 3 stream to file-like object. **Parameters** @@ -32,11 +32,15 @@ The high-level functions are simply [`dump()`](#qiskit.qasm3.dump "qiskit.qasm3. * **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – Circuit to serialize. * **stream** (*TextIOBase*) – stream-like object to dump the OpenQASM 3 serialization * **\*\*kwargs** – Arguments for the [`Exporter`](#qiskit.qasm3.Exporter "qiskit.qasm3.Exporter") constructor. + + **Return type** + + None ### dumps - + Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object in an OpenQASM 3 string. **Parameters** @@ -58,6 +62,8 @@ Both of these exporter functions are single-use wrappers around the main [`Expor ### Exporter + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + QASM3 exporter main class. **Parameters** @@ -112,6 +118,8 @@ All of these interfaces will raise [`QASM3ExporterError`](#qiskit.qasm3.QASM3Exp ### QASM3ExporterError + Bases: `QASM3Error` + An error raised during running the OpenQASM 3 exporter. Set the error message. @@ -124,6 +132,8 @@ The OpenQASM 3 language is still evolving as hardware capabilities improve, so t #### ExperimentalFeatures + Bases: [`Flag`](https://docs.python.org/3/library/enum.html#enum.Flag "(in Python v3.13)") + Flags for experimental features that the OpenQASM 3 exporter supports. These are experimental and are more liable to change, because the OpenQASM 3 specification has not formally accepted them yet, so the syntax may not be finalized. @@ -217,7 +227,7 @@ Currently only two high-level functions are offered, as Qiskit support for impor ### load - + Load an OpenQASM 3 program from the file `filename`. **Parameters** @@ -239,7 +249,7 @@ Currently only two high-level functions are offered, as Qiskit support for impor ### loads - + Load an OpenQASM 3 program from the given string. **Parameters** @@ -264,6 +274,8 @@ Both of these two functions raise [`QASM3ImporterError`](#qiskit.qasm3.QASM3Impo ### QASM3ImporterError + Bases: `QASM3Error` + An error raised during the OpenQASM 3 importer. Set the error message. @@ -318,7 +330,7 @@ circuit = qiskit.qasm3.loads(program) circuit.draw("mpl") ``` -![../\_images/qasm3-1.png](/images/api/qiskit/dev/qasm3-1.png) +![../\_images/qasm3-2.png](/images/api/qiskit/dev/qasm3-2.png) ### Experimental import interface @@ -398,6 +410,8 @@ These two functions allow for specifying include paths as an iterable of paths, #### CustomGate + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Information received from Python space about how to construct a Python-space object to represent a given gate that might be declared. ##### constructor diff --git a/docs/api/qiskit/dev/qiskit.circuit.AnnotatedOperation.mdx b/docs/api/qiskit/dev/qiskit.circuit.AnnotatedOperation.mdx index a4a5a97ec14..19a18d6d0b8 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.AnnotatedOperation.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.AnnotatedOperation.mdx @@ -154,6 +154,10 @@ python_api_name: qiskit.circuit.AnnotatedOperation Validate a parameter for the underlying base operation. + **Parameters** + + **parameter** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + **Return type** [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") | [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") diff --git a/docs/api/qiskit/dev/qiskit.circuit.CommutationChecker.mdx b/docs/api/qiskit/dev/qiskit.circuit.CommutationChecker.mdx index ceca37e9a6b..5c742c590b2 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.CommutationChecker.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.CommutationChecker.mdx @@ -15,6 +15,12 @@ python_api_name: qiskit.circuit.CommutationChecker ## Methods + **Parameters** + + * **standard\_gate\_commutations** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")) – + * **cache\_max\_entries** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **gates** ([*Set*](https://docs.python.org/3/library/typing.html#typing.Set "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*] | None*) – + ### check\_commutation\_entries @@ -71,6 +77,10 @@ python_api_name: qiskit.circuit.CommutationChecker Checks if two DAGOpNodes commute. + **Parameters** + + **max\_num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") diff --git a/docs/api/qiskit/dev/qiskit.circuit.ControlledGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.ControlledGate.mdx index 6062c21edc8..0a5c4732113 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.ControlledGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.ControlledGate.mdx @@ -346,6 +346,10 @@ python_api_name: qiskit.circuit.ControlledGate Invert this gate by calling inverse on the base gate. + **Parameters** + + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **Return type** ControlledGate’ | ‘AnnotatedOperation diff --git a/docs/api/qiskit/dev/qiskit.circuit.InstructionSet.mdx b/docs/api/qiskit/dev/qiskit.circuit.InstructionSet.mdx index 296868cf699..622c0cc67fd 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.InstructionSet.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.InstructionSet.mdx @@ -98,6 +98,10 @@ python_api_name: qiskit.circuit.InstructionSet It is preferable to take the inverse *before* appending the gate(s) to the circuit. + + **Parameters** + + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – diff --git a/docs/api/qiskit/dev/qiskit.circuit.Parameter.mdx b/docs/api/qiskit/dev/qiskit.circuit.Parameter.mdx index 0dcf742ffaa..89ce4d75dda 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.Parameter.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.Parameter.mdx @@ -229,6 +229,11 @@ python_api_name: qiskit.circuit.Parameter Substitute self with the corresponding parameter in `parameter_map`. + + **Parameters** + + * **parameter\_map** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")) – + * **allow\_unknown\_parameters** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – ### sympify diff --git a/docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.mdx index 62be336949b..1ede9382c92 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.mdx @@ -12,7 +12,9 @@ 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 "(in Python v3.13)") + Core Qiskit representation of a quantum circuit. @@ -469,7 +471,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** @@ -491,7 +493,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** @@ -534,6 +536,14 @@ python_api_name: qiskit.circuit.QuantumCircuit Add Bits to the circuit. + + **Parameters** + + **bits** ([*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*Bit*](circuit#qiskit.circuit.Bit "qiskit.circuit.bit.Bit")*]*) – + + **Return type** + + None Registers are added to the circuit with [`add_register()`](#qiskit.circuit.QuantumCircuit.add_register "qiskit.circuit.QuantumCircuit.add_register"). In this method, it is not an error if some of the bits are already present in the circuit. In this case, the register will be an “alias” over the bits. This is not generally well-supported by hardware backends; it is probably best to stay away from relying on it. The registers a given bit is in are part of the return of [`find_bit()`](#qiskit.circuit.QuantumCircuit.find_bit "qiskit.circuit.QuantumCircuit.find_bit"). @@ -542,6 +552,14 @@ python_api_name: qiskit.circuit.QuantumCircuit Add registers. + + **Parameters** + + **regs** ([*Register*](circuit#qiskit.circuit.Register "qiskit.circuit.Register") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| Sequence\[*[*Bit*](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit")*]*) – + + **Return type** + + None [Real-time, typed classical data](circuit#circuit-repr-real-time-classical) is represented on the circuit by [`Var`](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") nodes with a well-defined [`Type`](circuit_classical#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type"). It is possible to instantiate these separately to a circuit (see [`Var.new()`](circuit_classical#qiskit.circuit.classical.expr.Var.new "qiskit.circuit.classical.expr.Var.new")), but it is often more convenient to use circuit methods that will automatically manage the types and expression initialization for you. The two most common methods are [`add_var()`](#qiskit.circuit.QuantumCircuit.add_var "qiskit.circuit.QuantumCircuit.add_var") (locally scoped variables) and [`add_input()`](#qiskit.circuit.QuantumCircuit.add_input "qiskit.circuit.QuantumCircuit.add_input") (inputs to the circuit). @@ -768,7 +786,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`](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. @@ -815,9 +833,9 @@ python_api_name: qiskit.circuit.QuantumCircuit circuit.draw('mpl') ``` - ![../\_images/qiskit-circuit-QuantumCircuit-1\_00.png](/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-1_00.png) + ![../\_images/qiskit-circuit-QuantumCircuit-4\_00.png](/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-4_00.png) - ![../\_images/qiskit-circuit-QuantumCircuit-1\_01.png](/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-1_01.png) + ![../\_images/qiskit-circuit-QuantumCircuit-4\_01.png](/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-4_01.png) Bind the values out-of-place by list and get a copy of the original circuit. @@ -835,9 +853,9 @@ python_api_name: qiskit.circuit.QuantumCircuit circuit.draw('mpl') ``` - ![../\_images/qiskit-circuit-QuantumCircuit-2\_00.png](/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-2_00.png) + ![../\_images/qiskit-circuit-QuantumCircuit-5\_00.png](/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-5_00.png) - ![../\_images/qiskit-circuit-QuantumCircuit-2\_01.png](/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-2_01.png) + ![../\_images/qiskit-circuit-QuantumCircuit-5\_01.png](/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-5_01.png) The circuit tracks parameters by [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") instances themselves, and forbids having multiple parameters of the same name to avoid some problems when interoperating with OpenQASM or other external formats. You can use [`has_parameter()`](#qiskit.circuit.QuantumCircuit.has_parameter "qiskit.circuit.QuantumCircuit.has_parameter") and [`get_parameter()`](#qiskit.circuit.QuantumCircuit.get_parameter "qiskit.circuit.QuantumCircuit.get_parameter") to query the circuit for a parameter with the given string name. @@ -1288,7 +1306,7 @@ python_api_name: qiskit.circuit.QuantumCircuit tensored.draw('mpl') ``` - ![../\_images/qiskit-circuit-QuantumCircuit-3.png](/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-3.png) + ![../\_images/qiskit-circuit-QuantumCircuit-6.png](/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-6.png) **Returns** @@ -1297,6 +1315,11 @@ python_api_name: qiskit.circuit.QuantumCircuit **Return type** [QuantumCircuit](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + + **Parameters** + + * **other** ([*QuantumCircuit*](#qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")) – + * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – As some rules of thumb: @@ -1398,7 +1421,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### barrier - + Apply `Barrier`. If `qargs` is empty, applies to all qubits in the circuit. **Parameters** @@ -1417,7 +1440,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### ccx - + Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1440,7 +1463,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### ccz - + Apply [`CCZGate`](qiskit.circuit.library.CCZGate "qiskit.circuit.library.CCZGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1464,7 +1487,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### ch - + Apply [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1487,7 +1510,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### cp - + Apply [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1511,7 +1534,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### crx - + Apply [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1535,7 +1558,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### cry - + Apply [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1559,7 +1582,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### crz - + Apply [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1583,7 +1606,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### cs - + Apply [`CSGate`](qiskit.circuit.library.CSGate "qiskit.circuit.library.CSGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1606,7 +1629,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### csdg - + Apply [`CSdgGate`](qiskit.circuit.library.CSdgGate "qiskit.circuit.library.CSdgGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1629,7 +1652,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### cswap - + Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1653,7 +1676,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### csx - + Apply [`CSXGate`](qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1676,7 +1699,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### cu - + Apply [`CUGate`](qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1703,7 +1726,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### cx - + Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1726,7 +1749,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### cy - + Apply [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1749,7 +1772,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### cz - + Apply [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1772,7 +1795,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### dcx - + Apply [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1793,7 +1816,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** @@ -1817,7 +1840,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### ecr - + Apply [`ECRGate`](qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1838,7 +1861,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### h - + Apply [`HGate`](qiskit.circuit.library.HGate "qiskit.circuit.library.HGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1858,7 +1881,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### id - + Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1878,7 +1901,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`](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`](qiskit.circuit.library.Initialize "qiskit.circuit.library.Initialize") instruction. @@ -1967,7 +1990,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### iswap - + Apply [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -1988,7 +2011,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### mcp - + Apply [`MCPhaseGate`](qiskit.circuit.library.MCPhaseGate "qiskit.circuit.library.MCPhaseGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2067,7 +2090,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### mcx - + Apply [`MCXGate`](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: @@ -2103,7 +2126,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. @@ -2179,7 +2202,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### ms - + Apply [`MSGate`](qiskit.circuit.library.MSGate "qiskit.circuit.library.MSGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2200,7 +2223,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### p - + Apply [`PhaseGate`](qiskit.circuit.library.PhaseGate "qiskit.circuit.library.PhaseGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2221,7 +2244,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### pauli - + Apply [`PauliGate`](qiskit.circuit.library.PauliGate "qiskit.circuit.library.PauliGate"). **Parameters** @@ -2240,7 +2263,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. @@ -2311,7 +2334,7 @@ python_api_name: qiskit.circuit.QuantumCircuit └─────────────────────────┘ ``` - Initialize two qubits from an array of complex amplitudes .. code-block: + Initialize two qubits from an array of complex amplitudes ```python import numpy as np @@ -2335,7 +2358,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### r - + Apply [`RGate`](qiskit.circuit.library.RGate "qiskit.circuit.library.RGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2357,7 +2380,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### rcccx - + Apply [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2380,7 +2403,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### rccx - + Apply [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2420,7 +2443,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### rv - + Apply [`RVGate`](qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2445,7 +2468,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### rx - + Apply [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2467,7 +2490,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### rxx - + Apply [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2489,7 +2512,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### ry - + Apply [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2511,7 +2534,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### ryy - + Apply [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2533,7 +2556,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### rz - + Apply [`RZGate`](qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2554,7 +2577,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### rzx - + Apply [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2576,7 +2599,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### rzz - + Apply [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2598,7 +2621,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### s - + Apply [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2618,7 +2641,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### sdg - + Apply [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2665,7 +2688,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### swap - + Apply [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2686,7 +2709,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### sx - + Apply [`SXGate`](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2706,7 +2729,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### sxdg - + Apply [`SXdgGate`](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2726,7 +2749,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### t - + Apply [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2746,7 +2769,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### tdg - + Apply [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2766,7 +2789,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### u - + Apply [`UGate`](qiskit.circuit.library.UGate "qiskit.circuit.library.UGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2789,7 +2812,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### unitary - + Apply unitary gate specified by `obj` to `qubits`. **Parameters** @@ -2823,7 +2846,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### x - + Apply [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2844,7 +2867,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### y - + Apply [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2864,7 +2887,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### z - + Apply [`ZGate`](qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate"). For the full matrix form of this gate, see the underlying gate documentation. @@ -2908,7 +2931,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### break\_loop - + Apply [`BreakLoopOp`](qiskit.circuit.BreakLoopOp "qiskit.circuit.BreakLoopOp"). @@ -2930,7 +2953,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### continue\_loop - + Apply [`ContinueLoopOp`](qiskit.circuit.ContinueLoopOp "qiskit.circuit.ContinueLoopOp"). @@ -2952,7 +2975,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`](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`](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. @@ -3003,7 +3026,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### if\_else - + Apply [`IfElseOp`](qiskit.circuit.IfElseOp "qiskit.circuit.IfElseOp"). @@ -3047,7 +3070,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`](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. @@ -3101,7 +3124,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`](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`](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. @@ -3148,7 +3171,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. @@ -3249,7 +3272,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. @@ -3269,7 +3292,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`. @@ -3308,11 +3331,15 @@ python_api_name: qiskit.circuit.QuantumCircuit A method to produce a new circuit with no instructions and all the same tracking of quantum and classical typed data, but without mutating the original circuit. + + **Return type** + + None #### 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.) @@ -3362,7 +3389,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### add\_calibration - + Register a low-level, custom pulse definition for the given gate. @@ -3379,6 +3406,10 @@ python_api_name: qiskit.circuit.QuantumCircuit **Raises** [**Exception**](https://docs.python.org/3/library/exceptions.html#Exception "(in Python v3.13)") – if the gate is of type string and params is None. + + **Return type** + + None #### has\_calibration\_for @@ -3389,6 +3420,10 @@ python_api_name: qiskit.circuit.QuantumCircuit The method `qiskit.circuit.quantumcircuit.QuantumCircuit.has_calibration_for()` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.circuit.quantumcircuit.QuantumCircuit.has_calibration_for()` will have no alternative in Qiskit. + + **Parameters** + + **instruction** ([*CircuitInstruction*](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – ## Circuit properties @@ -3418,7 +3453,7 @@ python_api_name: qiskit.circuit.QuantumCircuit qc.draw('mpl') ``` - ![../\_images/qiskit-circuit-QuantumCircuit-4.png](/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-4.png) + ![../\_images/qiskit-circuit-QuantumCircuit-19.png](/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-19.png) From the plot, it is easy to see that this circuit has 12 qubits, and a collection of Hadamard, CNOT, X, and SWAP gates. But how to quantify this programmatically? Because we can do single-qubit gates on all the qubits simultaneously, the number of qubits in this circuit is equal to the [`width()`](#qiskit.circuit.QuantumCircuit.width "qiskit.circuit.QuantumCircuit.width") of the circuit: @@ -3630,7 +3665,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** @@ -3648,14 +3683,14 @@ 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 **Parameters** - * **\*qubits** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Qubits within `self` to include. Integers are allowed for qubits, indicating + * **\*qubits** – Qubits within `self` to include. Integers are allowed for qubits, indicating * **self.qubits.** (*indices of*) – **Returns** @@ -3673,14 +3708,14 @@ 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 **Parameters** - * **\*qubits** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Qubits within `self` to include. Integers are allowed for qubits, indicating + * **\*qubits** – Qubits within `self` to include. Integers are allowed for qubits, indicating * **self.qubits.** (*indices of*) – **Returns** @@ -3959,7 +3994,7 @@ python_api_name: qiskit.circuit.QuantumCircuit qc.draw(output='mpl', style={'backgroundcolor': '#EEEEEE'}) ``` - ![../\_images/qiskit-circuit-QuantumCircuit-5.png](/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-5.png) + ![../\_images/qiskit-circuit-QuantumCircuit-20.png](/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-20.png) In addition to the core [`draw()`](#qiskit.circuit.QuantumCircuit.draw "qiskit.circuit.QuantumCircuit.draw") driver, there are two visualization-related helper methods, which are mostly useful for quickly unwrapping some inner instructions or reversing the [qubit-labelling conventions](circuit#circuit-conventions) in the drawing. For more general mutation, including basis-gate rewriting, you should use the transpiler ([`qiskit.transpiler`](transpiler#module-qiskit.transpiler "qiskit.transpiler")). @@ -4048,6 +4083,11 @@ python_api_name: qiskit.circuit.QuantumCircuit The method `qiskit.circuit.quantumcircuit.QuantumCircuit.cast()` is deprecated as of qiskit 1.2. It will be removed in the 2.0 release. This method is only used as an internal helper and will be removed with no replacement. + **Parameters** + + * **value** (*S*) – + * **type\_** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.13)")*\[\[...], T]*) – + **Return type** *S* | *T* @@ -4124,5 +4164,15 @@ python_api_name: qiskit.circuit.QuantumCircuit [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")\[[qiskit.circuit.quantumregister.Qubit](circuit#qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit")] + + **Parameters** + + * **regs** ([*Register*](circuit#qiskit.circuit.Register "qiskit.circuit.Register") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| Sequence\[*[*Bit*](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit")*]*) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **global\_phase** (*ParameterValueType*) – + * **metadata** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") *| None*) – + * **inputs** (*Iterable\[*[*expr.Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")*]*) – + * **captures** (*Iterable\[*[*expr.Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")*]*) – + * **declarations** (*Mapping\[*[*expr.Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")*,* [*expr.Expr*](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr")*] | Iterable\[Tuple\[*[*expr.Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")*,* [*expr.Expr*](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr")*]]*) – diff --git a/docs/api/qiskit/dev/qiskit.circuit.SwitchCaseOp.mdx b/docs/api/qiskit/dev/qiskit.circuit.SwitchCaseOp.mdx index 288524cd93b..7502cca8b57 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.SwitchCaseOp.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.SwitchCaseOp.mdx @@ -17,6 +17,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp * **target** ([*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit") *|*[*ClassicalRegister*](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") *|*[*expr.Expr*](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr")) – the real-time value to switch on. * **cases** (*Iterable\[Tuple\[Any,* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*]]*) – an ordered iterable of the corresponding value of the `target` and the circuit block that should be executed if this is matched. There is no fall-through between blocks, and the order matters. + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – ## Attributes diff --git a/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.BooleanExpression.mdx b/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.BooleanExpression.mdx index 84d0b46d02d..1be29e9370f 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.BooleanExpression.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.BooleanExpression.mdx @@ -274,6 +274,10 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression **Raises** [**FileNotFoundError**](https://docs.python.org/3/library/exceptions.html#FileNotFoundError "(in Python v3.13)") – If filename is not found. + + **Parameters** + + **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – ### inverse diff --git a/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx b/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx index b2bb1f85b04..845c52dd2f4 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx @@ -11,6 +11,8 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE # qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError + Bases: `ClassicalFunctionCompilerError` + ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. Set the error message. diff --git a/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx b/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx index 6b1f1bcfe9a..a7d4b081b97 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx @@ -11,6 +11,8 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError # qiskit.circuit.classicalfunction.ClassicalFunctionParseError + Bases: `ClassicalFunctionCompilerError` + ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. Set the error message. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CDKMRippleCarryAdder.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CDKMRippleCarryAdder.mdx index ac7999217f0..6a2163d1170 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CDKMRippleCarryAdder.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CDKMRippleCarryAdder.mdx @@ -151,7 +151,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CHGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CHGate.mdx index c27f4b43e70..81f7ff4fd21 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CHGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CHGate.mdx @@ -218,6 +218,10 @@ $$ Return inverted CH gate (itself). + + **Parameters** + + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CPhaseGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CPhaseGate.mdx index cebed2dcb40..ded5d95fc9e 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CPhaseGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CPhaseGate.mdx @@ -46,6 +46,12 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – + ### base\_class @@ -220,6 +226,10 @@ $$ Return inverted CPhase gate ($CPhase(\lambda)^{\dagger} = CPhase(-\lambda)$) + + **Parameters** + + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – ### power diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CRXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CRXGate.mdx index dad12981192..36e618b79d3 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CRXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CRXGate.mdx @@ -67,6 +67,12 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – + ### base\_class diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CRYGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CRYGate.mdx index 2cf8040dc1e..2f936681833 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CRYGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CRYGate.mdx @@ -67,6 +67,12 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – + ### base\_class diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CRZGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CRZGate.mdx index 1b67e0fde73..e199674fd58 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CRZGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CRZGate.mdx @@ -69,6 +69,12 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – + ### base\_class diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CU1Gate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CU1Gate.mdx index 9d2022fa589..0c3d719a0c1 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CU1Gate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CU1Gate.mdx @@ -57,6 +57,12 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – + ### base\_class diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CU3Gate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CU3Gate.mdx index 258fd444b1c..2cf0723a35d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CU3Gate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CU3Gate.mdx @@ -83,6 +83,14 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **phi** (*ParameterValueType*) – + * **lam** (*ParameterValueType*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – + ### base\_class diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CUGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CUGate.mdx index 9b8e9b53221..dffaa4abd33 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CUGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CUGate.mdx @@ -73,6 +73,15 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **phi** (*ParameterValueType*) – + * **lam** (*ParameterValueType*) – + * **gamma** (*ParameterValueType*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – + ### base\_class diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.DiagonalGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.DiagonalGate.mdx index 99e8f354d1e..de50fb8ecd5 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.DiagonalGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.DiagonalGate.mdx @@ -162,6 +162,10 @@ $$ Return the inverse of the diagonal gate. + + **Parameters** + + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – ### validate\_parameter diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.DraperQFTAdder.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.DraperQFTAdder.mdx index 741064d0cae..47ea7778062 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.DraperQFTAdder.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.DraperQFTAdder.mdx @@ -118,7 +118,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.EfficientSU2.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.EfficientSU2.mdx index 80dae2f0c59..ba0b51194ba 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.EfficientSU2.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.EfficientSU2.mdx @@ -82,6 +82,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The parameterized gates require a parameter to be defined, for which we use [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector"). * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, barriers are inserted in between each layer. If False, no barriers are inserted. * **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – Set this to `True` to output a flat circuit instead of nesting it inside multiple layers of gate objects. By default currently the contents of the output circuit will be wrapped in nested objects for cleaner visualization. However, if you’re using this circuit for anything besides visualization its **strongly** recommended to set this flag to `True` to avoid a large performance overhead for parameter binding. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – ## Attributes @@ -187,7 +188,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx index aa601c1e912..ccc599d1e76 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx @@ -142,7 +142,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ExactReciprocal.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.ExactReciprocal.mdx index ffb3f53149a..d4e5d637c12 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ExactReciprocal.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ExactReciprocal.mdx @@ -86,7 +86,7 @@ $$ ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ExcitationPreserving.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.ExcitationPreserving.mdx index c8ba656ee96..cf67a9d011e 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ExcitationPreserving.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ExcitationPreserving.mdx @@ -96,6 +96,7 @@ $$ * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The parameterized gates require a parameter to be defined, for which we use [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector"). * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, barriers are inserted in between each layer. If False, no barriers are inserted. * **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – Set this to `True` to output a flat circuit instead of nesting it inside multiple layers of gate objects. By default currently the contents of the output circuit will be wrapped in nested objects for cleaner visualization. However, if you’re using this circuit for anything besides visualization its **strongly** recommended to set this flag to `True` to avoid a large performance overhead for parameter binding. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – **Raises** @@ -205,7 +206,7 @@ $$ ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.FourierChecking.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.FourierChecking.mdx index f24fb29bc53..b29196b6e17 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.FourierChecking.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.FourierChecking.mdx @@ -104,7 +104,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.FullAdderGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.FullAdderGate.mdx index ff1a360228d..5961dedf4e3 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.FullAdderGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.FullAdderGate.mdx @@ -36,6 +36,7 @@ $$ * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits in each of the registers. * **name** – The name of the circuit. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – ## Attributes diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.FunctionalPauliRotations.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.FunctionalPauliRotations.mdx index 2a0b9c268d1..f07899b29f8 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.FunctionalPauliRotations.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.FunctionalPauliRotations.mdx @@ -91,7 +91,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GMS.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.GMS.mdx index db8f50ad804..9fb57b51378 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GMS.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GMS.mdx @@ -113,7 +113,7 @@ $$ ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GR.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.GR.mdx index 09d22444c21..53bd260444f 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GR.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GR.mdx @@ -103,7 +103,7 @@ $$ ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GRX.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.GRX.mdx index 81e514168ef..2bfcbeadedd 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GRX.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GRX.mdx @@ -102,7 +102,7 @@ $$ ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GRY.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.GRY.mdx index 9deb7727a25..a0b36635995 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GRY.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GRY.mdx @@ -102,7 +102,7 @@ $$ ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GRZ.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.GRZ.mdx index d143904598e..8fb0e0816ce 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GRZ.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GRZ.mdx @@ -102,7 +102,7 @@ $$ ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GraphState.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.GraphState.mdx index a86213ba29d..4c6cc8b36ad 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GraphState.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GraphState.mdx @@ -111,7 +111,7 @@ $$ ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GroverOperator.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.GroverOperator.mdx index b56b82925ed..a02e33d144f 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GroverOperator.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GroverOperator.mdx @@ -226,7 +226,7 @@ $$ ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.HRSCumulativeMultiplier.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.HRSCumulativeMultiplier.mdx index 725d10715c0..2715870da04 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.HRSCumulativeMultiplier.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.HRSCumulativeMultiplier.mdx @@ -123,7 +123,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.HalfAdderGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.HalfAdderGate.mdx index 69a7f61057f..c72eb1e50bd 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.HalfAdderGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.HalfAdderGate.mdx @@ -35,6 +35,7 @@ $$ * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits in each of the registers. * **name** – The name of the circuit. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – ## Attributes diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.HamiltonianGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.HamiltonianGate.mdx index c1eee8fcc4a..70b7f914188 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.HamiltonianGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.HamiltonianGate.mdx @@ -156,6 +156,10 @@ python_api_name: qiskit.circuit.library.HamiltonianGate Return the adjoint of the unitary. + + **Parameters** + + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – ### transpose diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.HiddenLinearFunction.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.HiddenLinearFunction.mdx index 6346d3e7961..3918a60bee8 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.HiddenLinearFunction.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.HiddenLinearFunction.mdx @@ -113,7 +113,7 @@ $$ ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.InnerProduct.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.InnerProduct.mdx index 2a0b2649286..2c55e1c5407 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.InnerProduct.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.InnerProduct.mdx @@ -112,7 +112,7 @@ $$ ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.IntegerComparator.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.IntegerComparator.mdx index c1db9b0f23d..cf0bb273734 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.IntegerComparator.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.IntegerComparator.mdx @@ -98,7 +98,7 @@ $$ ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.LinearAmplitudeFunction.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.LinearAmplitudeFunction.mdx index 032fcf58d28..c3a87e37439 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.LinearAmplitudeFunction.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.LinearAmplitudeFunction.mdx @@ -123,7 +123,7 @@ $$ ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.LinearPauliRotations.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.LinearPauliRotations.mdx index de1ad651664..46244c03c57 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.LinearPauliRotations.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.LinearPauliRotations.mdx @@ -114,7 +114,7 @@ $$ ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCMT.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCMT.mdx index d092f294303..18743893c9b 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCMT.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCMT.mdx @@ -105,7 +105,7 @@ python_api_name: qiskit.circuit.library.MCMT ### instances - + ### layout @@ -311,6 +311,10 @@ python_api_name: qiskit.circuit.library.MCMT Return the inverse MCMT circuit, which is itself. + + **Parameters** + + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCMTGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCMTGate.mdx index c50cdeba333..3171fbf6465 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCMTGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCMTGate.mdx @@ -199,6 +199,10 @@ python_api_name: qiskit.circuit.library.MCMTGate Return the inverse MCMT circuit. + + **Parameters** + + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCMTVChain.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCMTVChain.mdx index 4d343cdad28..ab4ceacc9f7 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCMTVChain.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCMTVChain.mdx @@ -60,6 +60,12 @@ python_api_name: qiskit.circuit.library.MCMTVChain ## Attributes + **Parameters** + + * **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate") *| Callable\[\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*,* [*circuit.Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*,* [*circuit.Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*],* [*circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")*]*) – + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **num\_target\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + ### ancillas @@ -116,7 +122,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### instances - + ### layout @@ -316,6 +322,10 @@ python_api_name: qiskit.circuit.library.MCMTVChain Return the inverse MCMT circuit, which is itself. + + **Parameters** + + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCPhaseGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCPhaseGate.mdx index 5f7610b8eac..eb386c9be8d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCPhaseGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCPhaseGate.mdx @@ -38,6 +38,13 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ## Attributes + **Parameters** + + * **lam** (*ParameterValueType*) – + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – + ### base\_class @@ -212,6 +219,10 @@ python_api_name: qiskit.circuit.library.MCPhaseGate Return inverted MCPhase gate ($MCPhase(\lambda)^{\dagger} = MCPhase(-\lambda)$) + + **Parameters** + + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCXGate.mdx index 0da75028e01..7ea3c95add5 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCXGate.mdx @@ -19,6 +19,12 @@ python_api_name: qiskit.circuit.library.MCXGate ## Attributes + **Parameters** + + * **num\_ctrl\_qubits** (*Optional\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – + ### base\_class @@ -206,6 +212,11 @@ python_api_name: qiskit.circuit.library.MCXGate The method `qiskit.circuit.library.standard_gates.x.MCXGate.get_num_ancilla_qubits()` is pending deprecation as of qiskit 1.3. It will be marked deprecated in a future release, and then removed no earlier than 3 months after the release date. For an MCXGate it is no longer possible to know the number of ancilla qubits that would be eventually used by the transpiler when the gate is created. Instead, it is recommended to use MCXGate and let HighLevelSynthesis choose the best synthesis method depending on the number of ancilla qubits available. However, if a specific synthesis method using a specific number of ancilla qubits is require, one can create a custom gate by calling the corresponding synthesis function directly. + **Parameters** + + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + **Return type** [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCXGrayCode.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCXGrayCode.mdx index 0240342e3be..669a46be86f 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCXGrayCode.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCXGrayCode.mdx @@ -21,6 +21,12 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ## Attributes + **Parameters** + + * **num\_ctrl\_qubits** (*Optional\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – + ### base\_class diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCXRecursive.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCXRecursive.mdx index 517d8b93abc..3b7d5ae94fa 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCXRecursive.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCXRecursive.mdx @@ -28,6 +28,12 @@ python_api_name: qiskit.circuit.library.MCXRecursive ## Attributes + **Parameters** + + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – + ### base\_class @@ -187,6 +193,11 @@ python_api_name: qiskit.circuit.library.MCXRecursive Get the number of required ancilla qubits. + + **Parameters** + + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – ### inverse diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCXVChain.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCXVChain.mdx index 2d9b4bbfc98..50699136cd6 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCXVChain.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCXVChain.mdx @@ -22,6 +22,9 @@ python_api_name: qiskit.circuit.library.MCXVChain * **dirty\_ancillas** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, the method applies an optimized multicontrolled-X gate up to a relative phase using dirty ancillary qubits with the properties of lemmas 7 and 8 from arXiv:1501.06911, with at most 8\*k - 6 CNOT gates. For k within the range \{1, …, ceil(n/2)}. And for n representing the total number of qubits. * **relative\_phase** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, the method applies the optimized multicontrolled-X gate up to a relative phase, in a way that, by lemma 7 of arXiv:1501.06911, the relative phases of the `action part` cancel out with the phases of the `reset part`. * **action\_only** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, the method applies only the action part of lemma 8 from arXiv:1501.06911. + * **num\_ctrl\_qubits** (*Optional\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – ## Attributes @@ -184,6 +187,11 @@ python_api_name: qiskit.circuit.library.MCXVChain Get the number of required ancilla qubits. + + **Parameters** + + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – ### inverse diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ModularAdderGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.ModularAdderGate.mdx index d34dc69fa60..24559f63926 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ModularAdderGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ModularAdderGate.mdx @@ -35,6 +35,7 @@ $$ * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits in each of the registers. * **name** – The name of the circuit. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – ## Attributes diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MultiplierGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MultiplierGate.mdx index b4c12f8203b..62e13b584c0 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MultiplierGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MultiplierGate.mdx @@ -38,6 +38,7 @@ $$ * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits in each of the input registers. * **num\_result\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The number of result qubits to limit the output to. Default value is `2 * num_state_qubits` to represent any possible result from the multiplication of the two inputs. * **name** – The name of the circuit. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – **Raises** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.NLocal.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.NLocal.mdx index 8e5c95c1383..971cda19f00 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.NLocal.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.NLocal.mdx @@ -172,7 +172,7 @@ python_api_name: qiskit.circuit.library.NLocal ### instances - + ### layout @@ -497,6 +497,11 @@ python_api_name: qiskit.circuit.library.NLocal [**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.13)") – If the parameters are given as list and do not match the number of parameters. + **Parameters** + + * **parameters** (*Mapping\[*[*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*,* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*] | Sequence\[*[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]*) – + * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **Return type** [QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") | None diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.OR.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.OR.mdx index 00780beea57..5a74fe810fb 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.OR.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.OR.mdx @@ -93,7 +93,7 @@ python_api_name: qiskit.circuit.library.OR ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PauliEvolutionGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PauliEvolutionGate.mdx index ec435e842ba..89bc5fb5f56 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PauliEvolutionGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PauliEvolutionGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.PauliEvolutionGate # PauliEvolutionGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Time-evolution of an operator consisting of Paulis. @@ -50,7 +50,7 @@ $$ The above will print (note that the `-0.1` coefficient is not printed!): - ```python + ```text ┌──────────────────────────┐ q_0: ┤0 ├ │ exp(-it (ZZ + XI))(0.2) │ @@ -196,9 +196,13 @@ $$ ### validate\_parameter - + Gate parameters should be int, float, or ParameterExpression + **Parameters** + + **parameter** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + **Return type** [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") | [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PauliFeatureMap.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PauliFeatureMap.mdx index 2647e3581a5..17020b27fd0 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PauliFeatureMap.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PauliFeatureMap.mdx @@ -112,6 +112,7 @@ $$ * **data\_map\_func** (*Optional\[Callable\[\[np.ndarray],* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]]*) – A mapping function for data x which can be supplied to override the default mapping from `self_product()`. * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The prefix used if default parameters are generated. * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, barriers are inserted in between the evolution instructions and hadamard layers. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – ## Attributes @@ -237,7 +238,7 @@ $$ ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PauliGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PauliGate.mdx index beca7c5ba1e..383d85286e3 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PauliGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PauliGate.mdx @@ -147,6 +147,10 @@ python_api_name: qiskit.circuit.library.PauliGate Return inverted pauli gate (itself). + + **Parameters** + + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – ### validate\_parameter diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PauliTwoDesign.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PauliTwoDesign.mdx index 2249fa874f2..34d37b1b78f 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PauliTwoDesign.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PauliTwoDesign.mdx @@ -65,6 +65,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Specifies how often a block consisting of a rotation layer and entanglement layer is repeated. * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The seed for randomly choosing the axes of the Pauli rotations. * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True`, barriers are inserted in between each layer. If `False`, no barriers are inserted. Defaults to `False`. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – ## Attributes @@ -170,7 +171,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.Permutation.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.Permutation.mdx index 776feebb22a..1cb0d8452ac 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.Permutation.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.Permutation.mdx @@ -95,7 +95,7 @@ python_api_name: qiskit.circuit.library.Permutation ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PermutationGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PermutationGate.mdx index a9ed49bdd63..6975e169e7a 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PermutationGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PermutationGate.mdx @@ -157,6 +157,10 @@ python_api_name: qiskit.circuit.library.PermutationGate Returns the inverse of the permutation. + **Parameters** + + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **Return type** [*PermutationGate*](#qiskit.circuit.library.PermutationGate "qiskit.circuit.library.generalized_gates.permutation.PermutationGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseEstimation.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseEstimation.mdx index 34894138944..f157f51edf4 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseEstimation.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseEstimation.mdx @@ -112,7 +112,7 @@ $$ ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseGate.mdx index 570b94710d5..e484b84818a 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseGate.mdx @@ -63,6 +63,11 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + ### base\_class diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseOracle.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseOracle.mdx index a58128879fc..5459b2d5f3f 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseOracle.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseOracle.mdx @@ -85,7 +85,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseChebyshev.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseChebyshev.mdx index 5e23cc6a94f..0e2e4e92815 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseChebyshev.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseChebyshev.mdx @@ -140,7 +140,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx index d073aba44ae..0400ae666da 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx @@ -123,7 +123,7 @@ $$ ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx index 08d7a209f3a..5633321e768 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx @@ -181,7 +181,7 @@ $$ ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PolynomialPauliRotations.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PolynomialPauliRotations.mdx index b4ef5482655..6ac9826cc07 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PolynomialPauliRotations.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PolynomialPauliRotations.mdx @@ -141,7 +141,7 @@ $$ ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.QuantumVolume.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.QuantumVolume.mdx index 6bbaaf6b730..07ee73f4d65 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.QuantumVolume.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.QuantumVolume.mdx @@ -97,7 +97,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RGQFTMultiplier.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RGQFTMultiplier.mdx index 991b0a879bd..b912e583ab1 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RGQFTMultiplier.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RGQFTMultiplier.mdx @@ -102,7 +102,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RGate.mdx index e5298f55ef9..21e8755935e 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RGate.mdx @@ -39,6 +39,12 @@ $$ ## Attributes + **Parameters** + + * **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + * **phi** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + ### base\_class diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RVGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RVGate.mdx index b4074a30e11..341fed38213 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RVGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RVGate.mdx @@ -166,6 +166,10 @@ $$ Invert this gate. + + **Parameters** + + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – ### to\_matrix diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RXGate.mdx index 1a2fecadc03..19a8c2eef96 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RXGate.mdx @@ -39,6 +39,11 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + ### base\_class diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RXXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RXXGate.mdx index e303647ee39..ef4cc0eef14 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RXXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RXXGate.mdx @@ -65,6 +65,11 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + ### base\_class diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RYGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RYGate.mdx index 160e9492e8c..38304a0e996 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RYGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RYGate.mdx @@ -39,6 +39,11 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + ### base\_class diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RYYGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RYYGate.mdx index 31befe054c2..53e2c6abee3 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RYYGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RYYGate.mdx @@ -65,6 +65,11 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + ### base\_class diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RZGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RZGate.mdx index 8fe8db8310f..903dcd9361a 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RZGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RZGate.mdx @@ -49,6 +49,11 @@ $$ ## Attributes + **Parameters** + + * **phi** (*ParameterValueType*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + ### base\_class diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RZXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RZXGate.mdx index 952d264da64..f46fa478da2 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RZXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RZXGate.mdx @@ -105,6 +105,11 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + ### base\_class diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RZZGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RZZGate.mdx index 31d81601a2b..6ea0404a738 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RZZGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RZZGate.mdx @@ -77,6 +77,11 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + ### base\_class diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RealAmplitudes.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RealAmplitudes.mdx index 57261778daf..ad233ed74cc 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RealAmplitudes.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RealAmplitudes.mdx @@ -121,6 +121,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The parameterized gates require a parameter to be defined, for which we use [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector"). * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, barriers are inserted in between each layer. If False, no barriers are inserted. * **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – Set this to `True` to output a flat circuit instead of nesting it inside multiple layers of gate objects. By default currently the contents of the output circuit will be wrapped in nested objects for cleaner visualization. However, if you’re using this circuit for anything besides visualization its **strongly** recommended to set this flag to `True` to avoid a large performance overhead for parameter binding. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – ## Attributes @@ -226,7 +227,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.StatePreparation.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.StatePreparation.mdx index de576b8ab7b..a05d1478c6c 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.StatePreparation.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.StatePreparation.mdx @@ -210,6 +210,10 @@ python_api_name: qiskit.circuit.library.StatePreparation Return inverted StatePreparation + + **Parameters** + + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – ### validate\_parameter diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.TwoLocal.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.TwoLocal.mdx index e84fa2d10f1..678dde9087a 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.TwoLocal.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.TwoLocal.mdx @@ -128,6 +128,7 @@ python_api_name: qiskit.circuit.library.TwoLocal * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True`, barriers are inserted in between each layer. If `False`, no barriers are inserted. Defaults to `False`. * **initial\_state** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *| None*) – A [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object to prepend to the circuit. * **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – Set this to `True` to output a flat circuit instead of nesting it inside multiple layers of gate objects. By default currently the contents of the output circuit will be wrapped in nested objects for cleaner visualization. However, if you’re using this circuit for anything besides visualization its **strongly** recommended to set this flag to `True` to avoid a large performance overhead for parameter binding. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – ## Attributes @@ -233,7 +234,7 @@ python_api_name: qiskit.circuit.library.TwoLocal ### instances - + ### layout @@ -524,6 +525,12 @@ python_api_name: qiskit.circuit.library.TwoLocal Overloading to handle the special case of 1 qubit where the entanglement are ignored. + **Parameters** + + * **rep\_num** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **block\_num** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **num\_block\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + **Return type** [*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)")\[[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)")\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")]] diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.U1Gate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.U1Gate.mdx index 31f66b6b65c..91496f7f841 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.U1Gate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.U1Gate.mdx @@ -76,6 +76,11 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + ### base\_class diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.U2Gate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.U2Gate.mdx index 3a1cbe18017..4cc82aad1c5 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.U2Gate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.U2Gate.mdx @@ -75,6 +75,12 @@ $$ ## Attributes + **Parameters** + + * **phi** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + * **lam** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + ### base\_class diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.U3Gate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.U3Gate.mdx index 287494d3a5c..bc16616b4d7 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.U3Gate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.U3Gate.mdx @@ -70,6 +70,13 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **phi** (*ParameterValueType*) – + * **lam** (*ParameterValueType*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + ### base\_class diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UCGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.UCGate.mdx index 2a2a28a40bc..972529977e8 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UCGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UCGate.mdx @@ -172,6 +172,10 @@ $$ This does not re-compute the decomposition for the multiplexer with the inverse of the gates but simply inverts the existing decomposition. + **Parameters** + + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **Return type** [*Gate*](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.UGate.mdx index 9ffbce0044a..793ec3fa310 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UGate.mdx @@ -53,6 +53,13 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **phi** (*ParameterValueType*) – + * **lam** (*ParameterValueType*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + ### base\_class diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryGate.mdx index b58ac9f187a..faf3a41fb8c 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.UnitaryGate # UnitaryGate - + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") Class quantum gates specified by a unitary matrix. @@ -161,19 +161,19 @@ python_api_name: qiskit.circuit.library.UnitaryGate ### adjoint - + Return the adjoint of the unitary. ### conjugate - + Return the conjugate of the unitary. ### control - + Return controlled version of gate. **Parameters** @@ -194,19 +194,23 @@ python_api_name: qiskit.circuit.library.UnitaryGate ### inverse - + Return the adjoint of the unitary. + + **Parameters** + + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – ### transpose - + Return the transpose of the unitary. ### validate\_parameter - + Unitary gate parameter has to be an ndarray. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.VBERippleCarryAdder.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.VBERippleCarryAdder.mdx index b9ea8bcd8df..6049a1a5f4f 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.VBERippleCarryAdder.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.VBERippleCarryAdder.mdx @@ -123,7 +123,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.WeightedAdder.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.WeightedAdder.mdx index 96cbe137188..cbd84cbaeee 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.WeightedAdder.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.WeightedAdder.mdx @@ -120,7 +120,7 @@ $$ ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.XOR.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.XOR.mdx index e1f57b69c33..eb27a25aa78 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.XOR.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.XOR.mdx @@ -95,7 +95,7 @@ python_api_name: qiskit.circuit.library.XOR ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ZFeatureMap.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.ZFeatureMap.mdx index a38fbe46e88..4f2405bee86 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ZFeatureMap.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ZFeatureMap.mdx @@ -81,6 +81,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap * **data\_map\_func** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.13)")*\[\[*[*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)")*],* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*] | None*) – A mapping function for data x which can be supplied to override the default mapping from `self_product()`. * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The prefix used if default parameters are generated. * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, barriers are inserted in between the evolution instructions and hadamard layers. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – ## Attributes @@ -206,7 +207,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ZZFeatureMap.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.ZZFeatureMap.mdx index 1254e892cd1..5a6b2b79640 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ZZFeatureMap.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ZZFeatureMap.mdx @@ -98,6 +98,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap * **data\_map\_func** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.13)")*\[\[*[*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)")*],* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*] | None*) – A mapping function for data x. * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The prefix used if default parameters are generated. * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, barriers are inserted in between the evolution instructions and hadamard layers. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – **Raises** @@ -227,7 +228,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### instances - + ### layout diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.fourier_checking.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.fourier_checking.mdx index 0bce8f163d8..475e0a72dad 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.fourier_checking.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.fourier_checking.mdx @@ -39,6 +39,11 @@ python_api_name: qiskit.circuit.library.fourier_checking \[2] S. Aaronson, A. Ambainis, Forrelation: a problem that optimally separates quantum from classical computing, 2014. [arXiv:1411.5729](https://arxiv.org/abs/1411.5729) + **Parameters** + + * **f** ([*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – + * **g** ([*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – + **Return type** [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.pauli_feature_map.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.pauli_feature_map.mdx index ae4ef6b8197..b5980f4f2bf 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.pauli_feature_map.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.pauli_feature_map.mdx @@ -98,6 +98,18 @@ $$ \[1] Havlicek et al. Supervised learning with quantum enhanced feature spaces, [Nature 567, 209-212 (2019)](https://www.nature.com/articles/s41586-019-0980-2). + **Parameters** + + * **feature\_dimension** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| Mapping\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, Sequence\[Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*],* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| Mapping\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, Sequence\[Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]]]*) – + * **alpha** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + * **paulis** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*] | None*) – + * **data\_map\_func** (*Callable\[\[*[*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*],* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*] | None*) – + * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + **Return type** [QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.quantum_volume.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.quantum_volume.mdx index d363576b3f6..8e6f5793cc8 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.quantum_volume.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.quantum_volume.mdx @@ -29,6 +29,12 @@ python_api_name: qiskit.circuit.library.quantum_volume \[1] A. Cross et al. Validating quantum computers using randomized model circuits, Phys. Rev. A 100, 032328 (2019). [arXiv:1811.12926](https://arxiv.org/abs/1811.12926) + **Parameters** + + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **depth** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| np.random.Generator | None*) – + **Return type** [QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.z_feature_map.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.z_feature_map.mdx index d31f24de6d2..74ffa441e49 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.z_feature_map.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.z_feature_map.mdx @@ -70,6 +70,17 @@ python_api_name: qiskit.circuit.library.z_feature_map └───┘└─────────────┘└──────────┘ └──────────┘ ``` + **Parameters** + + * **feature\_dimension** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| Sequence\[Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*],* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| Sequence\[Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]]*) – + * **alpha** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + * **data\_map\_func** (*Callable\[\[*[*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*],* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*] | None*) – + * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + **Return type** [QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.zz_feature_map.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.zz_feature_map.mdx index 93240a920e8..9c13770d4cc 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.zz_feature_map.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.zz_feature_map.mdx @@ -66,6 +66,17 @@ python_api_name: qiskit.circuit.library.zz_feature_map ]) ``` + **Parameters** + + * **feature\_dimension** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| Sequence\[Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*],* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| Sequence\[Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]]*) – + * **alpha** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + * **data\_map\_func** (*Callable\[\[*[*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*],* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*] | None*) – + * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + **Return type** [QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") diff --git a/docs/api/qiskit/dev/qiskit.dagcircuit.DAGDepNode.mdx b/docs/api/qiskit/dev/qiskit.dagcircuit.DAGDepNode.mdx index a4073cd373a..3421e36ca7b 100644 --- a/docs/api/qiskit/dev/qiskit.dagcircuit.DAGDepNode.mdx +++ b/docs/api/qiskit/dev/qiskit.dagcircuit.DAGDepNode.mdx @@ -17,6 +17,17 @@ python_api_name: qiskit.dagcircuit.DAGDepNode ## Attributes + **Parameters** + + * **successors** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – + * **predecessors** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – + * **matchedwith** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – + * **successorstovisit** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – + * **isblocked** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – + * **qindices** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – + * **cindices** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – + * **nid** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + ### type diff --git a/docs/api/qiskit/dev/qiskit.passmanager.BasePassManager.mdx b/docs/api/qiskit/dev/qiskit.passmanager.BasePassManager.mdx index 40c688a7f8c..b1a57b7018c 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.BasePassManager.mdx +++ b/docs/api/qiskit/dev/qiskit.passmanager.BasePassManager.mdx @@ -34,6 +34,10 @@ python_api_name: qiskit.passmanager.BasePassManager **Raises** [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.13)") – When any element of tasks is not a subclass of passmanager Task. + + **Return type** + + None ### remove @@ -48,6 +52,10 @@ python_api_name: qiskit.passmanager.BasePassManager **Raises** [**PassManagerError**](passmanager#qiskit.passmanager.PassManagerError "qiskit.passmanager.PassManagerError") – If the index is not found. + + **Return type** + + None ### replace @@ -64,6 +72,10 @@ python_api_name: qiskit.passmanager.BasePassManager * [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.13)") – When any element of tasks is not a subclass of passmanager Task. * [**PassManagerError**](passmanager#qiskit.passmanager.PassManagerError "qiskit.passmanager.PassManagerError") – If the index is not found. + + **Return type** + + None ### run diff --git a/docs/api/qiskit/dev/qiskit.passmanager.ConditionalController.mdx b/docs/api/qiskit/dev/qiskit.passmanager.ConditionalController.mdx index 59f7aefa351..9c6e2e13068 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.ConditionalController.mdx +++ b/docs/api/qiskit/dev/qiskit.passmanager.ConditionalController.mdx @@ -17,7 +17,9 @@ python_api_name: qiskit.passmanager.ConditionalController **Parameters** - **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, Any] | None*) – Option for this flow controller. + * **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, Any] | None*) – Option for this flow controller. + * **tasks** (*Task | Iterable\[Task]*) – + * **condition** (*Callable\[\[*[*PropertySet*](qiskit.passmanager.PropertySet "qiskit.passmanager.PropertySet")*],* [*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*]*) – ## Attributes diff --git a/docs/api/qiskit/dev/qiskit.passmanager.DoWhileController.mdx b/docs/api/qiskit/dev/qiskit.passmanager.DoWhileController.mdx index b348ad45121..f87e22f2793 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.DoWhileController.mdx +++ b/docs/api/qiskit/dev/qiskit.passmanager.DoWhileController.mdx @@ -19,7 +19,9 @@ python_api_name: qiskit.passmanager.DoWhileController **Parameters** - **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, Any] | None*) – Option for this flow controller. + * **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, Any] | None*) – Option for this flow controller. + * **tasks** (*Task | Iterable\[Task]*) – + * **do\_while** (*Callable\[\[*[*PropertySet*](qiskit.passmanager.PropertySet "qiskit.passmanager.PropertySet")*],* [*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*]*) – ## Attributes diff --git a/docs/api/qiskit/dev/qiskit.passmanager.FlowControllerLinear.mdx b/docs/api/qiskit/dev/qiskit.passmanager.FlowControllerLinear.mdx index 2f055de610d..b9209dec117 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.FlowControllerLinear.mdx +++ b/docs/api/qiskit/dev/qiskit.passmanager.FlowControllerLinear.mdx @@ -17,7 +17,8 @@ python_api_name: qiskit.passmanager.FlowControllerLinear **Parameters** - **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, Any] | None*) – Option for this flow controller. + * **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, Any] | None*) – Option for this flow controller. + * **tasks** (*Task | Iterable\[Task]*) – ## Attributes diff --git a/docs/api/qiskit/dev/qiskit.passmanager.PassManagerState.mdx b/docs/api/qiskit/dev/qiskit.passmanager.PassManagerState.mdx index dd1038991fb..60732cabc1b 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.PassManagerState.mdx +++ b/docs/api/qiskit/dev/qiskit.passmanager.PassManagerState.mdx @@ -19,6 +19,11 @@ python_api_name: qiskit.passmanager.PassManagerState ## Attributes + **Parameters** + + * **workflow\_status** ([*WorkflowStatus*](qiskit.passmanager.WorkflowStatus "qiskit.passmanager.compilation_status.WorkflowStatus")) – + * **property\_set** ([*PropertySet*](qiskit.passmanager.PropertySet "qiskit.passmanager.compilation_status.PropertySet")) – + ### workflow\_status diff --git a/docs/api/qiskit/dev/qiskit.passmanager.WorkflowStatus.mdx b/docs/api/qiskit/dev/qiskit.passmanager.WorkflowStatus.mdx index ecbbcea68d3..c6d3c6e3029 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.WorkflowStatus.mdx +++ b/docs/api/qiskit/dev/qiskit.passmanager.WorkflowStatus.mdx @@ -17,6 +17,12 @@ python_api_name: qiskit.passmanager.WorkflowStatus ## Attributes + **Parameters** + + * **count** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **completed\_passes** ([*set*](https://docs.python.org/3/library/stdtypes.html#set "(in Python v3.13)")) – + * **previous\_run** (*RunState*) – + ### count diff --git a/docs/api/qiskit/dev/qiskit.primitives.BackendEstimator.mdx b/docs/api/qiskit/dev/qiskit.primitives.BackendEstimator.mdx index ecfe655e181..b84cdeefaf6 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.BackendEstimator.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.BackendEstimator.mdx @@ -73,7 +73,7 @@ python_api_name: qiskit.primitives.BackendEstimator ### run - + Run the job of the estimation of expectation value(s). `circuits`, `observables`, and `parameter_values` should have the same length. The i-th element of the result is the expectation of observable diff --git a/docs/api/qiskit/dev/qiskit.primitives.BackendSampler.mdx b/docs/api/qiskit/dev/qiskit.primitives.BackendSampler.mdx index 0aaca313fb4..ab6f5fa9fcb 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.BackendSampler.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.BackendSampler.mdx @@ -80,7 +80,7 @@ python_api_name: qiskit.primitives.BackendSampler ### run - + Run the job of the sampling of bitstrings. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.primitives.BaseEstimator.mdx b/docs/api/qiskit/dev/qiskit.primitives.BaseEstimator.mdx index ac31b3fa12b..cc820dc984e 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.BaseEstimator.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.BaseEstimator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseEstimator # BaseEstimator - + Bases: [`BaseEstimatorV1`](qiskit.primitives.BaseEstimatorV1 "qiskit.primitives.base.base_estimator.BaseEstimatorV1")\[`T`] DEPRECATED. Type alias for Estimator V1 base class. @@ -41,7 +41,7 @@ python_api_name: qiskit.primitives.BaseEstimator ### run - + Run the job of the estimation of expectation value(s). `circuits`, `observables`, and `parameter_values` should have the same length. The i-th element of the result is the expectation of observable diff --git a/docs/api/qiskit/dev/qiskit.primitives.BaseEstimatorV1.mdx b/docs/api/qiskit/dev/qiskit.primitives.BaseEstimatorV1.mdx index 12b724f26bb..6999bc13ff6 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.BaseEstimatorV1.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.BaseEstimatorV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseEstimatorV1 # BaseEstimatorV1 - + Bases: `BasePrimitive`, [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.13)")\[`T`] Estimator V1 base class. @@ -82,7 +82,7 @@ $$ ### run - + Run the job of the estimation of expectation value(s). `circuits`, `observables`, and `parameter_values` should have the same length. The i-th element of the result is the expectation of observable diff --git a/docs/api/qiskit/dev/qiskit.primitives.BaseEstimatorV2.mdx b/docs/api/qiskit/dev/qiskit.primitives.BaseEstimatorV2.mdx index d5252edabed..acab5c2042f 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.BaseEstimatorV2.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.BaseEstimatorV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseEstimatorV2 # BaseEstimatorV2 - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)") Estimator V2 base class. @@ -21,7 +21,7 @@ python_api_name: qiskit.primitives.BaseEstimatorV2 ### run - + Estimate expectation values for each provided pub (Primitive Unified Bloc). **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.primitives.BaseSampler.mdx b/docs/api/qiskit/dev/qiskit.primitives.BaseSampler.mdx index 63f4c6ea939..d625c6f93f2 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.BaseSampler.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.BaseSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseSampler # BaseSampler - + Bases: [`BaseSamplerV1`](qiskit.primitives.BaseSamplerV1 "qiskit.primitives.base.base_sampler.BaseSamplerV1")\[`T`] DEPRECATED. Type alias for Sampler V1 base class @@ -39,7 +39,7 @@ python_api_name: qiskit.primitives.BaseSampler ### run - + Run the job of the sampling of bitstrings. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.primitives.BaseSamplerV1.mdx b/docs/api/qiskit/dev/qiskit.primitives.BaseSamplerV1.mdx index 3a088eacf3f..8765e519abd 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.BaseSamplerV1.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.BaseSamplerV1.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseSamplerV1 # BaseSamplerV1 - + Bases: `BasePrimitive`, [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.13)")\[`T`] Sampler V1 base class @@ -81,7 +81,7 @@ python_api_name: qiskit.primitives.BaseSamplerV1 ### run - + Run the job of the sampling of bitstrings. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.primitives.BaseSamplerV2.mdx b/docs/api/qiskit/dev/qiskit.primitives.BaseSamplerV2.mdx index 4825f848031..005b337a43d 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.BaseSamplerV2.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.BaseSamplerV2.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.BaseSamplerV2 # BaseSamplerV2 - + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)") Sampler V2 base class. @@ -21,7 +21,7 @@ python_api_name: qiskit.primitives.BaseSamplerV2 ### run - + Run and collect samples from each pub. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.primitives.DataBin.mdx b/docs/api/qiskit/dev/qiskit.primitives.DataBin.mdx index 63cd2f91cfa..e1268182356 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.DataBin.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.DataBin.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.DataBin # DataBin - + Bases: `ShapedMixin` Namespace for storing data. @@ -59,7 +59,7 @@ python_api_name: qiskit.primitives.DataBin ### items - + Return a view of field names and values **Return type** @@ -69,7 +69,7 @@ python_api_name: qiskit.primitives.DataBin ### keys - + Return a view of field names. **Return type** @@ -79,7 +79,7 @@ python_api_name: qiskit.primitives.DataBin ### values - + Return a view of values. **Return type** diff --git a/docs/api/qiskit/dev/qiskit.primitives.Estimator.mdx b/docs/api/qiskit/dev/qiskit.primitives.Estimator.mdx index f5e0623e0c5..c31f8d781ce 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.Estimator.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.Estimator.mdx @@ -18,6 +18,10 @@ python_api_name: qiskit.primitives.Estimator * **shots** (None or int) – The number of shots. If None, it calculates the expectation values with full state vector simulation. Otherwise, it samples from normal distributions with standard errors as standard deviations using normal distribution approximation. * **seed** (np.random.Generator or int) – Set a fixed seed or generator for the normal distribution. If shots is None, this option is ignored. + **Parameters** + + **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") *| None*) – + The result of this class is exact if the circuit contains only unitary operations. On the other hand, the result could be stochastic if the circuit contains a non-unitary operation such as a reset for a some subsystems. The stochastic result can be made reproducible by setting `seed`, e.g., `Estimator(options={"seed":123})`. @@ -50,7 +54,7 @@ python_api_name: qiskit.primitives.Estimator ### run - + Run the job of the estimation of expectation value(s). `circuits`, `observables`, and `parameter_values` should have the same length. The i-th element of the result is the expectation of observable diff --git a/docs/api/qiskit/dev/qiskit.primitives.Sampler.mdx b/docs/api/qiskit/dev/qiskit.primitives.Sampler.mdx index 75aff7f2d6f..637267cacc7 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.Sampler.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.Sampler.mdx @@ -20,6 +20,10 @@ python_api_name: qiskit.primitives.Sampler * **shots** (None or int) – The number of shots. If None, it calculates the probabilities. Otherwise, it samples from multinomial distributions. * **seed** (np.random.Generator or int) – Set a fixed seed or generator for the multinomial distribution. If shots is None, this option is ignored. + **Parameters** + + **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") *| None*) – + The class `qiskit.primitives.sampler.Sampler` is deprecated as of qiskit 1.2. It will be removed no earlier than 3 months after the release date. All implementations of the BaseSamplerV1 interface have been deprecated in favor of their V2 counterparts. The V2 alternative for the Sampler class is StatevectorSampler. @@ -48,7 +52,7 @@ python_api_name: qiskit.primitives.Sampler ### run - + Run the job of the sampling of bitstrings. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.primitives.StatevectorSampler.mdx b/docs/api/qiskit/dev/qiskit.primitives.StatevectorSampler.mdx index b2103cb37c7..ed09672fdee 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.StatevectorSampler.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.StatevectorSampler.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.primitives.StatevectorSampler # StatevectorSampler - + Bases: [`BaseSamplerV2`](qiskit.primitives.BaseSamplerV2 "qiskit.primitives.base.base_sampler.BaseSamplerV2") Simple implementation of [`BaseSamplerV2`](qiskit.primitives.BaseSamplerV2 "qiskit.primitives.BaseSamplerV2") using full state vector simulation. @@ -108,7 +108,7 @@ python_api_name: qiskit.primitives.StatevectorSampler ### run - + Run and collect samples from each pub. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.providers.BackendV2.mdx b/docs/api/qiskit/dev/qiskit.providers.BackendV2.mdx index 007d8a9957f..674a382eea4 100644 --- a/docs/api/qiskit/dev/qiskit.providers.BackendV2.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.BackendV2.mdx @@ -238,6 +238,10 @@ python_api_name: qiskit.providers.BackendV2 **Raises** [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – if the backend doesn’t support querying the measurement mapping + + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – ### control\_channel @@ -292,6 +296,10 @@ python_api_name: qiskit.providers.BackendV2 **Raises** [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – if the backend doesn’t support querying the measurement mapping + + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – ### measure\_channel @@ -316,6 +324,10 @@ python_api_name: qiskit.providers.BackendV2 **Raises** [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – if the backend doesn’t support querying the measurement mapping + + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – ### qubit\_properties diff --git a/docs/api/qiskit/dev/qiskit.providers.BackendV2Converter.mdx b/docs/api/qiskit/dev/qiskit.providers.BackendV2Converter.mdx index dabf2882f16..034f4aa88b3 100644 --- a/docs/api/qiskit/dev/qiskit.providers.BackendV2Converter.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.BackendV2Converter.mdx @@ -175,6 +175,10 @@ python_api_name: qiskit.providers.BackendV2Converter The method `qiskit.providers.backend_compat.BackendV2Converter.acquire_channel()` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend_compat.BackendV2Converter.acquire_channel()` will have no alternative in Qiskit. + + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – ### control\_channel @@ -183,6 +187,10 @@ python_api_name: qiskit.providers.BackendV2Converter The method `qiskit.providers.backend_compat.BackendV2Converter.control_channel()` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend_compat.BackendV2Converter.control_channel()` will have no alternative in Qiskit. + + **Parameters** + + **qubits** ([*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – ### drive\_channel @@ -191,6 +199,10 @@ python_api_name: qiskit.providers.BackendV2Converter The method `qiskit.providers.backend_compat.BackendV2Converter.drive_channel()` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend_compat.BackendV2Converter.drive_channel()` will have no alternative in Qiskit. + + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – ### measure\_channel @@ -199,6 +211,10 @@ python_api_name: qiskit.providers.BackendV2Converter The method `qiskit.providers.backend_compat.BackendV2Converter.measure_channel()` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend_compat.BackendV2Converter.measure_channel()` will have no alternative in Qiskit. + + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – ### qubit\_properties diff --git a/docs/api/qiskit/dev/qiskit.providers.JobV1.mdx b/docs/api/qiskit/dev/qiskit.providers.JobV1.mdx index 598f147a020..4cf16748dc5 100644 --- a/docs/api/qiskit/dev/qiskit.providers.JobV1.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.JobV1.mdx @@ -147,6 +147,10 @@ python_api_name: qiskit.providers.JobV1 **Raises** [**JobTimeoutError**](providers#qiskit.providers.JobTimeoutError "qiskit.providers.JobTimeoutError") – If the job does not reach a final state before the specified timeout. + + **Return type** + + None diff --git a/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProvider.mdx b/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProvider.mdx index bccf01604dc..c8c2e7fc493 100644 --- a/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProvider.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProvider.mdx @@ -34,6 +34,7 @@ python_api_name: qiskit.providers.basic_provider.BasicProvider * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name of the backend. * **\*\*kwargs** – dict used for filtering. + * **filters** (*Callable | None*) – **Returns** diff --git a/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProviderError.mdx b/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProviderError.mdx index 5619f3d4118..de047e74cf8 100644 --- a/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProviderError.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProviderError.mdx @@ -11,6 +11,8 @@ python_api_name: qiskit.providers.basic_provider.BasicProviderError # qiskit.providers.basic\_provider.BasicProviderError + Bases: [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + Base class for errors raised by the Basic Provider. Set the error message. diff --git a/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProviderJob.mdx b/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProviderJob.mdx index 81337d57d24..d6e3202c9fa 100644 --- a/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProviderJob.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProviderJob.mdx @@ -153,6 +153,10 @@ python_api_name: qiskit.providers.basic_provider.BasicProviderJob **Raises** [**JobTimeoutError**](providers#qiskit.providers.JobTimeoutError "qiskit.providers.JobTimeoutError") – If the job does not reach a final state before the specified timeout. + + **Return type** + + None diff --git a/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicSimulator.mdx b/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicSimulator.mdx index da55b41b5b8..341c615e33e 100644 --- a/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicSimulator.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicSimulator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.basic_provider.BasicSimulator # BasicSimulator - + Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") Python implementation of a basic (non-efficient) quantum simulator. @@ -199,11 +199,15 @@ python_api_name: qiskit.providers.basic_provider.BasicSimulator **Raises** [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – if the backend doesn’t support querying the measurement mapping + + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – ### configuration - + Return the simulator backend configuration. @@ -271,6 +275,10 @@ python_api_name: qiskit.providers.basic_provider.BasicSimulator **Raises** [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – if the backend doesn’t support querying the measurement mapping + + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – ### measure\_channel @@ -295,6 +303,10 @@ python_api_name: qiskit.providers.basic_provider.BasicSimulator **Raises** [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – if the backend doesn’t support querying the measurement mapping + + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – ### qubit\_properties @@ -323,7 +335,7 @@ python_api_name: qiskit.providers.basic_provider.BasicSimulator ### run - + Run on the backend. **Parameters** @@ -358,7 +370,7 @@ python_api_name: qiskit.providers.basic_provider.BasicSimulator ### run\_experiment - + Run an experiment (circuit) and return a single experiment result. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.providers.fake_provider.GenericBackendV2.mdx b/docs/api/qiskit/dev/qiskit.providers.fake_provider.GenericBackendV2.mdx index 1241f54c3f6..ce52e5f8aed 100644 --- a/docs/api/qiskit/dev/qiskit.providers.fake_provider.GenericBackendV2.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.fake_provider.GenericBackendV2.mdx @@ -200,6 +200,10 @@ python_api_name: qiskit.providers.fake_provider.GenericBackendV2 The method `qiskit.providers.fake_provider.generic_backend_v2.GenericBackendV2.acquire_channel()` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.fake_provider.generic_backend_v2.GenericBackendV2.acquire_channel()` will have no alternative in Qiskit. + + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – ### control\_channel @@ -208,6 +212,10 @@ python_api_name: qiskit.providers.fake_provider.GenericBackendV2 The method `qiskit.providers.fake_provider.generic_backend_v2.GenericBackendV2.control_channel()` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.fake_provider.generic_backend_v2.GenericBackendV2.control_channel()` will have no alternative in Qiskit. + + **Parameters** + + **qubits** ([*Iterable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Iterable "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – ### drive\_channel @@ -216,6 +224,10 @@ python_api_name: qiskit.providers.fake_provider.GenericBackendV2 The method `qiskit.providers.fake_provider.generic_backend_v2.GenericBackendV2.drive_channel()` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.fake_provider.generic_backend_v2.GenericBackendV2.drive_channel()` will have no alternative in Qiskit. + + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – ### measure\_channel @@ -224,6 +236,10 @@ python_api_name: qiskit.providers.fake_provider.GenericBackendV2 The method `qiskit.providers.fake_provider.generic_backend_v2.GenericBackendV2.measure_channel()` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.fake_provider.generic_backend_v2.GenericBackendV2.measure_channel()` will have no alternative in Qiskit. + + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – ### qubit\_properties diff --git a/docs/api/qiskit/dev/qiskit.providers.models.PulseBackendConfiguration.mdx b/docs/api/qiskit/dev/qiskit.providers.models.PulseBackendConfiguration.mdx index a2dc45ecb82..2fdbb86e00e 100644 --- a/docs/api/qiskit/dev/qiskit.providers.models.PulseBackendConfiguration.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.models.PulseBackendConfiguration.mdx @@ -98,6 +98,10 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration Qubit measurement acquisition line. + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + **Return type** [*AcquireChannel*](qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") @@ -174,6 +178,10 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration Qubit drive channel. + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + **Return type** [*DriveChannel*](qiskit.pulse.channels.DriveChannel "qiskit.pulse.channels.DriveChannel") @@ -210,6 +218,10 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration List of qubits operated on my the given `channel`. + **Parameters** + + **channel** ([*Channel*](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – + **Return type** [*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")] @@ -228,6 +240,10 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration List of `Channel`s operated on my the given `qubit`. + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – + **Return type** [*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")\[[*Channel*](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] @@ -246,6 +262,10 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration Qubit measurement stimulus line. + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + **Return type** [*MeasureChannel*](qiskit.pulse.channels.MeasureChannel "qiskit.pulse.channels.MeasureChannel") diff --git a/docs/api/qiskit/dev/qiskit.providers.models.PulseDefaults.mdx b/docs/api/qiskit/dev/qiskit.providers.models.PulseDefaults.mdx index 1f15ef6bca9..f019450892c 100644 --- a/docs/api/qiskit/dev/qiskit.providers.models.PulseDefaults.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.models.PulseDefaults.mdx @@ -21,6 +21,17 @@ python_api_name: qiskit.providers.models.PulseDefaults ## Attributes + **Parameters** + + * **qubit\_freq\_est** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]*) – + * **meas\_freq\_est** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]*) – + * **buffer** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **pulse\_library** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*PulseLibraryItem*](qiskit.qobj.PulseLibraryItem "qiskit.qobj.pulse_qobj.PulseLibraryItem")*]*) – + * **cmd\_def** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*Command*](qiskit.providers.models.Command "qiskit.providers.models.pulsedefaults.Command")*]*) – + * **meas\_kernel** (*MeasurementKernel*) – + * **discriminator** (*Discriminator*) – + * **kwargs** ([*Dict*](https://docs.python.org/3/library/typing.html#typing.Dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")*]*) – + ### qubit\_freq\_est diff --git a/docs/api/qiskit/dev/qiskit.pulse.InstructionScheduleMap.mdx b/docs/api/qiskit/dev/qiskit.pulse.InstructionScheduleMap.mdx index beb2106a0e5..d5ff2850e3c 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.InstructionScheduleMap.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.InstructionScheduleMap.mdx @@ -58,6 +58,10 @@ python_api_name: qiskit.pulse.InstructionScheduleMap **Raises** [**PulseError**](pulse#qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If the qubits are provided as an empty iterable. + + **Return type** + + None ### assert\_has @@ -73,6 +77,10 @@ python_api_name: qiskit.pulse.InstructionScheduleMap **Raises** [**PulseError**](pulse#qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If the instruction is not defined on the qubits. + + **Return type** + + None ### get @@ -218,6 +226,10 @@ python_api_name: qiskit.pulse.InstructionScheduleMap * **instruction** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction")) – The name of the instruction to add. * **qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| Iterable\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubits which the instruction applies to. + + **Return type** + + None diff --git a/docs/api/qiskit/dev/qiskit.pulse.Schedule.mdx b/docs/api/qiskit/dev/qiskit.pulse.Schedule.mdx index b64c0b1497e..4136f1480ab 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.Schedule.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.Schedule.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.Schedule # Schedule - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. @@ -99,7 +99,7 @@ python_api_name: qiskit.pulse.Schedule ### instances\_counter - + ### instructions @@ -153,7 +153,7 @@ python_api_name: qiskit.pulse.Schedule ### append - + Return a new schedule with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. $$ @@ -174,7 +174,7 @@ $$ ### assign\_parameters - + Assign the parameters in this schedule according to the input. **Parameters** @@ -195,7 +195,7 @@ $$ ### ch\_duration - + Return the time of the end of the last instruction over the supplied channels. **Parameters** @@ -209,7 +209,7 @@ $$ ### ch\_start\_time - + Return the time of the start of the first instruction over the supplied channels. **Parameters** @@ -223,7 +223,7 @@ $$ ### ch\_stop\_time - + Return maximum start time over supplied channels. **Parameters** @@ -237,7 +237,7 @@ $$ ### draw - + Plot the schedule. **Parameters** @@ -283,7 +283,7 @@ $$ ### exclude - + Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of [`filter()`](#qiskit.pulse.Schedule.filter "qiskit.pulse.Schedule.filter"), so that: ```python @@ -306,7 +306,7 @@ $$ ### filter - + Return a new `Schedule` with only the instructions from this `Schedule` which pass though the provided filters; i.e. an instruction will be retained iff every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, the instruction type is contained in `instruction_types`, and the period over which the instruction operates is *fully* contained in one specified in `time_ranges` or `intervals`. If no arguments are provided, `self` is returned. @@ -327,7 +327,7 @@ $$ ### get\_parameters - + Get parameter object bound to this schedule by string name. Because different `Parameter` objects can have the same name, this method returns a list of `Parameter` s for the provided name. @@ -347,7 +347,7 @@ $$ ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** @@ -370,7 +370,7 @@ $$ ### insert - + Return a new schedule with `schedule` inserted into `self` at `start_time`. **Parameters** @@ -387,7 +387,7 @@ $$ ### is\_parameterized - + Return True iff the instruction is parameterized. **Return type** @@ -397,7 +397,7 @@ $$ ### replace - + Return a `Schedule` with the `old` instruction replaced with a `new` instruction. The replacement matching is based on an instruction equality check. @@ -422,16 +422,14 @@ $$ Only matches at the top-level of the schedule tree. If you wish to perform this replacement over all instructions in the schedule tree. Flatten the schedule prior to running: ```python - .. code-block:: - ``` + sched = pulse.Schedule() - > sched = pulse.Schedule() - > - > sched += pulse.Schedule(old) - > - > sched = sched.replace(old, new) - > - > assert sched == pulse.Schedule(new) + sched += pulse.Schedule(old) + + sched = sched.replace(old, new) + + assert sched == pulse.Schedule(new) + ``` **Parameters** @@ -454,7 +452,7 @@ $$ ### shift - + Return a schedule shifted forward by `time`. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.pulse.ScheduleBlock.mdx b/docs/api/qiskit/dev/qiskit.pulse.ScheduleBlock.mdx index 23366c10cf8..f2b95e7f7aa 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.ScheduleBlock.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.ScheduleBlock.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.ScheduleBlock # ScheduleBlock - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") Time-ordered sequence of instructions with alignment context. @@ -159,7 +159,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### instances\_counter - + ### instructions @@ -201,7 +201,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### append - + Return a new schedule block with `block` appended to the context block. The execution time is automatically assigned when the block is converted into schedule. **Parameters** @@ -225,7 +225,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### assign\_parameters - + Assign the parameters in this schedule according to the input. **Parameters** @@ -250,7 +250,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### assign\_references - + Assign schedules to references. It is only capable of assigning a schedule block to immediate references which are directly referred within the current scope. Let’s see following example: @@ -308,7 +308,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### ch\_duration - + Return the time of the end of the last instruction over the supplied channels. **Parameters** @@ -322,7 +322,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### draw - + Plot the schedule. **Parameters** @@ -368,7 +368,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### exclude - + Return a new `ScheduleBlock` with only the instructions from this `ScheduleBlock` *failing* at least one of the provided filters. This method is the complement of [`filter()`](#qiskit.pulse.ScheduleBlock.filter "qiskit.pulse.ScheduleBlock.filter"), so that: ```python @@ -393,7 +393,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### filter - + Return a new `ScheduleBlock` with only the instructions from this `ScheduleBlock` which pass though the provided filters; i.e. an instruction will be retained if every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, and the instruction type is contained in `instruction_types`. @@ -416,7 +416,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### get\_parameters - + Get parameter object bound to this schedule by string name. Note that we can define different parameter objects with the same name, because these different objects are identified by their unique uuid. For example, @@ -454,7 +454,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### initialize\_from - + Create new schedule object with metadata of another schedule object. **Parameters** @@ -477,7 +477,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### is\_parameterized - + Return True iff the instruction is parameterized. **Return type** @@ -487,7 +487,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### is\_referenced - + Return True iff the current schedule block contains reference to subroutine. **Return type** @@ -497,7 +497,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### is\_schedulable - + Return `True` if all durations are assigned. **Return type** @@ -507,7 +507,7 @@ python_api_name: qiskit.pulse.ScheduleBlock ### replace - + Return a `ScheduleBlock` with the `old` component replaced with a `new` component. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.pulse.instructions.TimeBlockade.mdx b/docs/api/qiskit/dev/qiskit.pulse.instructions.TimeBlockade.mdx index fe5ee6e0d21..e9fe3f25bb9 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.instructions.TimeBlockade.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.instructions.TimeBlockade.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.instructions.TimeBlockade # TimeBlockade - + Bases: `Directive` Pulse `TimeBlockade` directive. diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.Cos.mdx b/docs/api/qiskit/dev/qiskit.pulse.library.Cos.mdx index 793b3260a0b..d9fe1b70f10 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.Cos.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.library.Cos.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Cos # qiskit.pulse.library.Cos - + A cosine pulse. The envelope of the pulse is given by: diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.GaussianDeriv.mdx b/docs/api/qiskit/dev/qiskit.pulse.library.GaussianDeriv.mdx index e54a3a82110..18323954dd0 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.GaussianDeriv.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.library.GaussianDeriv.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.GaussianDeriv # qiskit.pulse.library.GaussianDeriv - + An unnormalized Gaussian derivative pulse. The Gaussian function is centered around the halfway point of the pulse, and the envelope of the pulse is given by: diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.GaussianSquareDrag.mdx b/docs/api/qiskit/dev/qiskit.pulse.library.GaussianSquareDrag.mdx index d8dc151c463..67ec0b30d0c 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.GaussianSquareDrag.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.library.GaussianSquareDrag.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.GaussianSquareDrag # qiskit.pulse.library.GaussianSquareDrag - + A square pulse with a Drag shaped rise and fall This pulse shape is similar to [`GaussianSquare`](qiskit.pulse.library.GaussianSquare "qiskit.pulse.library.GaussianSquare") but uses [`Drag`](qiskit.pulse.library.Drag "qiskit.pulse.library.Drag") for its rise and fall instead of [`Gaussian`](qiskit.pulse.library.Gaussian "qiskit.pulse.library.Gaussian"). The addition of the DRAG component of the rise and fall is sometimes helpful in suppressing the spectral content of the pulse at frequencies near to, but slightly offset from, the fundamental frequency of the drive. When there is a spectator qubit close in frequency to the fundamental frequency, suppressing the drive at the spectator’s frequency can help avoid unwanted excitation of the spectator. diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.Sawtooth.mdx b/docs/api/qiskit/dev/qiskit.pulse.library.Sawtooth.mdx index 378913c6d04..011e1df7a86 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.Sawtooth.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.library.Sawtooth.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Sawtooth # qiskit.pulse.library.Sawtooth - + A sawtooth pulse. The envelope of the pulse is given by: diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.Sech.mdx b/docs/api/qiskit/dev/qiskit.pulse.library.Sech.mdx index a2e99734e71..5fded8697ac 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.Sech.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.library.Sech.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Sech # qiskit.pulse.library.Sech - + An unnormalized sech pulse. The sech function is centered around the halfway point of the pulse, and the envelope of the pulse is given by: diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.SechDeriv.mdx b/docs/api/qiskit/dev/qiskit.pulse.library.SechDeriv.mdx index a764a03d452..b65d943aca6 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.SechDeriv.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.library.SechDeriv.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.SechDeriv # qiskit.pulse.library.SechDeriv - + An unnormalized sech derivative pulse. The sech function is centered around the halfway point of the pulse, and the envelope of the pulse is given by: diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.Sin.mdx b/docs/api/qiskit/dev/qiskit.pulse.library.Sin.mdx index ad2366a79db..bd6ee5dff74 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.Sin.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.library.Sin.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Sin # qiskit.pulse.library.Sin - + A sinusoidal pulse. The envelope of the pulse is given by: diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.Square.mdx b/docs/api/qiskit/dev/qiskit.pulse.library.Square.mdx index 9680291b59d..0647b681743 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.Square.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.library.Square.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Square # qiskit.pulse.library.Square - + A square wave pulse. The envelope of the pulse is given by: diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.SymbolicPulse.mdx b/docs/api/qiskit/dev/qiskit.pulse.library.SymbolicPulse.mdx index 7477066bcb8..f829f0a16d1 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.SymbolicPulse.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.library.SymbolicPulse.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.library.SymbolicPulse # SymbolicPulse - + Bases: `Pulse` The pulse representation model with parameters and symbolic expressions. @@ -222,7 +222,7 @@ $$ ### get\_waveform - + Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. Since the returned array is a discretized time series of the continuous function, this method uses a midpoint sampler. For `duration`, return: @@ -247,7 +247,7 @@ $$ ### is\_parameterized - + Return True iff the instruction is parameterized. **Return type** @@ -257,12 +257,16 @@ $$ ### validate\_parameters - + Validate parameters. **Raises** [**PulseError**](pulse#qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If the parameters passed are not valid. + + **Return type** + + None diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.Triangle.mdx b/docs/api/qiskit/dev/qiskit.pulse.library.Triangle.mdx index 6fcec62dc06..15d15219585 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.Triangle.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.library.Triangle.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Triangle # qiskit.pulse.library.Triangle - + A triangle wave pulse. The envelope of the pulse is given by: diff --git a/docs/api/qiskit/dev/qiskit.pulse.library.gaussian_square_echo.mdx b/docs/api/qiskit/dev/qiskit.pulse.library.gaussian_square_echo.mdx index 59ac4835c2c..3342c403549 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.library.gaussian_square_echo.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.library.gaussian_square_echo.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.gaussian_square_echo # qiskit.pulse.library.gaussian\_square\_echo - + An echoed Gaussian square pulse with an active tone overlaid on it. The Gaussian Square Echo pulse is composed of three pulses. First, a Gaussian Square pulse $f_{echo}(x)$ with amplitude `amp` and phase `angle` playing for half duration, followed by a second Gaussian Square pulse $-f_{echo}(x)$ with opposite amplitude and same phase playing for the rest of the duration. Third a Gaussian Square pulse $f_{active}(x)$ with amplitude `active_amp` and phase `active_angle` playing for the entire duration. The Gaussian Square Echo pulse $g_e()$ can be written as: diff --git a/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignFunc.mdx b/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignFunc.mdx index d5f2ce99bdd..394c2ba8956 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignFunc.mdx +++ b/docs/api/qiskit/dev/qiskit.pulse.transforms.AlignFunc.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.pulse.transforms.AlignFunc # AlignFunc - + Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") Allocate instructions at position specified by callback function. @@ -59,7 +59,7 @@ python_api_name: qiskit.pulse.transforms.AlignFunc ### align - + Reallocate instructions according to the policy. Only top-level sub-schedules are aligned. If sub-schedules are nested, nested schedules are not recursively aligned. diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.CNOTDihedral.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.CNOTDihedral.mdx index 7ab6977341a..f27ae2477a7 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.CNOTDihedral.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.CNOTDihedral.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral # CNOTDihedral - + Bases: `BaseOperator`, `AdjointMixin` An N-qubit operator from the CNOT-Dihedral group. @@ -106,13 +106,13 @@ python_api_name: qiskit.quantum_info.CNOTDihedral ### adjoint - + Return the adjoint of the Operator. ### compose - + Return the operator composition with another CNOTDihedral. **Parameters** @@ -142,7 +142,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral ### conjugate - + Return the conjugate of the CNOTDihedral. @@ -177,7 +177,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral ### expand - + Return the reverse-order tensor product with another CNOTDihedral. **Parameters** @@ -255,7 +255,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral ### tensor - + Return the tensor product with another CNOTDihedral. **Parameters** @@ -279,7 +279,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral ### to\_circuit - + Return a QuantumCircuit implementing the CNOT-Dihedral element. **Returns** @@ -298,19 +298,19 @@ python_api_name: qiskit.quantum_info.CNOTDihedral ### to\_instruction - + Return a Gate instruction implementing the CNOTDihedral object. ### to\_matrix - + Convert operator to Numpy matrix. ### to\_operator - + Convert to an Operator object. **Return type** @@ -320,7 +320,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral ### transpose - + Return the transpose of the CNOTDihedral. diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Chi.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.Chi.mdx index 054c6ff8ac5..d12188301ed 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Chi.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Chi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Chi # Chi - + Bases: `QuantumChannel` Pauli basis Chi-matrix representation of a quantum channel. @@ -31,9 +31,9 @@ $$ **Parameters** - * **or** (*data (*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – Instruction or BaseOperator or matrix): data to initialize superoperator. - * **input\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – the input subsystem dimensions. \[Default: None] - * **output\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – the output subsystem dimensions. \[Default: None] + * **data** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") *| BaseOperator | np.ndarray*) – data to initialize superoperator. + * **input\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *| None*) – the input subsystem dimensions. + * **output\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *| None*) – the output subsystem dimensions. **Raises** @@ -195,6 +195,11 @@ $$ Test if Choi-matrix is completely-positive (CP) + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -205,6 +210,11 @@ $$ Return True if completely-positive trace-preserving (CPTP). + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -215,6 +225,11 @@ $$ Test if a channel is trace-preserving (TP) + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -225,6 +240,11 @@ $$ Return True if QuantumChannel is a unitary channel. + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Choi.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.Choi.mdx index 8651bb6946d..66caf987fcb 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Choi.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Choi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Choi # Choi - + Bases: `QuantumChannel` Choi-matrix representation of a Quantum Channel. @@ -39,9 +39,9 @@ $$ **Parameters** - * **or** (*data (*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – Instruction or BaseOperator or matrix): data to initialize superoperator. - * **input\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – the input subsystem dimensions. \[Default: None] - * **output\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – the output subsystem dimensions. \[Default: None] + * **data** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") *| BaseOperator | np.ndarray*) – data to initialize superoperator. + * **input\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *| None*) – the input subsystem dimensions. + * **output\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *| None*) – the output subsystem dimensions. **Raises** @@ -207,6 +207,11 @@ $$ Test if Choi-matrix is completely-positive (CP) + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -217,6 +222,11 @@ $$ Return True if completely-positive trace-preserving (CPTP). + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -227,6 +237,11 @@ $$ Test if a channel is trace-preserving (TP) + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -237,6 +252,11 @@ $$ Return True if QuantumChannel is a unitary channel. + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Clifford.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.Clifford.mdx index 653851b5723..0c79011517e 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Clifford.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Clifford.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Clifford # Clifford - + Bases: `BaseOperator`, `AdjointMixin`, [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") An N-qubit unitary operator from the Clifford group. @@ -182,13 +182,13 @@ python_api_name: qiskit.quantum_info.Clifford ### adjoint - + Return the adjoint of the Operator. ### compose - + Return the operator composition with another Clifford. **Parameters** @@ -218,13 +218,13 @@ python_api_name: qiskit.quantum_info.Clifford ### conjugate - + Return the conjugate of the Clifford. ### copy - + Make a deep copy of current operator. @@ -253,7 +253,7 @@ python_api_name: qiskit.quantum_info.Clifford ### expand - + Return the reverse-order tensor product with another Clifford. **Parameters** @@ -273,7 +273,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_circuit - + Initialize from a QuantumCircuit or Instruction. **Parameters** @@ -295,13 +295,13 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_dict - + Load a Clifford from a dictionary ### from\_label - + Return a tensor product of single-qubit Clifford gates. **Parameters** @@ -349,7 +349,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_linear\_function - + Create a Clifford from a Linear Function. If the linear function is represented by a nxn binary invertible matrix A, then the corresponding Clifford has symplectic matrix \[\[A^t, 0], \[0, A^\{-1}]]. @@ -369,7 +369,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_matrix - + Create a Clifford from a unitary matrix. Note that this function takes exponentially long time w\.r.t. the number of qubits. @@ -393,7 +393,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_operator - + Create a Clifford from a operator. Note that this function takes exponentially long time w\.r.t. the number of qubits. @@ -417,7 +417,7 @@ python_api_name: qiskit.quantum_info.Clifford ### from\_permutation - + Create a Clifford from a PermutationGate. **Parameters** @@ -441,7 +441,7 @@ python_api_name: qiskit.quantum_info.Clifford ### is\_unitary - + Return True if the Clifford table is valid. @@ -499,7 +499,7 @@ python_api_name: qiskit.quantum_info.Clifford ### tensor - + Return the tensor product with another Clifford. **Parameters** @@ -523,7 +523,7 @@ python_api_name: qiskit.quantum_info.Clifford ### to\_circuit - + Return a QuantumCircuit implementing the Clifford. For N \<= 3 qubits this is based on optimal CX cost decomposition from reference \[1]. For N > 3 qubits this is done using the general non-optimal compilation routine from reference \[2]. @@ -544,19 +544,19 @@ python_api_name: qiskit.quantum_info.Clifford ### to\_dict - + Return dictionary representation of Clifford object. ### to\_instruction - + Return a Gate instruction implementing the Clifford. ### to\_labels - + Convert a Clifford to a list Pauli (de)stabilizer string labels. For large Clifford converting using the `array=True` kwarg will be more efficient since it allocates memory for the full Numpy array of labels in advance. @@ -592,13 +592,13 @@ python_api_name: qiskit.quantum_info.Clifford ### to\_matrix - + Convert operator to Numpy matrix. ### to\_operator - + Convert to an Operator object. **Return type** @@ -608,7 +608,7 @@ python_api_name: qiskit.quantum_info.Clifford ### transpose - + Return the transpose of the Clifford. diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.DensityMatrix.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.DensityMatrix.mdx index 6bd8c371302..c4ad57a84bd 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.DensityMatrix.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.DensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix # DensityMatrix - + Bases: `QuantumState`, `TolerancesMixin` DensityMatrix class @@ -17,8 +17,8 @@ python_api_name: qiskit.quantum_info.DensityMatrix **Parameters** - * **or** (*data (np.ndarray or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or matrix\_like or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – qiskit.circuit.Instruction): A statevector, quantum instruction or an object with a `to_operator` or `to_matrix` method from which the density matrix can be constructed. If a vector the density matrix is constructed as the projector of that vector. If a quantum instruction, the density matrix is constructed by assuming all qubits are initialized in the zero state. - * **dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *or*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – Optional. The subsystem dimension of the state (See additional information). + * **data** (*np.ndarray |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") *| QuantumState*) – A statevector, quantum instruction or an object with a `to_operator` or `to_matrix` method from which the density matrix can be constructed. If a vector the density matrix is constructed as the projector of that vector. If a quantum instruction, the density matrix is constructed by assuming all qubits are initialized in the zero state. + * **dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *| None*) – The subsystem dimension of the state (See additional information). **Raises** @@ -69,7 +69,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### conjugate - + Return the conjugate of the density matrix. @@ -87,7 +87,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### draw - + Return a visualization of the Statevector. **repr**: ASCII TextMatrix of the state’s `__repr__`. @@ -120,30 +120,30 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### evolve - + Evolve a quantum state by an operator. **Parameters** - * **QuantumChannel** (*other (Operator or*) – or Instruction or Circuit): The operator to evolve by. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – a list of QuantumState subsystem positions to apply the operator on. + * **other** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") *| QuantumChannel |*[*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The operator to evolve by. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – a list of QuantumState subsystem positions to apply the operator on. **Returns** - the output density matrix. - - **Return type** - - [DensityMatrix](#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") + The output density matrix. **Raises** [**QiskitError**](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") – if the operator dimension does not match the specified QuantumState subsystem dimensions. + + **Return type** + + [DensityMatrix](#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") ### expand - + Return the tensor product state other ⊗ self. **Parameters** @@ -184,31 +184,31 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_instruction - + Return the output density matrix of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. **Parameters** - **instruction** ([*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – instruction or circuit + **instruction** ([*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – instruction or circuit **Returns** - the final density matrix. - - **Return type** - - [DensityMatrix](#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") + The final density matrix. **Raises** [**QiskitError**](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") – if the instruction contains invalid instructions for density matrix simulation. + + **Return type** + + [DensityMatrix](#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") ### from\_int - + Return a computational basis state density matrix. **Parameters** @@ -234,7 +234,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | @@ -265,7 +265,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### is\_valid - + Return True if trace 1 and positive semidefinite. @@ -293,7 +293,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### partial\_transpose - + Return partially transposed density matrix. **Parameters** @@ -311,7 +311,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### probabilities - + Return the subsystem measurement probability vector. Measurement probabilities are with respect to measurement in the computation (diagonal) basis. @@ -405,13 +405,13 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### purity - + Return the purity of the quantum state. ### reset - + Reset state or subsystems to the 0-state. **Parameters** @@ -505,7 +505,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### tensor - + Return the tensor product state self ⊗ other. **Parameters** @@ -527,7 +527,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### to\_dict - + Convert the density matrix to dictionary form. This dictionary representation uses a Ket-like notation where the dictionary keys are qudit strings for the subsystem basis vectors. If any subsystem has a dimension greater than 10 comma delimiters are inserted between integers so that subsystems can be distinguished. @@ -603,7 +603,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### to\_operator - + Convert to Operator **Return type** @@ -613,7 +613,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### to\_statevector - + Return a statevector from a pure density matrix. **Parameters** @@ -638,7 +638,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### trace - + Return the trace of the density matrix. diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Kraus.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.Kraus.mdx index fc754b390c3..108eb2e8a3a 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Kraus.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Kraus.mdx @@ -199,6 +199,11 @@ $$ Test if Choi-matrix is completely-positive (CP) + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -215,6 +220,11 @@ $$ Test if a channel is trace-preserving (TP) + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -225,6 +235,11 @@ $$ Return True if QuantumChannel is a unitary channel. + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Operator.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.Operator.mdx index aae76646032..d6286a014aa 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Operator.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Operator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Operator # Operator - + Bases: `LinearOp` Matrix operator class @@ -31,13 +31,17 @@ $$ >>> import numpy as np >>> from qiskit.quantum_info import Operator >>> op = Operator(np.array([[0.0, 1.0], [1.0, 0.0]])) # Represents Pauli X operator + ``` + ```python >>> from qiskit.quantum_info import Statevector >>> sv = Statevector(np.array([1.0, 0.0])) >>> sv.evolve(op) Statevector([0.+0.j, 1.+0.j], dims=(2,)) + ``` + ```python >>> from qiskit.quantum_info import DensityMatrix >>> dm = DensityMatrix(np.array([[1.0, 0.0], [0.0, 0.0]])) >>> dm.evolve(op) @@ -116,7 +120,7 @@ $$ ### apply\_permutation - + Modifies operator’s data by composing it with a permutation. **Parameters** @@ -139,7 +143,7 @@ $$ ### compose - + Return the operator composition with another Operator. **Parameters** @@ -169,7 +173,7 @@ $$ ### conjugate - + Return the conjugate of the Operator. @@ -204,7 +208,7 @@ $$ ### draw - + Return a visualization of the Operator. **repr**: String of the state’s `__repr__`. @@ -235,7 +239,7 @@ $$ ### equiv - + Return True if operators are equivalent up to global phase. **Parameters** @@ -255,7 +259,7 @@ $$ ### expand - + Return the reverse-order tensor product with another Operator. **Parameters** @@ -275,7 +279,7 @@ $$ ### from\_circuit - + Create a new Operator object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") While a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object can passed directly as `data` to the class constructor this provides no options on how the circuit is used to create an [`Operator`](#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator"). This constructor method lets you control how the [`Operator`](#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") is created so it can be adjusted for a particular use case. @@ -300,7 +304,7 @@ $$ ### from\_label - + Return a tensor product of single-qubit operators. **Parameters** @@ -332,7 +336,7 @@ $$ ### is\_unitary - + Return True if operator is a unitary matrix. @@ -344,7 +348,7 @@ $$ ### power - + Return the matrix power of the operator. Non-integer powers of operators with an eigenvalue whose complex phase is $\pi$ have a branch cut in the complex plane, which makes the calculation of the principal root around this cut subject to precision / differences in BLAS implementation. For example, the square root of Pauli Y can return the $\pi/2$ or $-\pi/2$ Y rotation depending on whether the -1 eigenvalue is found as `complex(-1, tiny)` or `complex(-1, -tiny)`. Such eigenvalues are really common in quantum information, so this function first phase-rotates the input matrix to shift the branch cut to a far less common point. The underlying numerical precision issues around the branch-cut point remain, if an operator has an eigenvalue close to this phase. The magnitude of this rotation can be controlled with the `branch_cut_rotation` parameter. @@ -409,7 +413,7 @@ $$ ### reverse\_qargs - + Return an Operator with reversed subsystem ordering. For a tensor product operator this is equivalent to reversing the order of tensor product subsystems. For an operator $A = A_{n-1} \otimes ... \otimes A_0$ the returned operator will be $A_0 \otimes ... \otimes A_{n-1}$. @@ -425,7 +429,7 @@ $$ ### tensor - + Return the tensor product with another Operator. **Parameters** @@ -449,19 +453,19 @@ $$ ### to\_instruction - + Convert to a UnitaryGate instruction. ### to\_matrix - + Convert operator to NumPy matrix. ### to\_operator - + Convert operator to matrix operator class **Return type** @@ -471,7 +475,7 @@ $$ ### transpose - + Return the transpose of the Operator. diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.PTM.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.PTM.mdx index 4e3be0aa1ac..5c100b4411b 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.PTM.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.PTM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PTM # PTM - + Bases: `QuantumChannel` Pauli Transfer Matrix (PTM) representation of a Quantum Channel. @@ -39,9 +39,9 @@ $$ **Parameters** - * **or** (*data (*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – Instruction or BaseOperator or matrix): data to initialize superoperator. - * **input\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – the input subsystem dimensions. \[Default: None] - * **output\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – the output subsystem dimensions. \[Default: None] + * **data** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") *| BaseOperator | np.ndarray*) – data to initialize superoperator. + * **input\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *| None*) – the input subsystem dimensions. + * **output\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *| None*) – the output subsystem dimensions. **Raises** @@ -203,6 +203,11 @@ $$ Test if Choi-matrix is completely-positive (CP) + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -213,6 +218,11 @@ $$ Return True if completely-positive trace-preserving (CPTP). + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -223,6 +233,11 @@ $$ Test if a channel is trace-preserving (TP) + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -233,6 +248,11 @@ $$ Return True if QuantumChannel is a unitary channel. + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Pauli.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.Pauli.mdx index 41fffce67c4..f2fedeff29e 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Pauli.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Pauli.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Pauli # Pauli - + Bases: `BasePauli` N-qubit Pauli operator. @@ -171,13 +171,13 @@ $$ ### adjoint - + Return the adjoint of the Operator. ### anticommutes - + Return True if other Pauli anticommutes with self. **Parameters** @@ -196,7 +196,7 @@ $$ ### apply\_layout - + Apply a transpiler layout to this [`Pauli`](#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") **Parameters** @@ -215,7 +215,7 @@ $$ ### commutes - + Return True if the Pauli commutes with other. **Parameters** @@ -234,7 +234,7 @@ $$ ### compose - + Return the operator composition with another Pauli. **Parameters** @@ -265,7 +265,7 @@ $$ ### conjugate - + Return the complex conjugate of the Pauli with respect to the Z basis. @@ -277,7 +277,7 @@ $$ ### delete - + Return a Pauli with qubits deleted. **Parameters** @@ -299,7 +299,7 @@ $$ ### dot - + Return the right multiplied operator self \* other. **Parameters** @@ -319,7 +319,7 @@ $$ ### equiv - + Return True if Pauli’s are equivalent up to group phase. **Parameters** @@ -337,7 +337,7 @@ $$ ### evolve - + Performs either Heisenberg (default) or Schrödinger picture evolution of the Pauli by a Clifford and returns the evolved Pauli. Schrödinger picture evolution can be chosen by passing parameter `frame='s'`. This option yields a faster calculation. @@ -368,7 +368,7 @@ $$ ### expand - + Return the reverse-order tensor product with another Pauli. **Parameters** @@ -394,7 +394,7 @@ $$ ### insert - + Insert a Pauli at specific qubit value. **Parameters** @@ -417,7 +417,7 @@ $$ ### inverse - + Return the inverse of the Pauli. @@ -475,7 +475,7 @@ $$ ### set\_truncation - + Set the max number of Pauli characters to display before truncation/ **Parameters** @@ -489,7 +489,7 @@ $$ ### tensor - + Return the tensor product with another Pauli. **Parameters** @@ -513,13 +513,13 @@ $$ ### to\_instruction - + Convert to Pauli circuit instruction. ### to\_label - + Convert a Pauli to a string label. @@ -537,7 +537,7 @@ $$ ### to\_matrix - + Convert to a Numpy array or sparse CSR matrix. **Parameters** @@ -555,7 +555,7 @@ $$ ### transpose - + Return the transpose of each Pauli in the list. diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.PauliList.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.PauliList.mdx index 1f7eef7bd5a..3ac64b30662 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.PauliList.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.PauliList.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PauliList # PauliList - + Bases: `BasePauli`, `LinearMixin`, `GroupMixin` List of N-qubit Pauli operators. @@ -161,13 +161,13 @@ python_api_name: qiskit.quantum_info.PauliList ### adjoint - + Return the adjoint of each Pauli in the list. ### anticommutes - + Return `True` if other Pauli that anticommutes with other. **Parameters** @@ -186,7 +186,7 @@ python_api_name: qiskit.quantum_info.PauliList ### anticommutes\_with\_all - + Return indexes of rows that commute other. If `other` is a multi-row Pauli list the returned vector indexes rows of the current PauliList that anti-commute with *all* Paulis in other. If no rows satisfy the condition the returned array will be empty. @@ -206,7 +206,7 @@ python_api_name: qiskit.quantum_info.PauliList ### argsort - + Return indices for sorting the rows of the table. The default sort method is lexicographic sorting by qubit number. By using the weight kwarg the output can additionally be sorted by the number of non-identity terms in the Pauli, where the set of all Paulis of a given weight are still ordered lexicographically. @@ -227,7 +227,7 @@ python_api_name: qiskit.quantum_info.PauliList ### commutes - + Return True for each Pauli that commutes with other. **Parameters** @@ -246,7 +246,7 @@ python_api_name: qiskit.quantum_info.PauliList ### commutes\_with\_all - + Return indexes of rows that commute `other`. If `other` is a multi-row Pauli list the returned vector indexes rows of the current PauliList that commute with *all* Paulis in other. If no rows satisfy the condition the returned array will be empty. @@ -266,7 +266,7 @@ python_api_name: qiskit.quantum_info.PauliList ### compose - + Return the composition self∘other for each Pauli in the list. **Parameters** @@ -291,7 +291,7 @@ python_api_name: qiskit.quantum_info.PauliList ### conjugate - + Return the conjugate of each Pauli in the list. @@ -303,7 +303,7 @@ python_api_name: qiskit.quantum_info.PauliList ### delete - + Return a copy with Pauli rows deleted from table. When deleting qubits the qubit index is the same as the column index of the underlying `X` and `Z` arrays. @@ -328,7 +328,7 @@ python_api_name: qiskit.quantum_info.PauliList ### dot - + Return the composition other∘self for each Pauli in the list. **Parameters** @@ -352,7 +352,7 @@ python_api_name: qiskit.quantum_info.PauliList ### equiv - + Entrywise comparison of Pauli equivalence up to global phase. **Parameters** @@ -372,7 +372,7 @@ python_api_name: qiskit.quantum_info.PauliList ### evolve - + Performs either Heisenberg (default) or Schrödinger picture evolution of the Pauli by a Clifford and returns the evolved Pauli. Schrödinger picture evolution can be chosen by passing parameter `frame='s'`. This option yields a faster calculation. @@ -402,7 +402,7 @@ python_api_name: qiskit.quantum_info.PauliList ### expand - + Return the expand product of each Pauli in the list. **Parameters** @@ -424,7 +424,7 @@ python_api_name: qiskit.quantum_info.PauliList ### from\_symplectic - + Construct a PauliList from a symplectic data. **Parameters** @@ -444,7 +444,7 @@ python_api_name: qiskit.quantum_info.PauliList ### group\_commuting - + Partition a PauliList into sets of commuting Pauli strings. **Parameters** @@ -473,7 +473,7 @@ python_api_name: qiskit.quantum_info.PauliList ### group\_qubit\_wise\_commuting - + Partition a PauliList into sets of mutually qubit-wise commuting Pauli strings. **Returns** @@ -493,7 +493,7 @@ python_api_name: qiskit.quantum_info.PauliList ### insert - + Insert Paulis into the table. When inserting qubits the qubit index is the same as the column index of the underlying `X` and `Z` arrays. @@ -519,13 +519,13 @@ python_api_name: qiskit.quantum_info.PauliList ### inverse - + Return the inverse of each Pauli in the list. ### label\_iter - + Return a label representation iterator. This is a lazy iterator that converts each row into the string label only as it is used. To convert the entire table to labels use the [`to_labels()`](#qiskit.quantum_info.PauliList.to_labels "qiskit.quantum_info.PauliList.to_labels") method. @@ -541,7 +541,7 @@ python_api_name: qiskit.quantum_info.PauliList ### matrix\_iter - + Return a matrix representation iterator. This is a lazy iterator that converts each row into the Pauli matrix representation only as it is used. To convert the entire table to matrices use the [`to_matrix()`](#qiskit.quantum_info.PauliList.to_matrix "qiskit.quantum_info.PauliList.to_matrix") method. @@ -561,7 +561,7 @@ python_api_name: qiskit.quantum_info.PauliList ### noncommutation\_graph - + Create the non-commutation graph of this PauliList. This transforms the measurement operator grouping problem into graph coloring problem. The constructed graph contains one node for each Pauli. The nodes will be connecting for any two Pauli terms that do \_not\_ commute. @@ -635,7 +635,7 @@ python_api_name: qiskit.quantum_info.PauliList ### sort - + Sort the rows of the table. The default sort method is lexicographic sorting by qubit number. By using the weight kwarg the output can additionally be sorted by the number of non-identity terms in the Pauli, where the set of all Paulis of a given weight are still ordered lexicographically. @@ -696,7 +696,7 @@ python_api_name: qiskit.quantum_info.PauliList ### tensor - + Return the tensor product with each Pauli in the list. **Parameters** @@ -718,7 +718,7 @@ python_api_name: qiskit.quantum_info.PauliList ### to\_labels - + Convert a PauliList to a list Pauli string labels. For large PauliLists converting using the `array=True` kwarg will be more efficient since it allocates memory for the full Numpy array of labels in advance. @@ -745,7 +745,7 @@ python_api_name: qiskit.quantum_info.PauliList ### to\_matrix - + Convert to a list or array of Pauli matrices. For large PauliLists converting using the `array=True` kwarg will be more efficient since it allocates memory a full rank-3 Numpy array of matrices in advance. @@ -773,13 +773,13 @@ python_api_name: qiskit.quantum_info.PauliList ### transpose - + Return the transpose of each Pauli in the list. ### unique - + Return unique Paulis from the table. **Example** diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.SparseObservable.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.SparseObservable.mdx index 682356d57c0..19dba236433 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.SparseObservable.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.SparseObservable.mdx @@ -194,6 +194,8 @@ $$ #### Term + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + A single term from a complete [`SparseObservable`](#qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable"). These are typically created by indexing into or iterating through a [`SparseObservable`](#qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable"). diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.SparsePauliOp.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.SparsePauliOp.mdx index 9c1ef9795bc..2820dd4a7c3 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.SparsePauliOp.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.SparsePauliOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp # SparsePauliOp - + Bases: `LinearOp` Sparse N-qubit operator in a Pauli basis representation. @@ -27,7 +27,9 @@ python_api_name: qiskit.quantum_info.SparsePauliOp >>> import numpy as np >>> from qiskit.circuit import ParameterVector >>> from qiskit.quantum_info import SparsePauliOp + ``` + ```python >>> SparsePauliOp(["II", "XZ"], np.array(ParameterVector("a", 2))) SparsePauliOp(['II', 'XZ'], coeffs=[ParameterExpression(1.0*a[0]), ParameterExpression(1.0*a[1])]) @@ -127,13 +129,13 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### adjoint - + Return the adjoint of the Operator. ### apply\_layout - + Apply a transpiler layout to this [`SparsePauliOp`](#qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") **Parameters** @@ -152,7 +154,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### argsort - + Return indices for sorting the rows of the table. Returns the composition of permutations in the order of sorting by coefficient and sorting by Pauli. By using the weight kwarg the output can additionally be sorted by the number of non-identity terms in the Pauli, where the set of all Pauli’s of a given weight are still ordered lexicographically. @@ -220,7 +222,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### assign\_parameters - + Bind the free `Parameter`s in the coefficients to provided values. **Parameters** @@ -239,7 +241,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### chop - + Set real and imaginary parts of the coefficients to 0 if `< tol` in magnitude. For example, the operator representing `1+1e-17j X + 1e-17 Y` with a tolerance larger than `1e-17` will be reduced to `1 X` whereas [`SparsePauliOp.simplify()`](#qiskit.quantum_info.SparsePauliOp.simplify "qiskit.quantum_info.SparsePauliOp.simplify") would return `1+1e-17j X`. @@ -261,7 +263,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### compose - + Return the operator composition with another SparsePauliOp. **Parameters** @@ -291,7 +293,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### conjugate - + Return the conjugate of the SparsePauliOp. @@ -326,7 +328,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### equiv - + Check if two SparsePauliOp operators are equivalent. **Parameters** @@ -345,7 +347,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### expand - + Return the reverse-order tensor product with another SparsePauliOp. **Parameters** @@ -365,7 +367,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp ### from\_list - + Construct from a list of Pauli strings and coefficients. For example, the 5-qubit Hamiltonian @@ -405,7 +407,7 @@ $$ ### from\_operator - + Construct from an Operator objector. Note that the cost of this construction is exponential in general because the number of possible Pauli terms in the decomposition is exponential in the number of qubits. @@ -433,7 +435,7 @@ $$ ### from\_sparse\_list - + Construct from a list of local Pauli strings and coefficients. Each list element is a 3-tuple of a local Pauli string, indices where to apply it, and a coefficient. @@ -480,7 +482,7 @@ $$ ### group\_commuting - + Partition a SparsePauliOp into sets of commuting Pauli strings. **Parameters** @@ -520,7 +522,7 @@ $$ ### is\_unitary - + Return True if operator is a unitary matrix. **Parameters** @@ -539,7 +541,7 @@ $$ ### label\_iter - + Return a label representation iterator. This is a lazy iterator that converts each term in the SparsePauliOp into a tuple (label, coeff). To convert the entire table to labels use the `to_labels()` method. @@ -555,7 +557,7 @@ $$ ### matrix\_iter - + Return a matrix representation iterator. This is a lazy iterator that converts each term in the SparsePauliOp into a matrix as it is used. To convert to a single matrix use the [`to_matrix()`](#qiskit.quantum_info.SparsePauliOp.to_matrix "qiskit.quantum_info.SparsePauliOp.to_matrix") method. @@ -575,7 +577,7 @@ $$ ### noncommutation\_graph - + Create the non-commutation graph of this SparsePauliOp. This transforms the measurement operator grouping problem into graph coloring problem. The constructed graph contains one node for each Pauli. The nodes will be connecting for any two Pauli terms that do \_not\_ commute. @@ -649,7 +651,7 @@ $$ ### simplify - + Simplify PauliList by combining duplicates and removing zeros. **Parameters** @@ -668,7 +670,7 @@ $$ ### sort - + Sort the rows of the table. After sorting the coefficients using numpy’s argsort, sort by Pauli. Pauli sort takes precedence. If Pauli is the same, it will be sorted by coefficient. By using the weight kwarg the output can additionally be sorted by the number of non-identity terms in the Pauli, where the set of all Pauli’s of a given weight are still ordered lexicographically. @@ -739,7 +741,7 @@ $$ ### sum - + Sum of SparsePauliOps. This is a specialized version of the builtin `sum` function for SparsePauliOp with smaller overhead. @@ -765,7 +767,7 @@ $$ ### tensor - + Return the tensor product with another SparsePauliOp. **Parameters** @@ -789,7 +791,7 @@ $$ ### to\_list - + Convert to a list Pauli string labels and coefficients. For operators with a lot of terms converting using the `array=True` kwarg will be more efficient since it allocates memory for the full Numpy array of labels in advance. @@ -809,7 +811,7 @@ $$ ### to\_matrix - + Convert to a dense or sparse matrix. **Parameters** @@ -828,7 +830,7 @@ $$ ### to\_operator - + Convert to a matrix Operator object **Return type** @@ -838,13 +840,13 @@ $$ ### to\_sparse\_list - + Convert to a sparse Pauli list format with elements (pauli, qubits, coefficient). ### transpose - + Return the transpose of the SparsePauliOp. diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.StabilizerState.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.StabilizerState.mdx index d189234d5c6..5a540dac574 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.StabilizerState.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.StabilizerState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerState # StabilizerState - + Bases: `QuantumState` StabilizerState class. Stabilizer simulator using the convention from reference \[1]. Based on the internal class [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). @@ -56,8 +56,8 @@ python_api_name: qiskit.quantum_info.StabilizerState **Parameters** - * **or** (*data (*[*StabilizerState*](#qiskit.quantum_info.StabilizerState "qiskit.quantum_info.StabilizerState") *or*[*Clifford*](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") *or*[*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – qiskit.circuit.Instruction): Data from which the stabilizer state can be constructed. - * **validate** (*boolean*) – validate that the stabilizer state data is a valid Clifford. + * **data** ([*StabilizerState*](#qiskit.quantum_info.StabilizerState "qiskit.quantum_info.StabilizerState") *|*[*Clifford*](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") *|*[*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction")) – Data from which the stabilizer state can be constructed. + * **validate** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – validate that the stabilizer state data is a valid Clifford. ## Attributes @@ -83,7 +83,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### conjugate - + Return the conjugate of the operator. @@ -101,7 +101,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### equiv - + Return True if the two generating sets generate the same stabilizer group. **Parameters** @@ -119,7 +119,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### evolve - + Evolve a stabilizer state by a Clifford operator. **Parameters** @@ -143,7 +143,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### expand - + Return the tensor product stabilizer state other ⊗ self. **Parameters** @@ -165,7 +165,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### expectation\_value - + Compute the expectation value of a Pauli operator. **Parameters** @@ -188,7 +188,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### from\_stabilizer\_list - + Create a stabilizer state from the collection of stabilizers. **Parameters** @@ -208,13 +208,13 @@ python_api_name: qiskit.quantum_info.StabilizerState ### is\_valid - + Return True if a valid StabilizerState. ### measure - + Measure subsystems and return outcome and post-measure state. Note that this function uses the QuantumStates internal random number generator for sampling the measurement outcome. The RNG seed can be set using the [`seed()`](#qiskit.quantum_info.StabilizerState.seed "qiskit.quantum_info.StabilizerState.seed") method. @@ -236,7 +236,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### probabilities - + Return the subsystem measurement probability vector. Measurement probabilities are with respect to measurement in the computation (diagonal) basis. @@ -257,7 +257,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### probabilities\_dict - + Return the subsystem measurement probability dictionary. Measurement probabilities are with respect to measurement in the computation (diagonal) basis. @@ -280,7 +280,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### probabilities\_dict\_from\_bitstring - + Return the subsystem measurement probability dictionary utilizing a targeted outcome\_bitstring to perform the measurement for. This will calculate a probability for only a single targeted outcome\_bitstring value, giving a performance boost over calculating all possible outcomes. Measurement probabilities are with respect to measurement in the computation (diagonal) basis. @@ -304,7 +304,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### purity - + Return the purity of the quantum state, which equals to 1, since it is always a pure state. **Returns** @@ -322,7 +322,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### reset - + Reset state or subsystems to the 0-state. **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### sample\_memory - + Sample a list of qubit measurement outcomes in the computational basis. **Parameters** @@ -400,7 +400,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### tensor - + Return the tensor product stabilizer state self ⊗ other. **Parameters** @@ -422,7 +422,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### to\_operator - + Convert state to matrix operator class **Return type** @@ -432,7 +432,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### trace - + Return the trace of the stabilizer state as a density matrix, which equals to 1, since it is always a pure state. **Returns** diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Statevector.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.Statevector.mdx index dc6ba451600..31c294e5009 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Statevector.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Statevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Statevector # Statevector - + Bases: `QuantumState`, `TolerancesMixin` Statevector class @@ -17,8 +17,8 @@ python_api_name: qiskit.quantum_info.Statevector **Parameters** - * **or** (*data (np.array or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or*[*Statevector*](#qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") *or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – qiskit.circuit.Instruction): Data from which the statevector can be constructed. This can be either a complex vector, another statevector, a `Operator` with only one column or a `QuantumCircuit` or `Instruction`. If the data is a circuit or instruction, the statevector is constructed by assuming that all qubits are initialized to the zero state. - * **dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *or*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – Optional. The subsystem dimension of the state (See additional information). + * **data** (*np.ndarray |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *|*[*Statevector*](#qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *|*[*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction")) – Data from which the statevector can be constructed. This can be either a complex vector, another statevector, a `Operator` with only one column or a `QuantumCircuit` or `Instruction`. If the data is a circuit or instruction, the statevector is constructed by assuming that all qubits are initialized to the zero state. + * **dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *| None*) – The subsystem dimension of the state (See additional information). **Raises** @@ -69,7 +69,7 @@ python_api_name: qiskit.quantum_info.Statevector ### conjugate - + Return the conjugate of the operator. **Return type** @@ -91,7 +91,7 @@ python_api_name: qiskit.quantum_info.Statevector ### draw - + Return a visualization of the Statevector. **repr**: ASCII TextMatrix of the state’s `__repr__`. @@ -141,7 +141,7 @@ python_api_name: qiskit.quantum_info.Statevector ### equiv - + Return True if other is equivalent as a statevector up to global phase. @@ -165,7 +165,7 @@ python_api_name: qiskit.quantum_info.Statevector ### evolve - + Evolve a quantum state by the operator. **Parameters** @@ -188,7 +188,7 @@ python_api_name: qiskit.quantum_info.Statevector ### expand - + Return the tensor product state other ⊗ self. **Parameters** @@ -210,7 +210,7 @@ python_api_name: qiskit.quantum_info.Statevector ### expectation\_value - + Compute the expectation value of an operator. **Parameters** @@ -229,7 +229,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_instruction - + Return the output statevector of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -253,7 +253,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_int - + Return a computational basis statevector. **Parameters** @@ -279,7 +279,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | @@ -310,7 +310,7 @@ python_api_name: qiskit.quantum_info.Statevector ### inner - + Return the inner product of self and other as $\langle self| other \rangle$. **Parameters** @@ -332,9 +332,14 @@ python_api_name: qiskit.quantum_info.Statevector ### is\_valid - + Return True if a Statevector has norm 1. + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -364,7 +369,7 @@ python_api_name: qiskit.quantum_info.Statevector ### probabilities - + Return the subsystem measurement probability vector. Measurement probabilities are with respect to measurement in the computation (diagonal) basis. @@ -458,7 +463,7 @@ python_api_name: qiskit.quantum_info.Statevector ### purity - + Return the purity of the quantum state. **Return type** @@ -468,7 +473,7 @@ python_api_name: qiskit.quantum_info.Statevector ### reset - + Reset state or subsystems to the 0-state. **Parameters** @@ -490,7 +495,7 @@ python_api_name: qiskit.quantum_info.Statevector ### reverse\_qargs - + Return a Statevector with reversed subsystem ordering. For a tensor product state this is equivalent to reversing the order of tensor product subsystems. For a statevector $|\psi \rangle = |\psi_{n-1} \rangle \otimes ... \otimes |\psi_0 \rangle$ the returned statevector will be $|\psi_{0} \rangle \otimes ... \otimes |\psi_{n-1} \rangle$. @@ -562,7 +567,7 @@ python_api_name: qiskit.quantum_info.Statevector ### tensor - + Return the tensor product state self ⊗ other. **Parameters** @@ -584,7 +589,7 @@ python_api_name: qiskit.quantum_info.Statevector ### to\_dict - + Convert the statevector to dictionary form. This dictionary representation uses a Ket-like notation where the dictionary keys are qudit strings for the subsystem basis vectors. If any subsystem has a dimension greater than 10 comma delimiters are inserted between integers so that subsystems can be distinguished. @@ -653,7 +658,7 @@ python_api_name: qiskit.quantum_info.Statevector ### to\_operator - + Convert state to a rank-1 projector operator **Return type** @@ -663,7 +668,7 @@ python_api_name: qiskit.quantum_info.Statevector ### trace - + Return the trace of the quantum state as a density matrix. **Return type** diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Stinespring.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.Stinespring.mdx index 45b14d02bdc..606ad4f089b 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Stinespring.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Stinespring.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Stinespring # Stinespring - + Bases: `QuantumChannel` Stinespring representation of a quantum channel. @@ -37,9 +37,9 @@ $$ **Parameters** - * **or** (*data (*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – Instruction or BaseOperator or matrix): data to initialize superoperator. - * **input\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – the input subsystem dimensions. \[Default: None] - * **output\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – the output subsystem dimensions. \[Default: None] + * **data** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") *| BaseOperator | np.ndarray*) – data to initialize superoperator. + * **input\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *| None*) – the input subsystem dimensions. + * **output\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *| None*) – the output subsystem dimensions. **Raises** @@ -203,6 +203,11 @@ $$ Test if Choi-matrix is completely-positive (CP) + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -219,6 +224,11 @@ $$ Test if a channel is trace-preserving (TP) + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -229,6 +239,11 @@ $$ Return True if QuantumChannel is a unitary channel. + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.SuperOp.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.SuperOp.mdx index ab951f8c14f..8ff054c5c62 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.SuperOp.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.SuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SuperOp # SuperOp - + Bases: `QuantumChannel` Superoperator representation of a quantum channel. @@ -31,9 +31,9 @@ $$ **Parameters** - * **or** (*data (*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – Instruction or BaseOperator or matrix): data to initialize superoperator. - * **input\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – the input subsystem dimensions. \[Default: None] - * **output\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – the output subsystem dimensions. \[Default: None] + * **data** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") *| BaseOperator | np.ndarray*) – data to initialize superoperator. + * **input\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *| None*) – the input subsystem dimensions. + * **output\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *| None*) – the output subsystem dimensions. **Raises** @@ -87,7 +87,7 @@ $$ ### adjoint - + Return the adjoint quantum channel. @@ -97,7 +97,7 @@ $$ ### compose - + Return the operator composition with another SuperOp. **Parameters** @@ -127,7 +127,7 @@ $$ ### conjugate - + Return the conjugate quantum channel. @@ -166,7 +166,7 @@ $$ ### expand - + Return the reverse-order tensor product with another SuperOp. **Parameters** @@ -195,6 +195,11 @@ $$ Test if Choi-matrix is completely-positive (CP) + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -205,6 +210,11 @@ $$ Return True if completely-positive trace-preserving (CPTP). + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -215,6 +225,11 @@ $$ Test if a channel is trace-preserving (TP) + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -225,6 +240,11 @@ $$ Return True if QuantumChannel is a unitary channel. + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -288,7 +308,7 @@ $$ ### tensor - + Return the tensor product with another SuperOp. **Parameters** @@ -342,7 +362,7 @@ $$ ### transpose - + Return the transpose quantum channel. diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Z2Symmetries.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.Z2Symmetries.mdx index fd6ce6cc369..21016a241f0 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Z2Symmetries.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Z2Symmetries.mdx @@ -118,6 +118,10 @@ python_api_name: qiskit.quantum_info.Z2Symmetries A `Z2Symmetries` instance. + **Parameters** + + **operator** ([*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.operators.symplectic.sparse_pauli_op.SparsePauliOp")) – + **Return type** [*Z2Symmetries*](#qiskit.quantum_info.Z2Symmetries "qiskit.quantum_info.analysis.z2_symmetries.Z2Symmetries") diff --git a/docs/api/qiskit/dev/qiskit.result.ResultError.mdx b/docs/api/qiskit/dev/qiskit.result.ResultError.mdx index 6a8aa21d108..540cb9152a2 100644 --- a/docs/api/qiskit/dev/qiskit.result.ResultError.mdx +++ b/docs/api/qiskit/dev/qiskit.result.ResultError.mdx @@ -11,6 +11,8 @@ python_api_name: qiskit.result.ResultError # qiskit.result.ResultError + Bases: [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + Exceptions raised due to errors in result output. It may be better for the Qiskit API to raise this exception. diff --git a/docs/api/qiskit/dev/qiskit.synthesis.TwoQubitWeylDecomposition.mdx b/docs/api/qiskit/dev/qiskit.synthesis.TwoQubitWeylDecomposition.mdx index 8179025da37..130c12d6850 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.TwoQubitWeylDecomposition.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.TwoQubitWeylDecomposition.mdx @@ -42,6 +42,12 @@ $$ ## Attributes + **Parameters** + + * **unitary\_matrix** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)")) – + * **fidelity** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **\_specialization** (*two\_qubit\_decompose.Specialization | None*) – + ### a @@ -103,6 +109,12 @@ $$ Returns Weyl decomposition in circuit form. + **Parameters** + + * **euler\_basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **simplify** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + **Return type** [QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") @@ -113,6 +125,12 @@ $$ Decode bytes into [`TwoQubitWeylDecomposition`](#qiskit.synthesis.TwoQubitWeylDecomposition "qiskit.synthesis.TwoQubitWeylDecomposition"). + **Parameters** + + * **bytes\_in** ([*bytes*](https://docs.python.org/3/library/stdtypes.html#bytes "(in Python v3.13)")) – + * **requested\_fidelity** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + * **\_specialization** (*two\_qubit\_decompose.Specialization | None*) – + **Return type** [TwoQubitWeylDecomposition](#qiskit.synthesis.TwoQubitWeylDecomposition "qiskit.synthesis.TwoQubitWeylDecomposition") diff --git a/docs/api/qiskit/dev/qiskit.synthesis.XXDecomposer.mdx b/docs/api/qiskit/dev/qiskit.synthesis.XXDecomposer.mdx index 4d9ed8baf43..93f3bd742fa 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.XXDecomposer.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.XXDecomposer.mdx @@ -55,6 +55,10 @@ python_api_name: qiskit.synthesis.XXDecomposer This method is used by [`ConsolidateBlocks`](qiskit.transpiler.passes.ConsolidateBlocks "qiskit.transpiler.passes.ConsolidateBlocks"). + + **Parameters** + + **unitary** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") *| np.ndarray*) – diff --git a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.AQC.mdx b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.AQC.mdx index 11709323f3f..4fc6676b022 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.AQC.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.AQC.mdx @@ -36,6 +36,10 @@ python_api_name: qiskit.synthesis.unitary.aqc.AQC * **approximate\_circuit** ([*ApproximateCircuit*](qiskit.synthesis.unitary.aqc.ApproximateCircuit "qiskit.synthesis.unitary.aqc.ApproximateCircuit")) – a template circuit that will be filled with the parameter values obtained in the optimization procedure. * **approximating\_objective** ([*ApproximatingObjective*](qiskit.synthesis.unitary.aqc.ApproximatingObjective "qiskit.synthesis.unitary.aqc.ApproximatingObjective")) – a definition of the optimization problem. * **initial\_point** (*np.ndarray | None*) – initial values of angles/parameters to start optimization from. + + **Return type** + + None diff --git a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximateCircuit.mdx b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximateCircuit.mdx index 16322f70779..676e7efa785 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximateCircuit.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximateCircuit.mdx @@ -286,6 +286,10 @@ python_api_name: qiskit.synthesis.unitary.aqc.ApproximateCircuit **Parameters** **thetas** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)")) – a vector of parameters to be set in this circuit. + + **Return type** + + None diff --git a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.mdx b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.mdx index c1e8bcb74be..5ba9c1c38aa 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.mdx @@ -82,7 +82,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.CNOTUnitCircuit ### instances - + ### layout @@ -288,6 +288,14 @@ python_api_name: qiskit.synthesis.unitary.aqc.CNOTUnitCircuit **Constructs a Qiskit quantum circuit out of the parameters (angles) of this circuit. If a** parameter value is less in absolute value than the specified tolerance then the corresponding rotation gate will be skipped in the circuit. + + **Parameters** + + **thetas** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)")) – + + **Return type** + + None diff --git a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.mdx b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.mdx index 37582025ec3..4cacc849d3a 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.mdx @@ -45,6 +45,10 @@ python_api_name: qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective Computes the gradient of objective function. See description of the base class method. + **Parameters** + + **param\_values** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)")) – + **Return type** [*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)") @@ -55,6 +59,10 @@ python_api_name: qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective Computes the objective function and some intermediate data for the subsequent gradient computation. See description of the base class method. + **Parameters** + + **param\_values** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)")) – + **Return type** [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.InstructionDurations.mdx b/docs/api/qiskit/dev/qiskit.transpiler.InstructionDurations.mdx index e690b79a067..37299f3ab24 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.InstructionDurations.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.InstructionDurations.mdx @@ -17,6 +17,11 @@ python_api_name: qiskit.transpiler.InstructionDurations ## Methods + **Parameters** + + * **instruction\_durations** (*'InstructionDurationsType' | None*) – + * **dt** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + ### from\_backend diff --git a/docs/api/qiskit/dev/qiskit.transpiler.Layout.mdx b/docs/api/qiskit/dev/qiskit.transpiler.Layout.mdx index c9aa07737e7..1a190be3557 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.Layout.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.Layout.mdx @@ -280,6 +280,10 @@ python_api_name: qiskit.transpiler.Layout This is possible when the layout is a bijective mapping with the same source and target qubits (for instance, a “final\_layout” corresponds to a permutation of the physical circuit qubits). If this layout is a mapping from qubits to their new positions, the resulting permutation describes which qubits occupy the positions 0, 1, 2, etc. after applying the permutation. For example, suppose that the list of qubits is `[qr_0, qr_1, qr_2]`, and the layout maps `qr_0` to `2`, `qr_1` to `0`, and `qr_2` to `1`. In terms of positions in `qubits`, this maps `0` to `2`, `1` to `0` and `2` to `1`, with the corresponding permutation being `[1, 2, 0]`. + + **Parameters** + + **qubits** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit")*]*) – diff --git a/docs/api/qiskit/dev/qiskit.transpiler.PassManager.mdx b/docs/api/qiskit/dev/qiskit.transpiler.PassManager.mdx index c4aa14982e2..dba43441895 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.PassManager.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.PassManager.mdx @@ -34,6 +34,10 @@ python_api_name: qiskit.transpiler.PassManager **Raises** [**TranspilerError**](transpiler#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if a pass in passes is not a proper pass. + + **Return type** + + None ### draw @@ -74,6 +78,10 @@ python_api_name: qiskit.transpiler.PassManager **Raises** [**PassManagerError**](passmanager#qiskit.passmanager.PassManagerError "qiskit.passmanager.PassManagerError") – If the index is not found. + + **Return type** + + None ### replace @@ -85,6 +93,10 @@ python_api_name: qiskit.transpiler.PassManager * **index** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Pass index to replace, based on the position in passes(). * **passes** (*Task |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[Task]*) – A pass set to be added to the pass manager schedule. + + **Return type** + + None ### run diff --git a/docs/api/qiskit/dev/qiskit.transpiler.StagedPassManager.mdx b/docs/api/qiskit/dev/qiskit.transpiler.StagedPassManager.mdx index 89d3e883c66..d4926db0191 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.StagedPassManager.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.StagedPassManager.mdx @@ -74,6 +74,10 @@ python_api_name: qiskit.transpiler.StagedPassManager **Raises** [**TranspilerError**](transpiler#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if a pass in passes is not a proper pass. + + **Return type** + + None ### draw @@ -94,6 +98,10 @@ python_api_name: qiskit.transpiler.StagedPassManager **Raises** [**PassManagerError**](passmanager#qiskit.passmanager.PassManagerError "qiskit.passmanager.PassManagerError") – If the index is not found. + + **Return type** + + None ### replace @@ -105,6 +113,10 @@ python_api_name: qiskit.transpiler.StagedPassManager * **index** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Pass index to replace, based on the position in passes(). * **passes** (*BasePass |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[BasePass]*) – A pass set to be added to the pass manager schedule. + + **Return type** + + None ### run diff --git a/docs/api/qiskit/dev/qiskit.transpiler.TranspileLayout.mdx b/docs/api/qiskit/dev/qiskit.transpiler.TranspileLayout.mdx index 0bd2dbb9bab..3ae310e6d57 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.TranspileLayout.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.TranspileLayout.mdx @@ -87,6 +87,14 @@ python_api_name: qiskit.transpiler.TranspileLayout ## Attributes + **Parameters** + + * **initial\_layout** ([*Layout*](qiskit.transpiler.Layout "qiskit.transpiler.Layout")) – + * **input\_qubit\_mapping** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*circuit.Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – + * **final\_layout** ([*Layout*](qiskit.transpiler.Layout "qiskit.transpiler.Layout") *| None*) – + * **\_input\_qubit\_count** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – + * **\_output\_qubit\_list** (*List\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*] | None*) – + ### final\_layout diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Commuting2qGateRouter.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.Commuting2qGateRouter.mdx index 0c1a7918a67..d84ad1ab555 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Commuting2qGateRouter.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Commuting2qGateRouter.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter # Commuting2qGateRouter - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") A class to swap route one or more commuting gates to the coupling map. @@ -127,7 +127,7 @@ python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter ### run - + Run the pass by decomposing the nodes it applies on. **Parameters** @@ -151,7 +151,7 @@ python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter ### swap\_decompose - + Take an instance of `Commuting2qBlock` and map it to the coupling map. The mapping is done with the swap strategy. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.FilterOpNodes.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.FilterOpNodes.mdx index 121f41a342b..b743fb61b91 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.FilterOpNodes.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.FilterOpNodes.mdx @@ -95,6 +95,10 @@ python_api_name: qiskit.transpiler.passes.FilterOpNodes Run the RemoveBarriers pass on dag. + **Parameters** + + **dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit._accelerate.circuit.DAGCircuit")) – + **Return type** [*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit._accelerate.circuit.DAGCircuit") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx index 6f04201a621..4d26f36960c 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx @@ -72,6 +72,10 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations Output dag with LinearFunctions synthesized. + **Parameters** + + **dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit._accelerate.circuit.DAGCircuit")) – + **Return type** [*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit._accelerate.circuit.DAGCircuit") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDelay.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDelay.mdx index d8ae11df855..fa93bf9746e 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDelay.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDelay.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay # PadDelay - + Bases: `BasePadding` Padding idle time with Delay instructions. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.RXCalibrationBuilder.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.RXCalibrationBuilder.mdx index 8d68c68380a..20bf1cda267 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.RXCalibrationBuilder.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.RXCalibrationBuilder.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.RXCalibrationBuilder # RXCalibrationBuilder - + Bases: `CalibrationBuilder` Add single-pulse RX calibrations that are bootstrapped from the SX calibration. @@ -109,9 +109,14 @@ python_api_name: qiskit.transpiler.passes.RXCalibrationBuilder ### get\_calibration - + Generate RX calibration for the rotation angle specified in node\_op. + **Parameters** + + * **node\_op** ([*Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction")) – + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – + **Return type** [*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.schedule.Schedule") | [*ScheduleBlock*](qiskit.pulse.ScheduleBlock "qiskit.pulse.schedule.ScheduleBlock") @@ -147,9 +152,14 @@ python_api_name: qiskit.transpiler.passes.RXCalibrationBuilder ### supported - + Check if the calibration for SX gate exists and it’s a single DRAG pulse. + **Parameters** + + * **node\_op** ([*Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction")) – + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveBarriers.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveBarriers.mdx index b415bba4423..07b9e531abf 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveBarriers.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveBarriers.mdx @@ -87,6 +87,10 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers Run the RemoveBarriers pass on dag. + **Parameters** + + **dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit._accelerate.circuit.DAGCircuit")) – + **Return type** [*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit._accelerate.circuit.DAGCircuit") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.SolovayKitaev.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.SolovayKitaev.mdx index 7f4ebbb1a1d..86aa96d8e3a 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.SolovayKitaev.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.SolovayKitaev.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaev # SolovayKitaev - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Approximately decompose 1q gates to a discrete basis using the Solovay-Kitaev algorithm. @@ -154,7 +154,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaev ### run - + Run the `SolovayKitaev` pass on dag. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Split2QUnitaries.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.Split2QUnitaries.mdx index c8c7e558783..2602e182f08 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Split2QUnitaries.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Split2QUnitaries.mdx @@ -74,6 +74,10 @@ python_api_name: qiskit.transpiler.passes.Split2QUnitaries Run the Split2QUnitaries pass on dag. + **Parameters** + + **dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit._accelerate.circuit.DAGCircuit")) – + **Return type** [*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit._accelerate.circuit.DAGCircuit") diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.StarPreRouting.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.StarPreRouting.mdx index 5e2deaf3a37..60497bfbd72 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.StarPreRouting.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.StarPreRouting.mdx @@ -82,6 +82,11 @@ python_api_name: qiskit.transpiler.passes.StarPreRouting **Return type** List\[StarBlock] + + **Parameters** + + * **dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit._accelerate.circuit.DAGCircuit") *|*[*DAGDependency*](qiskit.dagcircuit.DAGDependency "qiskit.dagcircuit.dagdependency.DAGDependency")) – + * **min\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – ### execute diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.solovay_kitaev_synthesis.SolovayKitaevSynthesis.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.solovay_kitaev_synthesis.SolovayKitaevSynthesis.mdx index e607b474093..ce5dc8814ee 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.solovay_kitaev_synthesis.SolovayKitaevSynthesis.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.solovay_kitaev_synthesis.SolovayKitaevSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.solovay_kitaev_synthesis.Sol # SolovayKitaevSynthesis - + Bases: [`UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") A Solovay-Kitaev Qiskit unitary synthesis plugin. @@ -149,7 +149,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.solovay_kitaev_synthesis.Sol ### run - + Run synthesis for the given unitary matrix **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx b/docs/api/qiskit/dev/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx index 608ce54db7b..e3c4457ca2d 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx @@ -20,6 +20,12 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl Get a stage + **Parameters** + + * **stage\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **plugin\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **pm\_config** ([*PassManagerConfig*](qiskit.transpiler.PassManagerConfig "qiskit.transpiler.passmanager_config.PassManagerConfig")) – + **Return type** [*PassManager*](qiskit.transpiler.PassManager "qiskit.transpiler.passmanager.PassManager") diff --git a/docs/api/qiskit/dev/qiskit.visualization.pass_manager_drawer.mdx b/docs/api/qiskit/dev/qiskit.visualization.pass_manager_drawer.mdx index f9d84c0627d..7b4bd2af926 100644 --- a/docs/api/qiskit/dev/qiskit.visualization.pass_manager_drawer.mdx +++ b/docs/api/qiskit/dev/qiskit.visualization.pass_manager_drawer.mdx @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pass_manager_drawer # qiskit.visualization.pass\_manager\_drawer - + Draws the pass manager. This function needs [pydot](https://github.com/pydot/pydot), which in turn needs [Graphviz](https://www.graphviz.org/) to be installed. diff --git a/docs/api/qiskit/dev/qiskit.visualization.plot_bloch_multivector.mdx b/docs/api/qiskit/dev/qiskit.visualization.plot_bloch_multivector.mdx index 9c336526e3c..9a4f36d5470 100644 --- a/docs/api/qiskit/dev/qiskit.visualization.plot_bloch_multivector.mdx +++ b/docs/api/qiskit/dev/qiskit.visualization.plot_bloch_multivector.mdx @@ -31,7 +31,7 @@ python_api_name: qiskit.visualization.plot_bloch_multivector **Return type** - [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.2)") + [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.3)") **Raises** diff --git a/docs/api/qiskit/dev/qiskit.visualization.plot_bloch_vector.mdx b/docs/api/qiskit/dev/qiskit.visualization.plot_bloch_vector.mdx index 509a1d362a5..154f2dc5286 100644 --- a/docs/api/qiskit/dev/qiskit.visualization.plot_bloch_vector.mdx +++ b/docs/api/qiskit/dev/qiskit.visualization.plot_bloch_vector.mdx @@ -19,7 +19,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector * **bloch** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[double]*) – array of three elements where \[\, \, \] (Cartesian) or \[\, \, \] (spherical in radians) \ is inclination angle from +z direction \ is azimuth from +x direction * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – a string that represents the plot title - * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.2)")) – An Axes to use for rendering the bloch sphere + * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.3)")) – An Axes to use for rendering the bloch sphere * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – Figure size in inches. Has no effect is passing `ax`. * **coord\_type** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – a string that specifies coordinate type for bloch (Cartesian or spherical), default is Cartesian * **font\_size** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Font size. @@ -30,7 +30,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector **Return type** - [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.2)") + [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.3)") **Raises** diff --git a/docs/api/qiskit/dev/qiskit.visualization.plot_distribution.mdx b/docs/api/qiskit/dev/qiskit.visualization.plot_distribution.mdx index c5a4849a65c..026f9339cd1 100644 --- a/docs/api/qiskit/dev/qiskit.visualization.plot_distribution.mdx +++ b/docs/api/qiskit/dev/qiskit.visualization.plot_distribution.mdx @@ -24,7 +24,7 @@ python_api_name: qiskit.visualization.plot_distribution * **legend** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – A list of strings to use for labels of the data. The number of entries must match the length of data (if data is a list or 1 if it’s a dict) * **bar\_labels** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Label each bar in histogram with probability value. * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – A string to use for the plot title - * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.2)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. + * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.3)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – file path to save image to. **Returns** diff --git a/docs/api/qiskit/dev/qiskit.visualization.plot_histogram.mdx b/docs/api/qiskit/dev/qiskit.visualization.plot_histogram.mdx index 7ffc4807fc7..4460b449673 100644 --- a/docs/api/qiskit/dev/qiskit.visualization.plot_histogram.mdx +++ b/docs/api/qiskit/dev/qiskit.visualization.plot_histogram.mdx @@ -24,7 +24,7 @@ python_api_name: qiskit.visualization.plot_histogram * **legend** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – A list of strings to use for labels of the data. The number of entries must match the length of data (if data is a list or 1 if it’s a dict) * **bar\_labels** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Label each bar in histogram with counts value. * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – A string to use for the plot title - * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.2)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. + * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.3)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – file path to save image to. **Returns** diff --git a/docs/api/qiskit/dev/qiskit.visualization.plot_state_city.mdx b/docs/api/qiskit/dev/qiskit.visualization.plot_state_city.mdx index 81541f64d5e..eea22b23dfb 100644 --- a/docs/api/qiskit/dev/qiskit.visualization.plot_state_city.mdx +++ b/docs/api/qiskit/dev/qiskit.visualization.plot_state_city.mdx @@ -22,8 +22,8 @@ python_api_name: qiskit.visualization.plot_state_city * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – Figure size in inches. * **color** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – A list of len=2 giving colors for real and imaginary components of matrix elements. * **alpha** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Transparency value for bars - * **ax\_real** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.2)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_imag only the real component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. - * **ax\_imag** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.2)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_real only the imaginary component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. + * **ax\_real** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.3)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_imag only the real component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. + * **ax\_imag** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.3)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_real only the imaginary component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. **Returns** @@ -31,7 +31,7 @@ python_api_name: qiskit.visualization.plot_state_city **Return type** - [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.2)") + [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.3)") **Raises** diff --git a/docs/api/qiskit/dev/qiskit.visualization.plot_state_hinton.mdx b/docs/api/qiskit/dev/qiskit.visualization.plot_state_hinton.mdx index f13cbd3ce7e..893fc22f0c0 100644 --- a/docs/api/qiskit/dev/qiskit.visualization.plot_state_hinton.mdx +++ b/docs/api/qiskit/dev/qiskit.visualization.plot_state_hinton.mdx @@ -21,8 +21,8 @@ python_api_name: qiskit.visualization.plot_state_hinton * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – a string that represents the plot title * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – Figure size in inches. * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – file path to save image to. - * **ax\_real** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.2)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_imag only the real component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. - * **ax\_imag** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.2)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_imag only the real component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. + * **ax\_real** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.3)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_imag only the real component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. + * **ax\_imag** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.3)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_imag only the real component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. **Returns** @@ -30,7 +30,7 @@ python_api_name: qiskit.visualization.plot_state_hinton **Return type** - [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.2)") + [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.3)") **Raises** diff --git a/docs/api/qiskit/dev/qiskit.visualization.plot_state_paulivec.mdx b/docs/api/qiskit/dev/qiskit.visualization.plot_state_paulivec.mdx index 344a7f35de3..046f69e0902 100644 --- a/docs/api/qiskit/dev/qiskit.visualization.plot_state_paulivec.mdx +++ b/docs/api/qiskit/dev/qiskit.visualization.plot_state_paulivec.mdx @@ -28,7 +28,7 @@ $$ * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – a string that represents the plot title * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – Figure size in inches. * **color** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Color of the coefficient value bars. - * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.2)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. + * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.3)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. **Returns** @@ -36,7 +36,7 @@ $$ **Return type** - [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.2)") + [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.3)") **Raises** diff --git a/docs/api/qiskit/dev/qiskit.visualization.plot_state_qsphere.mdx b/docs/api/qiskit/dev/qiskit.visualization.plot_state_qsphere.mdx index c4cc45ec67e..4119e7281d6 100644 --- a/docs/api/qiskit/dev/qiskit.visualization.plot_state_qsphere.mdx +++ b/docs/api/qiskit/dev/qiskit.visualization.plot_state_qsphere.mdx @@ -17,7 +17,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere * **state** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") *or ndarray*) – an N-qubit quantum state. * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – Figure size in inches. - * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.2)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. + * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.3)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. * **show\_state\_labels** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – An optional boolean indicating whether to show labels for each basis state. * **show\_state\_phases** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – An optional boolean indicating whether to show the phase for each basis state. * **use\_degrees** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – An optional boolean indicating whether to use radians or degrees for the phase values in the plot. @@ -28,7 +28,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere **Return type** - [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.2)") + [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.3)") **Raises** diff --git a/docs/api/qiskit/dev/qiskit.visualization.timeline_drawer.mdx b/docs/api/qiskit/dev/qiskit.visualization.timeline_drawer.mdx index 144d36196cd..4bb9c03f6cd 100644 --- a/docs/api/qiskit/dev/qiskit.visualization.timeline_drawer.mdx +++ b/docs/api/qiskit/dev/qiskit.visualization.timeline_drawer.mdx @@ -262,6 +262,36 @@ python_api_name: qiskit.visualization.timeline_drawer * **layout.time\_axis\_map** – Callback function that determines the layout of horizontal axis labels. See `layouts` for more details. No default layout is set. (default None). + * **program** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")) – + + * **style** ([*Dict*](https://docs.python.org/3/library/typing.html#typing.Dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")*] | None*) – + + * **time\_range** ([*Tuple*](https://docs.python.org/3/library/typing.html#typing.Tuple "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – + + * **disable\_bits** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[Bits]*) – + + * **show\_clbits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – + + * **idle\_wires** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – + + * **plot\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – + + * **show\_delays** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – + + * **show\_labels** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + + * **plotter** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + + * **axis** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)") *| None*) – + + * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + + * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.target.Target") *| None*) – + + * **show\_idle** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – + + * **show\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – + **Examples** To visualize a scheduled circuit program, you can call this function with set of control arguments. Most of appearance of the output image can be controlled by the stylesheet. diff --git a/docs/api/qiskit/dev/qpy.mdx b/docs/api/qiskit/dev/qpy.mdx index 5b3f235c823..74eedd8d8da 100644 --- a/docs/api/qiskit/dev/qpy.mdx +++ b/docs/api/qiskit/dev/qpy.mdx @@ -47,15 +47,16 @@ with open('twenty_bells.qpy', 'wb') as fd: and then loading that file will return a list with all the circuits -> **with open(‘twenty\_bells.qpy’, ‘rb’) as fd:** -> -> twenty\_new\_bells = qpy.load(fd) +```python +with open('twenty_bells.qpy', 'rb') as fd: + twenty_new_bells = qpy.load(fd) +``` ## API documentation ### load - + Load a QPY binary file This function is used to load a serialized QPY Qiskit program file and create [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") objects or [`ScheduleBlock`](qiskit.pulse.ScheduleBlock "qiskit.pulse.schedule.ScheduleBlock") objects from its contents. For example: @@ -100,7 +101,7 @@ and then loading that file will return a list with all the circuits ### dump - + Write QPY binary data to a file This function is used to save a circuit to a file for later use or transfer between machines. The QPY format is backwards compatible and can be loaded with future versions of Qiskit. @@ -173,6 +174,8 @@ These functions will raise a custom subclass of [`QiskitError`](exceptions#qiski ### QpyError + Bases: [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + Errors raised by the qpy module. Set the error message. @@ -183,6 +186,8 @@ When a lower-than-maximum target QPY version is set for serialization, but the o ### UnsupportedFeatureForVersion + Bases: [`QpyError`](#qiskit.qpy.QpyError "qiskit.qpy.exceptions.QpyError") + QPY error raised when the target dump version is too low for a feature that is present in the object to be serialized. **Parameters** @@ -225,6 +230,8 @@ If a feature being loaded is deprecated in the corresponding qiskit release, QPY ### QPYLoadingDeprecatedFeatureWarning + Bases: [`QiskitWarning`](exceptions#qiskit.exceptions.QiskitWarning "qiskit.exceptions.QiskitWarning") + Visible deprecation warning for QPY loading functions without a stable point in the call stack. @@ -768,10 +775,10 @@ with pulse.build() as schedule: pulse.play(pulse.Gaussian(160, 0.1, 40), pulse.DriveChannel(0)) with open('schedule.qpy', 'wb') as fd: - qpy.dump(qc, fd) + qpy.dump(schedule, fd) with open('schedule.qpy', 'rb') as fd: - new_qc = qpy.load(fd)[0] + new_schedule = qpy.load(fd)[0] ``` Note that circuit and schedule block are serialized and deserialized through the same QPY interface. Input data type is implicitly analyzed and no extra option is required to save the schedule block. diff --git a/docs/api/qiskit/dev/quantum_info.mdx b/docs/api/qiskit/dev/quantum_info.mdx index 1b36f1724f3..85e8b284ab5 100644 --- a/docs/api/qiskit/dev/quantum_info.mdx +++ b/docs/api/qiskit/dev/quantum_info.mdx @@ -836,7 +836,7 @@ $$ ### hellinger\_fidelity - + Computes the Hellinger fidelity between two counts distributions. The fidelity is defined as $\left(1-H^{2}\right)^{2}$ where H is the Hellinger distance. This value is bounded in the range \[0, 1]. diff --git a/docs/api/qiskit/dev/scheduler.mdx b/docs/api/qiskit/dev/scheduler.mdx index 8e8335431c4..50608631926 100644 --- a/docs/api/qiskit/dev/scheduler.mdx +++ b/docs/api/qiskit/dev/scheduler.mdx @@ -23,6 +23,8 @@ A circuit scheduler compiles a circuit program to a pulse program. ### ScheduleConfig + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Configuration for pulse scheduling. Container for information needed to schedule a QuantumCircuit into a pulse Schedule. diff --git a/docs/api/qiskit/dev/synthesis.mdx b/docs/api/qiskit/dev/synthesis.mdx index 04ef067ed4f..e43dc13d3d3 100644 --- a/docs/api/qiskit/dev/synthesis.mdx +++ b/docs/api/qiskit/dev/synthesis.mdx @@ -858,6 +858,13 @@ The Approximate Quantum Compiler is available as the module [`qiskit.synthesis.u └───┘ └───┘ ``` + **Parameters** + + * **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **num\_target\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – + **Return type** [QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") diff --git a/docs/api/qiskit/dev/transpiler.mdx b/docs/api/qiskit/dev/transpiler.mdx index 7fdcbece3d6..f381b75ab05 100644 --- a/docs/api/qiskit/dev/transpiler.mdx +++ b/docs/api/qiskit/dev/transpiler.mdx @@ -453,7 +453,7 @@ qc.measure([0], [0]) qc.draw(output='mpl') ``` -![../\_images/transpiler-4.png](/images/api/qiskit/dev/transpiler-4.png) +![../\_images/transpiler-8.png](/images/api/qiskit/dev/transpiler-8.png) We have $H$, $X$, and controlled-$P$ gates, none of which are in our device’s basis gate set, and thus must be translated. We can transpile the circuit to show what it will look like in the native gate set of the target IBM Quantum device (the [`GenericBackendV2`](qiskit.providers.fake_provider.GenericBackendV2 "qiskit.providers.fake_provider.GenericBackendV2") class generates a fake backend with a specified number of qubits for test purposes): @@ -476,7 +476,7 @@ qc_basis = transpile(qc, backend) qc_basis.draw(output='mpl') ``` -![../\_images/transpiler-5.png](/images/api/qiskit/dev/transpiler-5.png) +![../\_images/transpiler-9.png](/images/api/qiskit/dev/transpiler-9.png) A few things to highlight. First, the circuit has gotten longer with respect to the original. This can be verified by checking the depth of both circuits: @@ -517,7 +517,7 @@ It is important to highlight two special cases: ccx_circ.decompose().draw(output='mpl') ``` - ![../\_images/transpiler-6.png](/images/api/qiskit/dev/transpiler-6.png) + ![../\_images/transpiler-12.png](/images/api/qiskit/dev/transpiler-12.png) For every Toffoli gate in a quantum circuit, the hardware may execute up to six CNOT gates, and a handful of single-qubit gates. From this example, it should be clear that any algorithm that makes use of multiple Toffoli gates will end up as a circuit with large depth and will therefore be appreciably affected by noise and gate errors. @@ -559,7 +559,7 @@ ghz.measure(range(3), range(3)) ghz.draw(output='mpl') ``` -![../\_images/transpiler-7.png](/images/api/qiskit/dev/transpiler-7.png) +![../\_images/transpiler-13.png](/images/api/qiskit/dev/transpiler-13.png) * **Layout Using Optimization Level 0** @@ -579,7 +579,7 @@ ghz.draw(output='mpl') > plot_circuit_layout(new_circ_lv0, backend) > ``` > - > ![../\_images/transpiler-8.png](/images/api/qiskit/dev/transpiler-8.png) + > ![../\_images/transpiler-14.png](/images/api/qiskit/dev/transpiler-14.png) * **Layout Using Optimization Level 3** @@ -599,7 +599,7 @@ ghz.draw(output='mpl') > plot_circuit_layout(new_circ_lv3, backend) > ``` > - > ![../\_images/transpiler-9.png](/images/api/qiskit/dev/transpiler-9.png) + > ![../\_images/transpiler-15.png](/images/api/qiskit/dev/transpiler-15.png) It is possible to override automatic layout selection by specifying an initial layout. To do so we can pass a list of integers to [`qiskit.compiler.transpile()`](compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") via the initial\_layout keyword argument, where the index labels the virtual qubit in the circuit and the corresponding value is the label for the physical qubit to map onto: @@ -624,7 +624,7 @@ my_ghz = transpile(ghz, backend, initial_layout=[3, 4, 2]) plot_circuit_layout(my_ghz, backend) ``` -![../\_images/transpiler-10.png](/images/api/qiskit/dev/transpiler-10.png) +![../\_images/transpiler-16.png](/images/api/qiskit/dev/transpiler-16.png) @@ -636,7 +636,7 @@ However, as with many important things in life, finding the optimal swap mapping In order to highlight this, we run a GHZ circuit 100 times, using a “bad” (disconnected) `initial_layout` in a heavy hex coupling map: -![../\_images/transpiler-11.png](/images/api/qiskit/dev/transpiler-11.png) +![../\_images/transpiler-17.png](/images/api/qiskit/dev/transpiler-17.png) ```python import matplotlib.pyplot as plt @@ -668,7 +668,7 @@ plt.xlabel('Depth', fontsize=14) plt.ylabel('Counts', fontsize=14); ``` -![../\_images/transpiler-12.png](/images/api/qiskit/dev/transpiler-12.png) +![../\_images/transpiler-18.png](/images/api/qiskit/dev/transpiler-18.png) This distribution is quite wide, signaling the difficulty the swap mapper is having in computing the best mapping. Most circuits will have a distribution of depths, perhaps not as wide as this one, due to the stochastic nature of the default swap mapper. Of course, we want the best circuit we can get, especially in cases where the depth is critical to success or failure. The [`SabreSwap`](qiskit.transpiler.passes.SabreSwap "qiskit.transpiler.passes.SabreSwap") pass will by default by run its algorithm in parallel with multiple seed values and select the output which uses the fewest swaps. If you would like to increase the number of trials [`SabreSwap`](qiskit.transpiler.passes.SabreSwap "qiskit.transpiler.passes.SabreSwap") runs you can refer to [Working with Preset Pass Managers](#working-with-preset-pass-managers) and modify the `routing` stage with a custom instance of [`SabreSwap`](qiskit.transpiler.passes.SabreSwap "qiskit.transpiler.passes.SabreSwap") with a larger value for the `trials` argument. @@ -684,7 +684,7 @@ Decomposing quantum circuits into the basis gate set of the target device, and t The output from [`transpile()`](compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") varies due to the stochastic swap mapper. So the numbers below will likely change each time you run the code. -![../\_images/transpiler-13.png](/images/api/qiskit/dev/transpiler-13.png) +![../\_images/transpiler-19.png](/images/api/qiskit/dev/transpiler-19.png) ```python import matplotlib.pyplot as plt @@ -720,7 +720,7 @@ fig.tight_layout() plt.show() ``` -![../\_images/transpiler-14.png](/images/api/qiskit/dev/transpiler-14.png) +![../\_images/transpiler-20.png](/images/api/qiskit/dev/transpiler-20.png) @@ -728,7 +728,7 @@ plt.show() After the circuit has been translated to the target basis, mapped to the device, and optimized, a scheduling phase can be applied to optionally account for all the idle time in the circuit. At a high level, the scheduling can be thought of as inserting delays into the circuit to account for idle time on the qubits between the execution of instructions. For example, if we start with a circuit such as: -![../\_images/transpiler-15.png](/images/api/qiskit/dev/transpiler-15.png) +![../\_images/transpiler-21.png](/images/api/qiskit/dev/transpiler-21.png) we can then call [`transpile()`](compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") on it with `scheduling_method` set: @@ -746,11 +746,11 @@ circ = transpile(ghz, backend, scheduling_method="asap") circ.draw(output='mpl') ``` -![../\_images/transpiler-16.png](/images/api/qiskit/dev/transpiler-16.png) +![../\_images/transpiler-22.png](/images/api/qiskit/dev/transpiler-22.png) You can see here that the transpiler inserted [`Delay`](circuit#qiskit.circuit.Delay "qiskit.circuit.Delay") instructions to account for idle time on each qubit. To get a better idea of the timing of the circuit we can also look at it with the `timeline.draw()` function: -![../\_images/transpiler-17.png](/images/api/qiskit/dev/transpiler-17.png) +![../\_images/transpiler-23.png](/images/api/qiskit/dev/transpiler-23.png) The scheduling of a circuit involves two parts: analysis and constraint mapping, followed by a padding pass. The first part requires running a scheduling analysis pass such as `ALAPSchedulingAnalysis` or `ASAPSchedulingAnalysis` which analyzes the circuit and records the start time of each instruction in the circuit using a scheduling algorithm (“as late as possible” for `ALAPSchedulingAnalysis` and “as soon as possible” for `ASAPSchedulingAnalysis`) in the property set. Once the circuit has an initial scheduling, additional passes can be run to account for any timing constraints on the target backend, such as alignment constraints. This is typically done with the [`ConstrainedReschedule`](qiskit.transpiler.passes.ConstrainedReschedule "qiskit.transpiler.passes.ConstrainedReschedule") pass which will adjust the scheduling set in the property set to the constraints of the target backend. Once all the scheduling and adjustments/rescheduling are finished, a padding pass, such as [`PadDelay`](qiskit.transpiler.passes.PadDelay "qiskit.transpiler.passes.PadDelay") or [`PadDynamicalDecoupling`](qiskit.transpiler.passes.PadDynamicalDecoupling "qiskit.transpiler.passes.PadDynamicalDecoupling") is run to insert the instructions into the circuit, which completes the scheduling. @@ -944,6 +944,8 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor #### TranspilerError + Bases: [`TranspilerAccessError`](#qiskit.transpiler.TranspilerAccessError "qiskit.transpiler.exceptions.TranspilerAccessError") + Exceptions raised during transpilation. Set the error message. @@ -952,6 +954,8 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor #### TranspilerAccessError + Bases: [`PassManagerError`](passmanager#qiskit.passmanager.PassManagerError "qiskit.passmanager.exceptions.PassManagerError") + DEPRECATED: Exception of access error in the transpiler passes. Set the error message. @@ -960,6 +964,8 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor #### CouplingError + Bases: [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + Base class for errors raised by the coupling graph object. Set the error message. @@ -968,6 +974,8 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor #### LayoutError + Bases: [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + Errors raised by the layout object. Set the error message. @@ -976,6 +984,8 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor #### CircuitTooWideForTarget + Bases: [`TranspilerError`](#qiskit.transpiler.TranspilerError "qiskit.transpiler.exceptions.TranspilerError") + Error raised if the circuit is too wide for the target. Set the error message. @@ -984,6 +994,8 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor #### InvalidLayoutError + Bases: [`TranspilerError`](#qiskit.transpiler.TranspilerError "qiskit.transpiler.exceptions.TranspilerError") + Error raised when a user provided layout is invalid. Set the error message. diff --git a/docs/api/qiskit/dev/transpiler_plugins.mdx b/docs/api/qiskit/dev/transpiler_plugins.mdx index aa6f0459803..fd1d437c90e 100644 --- a/docs/api/qiskit/dev/transpiler_plugins.mdx +++ b/docs/api/qiskit/dev/transpiler_plugins.mdx @@ -116,7 +116,7 @@ There isn’t a limit to the number of plugins a single package can include as l ### passmanager\_stage\_plugins - + Return a dict with, for each stage name, the class type of the plugin. This function is useful for getting more information about a plugin: diff --git a/docs/api/qiskit/dev/utils.mdx b/docs/api/qiskit/dev/utils.mdx index caa9aa30d21..ebbd84a949a 100644 --- a/docs/api/qiskit/dev/utils.mdx +++ b/docs/api/qiskit/dev/utils.mdx @@ -20,7 +20,7 @@ python_api_name: qiskit.utils ### add\_deprecation\_to\_docstring - + Dynamically insert the deprecation message into `func`’s docstring. **Parameters** @@ -29,6 +29,10 @@ python_api_name: qiskit.utils * **msg** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The full deprecation message. * **since** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The version the deprecation started at. * **pending** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Is the deprecation still pending? + + **Return type** + + None ### deprecate\_arg @@ -59,26 +63,6 @@ python_api_name: qiskit.utils Callable -### deprecate\_arguments - - - Deprecated. Instead, use @deprecate\_arg. - - **Parameters** - - * **kwarg\_map** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None]*) – A dictionary of the old argument name to the new name. - * **category** ([*Type*](circuit_classical#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type")*\[*[*Warning*](https://docs.python.org/3/library/exceptions.html#Warning "(in Python v3.13)")*]*) – Usually either DeprecationWarning or PendingDeprecationWarning. - * **since** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The version the deprecation started at. Only Optional for backwards compatibility - this should always be set. If the deprecation is pending, set the version to when that started; but later, when switching from pending to deprecated, update since to the new version. - - **Returns** - - The decorated callable. - - **Return type** - - Callable - - ### deprecate\_func @@ -107,27 +91,6 @@ python_api_name: qiskit.utils Callable -### deprecate\_function - - - Deprecated. Instead, use @deprecate\_func. - - **Parameters** - - * **msg** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Warning message to emit. - * **stacklevel** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The warning stacklevel to use, defaults to 2. - * **category** ([*Type*](circuit_classical#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type")*\[*[*Warning*](https://docs.python.org/3/library/exceptions.html#Warning "(in Python v3.13)")*]*) – Usually either DeprecationWarning or PendingDeprecationWarning. - * **since** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The version the deprecation started at. Only Optional for backwards compatibility - this should always be set. If the deprecation is pending, set the version to when that started; but later, when switching from pending to deprecated, update since to the new version. - - **Returns** - - The decorated, deprecated callable. - - **Return type** - - Callable - - ## SI unit conversion ### apply\_prefix @@ -156,6 +119,11 @@ python_api_name: qiskit.utils [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If the `units` aren’t recognized. + **Parameters** + + * **value** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *|*[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")) – + * **unit** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + **Return type** [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") | [ParameterExpression](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") @@ -198,6 +166,11 @@ python_api_name: qiskit.utils * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If the `value` is out of range. * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If the `value` is not real number. + **Parameters** + + * **value** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + * **decimal** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – + **Return type** [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)"), [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")] @@ -254,7 +227,7 @@ A helper function for calling a custom function with Python [`ProcessPoolExecuto ### parallel\_map - + Parallel execution of a mapping of values to the function task. This is functionally equivalent to: ```python @@ -512,6 +485,8 @@ from qiskit.utils import LazyImportTester #### LazyDependencyManager + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)") + A mananger for some optional features that are expensive to import, or to verify the existence of. These objects can be used as Booleans, such as `if x`, and will evaluate `True` if the dependency they test for is available, and `False` if not. The presence of the dependency will only be tested when the Boolean is evaluated, so it can be used as a runtime test in functions and methods without requiring an import-time test. @@ -619,11 +594,17 @@ from qiskit.utils import LazyImportTester #### LazyImportTester + Bases: [`LazyDependencyManager`](#qiskit.utils.LazyDependencyManager "qiskit.utils.lazy_tester.LazyDependencyManager") + A lazy dependency tester for importable Python modules. Any required objects will only be imported at the point that this object is tested for its Boolean value. **Parameters** - **name\_map\_or\_modules** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*Dict*](https://docs.python.org/3/library/typing.html#typing.Dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]] |* [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – if a name map, then a dictionary where the keys are modules or packages, and the values are iterables of names to try and import from that module. It should be valid to write `from import , , ...`. If simply a string or iterable of strings, then it should be valid to write `import ` for each of them. + * **name\_map\_or\_modules** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*Dict*](https://docs.python.org/3/library/typing.html#typing.Dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]] |* [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – if a name map, then a dictionary where the keys are modules or packages, and the values are iterables of names to try and import from that module. It should be valid to write `from import , , ...`. If simply a string or iterable of strings, then it should be valid to write `import ` for each of them. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **callback** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.13)")*\[\[*[*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*], None] | None*) – + * **install** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **msg** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – **Raises** @@ -633,11 +614,17 @@ from qiskit.utils import LazyImportTester #### LazySubprocessTester + Bases: [`LazyDependencyManager`](#qiskit.utils.LazyDependencyManager "qiskit.utils.lazy_tester.LazyDependencyManager") + A lazy checker that a command-line tool is available. The command will only be run once, at the point that this object is checked for its Boolean value. **Parameters** - **command** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – the strings that make up the command to be run. For example, `["pdflatex", "-version"]`. + * **command** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – the strings that make up the command to be run. For example, `["pdflatex", "-version"]`. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **callback** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.13)")*\[\[*[*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*], None] | None*) – + * **install** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **msg** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – **Raises** diff --git a/docs/api/qiskit/dev/visualization.mdx b/docs/api/qiskit/dev/visualization.mdx index 10087c14417..61dd037c689 100644 --- a/docs/api/qiskit/dev/visualization.mdx +++ b/docs/api/qiskit/dev/visualization.mdx @@ -224,6 +224,8 @@ You can find code examples for each visualization functions on the individual fu ### VisualizationError + Bases: [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + For visualization specific errors. Set the error message. diff --git a/public/api/qiskit/dev/objects.inv b/public/api/qiskit/dev/objects.inv index 7a1afc600ccdb374918777287e6e3471b2be3ba9..d3ca66a006eb1973c3cb26bc7e420442127b5f48 100644 GIT binary patch delta 2370 zcmV-I3BC5}*aYC%1c0;wrUZYgLS>;k6baW2t*vSSJ>mP`D)ng7T-g@APf|@v?bM$GlOeQA_s=G!N z0?;s(>Gjp}b}>1>x((KxU!2?pD}A|}e+yNbT}N@9p5NVmUYsmL_0E45lliAF=l7v{ z=N~U`f_2WW&Vvm+pMSgkbbS?}_Vs*rc5)j`_`j3j!vEjT^KZA|)$ww2JHNQTy*U3E zs(E#C`}KP9SFoX17uWOPx<8+tUQBMotK@ukdV4*coG-3}HP0`CRld!x!*llS?DFI) zyo$`fMHR@+WO?}^Ilq6LUoV19U7k!nUN3^(VENa@$s|VY=JO=Hm0aE|udY9yo`)-b zyF9r%JHI*!RlGe}-rincUj+Yzx7Rn9!8%`0PG%P;v(Ler_aFQkJ5-=F#c8wi%Kr}i zQJ`JY9&h4Ocp>E;rR0}5K1sZCl@!CPS4ltmB8N`sL@NcuKUaTv$Ej63D-bFQbfEpx z6jk`A`HM%Vh6Q&;iq)P}$+|#4I+H&T4GS(^RfS_p(iS{XWTm%E$9kbce;Et4Jiii< zCzG0uA?jf*3!G*dZWtBe_XbXmIHC(u5#n#nGbpQiP zDt_b*$*O=~Pf_xt@8~IzFL)J*FVy@D&*g4|3miz$Xj$+pvc>d3yMPuBA-*z2 zpsr)o8^1w2vd&lkP1nq~4=FB2WwrjFb-tqQdK)>d8;pMu%GRT0z3PTX6OsH6&L|ZA ztHI?hjf~nv-Rx0T?YAPl&DS^;P&`%#O4yVDS)tSbDJ4$D6aGmjZcBE|p9X#;hEFp)G#O_^Nqunx}UI?yG_o>EL}zX7~WT#6@Y2U#}@LZRhpG9_w+%+pB}B_)n5 zUgcXh>1%&4u12}#Y*b{bCT_|e>b~8AEf8ZVA6!a;Vq44TRs#i0#5UzVZKGPSCQ87q z(UYMLO0l!aSp(Suwdn$=?GnjAQtWNM8?z-oIkEw4qXZzy*7&E4RYy$b=c5IF#0Ab) zxRI3?o+S-AdM-UTtWvt5-4$d@XxBx_hZH++9|eDoh>~FP7qZrVr8aUdp3buh7msL# zB{ZJa1!H^5R!I{!V(T*OitvW-e@62|waK$F{kUd5T9WNPMO9vuUG^gt$6(AO`i?!e zs3NE6I~G|tFe=gpLe>PDOSDP*h*sZmwjNzS{Eb(YDO z^t>`KnB^wBU6KDJTU253_L}OArBSubYX0!I!bih5^p7Z-{Ne9be5bsEXz*tKZB*id zwBu!=xoclG&$W5=l(&o^$2WO6&mQw)tAT$>f&#U`B|U&$!s9U~KXQP9XP4nB|MiT}wVv~#XNhD$b! z$#BtnJ*qd;r4plHSs~W#kI2O(%J#J6TYypisPz3?lBOR%mIgQMdA!P{FGNhWpdBOC z^+8BO&$9I}GJq63`#1s5*_|DaV|{apl5>s(`H0Bk|M7UKU; z9WYZvSrG~30;9C9dr|e|YhHhRrzQG>RGX2&8dZlKUbo|G*3wCo_G+R!2`v%PB$I4( z!>mz&qztIDAx7}VzE+gF-(GXcvK}bey!!2L%}|QfCA}j5sEcIGio~L?6kDTMkC(;! zfYnjuAOQtTjB(!bs?Q|315E1*UVmM5R{!8Np41+W}C0cBmHc&8E>@CusghMQpYs)@_KfDdVaEa!$0n=cW}9hWl>IlEk$u7 z*pzL8Uvje*EP0Gya%O+VeDe9?JURJteewDB{QByRVOx8`_q^x&o29$Sy8bt&+GDOg zmb9h5>!{f&byg=+9}@Lv{In-)+|-#dJ*dP|(SB>j@$9ISx_i;VY2Ew<6@>0oEbVx$ zqYL3TY*as9ZBUjq(+aIFO`{Eald4Pw95qV+#X)G3YC$+RO-~NiC~`y0krI@Wr>y=C z%$KeV0Zlp=qFW(^;J6l?vOX`V@JOV*VKX;lM89jzP&*yix*ScXZ)-_{EAdv+^6qIA zmpi;7j|Zvm(JF{Lez!FZ0Yd=-(3h8b4go3`36r92_;%dW4Yz@e6%Z3yTYNsFyQgKh zyAA;p0Ro>}x6ls(Tmc*taojWHT#8SQ*PA4t_`G;~%8du4734U}_IwA`btGlv=3Al!|z@Z{SqUkYYNo0l{a0YL)(p|^Ju o0Sy8Ixd^w06afkW0^L=Yk`)2l1qL0{81c0;wrUZYXvKQmt5Jf5*qtndbK=dlK+5{B^q3~rRE0|ICPJS^t=XeUtQJ=pe&Ysc^C=p3{qNj9ih|3J)*A9Gmo)+1dM)TRoZ zqfe7%GC5gL-8HHZfQG3|udkN3i^=)bZLsG2;^Zz^>C4^xTd30PI*Nbm^!)Dj^WtO~ zs&}@S%s+iOzYo#GR0ujjL~liOgz|D6OE{{McSf4dE@ zj+c|$`Nj3^#relj&8w5!uh)yef(^a8xSj{s{rT+lVsaZ^CFir#+w1A%d~qGDd43VB z@@;k{&(n)0_~FaJQbJ13n}*~CBMXZP2!cSq!?bkO8S4%7ddo7XLczV{<*?C zPOaiuflyJP1MLW>sKP(ZpIACIEVwIDtoEcz)&=^}nQek-Sa9hwE*w*mw%~~(E4^hp z)(aK-%UG!837vpEnbd3yXV}k6{#2kX7`D}L z;g%I!$RpJO3@oYmkvAl(0)9P3$&bFH$4qwB(4^#{K*hmC(j+xya>2toIG5`{mn3^iF|GXu@HTNNo}?{n-7E-&mZ!;- zs1Y(xCsBWtlsF@Km2cTBv%R<)<(9Kik*S)vDSN24-eYQdT)0k=j^hB_$4&L(FKWDC@$3!t`3Bm+sYxA|_&))eK)2C$71fFxVvpE6b* zF`1u_7WfetI9uUHR$l3rH00>H^xUvY>4J7wkS%|qT^A)EQtZ5a6gVPEg2`XVTKkpS z$hmkr&njFzq7|0Vcv=^XZDv~~P1uO7%dk7i8@~S;%@5Tk&&Kp?p7m%+w)+%Sc~N%R zk5n9kF^}jw_Sm9|oTBeoWZl51NE--Q6KF2cCha3yeaG2)bp7x*UR9=S)q*WL-TSRT zvWR~<`zy3*NT@uca(gVR)DhP^oY6^w(Xr5D35wnaUGGDy_d(J7(CVqp41Y09yKd_i z)Pk(F(kME6!jI7N%D`Zjo9uQ){*!D`g~i)zsyCKK)i$g7!`})Y4d2i|qGmxbo8ec3$M=G9Z)GJ<~`-{j#ud(4Zi1||s#)B>0E#CHjg$DI7! z;eyaLnbCs9v=y_K5DfF`|xEb5hyHj3ve1 zwvYelEXNvPl6u>t8Ldf_K<9PLKWzIajTC%Q+rq(9B@(u%KjM2ky6rM(aouPLleT}^ zQ76v%KY8yWjM&83`N-Nr-j!=>!<@(b1AJtbu%upYmniFq&lO1tTi^eOJQF6=)M+kB zT}@EtN?I&M=)d0ZMsSQC%Bn!CYFy>x-R98tjZ^f1Q>kzH_P3_XMAvm2wI;P3RryHh zH<2yNdQGyYF`XkE=ls>9kT{#>x4(alCJbQ2CK)+^4o-JRptgq<3N5KuxgiHTy4X3U z{mq=e5Wx(WY!;K@qV;-I@7_x#M!~W|tlJ-vi%XR4Y00+$qx@0n`?n-bKYT0=ZrJm9 zl}n$bm})^gMyl(BkcOZanE7W`AsGHbk#8C5cjlOmc*k^Nd5cAV-&ku~@ezL)FSs8_ zm~8v*m~P)4Z~5;PQ;j&#i0uP5RV0OpmWadKS|pMgkzR0Ss4Egi)0t^STlIZe<=b)n ziMLI^z=-*KEo`n&Yy3zu0=0txQLf_g2)|DQTwriQX263BlAMrmF5qUy=ly!cK_^arUnBY`!l4m-SV$JeZ-lPK-g zM0FBcBBDtq+31E@qX0=6P-jDo;EjE)D0RQR=8|PSP_lXT+uxd@6st>mMgCD2$(R+1 zMPDhlMzJ0*i}wMmqsqwz3YZwlT-mWhG7CX9}c-Z2-VTeL>I0#i47Q%~gc zEtv{^o0qq>(6|=5sHgr}m+;LtUz11rooX}QXq{nqc-y3oY3k+m?ELinWbuZ7Oyh;zqD3+XR2VWd)f>Y;`h;(?&-FJ; zcUO1)Z%nnvTzf2OOMTZ-vs3Dd*LTPu94pGh=!(ilw6c){NuX*(`PUqJz`A z`3out-5Oci@mfb0!f)89e!SYCENi9}T3wn(8}=qunF=^+l>QitgU}|`f^cq{o~%*i zhL|HIC?!u>y?f7>qznN~7&ow6A%x(#7M!v^FRAcIq`YA>H)BLUq?ZW|0U!cPg|{mW z0Yd=-l$n=s4go3`&6J{T_*mW34Yz@e6%Z3yTYNsFyT^04u?_(f0RrE5x5f_vTmc*- zc-%AOT#8SQ*PA4t_`G;~td0ky734U}_COw&J`n*a0uP6mX%PWU7&9;6%O6Z$Uht?l z3Y|3(BXLhVhpyN`50}mn0T==Om*)`yA_8OWmkSaB9Rg>mmnsqgK?2~Sw`~#u4FUq2 j3AcO{0SW;EWm%Vq6#?4?cOBC!oVREe0rV9FReH*#$eEU{ diff --git a/public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_00.png b/public/images/api/qiskit-ibm-runtime/dev/fake_provider-1.png similarity index 99% rename from public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_00.png rename to public/images/api/qiskit-ibm-runtime/dev/fake_provider-1.png index 525727b96c4227e7bae462f4942ab32e3e7e44f2..9c55978b565a25cd880841a9e62b2edefdb748e4 100644 GIT binary patch delta 41 xcmZ3Nwk~aghn%sFLPkkRL9vy-er{q(K~8>2PG*u`eo?yqvEZeC8`Dl00RT&!5MuxU delta 41 wcmZ3Nwk~aghn$g)LPkkRL9vy-er{q(K~8>2PG*u`eo?x_iH_38%1sybDF{onp}`1+Re8QE1VY%ByptfI=D zP$h^(_>swH`BHpq+SXWzZ{m(8&pN8vm^iwew>Ksf&pX;$+BjO8U)bhsZ0}%hV=crl z&VO+KHZw;@TL%dN0js|sz;9!3DzN>`;s#t~g{_>n13|E!A^&6YcDcKgAOxAICyuIL z4jpQ7*VAx%#$ZgJT6<8yEY?ge_Q^JbSHE2edM2mtJZLhV7#a}idg&9te^t4eqFS&N z*LpQ=hrG~drO)l7NAojm29>l#p=~BVh7u(2H*mQ!4Ad0T+!H;LxGUMyY zXZUjN=mvb<{|6Swhxvcb!S`Ysm`b~chLV!?bAve-6YWbsm6SNmOqiz`iCynnd89sB zUqesN(wUX;VPC#{`2oo*HMZm;{p*_e$e%uanpS2~^Xb7pb_FGQd9{#3RueM=DU#2- zy1M%CL;bz&$2V|sB`Zn)j503H*^cvzx;AXsVD^#5bKB3)`au56m#S$dWz|1MJJ=N> z4!gb_&hFtFYRr)D>+758;AX^fd;NIIvon{IJTtnszTVRLhXn9J2$RdS9NaY_QrjkU%x)p zwa)Geb=|RJN4jOhL2C7Mn|DfSslvt$8`4kcWg7oXVOm7!(Zi+O14Ba-SFs-w4l>Zx zeE!JLOB;7pDBdeQ(lEG#S=e*0}l z-=Lp&e{G!G*Xx_rb#!=hTllH*v9Xo$8VTwK2FckDJ-mDN$bJ0y(XXrda)<9}Ik^KJ zJXx#GFbPL`7haikDVz;kx`u0iZcFlq4{}NRxt~Xy6BGCQa)_%QzrlLH#ac^8Czu+? zRCKr|MoG)uJPx0#uB`l|x7Uo%An&Zd)Kt)FZt1}wubwcM{+~S&_08E1Jk*d+qrTune8fcVjgH)m=gUtGjp2eJlq^-*YQ5?*|TGZLKHLG zymDLJN2K1->H9=QwMIurXNGe}9N%r!3YuUciah5A3>npPKga8yE3!`xHmDhT{p5*= z*nEV^Y-wS^mC47Z;dTlP;~s&qdEOEMKQ5{Gu`zpGOP)3}Ik4N%(9m1F?Iyi{*1enkl3E2X4>ld;3v7!va0;xejip z?$WK)>YfPiWS2Hit>ZUW*Rk8=Jsn8S_1kxri72}vbvGbvgynN}wW?x-bjxVoj~|!G z{r2hON0k#NuH9hW`Yfezp;3@))28R&zklCUv4(iD)Q=Er_?dhz47ZJY;;d-OaZ2#x z5Pv4^IU`3qEicb$B>!-K)dMYqxU8(KznzkPFF2S@YVLb+d}3l?OiWC2-q`7+v#H0z zBwZd-$X7|$0Bf=G*|R~?vx7nnmWKk=785%ALe6iw(XhRA!`ih^zJ0rpW<(IpM=Tmm z|Cb{DPk_s1(Gntv-|Tb0iN4qCxsVX2pTmCuo&Q7p8|5Q*e`V1md?ddv$6^215mPUR zpz!c~G)Xh>`t*PnwNuuw_dUCfx}4k}OILHmqBzCEo4#xz2(u5yD~}vK`uoHE+Rsn{ z^mOeslf4oWIU3t4>xjir_9ZH0MX=VIgWkL03cS4=~S78ACZ(e!$PmI z>1mtq40#2GyMEj<$@8<*@-z<*j}7eX37nG7v3YrVwAutMfmK@$9EppIJIH#RChXX& z?0WgK86d;Yn1@2?E&6@2Uv+m+Ps|^GEH}P*v9~r(jTTi|sr>WjPxFrVzJ5QGbB84~ z)YZuYX;IEYjpntnDvbr6xxBo*6zcE4|IV^%mByt@@kRx>Kpk+sr#y^C2`PJi?b?!| zrc9-iCr{F%(3viMd2wE+&?_Iy!9zWN{(OIPcG^K9A#>gpQv-7_g4YiiW+>}qGu_+igcs0#}VYzHs?K^_-Vw{#WT zuVuhh{EU4$B{i{gBrbn{67@Vk;@h`x=@#|;4<0e%EY);AD~;WXAsrK-xweGr#j?kW@3#WE7pO{3Ai z1x~A3ToCg5xzBzbV_b$2Svc1v;CGyX9n$|LHPXOi^rY16U>bQ79fcEU49TwJ-Fu~_ z4YUkgyIkpP>({Pr|M9}=_7m-dki5I^Hp z1AXVpl|?6IWi3X(y$i-KhjRw_`Sh}sX@L(OL<7K%rlzLSYI}cGY8RlqyH3ln?&=!p z*n9WZW>__8Vp$wGylgC42|~DYjCq@sRLkf{ORkHJZEIgW8~d+HY~BmRshs=&gP#2t z_^18HMfdLAd-D3~vJ&e|3$os_9bzbZv4;f(1^eq$B6jTDnE@oBANKYA3kUb38Roi- zXgWK;3ip~ZR}4R_O%t|i6jltA(8$it4iQ z6SZ^ap0KQ3Sr?}kGw#Q{Y+1+@8$sA=@aqx}`Sp3JZjAY95r=Mt{E2G$GuqY{Em#*lgGQi)H0Pyic!fFd;M`xHRGIFGIo zkR!uu-i_X|Zs)1k`1ntDNmu_{fwca{Dt3->07NfHY-6E!A>|{TE{pBnm}+zrl$wW{ z?>1TO!?ZXsIGDHi0EG&w@!;moo3CuzhR&q@G(VdHWQdd!Vx_H@YIa*_eMT|=1DRY1^_~bnbo}E`%SRGL9_Y)UT zH#8i{DtK#>ws-sXqc}!QMddyv&Z0h&Om*GV4Ui!;Z{#;2f zUmoo0?mkUx%(O|lzf+cX-#&S|A7=oCnVEU7nAlm1&xv-Wo6#J>Rg6tdR8 zLoK;l@7}$mMGd#)V%P1HlG2Y+ig-x5e)DF65#6sb&o#|R8;ilacdv?pK{zE2Pk;N? zt*VE7x{lx8uAr)pwC2~L%%h{D#k<+1J+jEx`n1647JvKU8^*KqGv*h-jJ2g*_-*oJ)+)g$1-*xKb$-P2CYP*%f11Z<9 zU5hoX2+xbqo0zZFQ&m+B9rL=RX!%~i`y~J1?S0A0;2Ot{9djJ~BIxSo_UQoYWN+1R zc2R3}EZRm6j=2z{%@T{&{-+44zt|S5K=*c)tA>bjs?*Sl)6KLdUlbN-7xna+Gnz+^ z_*}Vql^qI==&{dMBhV#sz)~m1D`ZNFi;t6fXS1Qlc9i7FJDbeMIzI-B+Js9u55`7C zQRp6jReCa^=TIiHs=RMrhp{lv9vYMVMG#ne4-gJaE%W~;+V-B>$|HJup&grO41Q35 zw4ic5PJ+l%IKxLk4}qP`l%?Y9(&>Eo2Hkcudx?;;sgN3>g9mGqbVW^5Rznrt*wwbe zcDOk^SkfgqDov766)78`w&>EOOW3R_jF}Y1rT%`Xwe`Z;gq}-_6Nx*l#g&E&W1AI& zg{e$TOsm3cURmj)XPUpcwn9-KH(+~Z*JdBI>38qnpO$c6(mq|t$Vc;R=sX8e|5I#| z?qhKIE3+v-K3;fz41=vbSj1wY!h1mt7!jYGY<<8ats&icNXIngH{9Tk7_XJ>ll6vL zC`io|gCsD5lBTBI*D_X3ubjGZZ$-xT{p);0+dR}zoONxC1sB)LwgE?R>I1duYFR&y zsuq{FvT|;M*xXYqB&Wek4gK44U+<%qqVgaDo+_yr^0o$%i<+Okp~uW z-MV$OsNE4BV|kfNk`odfx_O!KX||V`Et%fxjfs$O zI=z0ELS^OC<6+qnSk1>eooqfNPXont>w2K2bAdczkd4%Kk0Mhyd3Sqg$wDIM=zKrlbc{y z%qAbFfzM$=WdKNkqH0CBR9H4I_TdsN13==h$HN~AzoeP^AF^(a?V$T7IP{dWiChW< zKMOI^AfG}kg9sIOI2Euj%oKDG~3MQF~u5JP(9nY>^{V1S%Tqg9-#}9Q|(jMtAU0otjn7CEQMC`fKNUJ{S zTa<^2N0P5SrC=srNNWW_@LyH)C)Cx|%|6`QUMOyo*`#4$F#Pw2uZ&UR_MB=kEfjxc z-*tL&sHy&O0!sJM$G8|G+^v7FV#pyyxFb2U!?|4}BPqo<*I4`<>q4P_es=QC-|j_+ z@M6riCFJDjkc&$T2;gj6)Z3Vm(CRU+sQCEcyT2~kH_h~;n0w&~oy%Qe*=i2k=4IQ^ z2e`QSrgD#yFE2PxtGu+7)RYB3zTIJXKjq?LJ8;g2q{>W-m-Z&46p$$U^5x6m9BhI1 zC5rsS%1!$#udP@=!Oa-u?(r-y6KzXuvMJQJ$s0YTriGmt`s5??ww*hVPs0shj&P~h zcQJ=l`qzSluGfc{-|S(4m+RE|;r?^-)r%bsSa~GoOc-nsx7R%n9zKjm5&i2)v9WtR ze|){U*`xKPamj{_8|!MZm5AMD_J2N}MuKKvc2BsPmDP}VM@B{l3i%-(Xr;ComWPLjw4by+?~`{t&AYIWd@4@p60_QFL8w=#0;b6)VWv)z=S$eZfnG}sI9Xd2QP_G2LrV7wPDl%#{daGlHuP85t zasth~_7`~&IRxZnv;W9Gp#939ig#>N5z1EWysh9V*& ze`!-arti2{@DAg&1_~)J;V9jskPe5x^h_*e@4a-u|%;y`s7`-<^kqLpC9kyU=D%Kfa%*s-n}O#xqRH*r2GWv_a?Gyu3WNxr0Uk zQ_@b6)%lOKtgY3_f6%fL?i0HX9nzF^9#nR9&8Ea@r5KRgUR6!ac*_lnd2i*@vG3n2 zr-qt1OYll7e_yBEOgkWvcu>C>n9$Qm#Z&T#;X6KUMxKnfMQtOlDS z-E-C%@=J~e4Zo3%Exxu^o$i4P#HXaxmxoF6P+^*3%YaQq+`fIALM7Yui}S_lBoh_Y zee>o`ZMK7{v5ASqLlL(LGc4d<^j2DJfu}oZ@M&vnqk{)UrCk^P-*7Jp_j!f?*LAFf z`@Ye?WUSw;FYAAYh!ymnA26I8rE^=91&cuaKA`Bkc0Kra^0lBU_5G41OT?rtLw3N| z+9ePv$UJUi{kdzg&*SDUp<3-(R;_kg3;{_oStZNe7h+RjH#iraR=6k2_UkdKs;1^c zuODBRfmRsU{!*j%F$9R>WT{X^tWtzDo1}AMRNBpsSC$RWv%XA|(vB2H(CGahNl9JUFb^rrOP1_8d{_^fO9lOg^3gi8 zq@+Y1px|dr8t^hQhEQd+D1QB%JwSMbF4g`r3wx-f#D`4EIA6S!?g7a!;Wd{vHPR+P zHZ&DW%R~^;r|8dA)f9t#;d4bq^z-KsF4Sspz%HaB;Bt}=AHYCBUlO|=^53UMQ{ZHu zmeA!`|J!frHf_=yH*TcTa-4_a&lley$pgqZ^y2mFao~BMN=qI0TTJv;L4T^@JyPO4 zXQ$Z2?V~_aNUcRxMW=!sBAW!=1KS}!F3wJGpc=gwD`NpV%*)UJkV0}dq%)8w5}q^Z zl)YF?7=yLlWg!rKzP=h%>MitB3YAmBQ5lVctmXB)&&bi-riYWzn)dPWl?k?e|5^+> zkOUJ-o`%gJV%;p()!7MIb%NFj=C=L#jXivPifG2PC?H)N5WexH@f{;=$X<=}=bx_T zI=m;&d?Y3-ON#bCI*o;&pIay^%kdx% z1mt?$kg$mO%F_I8!;wtu7GcXT2Y_b^G%^FjIWTENCBRa=LP*!|kX0}#lHeJ%*cPwq zuY7tH%`(HRY6oc`jdz!+L3}{9cLv3fU}(#aqQ0|FpdRI_IdsOGQ3RV-uZ;yv@tJlZeVc zii(aNP(@rM>s#Oh`4NpQfFOkmdtfgDYQ@9$FOr4f#tbT}fs>3R_o< z%X^|qmQBJjmJ*kqUMn~s{m4KS8w&4SS7L{4gBbcvj~!T+VyKu3(gJw;o--3w)zR`i z)Cw6!-ob+h)uD_?CLHF{Dk#opYfe5d7kLoqjJJa&5?j8|rMCQMn2HXu`8q`Ce|iurwMz_T@Iiz`G|`#`)H;V z6d0&ISE#zeymA6kmx=r+@ZR5li`Dh9t zPyu$UpEz;iY9E&H9xOD(xSPm}x{?Q2L2!^V3XGafL15p$8dAwkOgK7RVepT%N(iVN%9XdNMDmj%DK9D4PF5OGA312U?upjlGmJ>=p)_ij?o}NBVnWW ztS!z>R&Il-bdDOhL}WAzsTg$cH$sQ2{#Og;VDgC$9SLQ)kL1@s6DNu+IsRdyAcm;q zwOzlN$P)g?-~RJCgZ4M!m%otfT;MF@6woTZ8kukw7B+!HD=jG zCTDjCJG@5@oPP1+Z|F!N_gH;$BcWI=fv7CYmy4OYA^Sz3`iyzyrVmX`P1i0G&791H z?Quj^B+9})EcIJdq^Lp=qG_lMp541GV5ykM{?0x#Rw5t*P-qx(Ud17%JW|LgXt;mw zH!s%ZwnC^S2oGh1aum{ZBYQCN=;uli*7i9oC4s=DzDVfc*TwL zX4O&D(@IM9?XRzr5d!j~7CSm8i6;%Cm2dVCSrpX!*wobLjaqu!scsk!aIBD;4hsFG zgNwJGla(!(=B^nC={!~#RD*4%Xwl5}PqFiz$HY@8a_&f>w zHuk&&FB&XoIs=p(5kU8T+Luxbdu0+wlE#CH?9~-}2%nX@>1I{T5dq=ht#e01JMnn^ z)zNp*eqsLapqTAWXyKVc#;gn()WM6d0hNt&AI_Eqi8v$~%yZGyGy&Zz zQr7<=<>aYTyxX=Nk#rdr7T;Q0w2siDkw6H+h6YB?P>|?E8ucc0d-tPhnxX?^E4$m8 z6H5xuf&h_v3D~)fN+Jx|B;m@U$F_7jCK-ZEK-R|t+4t?=uYmlIWaKl`BR0;$K|YIo znkU*HfG(WkICDG zo8pL}0yO-Cm{gF4Ip=9Y_gVRbXn#hgr@%~ga4W>>5z?ONj(w_WMz6~z`f6mMUxg%> zo^#zm=%pjJw@qE!{w&d+b46&3#zvpKyu-hO`q)@yxET}hKtL^;2hSc!pqDSRl}U;x z6#nF(b)6prGA_JhA^Rcz!J@A8@LBAWksdrtaERNVAm3ILHGo1T?*sn4Zkxy|!l%3X z63Y?%$!(%{yHZ8kG7-x|A<&l^XV041AB2IXlpw)uD+uB8rx3?bijR-ari#%Hf0=mj zq|Nhl#OB#l;jxfAbKMTp^+y&;YJ!KoE(u}aN%EQy`MIxOzb1tx=nSMVKISR*Ag`F% zm%+#R=a`5Cy11Da z|E}d0a7_%c5`6*5{%+bO)_AFnF{ylnrL5p03)MehJozXVKxZTCAp zOK(C`mg&H)G7}-mE77U*Wm<-YHqJ}rjb^XjArzHWRiE9x%S!Hf>;Y1wli*N%;EP}e z@k)kBf0@FRb2YQojT|8&QwMGB$B^3_)~}Cb%vCVd5ki&vxf}%@Lux$F({iQe!HfAa z7kHUgUtSzVyg){_NJa*KaQf%uNMxATydV4{iLHsduzmTFmAO-m7L$z@DSP2Bpm21u z?W4)Dn4vGJ$M0+w_zdT))bC5|!u)K4`}8omgPnjVdoU+}?D;-A7Sh@}Boe^$$DHGN zUlzJ^yB_Lx4h$rKbCVf5nTn%rb9qjvxL(d$(EbR|XtKXf9#)BoZ1#RjZ?P?Af;js| zi?t|do^$yZI=8naHeHz*<_A`M+*h`&!#ETSp&?G&hdsVTY7^G0OyGE5h(=+CEFQ# z&u1L6X-z~>p+W;Z1C}W02fe*jkuXfOu;oAQWuGpYijeUxaGUJ!3M!wn*$T#34GA>? z#UCMb2yq~CuKrXym(ccxcdj4`8bF<|#WyYbs-tHx-z0*EmHJ+^m`n!|sH&|| z>*QTdMF9V0;ojR!LZ^AeYg&?=HYg1eWRvmAYxSD7Lf)_K&|Rtm=2;Ty^Kix~~_l#eR}EHQ%y0tLf5=Vy1wB!Y*Qq*n~!QWBZ04QJ1f0C46f zYLtF8EM%igjWEO#RR1f=3gu15{6`g+0kvbEec?ym88(Dlv50r1N=4>{Zg$^cTJ?q?g z{T0klu3I*|Jjs~rkwL6~h?EELzf> z6ihmN84P+9T~N@<$L}@6S2(Edf(S*E+vCRhUQ%0Q-c6b@=Rk%)SkxR;PN|=>Hd@OB zx^X|~p0MPnlO?64wJ?a&-6k(xzi}g{Yl_j8R>PTDxbF#(?gM5*27qL|1U8)nOMz^V zkf)#3l%%3D?v_1qrnha}21pQofE^A1c$+hd(f7PorX3CaoNz&;5c1+%>kZtK>|j4<&$aoV4-H{pR!J0;@GdoA*VZ;~ zMt;L6zZtabd$d|#B-W9yUcGvK7L1Y_$KRSV&X|e!7G5Pw=oDeha-!>zVLzI#l&K{G z6bXm!y9S<<8tZBL94-}%_N#09pNCjie@QjUIQM!{l0m+XX?bXsqG$_+o12>yMd*(v z^uq!!6#`V~*P8W8ho6#mxZn^lW@bEskqB1c`Tg}We)lB`IkpRkeR3wu^S~d;p&gJK z#47ciF3nF#U5GIpGDpR*(I!5fi@<~&*(H4daFg}|wpJhXkBWxI z10zcWrTpGsK820fA`s8X);P&HNow!5(Rf(JPl_}A@*NhwKs z{IK1)Y15&gR?H=kH;LJYY8c6ir(Mo(4)CsduDB~Y_XUg?(xo7`8D<{hp<4SeB}uM9 z6edIa$?+JBPL=t&8sHpw1}1bzc?@YXLF34`LdtewCJc5uOzks%sRsFOq|dCSXLtS93ih7ipFHMR>71T$caAopLYQeh zVe|Sopf-6WC7YrRuS)h{zkuBZV{&98!t9{%;NW=7g6d*m^8tK(y(y`|;h*|jnV&qK zpY~>Cl0&0l!F}kEAT2@9o;@SSZL!n$@bjNRxBhdH7|jk9<`^#q;ik1%*OSr;AVdy2 zxlavNq2Qj2J9G!3KQ>D-Qm}LTd_`L;G4${NMj+W*k>&T3VVK(hUs{L$z1*Hh;Hi-S@y5aD)1FVrbIgLNi zaoF|DGz|=_L9^MBg1j2VcHfHOheLwrJ9LgOytnoZ2@Jew*_@Tiyk4KprDCLi4^h^u zzh~L;v&(UBbaK|C-J&mEqEV~Y2r+#&^K4}v_I{b6z z`tE$DF*526)Q~?wf(>VBmy=dTOoUfs=QUr4={f$2!KKx~Vd4(&g8;Hs(ej&(=6;Nx zQdOmah?#eGce8=%2*0vwGI4%;>VBKvaJY<&OxtBt38%l1kdQC-DH}-YDKv*F*s44C z?JIeE&39*EcC%EWWc!YyO&EiXMJ#(FK{KfumKZtffm}wytFEk$yj*A@Fcr-%XY3PZ z(!KklACcr9Q2jV?@Y_A|^V;fE2%SGh8P+vA+S+jeyOj?8khmkc?bj#Ney86d^Fxd} zX3cG%F#Pj#_rYE_vqPnkBX=06Df6?}{$Rt8H_H3xELt1fmH*2BHc-h}rhMCrh1**1 RIruL@J$dFt^09MQ{soVqi3I=v diff --git a/public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_01.png b/public/images/api/qiskit-ibm-runtime/dev/fake_provider-2.png similarity index 99% rename from public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_01.png rename to public/images/api/qiskit-ibm-runtime/dev/fake_provider-2.png index ddcdc81a90aa8a6fbb0ebdd9faf5b57143df7bef..84d7d792b7e148fedf92006967ddecb878a7a765 100644 GIT binary patch delta 43 zcmeyfhVjoD#t9yB#yScaB_##LR{Hw6i6sR&`6W4-NqYH3>H5clm-=l?6AJ?XeOVCy delta 43 zcmeyfhVjoD#t9yBMmh=^B_##LR{Hw6i6sR&`6W4-NqYH3>H3O(%r`ftiG=|GcGnO+ diff --git a/public/images/api/qiskit-ibm-runtime/dev/fake_provider-3.png b/public/images/api/qiskit-ibm-runtime/dev/fake_provider-3.png new file mode 100644 index 0000000000000000000000000000000000000000..3704faec715d9a8864e50cbdec63265516ab89bd GIT binary patch literal 11625 zcmdsdbySpV+wX&g3dlxL5DAq5K?Fp)F>y%gkQ8YN>5$k4Sbz>7?I7JKAI?@pKlOwapXj(bwwk|*au@9UpwXpgd-eafSBaAg1WB;LY?W&vxZ7y${nt_TCyB3}C(t*_qP zu`YI^gWJ5mQh!qD_+~p z_00b^>zPmLr-?IX4nmN?)Y2F>7@3GXI{OpXs1T&)ArE}3|J#1}N|OX%%q}y+*9%W! zQ3CgCz_;&D|NFezMO-?tPexX@r`TSv&;mh>6l`rX)$no-9<;&lA5cwwFU~%~A$QM% z773(TTwfQLepu^_&i)@O6KKyPDykzEr>Yz!5Q(w0wzmKF-ke3kIq~e-vk@^dwge|f z$GjV1?72^$9(?ln@l?Y(ytc7%0=9t);b+@F%+k=*)K#%iogE#`jK!HVv&j2bTD85+ zO_26H&(E)l#bTx0i4mA-`hbl`bzvO&@$szVV`Ds=oL5Z)$i*@0R7m?n4J7aP@^UHJ zoyFQ%Y0o^E3>Q{0j9mvNa`fm?4EB#d{#agH`>JQ^$AvBEyO))b@d}e5<*p6HKMO@xFqx1Al^%tI;)%O>lLf3tCf_M!`JXkJhy6W%H>A~Vi-6OGb%=ey1&Y|q_eAwG+Wqa@_xRsO|Hv#p(-8TF&!d4 z*uMC)c6{D{J}%mcK>j#iu^@N+#0esSvP~%VTDs%6(jwl%2G3!5LpTzcoO`=O&D-0X z*p(iJ$t*3^Z)j*ZfBt-Dcc#`%LN7fXosPbKG-f)tWUzCWyv>CjD0lCI|77)K>&>La zIoj=>qe5(!B=!uOX{D>_XlT4%US5ufib{uNZo$hBRqs@K4*BUh^ncWO@SqZt>A5ht z=CatOE^phDr9&Jd5O~{QWtTOO*p8jemE)|eIdXnmQ>K)ys5ci3&c?NHV|^&(^