Skip to main content
IBM Quantum
Documentation
Overview
Start
Build
Transpile
Verify
Run
API reference
Search
Application switcher
Qiskit
Select
v0.45.0 (latest)
v0.44.0
v0.43.0
v0.42.0
v0.41.0
v0.40.0
v0.39.5
v0.38.0
v0.37.2
v0.36.2
v0.35.0
v0.34.2
v0.33.1
v0.32.1
v0.31.0
v0.30.1
v0.29.1
v0.28.0
v0.27.0
v0.26.2
v0.25.4
v0.24.1
v0.19.6
qiskit
qiskit.algorithms
Overview
AlgorithmJob
AmplificationProblem
AmplitudeAmplifier
AmplitudeEstimation
AmplitudeEstimationResult
AmplitudeEstimator
AmplitudeEstimatorResult
Eigensolver
EigensolverResult
EstimationProblem
EvolutionProblem
EvolutionResult
FasterAmplitudeEstimation
FasterAmplitudeEstimationResult
Grover
GroverResult
HamiltonianPhaseEstimation
HamiltonianPhaseEstimationResult
ImaginaryEvolver
ImaginaryTimeEvolver
IterativeAmplitudeEstimation
IterativeAmplitudeEstimationResult
IterativePhaseEstimation
MaximumLikelihoodAmplitudeEstimation
MaximumLikelihoodAmplitudeEstimationResult
MinimumEigensolver
MinimumEigensolverResult
NumPyEigensolver
NumPyMinimumEigensolver
PhaseEstimation
PhaseEstimationResult
PhaseEstimationScale
PVQD
PVQDResult
QAOA
RealEvolver
RealTimeEvolver
SciPyImaginaryEvolver
SciPyRealEvolver
TimeEvolutionProblem
TimeEvolutionResult
TrotterQRTE
VarQITE
VarQRTE
VQD
VQDResult
VQE
qiskit.algorithms.eigensolvers
Overview
Eigensolver
EigensolverResult
NumPyEigensolver
NumPyEigensolverResult
VQD
VQDResult
qiskit.algorithms.gradients
Overview
BaseEstimatorGradient
BaseQGT
BaseSamplerGradient
EstimatorGradientResult
FiniteDiffEstimatorGradient
FiniteDiffSamplerGradient
LinCombEstimatorGradient
LinCombQGT
LinCombSamplerGradient
ParamShiftEstimatorGradient
ParamShiftSamplerGradient
QFI
QFIResult
QGTResult
ReverseEstimatorGradient
ReverseQGT
SamplerGradientResult
SPSAEstimatorGradient
SPSASamplerGradient
qiskit.algorithms.minimum_eigensolvers
Overview
AdaptVQE
AdaptVQEResult
MinimumEigensolver
MinimumEigensolverResult
NumPyMinimumEigensolver
NumPyMinimumEigensolverResult
QAOA
SamplingMinimumEigensolver
SamplingMinimumEigensolverResult
SamplingVQE
SamplingVQEResult
VQE
VQEResult
qiskit.algorithms.optimizers
Overview
ADAM
AQGD
AskData
BOBYQA
CG
COBYLA
CRS
DIRECT_L
DIRECT_L_RAND
ESCH
GradientDescent
GradientDescentState
GSLS
IMFIL
ISRES
L_BFGS_B
Minimizer
NELDER_MEAD
NFT
Optimizer
OptimizerResult
OptimizerState
OptimizerSupportLevel
P_BFGS
POWELL
QNSPSA
SciPyOptimizer
SLSQP
SNOBFIT
SPSA
SteppableOptimizer
TellData
TNC
UMDA
qiskit.algorithms.optimizers.optimizer_utils
Overview
LearningRate
qiskit.algorithms.state_fidelities
Overview
BaseStateFidelity
ComputeUncompute
StateFidelityResult
qiskit.algorithms.time_evolvers.trotterization
Overview
TrotterQRTE
qiskit.algorithms.time_evolvers.variational
Overview
ForwardEulerSolver
ImaginaryMcLachlanPrinciple
ImaginaryVariationalPrinciple
RealMcLachlanPrinciple
RealVariationalPrinciple
VariationalPrinciple
qiskit.assembler
Overview
RunConfig
qiskit.circuit
Overview
AncillaQubit
AncillaRegister
AnnotatedOperation
Bit
BreakLoopOp
CircuitInstruction
ClassicalRegister
Clbit
CommutationChecker
ContinueLoopOp
ControlFlowOp
ControlledGate
ControlModifier
Delay
EquivalenceLibrary
ForLoopOp
Gate
IfElseOp
Instruction
InstructionSet
InverseModifier
Operation
Parameter
ParameterExpression
ParameterVector
PowerModifier
qiskit.circuit.classical
qiskit.circuit.singleton
QuantumCircuit
QuantumRegister
Qubit
Register
SwitchCaseOp
WhileLoopOp
qiskit.circuit.classicalfunction
Overview
BooleanExpression
ClassicalFunction
ClassicalFunctionCompilerTypeError
ClassicalFunctionParseError
qiskit.circuit.library
Overview
AND
Barrier
C3SXGate
C3XGate
C4XGate
CCXGate
CCZGate
CDKMRippleCarryAdder
CHGate
CPhaseGate
CRXGate
CRYGate
CRZGate
CSdgGate
CSGate
CSwapGate
CSXGate
CU1Gate
CU3Gate
CUGate
CXGate
CYGate
CZGate
DCXGate
Diagonal
DiagonalGate
DraperQFTAdder
ECRGate
EfficientSU2
EvolvedOperatorAnsatz
ExactReciprocal
ExcitationPreserving
FourierChecking
FunctionalPauliRotations
GlobalPhaseGate
GMS
GR
GraphState
GroverOperator
GRX
GRY
GRZ
HamiltonianGate
HGate
HiddenLinearFunction
HRSCumulativeMultiplier
IGate
Initialize
InnerProduct
IntegerComparator
IQP
Isometry
iSwapGate
LinearAmplitudeFunction
LinearFunction
LinearPauliRotations
MCMT
MCMTVChain
MCPhaseGate
MCXGate
MCXGrayCode
MCXRecursive
MCXVChain
Measure
MSGate
NLocal
OR
PauliEvolutionGate
PauliFeatureMap
PauliGate
PauliTwoDesign
Permutation
PermutationGate
PhaseEstimation
PhaseGate
PhaseOracle
PiecewiseChebyshev
PiecewiseLinearPauliRotations
PiecewisePolynomialPauliRotations
PolynomialPauliRotations
QAOAAnsatz
QFT
QuadraticForm
QuantumVolume
RC3XGate
RCCXGate
RealAmplitudes
Reset
RGate
RGQFTMultiplier
RVGate
RXGate
RXXGate
RYGate
RYYGate
RZGate
RZXGate
RZZGate
SdgGate
SGate
StatePreparation
SwapGate
SXdgGate
SXGate
TdgGate
TGate
TwoLocal
U1Gate
U2Gate
U3Gate
UCGate
UCPauliRotGate
UCRXGate
UCRYGate
UCRZGate
UGate
UnitaryGate
UnitaryOverlap
VBERippleCarryAdder
WeightedAdder
XGate
XOR
XXMinusYYGate
XXPlusYYGate
YGate
ZFeatureMap
ZGate
ZZFeatureMap
qiskit.compiler
qiskit.converters
qiskit.dagcircuit
Overview
DAGCircuit
DAGDependency
DAGDepNode
DAGInNode
DAGNode
DAGOpNode
DAGOutNode
qiskit.exceptions
qiskit.execute_function
qiskit.extensions
Overview
SingleQubitUnitary
Snapshot
qiskit.opflow
Overview
OperatorBase
qiskit.opflow.converters
Overview
AbelianGrouper
CircuitSampler
ConverterBase
DictToCircuitSum
PauliBasisChange
TwoQubitReduction
qiskit.opflow.evolutions
Overview
EvolutionBase
EvolutionFactory
EvolvedOp
MatrixEvolution
PauliTrotterEvolution
QDrift
Suzuki
Trotter
TrotterizationBase
TrotterizationFactory
qiskit.opflow.expectations
Overview
AerPauliExpectation
CVaRExpectation
ExpectationBase
ExpectationFactory
MatrixExpectation
PauliExpectation
qiskit.opflow.gradients
Overview
CircuitGradient
CircuitQFI
DerivativeBase
Gradient
GradientBase
Hessian
HessianBase
NaturalGradient
QFI
QFIBase
qiskit.opflow.list_ops
Overview
ComposedOp
ListOp
SummedOp
TensoredOp
qiskit.opflow.primitive_ops
Overview
CircuitOp
MatrixOp
PauliOp
PauliSumOp
PrimitiveOp
TaperedPauliSumOp
Z2Symmetries
qiskit.opflow.state_fns
Overview
CircuitStateFn
CVaRMeasurement
DictStateFn
OperatorStateFn
SparseVectorStateFn
StateFn
VectorStateFn
qiskit.passmanager
Overview
BaseController
BasePassManager
ConditionalController
DoWhileController
FlowController
FlowControllerLinear
GenericPass
PassManagerState
PropertySet
WorkflowStatus
qiskit.primitives
Overview
BackendEstimator
BackendSampler
BaseEstimator
BaseSampler
Estimator
EstimatorResult
Sampler
SamplerResult
qiskit.providers
Overview
Backend
BackendV1
BackendV2
BackendV2Converter
convert_to_target
Job
JobStatus
JobV1
Options
Provider
ProviderV1
QubitProperties
qiskit.providers.basicaer
Overview
BasicAerError
BasicAerJob
BasicAerProvider
QasmSimulatorPy
StatevectorSimulatorPy
UnitarySimulatorPy
qiskit.providers.fake_provider
Overview
ConfigurableFakeBackend
Fake1Q
FakeAlmaden
FakeAlmadenV2
FakeArmonk
FakeArmonkV2
FakeAthens
FakeAthensV2
FakeAuckland
FakeBackend5QV2
FakeBackendV2
FakeBelem
FakeBelemV2
FakeBoeblingen
FakeBoeblingenV2
FakeBogota
FakeBogotaV2
FakeBrooklyn
FakeBrooklynV2
FakeBurlington
FakeBurlingtonV2
FakeCairo
FakeCairoV2
FakeCambridge
FakeCambridgeV2
FakeCasablanca
FakeCasablancaV2
FakeEssex
FakeEssexV2
FakeGeneva
FakeGuadalupe
FakeGuadalupeV2
FakeHanoi
FakeHanoiV2
FakeJakarta
FakeJakartaV2
FakeJohannesburg
FakeJohannesburgV2
FakeKolkata
FakeKolkataV2
FakeLagos
FakeLagosV2
FakeLima
FakeLimaV2
FakeLondon
FakeLondonV2
FakeManhattan
FakeManhattanV2
FakeManila
FakeManilaV2
FakeMelbourne
FakeMelbourneV2
FakeMontreal
FakeMontrealV2
FakeMumbai
FakeMumbaiFractionalCX
FakeMumbaiV2
FakeNairobi
FakeNairobiV2
FakeOpenPulse2Q
FakeOpenPulse3Q
FakeOslo
FakeOurense
FakeOurenseV2
FakeParis
FakeParisV2
FakePerth
FakePoughkeepsie
FakePoughkeepsieV2
FakePrague
FakeProvider
FakeProviderForBackendV2
FakeQasmSimulator
FakeQuito
FakeQuitoV2
FakeRochester
FakeRochesterV2
FakeRome
FakeRomeV2
FakeRueschlikon
FakeSantiago
FakeSantiagoV2
FakeSherbrooke
FakeSingapore
FakeSingaporeV2
FakeSydney
FakeSydneyV2
FakeTenerife
FakeTokyo
FakeToronto
FakeTorontoV2
FakeValencia
FakeValenciaV2
FakeVigo
FakeVigoV2
FakeWashington
FakeWashingtonV2
FakeYorktown
FakeYorktownV2
qiskit.providers.models
Overview
BackendConfiguration
BackendProperties
BackendStatus
Command
GateConfig
GateProperties
JobStatus
Nduv
PulseBackendConfiguration
PulseDefaults
QasmBackendConfiguration
UchannelLO
qiskit.pulse
Overview
Acquire
AcquireChannel
AlignEquispaced
AlignFunc
AlignLeft
AlignRight
AlignSequential
Call
Constant
ControlChannel
Cos
Delay
Drag
DriveChannel
Gaussian
gaussian_square_echo
GaussianDeriv
GaussianSquare
GaussianSquareDrag
InstructionScheduleMap
MeasureChannel
MemorySlot
ParametricPulse
Play
Reference
RegisterSlot
RelativeBarrier
Sawtooth
Schedule
ScheduleBlock
Sech
SechDeriv
SetFrequency
SetPhase
ShiftFrequency
ShiftPhase
Sin
Snapshot
SnapshotChannel
Square
SymbolicPulse
TimeBlockade
Triangle
Waveform
qiskit.qasm
qiskit.qasm2
qiskit.qasm3
qiskit.qobj
Overview
GateCalibration
PulseLibraryItem
PulseQobj
PulseQobjConfig
PulseQobjExperiment
PulseQobjExperimentConfig
PulseQobjInstruction
QasmExperimentCalibrations
QasmQobj
QasmQobjConfig
QasmQobjExperiment
QasmQobjExperimentConfig
QasmQobjInstruction
QobjExperimentHeader
QobjHeader
QobjMeasurementOption
qiskit.qpy
qiskit.quantum_info
Overview
Chi
Choi
Clifford
CNOTDihedral
DensityMatrix
Kraus
OneQubitEulerDecomposer
Operator
Pauli
pauli_basis
PauliList
PTM
Quaternion
ScalarOp
SparsePauliOp
StabilizerState
Statevector
Stinespring
SuperOp
TwoQubitBasisDecomposer
XXDecomposer
Z2Symmetries
qiskit.result
Overview
BaseReadoutMitigator
CorrelatedReadoutMitigator
Counts
LocalReadoutMitigator
ProbDistribution
QuasiDistribution
Result
ResultError
qiskit.scheduler
qiskit.synthesis
Overview
EvolutionSynthesis
LieTrotter
MatrixExponential
ProductFormula
QDrift
SolovayKitaevDecomposition
SuzukiTrotter
qiskit.tools
Overview
qiskit.tools.jupyter
qiskit.transpiler
Overview
AnalysisPass
CouplingMap
FencedDAGCircuit
FencedPropertySet
InstructionDurations
InstructionProperties
Layout
PassManager
PassManagerConfig
StagedPassManager
Target
TransformationPass
TranspileLayout
qiskit.transpiler.passes
Overview
ALAPSchedule
ALAPScheduleAnalysis
AlignMeasures
ApplyLayout
ASAPSchedule
ASAPScheduleAnalysis
BarrierBeforeFinalMeasurements
BasicSwap
BasisTranslator
CheckGateDirection
CheckMap
Collect1qRuns
Collect2qBlocks
CollectCliffords
CollectLinearFunctions
CollectMultiQBlocks
CommutationAnalysis
CommutativeCancellation
CommutativeInverseCancellation
Commuting2qGateRouter
ConsolidateBlocks
ConstrainedReschedule
ContainsInstruction
ConvertConditionsToIfOps
CountOps
CountOpsLongestPath
CrosstalkAdaptiveSchedule
CSPLayout
CXCancellation
DAGFixedPoint
DAGLongestPath
Decompose
DenseLayout
Depth
DynamicalDecoupling
EchoRZXWeylDecomposition
EnlargeWithAncilla
FixedPoint
FullAncillaAllocation
GateDirection
GatesInBasis
HighLevelSynthesis
HoareOptimizer
InstructionDurationCheck
InverseCancellation
Layout2qDistance
LinearFunctionsSynthesis
LinearFunctionsToPermutations
LookaheadSwap
MergeAdjacentBarriers
MinimumPoint
NoiseAdaptiveLayout
NormalizeRXAngle
NumTensorFactors
Optimize1qGates
Optimize1qGatesDecomposition
Optimize1qGatesSimpleCommutation
OptimizeCliffords
PadDelay
PadDynamicalDecoupling
PulseGates
RemoveBarriers
RemoveDiagonalGatesBeforeMeasure
RemoveFinalMeasurements
RemoveResetInZeroState
ResetAfterMeasureSimplification
RXCalibrationBuilder
RZXCalibrationBuilder
RZXCalibrationBuilderNoEcho
SabreLayout
SabrePreLayout
SabreSwap
SetIOLatency
SetLayout
Size
SolovayKitaev
SolovayKitaevSynthesis
StochasticSwap
TemplateOptimization
TimeUnitConversion
TranslateParameterizedGates
TrivialLayout
UnitarySynthesis
Unroll3qOrMore
UnrollCustomDefinitions
Unroller
UnrollForLoops
ValidatePulseGates
VF2Layout
VF2PostLayout
Width
qiskit.transpiler.passes.synthesis.plugin
Overview
HighLevelSynthesisPlugin
HighLevelSynthesisPluginManager
unitary_synthesis_plugin_names
UnitarySynthesisPlugin
UnitarySynthesisPluginManager
qiskit.transpiler.preset_passmanagers
Overview
qiskit.transpiler.preset_passmanagers.plugin
Overview
PassManagerStagePlugin
PassManagerStagePluginManager
qiskit.transpiler.synthesis.aqc
Overview
ApproximateCircuit
ApproximatingObjective
AQC
AQCSynthesisPlugin
CNOTUnitCircuit
CNOTUnitObjective
DefaultCNOTUnitObjective
FastCNOTUnitObjective
qiskit.utils
Overview
QuantumInstance
qiskit.utils.mitigation
Overview
CompleteMeasFitter
TensoredMeasFitter
qiskit.visualization
Overview
array_to_latex
circuit_drawer
dag_drawer
DefaultStyle
IQXDebugging
IQXSimple
IQXStandard
pass_manager_drawer
plot_bloch_multivector
plot_bloch_vector
plot_circuit_layout
plot_coupling_map
plot_distribution
plot_error_map
plot_gate_map
plot_histogram
plot_state_city
plot_state_hinton
plot_state_paulivec
plot_state_qsphere
pulse_drawer
timeline_drawer
visualize_transition
Release notes
0.45
0.44
0.43
0.42
0.41
0.40
0.39
0.38
0.37
0.36
0.35
0.34
0.33
0.32
0.31
0.30
0.29
0.28
0.27
0.26
0.25
0.24
0.23
0.22
0.21
0.20
0.19
0.18
0.17
0.16
0.15
0.14
0.13
0.12
0.11
0.10
0.9
0.8
0.7
0.6
0.5
Built-in Transpiler Synthesis Plugins
Approximate Quantum Compiler (
qiskit.transpiler.synthesis.aqc
)
Interface
Mathematical Detail
Was this page helpful?
Yes
No
Focus sentinel
Focus sentinel
Open Feedback