Root namespace (qiskit)
Most Qiskit functionality is accessed through specific submodules. You can consult the top-level documentation of qiskit to find the list of modules, such as qiskit.circuit or qiskit.transpiler.passes.
Several names are re-exported from the repository root, whose canonical public locations are in submodules. The re-exports in the root namespace are part of Qiskit’s public API.
Names re-exported from qiskit.circuit:
AncillaRegister([size, name, bits]) | Implement an ancilla register. |
ClassicalRegister([size, name, bits]) | Implement a register. |
QuantumCircuit(*regs[, name, global_phase, ...]) | Core Qiskit representation of a quantum circuit. |
QuantumRegister([size, name, bits]) | Implement a register. |
Names re-exported from qiskit.compiler:
transpile(circuits[, backend, basis_gates, ...]) | Transpile one or more circuits, according to some desired transpilation targets. |
Names re-exported from qiskit.exceptions:
MissingOptionalLibraryError(libname, name[, ...]) | Raised when an optional library is missing. |
QiskitError(*message) | Base class for errors raised by Qiskit. |
Names re-exported from qiskit.transpiler:
generate_preset_pass_manager([...]) | Generate a preset PassManager |
Was this page helpful?
Report a bug, typo, or request content on GitHub.