qml¶
This is the top level module from which all basic functions and classes of PennyLane can be directly imported.
Functions¶
|
Prints the information for pennylane installation. |
|
Create the adjoint of an Operator or a function that applies the adjoint of the provided function. |
|
Implements the adjoint method outlined in Jones to compute the metric tensor. |
|
Apply an instantiated operator or measurement to a queuing context. |
|
Provides the circuit to apply a controlled version of the \(\mathcal{Q}\) unitary defined in this paper. |
|
Transform a QNode to support an initial batch dimension for gate inputs. |
|
Transform a QNode to support an initial batch dimension for operation parameters. |
|
Create a batched partial callable object from the QNode specified. |
|
Applies a unitary multiple times to a specific pattern of wires. |
|
Construct the pairwise-commutation DAG (directed acyclic graph) representation of a quantum circuit. |
|
Compile a circuit by applying a series of transforms to a quantum function. |
|
Condition a quantum operation on the results of mid-circuit qubit measurements. |
|
Create a method that applies a controlled version of the provided method. |
|
Cut up a quantum circuit into smaller circuit fragments. |
|
Cut up a circuit containing sample measurements into smaller fragments using a Monte Carlo method. |
|
Quantum function transform that substitutes operations conditioned on measurement outcomes to controlled operations. |
|
Quantum density matrix in the computational basis. |
|
Load a |
|
Lazily perform the dot product between arrays, tensors, and |
|
Create a function that draws the given qnode. |
|
Draw a qnode with matplotlib |
|
The eigenvalues of one or more operations. |
|
Function for determining operator equality. |
|
Execute a batch of tapes on a device in an autodifferentiable-compatible manner. |
|
Expectation value of the supplied observable. |
|
Loads pyQuil Program objects by using the converter in the PennyLane-Forest plugin. |
|
Loads quantum circuits from a QASM string using the converter in the PennyLane-Qiskit plugin. |
|
Loads quantum circuits from a QASM file using the converter in the PennyLane-Qiskit plugin. |
|
Loads Qiskit QuantumCircuit objects by using the converter in the PennyLane-Qiskit plugin. |
|
Loads quantum circuits from a Quil string using the converter in the PennyLane-Forest plugin. |
|
Loads quantum circuits from a Quil file using the converter in the PennyLane-Forest plugin. |
|
Returns the generator of an operation. |
|
Convert an external operator to a PennyLane operator. |
|
Check if two operations are commuting using a lookup table. |
|
Returns the Jacobian as a callable function of vector-valued (functions of) QNodes. |
|
Repeatedly applies a unitary a given number of times. |
|
Load external quantum assembly and quantum circuits from supported frameworks into PennyLane templates. |
|
Map a quantum template over a list of observables to create a |
|
The matrix representation of an operation or quantum circuit. |
|
Perform a mid-circuit measurement in the computational basis on the supplied qubit. |
|
Returns a list of measurement optimized tapes, and a classical processing function, for evaluating the expectation value of a provided Hamiltonian. |
|
Returns a function that computes the metric tensor of a given QNode or quantum tape. |
|
Mutual information between the subsystems prior to measurement: |
|
Function that applies the pattern matching algorithm and returns the list of maximal matches. |
|
Quantum function transform to optimize a circuit given a list of patterns (templates). |
|
Generate the single qubit Pauli-X operators \(\sigma^{x}_{i}\) for each symmetry \(\tau_j\), such that it anti-commutes with \(\tau_j\) and commutes with all others symmetries \(\tau_{k\neq j}\). |
|
Probability of each computational basis state. |
|
Given a function which defines a tape transform, convert the function into one that applies the tape transform to quantum functions (qfuncs). |
|
Represents a quantum node in the hybrid computational graph. |
|
Provides the circuit to perform the quantum Monte Carlo estimation algorithm. |
Scan installed PennyLane plugins to refresh the device list. |
|
|
Sample from the supplied observable, with the number of shots determined from the |
|
Simplify the (controlled) rotation operations |
|
Create a function that retrieves snapshot results from a QNode. |
|
Resource information about a quantum circuit. |
|
Quantum state in the computational basis. |
|
Lazily sum the constituent QNodes of a |
Compute the generators \(\{\tau_1, \ldots, \tau_k\}\) for a Hamiltonian over the binary field \(\mathbb{Z}_2\). |
|
|
Transform a Hamiltonian with a Clifford operator and taper qubits. |
|
Variance of the supplied observable. |
|
Returns the PennyLane version number. |
|
Von Neumann entropy of the system prior to measurement. |
Classes¶
|
Gradient-descent optimizer with past-gradient-dependent learning rate in each dimension. |
|
Gradient-descent optimizer with adaptive learning rate, first and second moment. |
|
Builds a quantum circuit to prepare correlated states of molecules by applying all |
|
Single-qubit amplitude damping error channel. |
|
Encodes \(2^n\) features into the amplitude vector of \(n\) qubits. |
|
Encodes \(N\) features into the rotation angles of \(n\) qubits, where \(N \leq n\). |
|
Applies the Trotterized time-evolution operator for an arbitrary Hamiltonian, expressed in terms of Pauli gates. |
|
Implements an arbitrary state preparation on the specified wires. |
|
Implements an arbitrary unitary on the specified wires. |
|
The Barrier operator, used to separate the compilation process into blocks or as a visual tool. |
|
Layers consisting of one-parameter single-qubit rotations on each qubit, followed by a closed chain or ring of CNOT gates. |
|
Encodes \(n\) binary features into a basis state of \(n\) qubits. |
|
Prepares a single computational basis state. |
|
Prepares a basis state on the given wires using a sequence of Pauli-X gates. |
|
Beamsplitter interaction. |
|
Single-qubit bit flip (Pauli \(X\)) error channel. |
|
Wrapper for simple callables with boolean output that can be manipulated and combined with bit-wise operators. |
|
The controlled-NOT operator |
alias of |
|
|
The controlled-RX operator |
|
The controlled-RY operator |
|
The controlled-RZ operator |
|
The controlled-Rot operator |
|
The controlled-swap operator |
|
A sequence of layers of a continuous-variable quantum neural network, as specified in Killoran et al. (2019). |
|
The controlled-Y operator |
|
The controlled-Z operator |
|
Prepares a cat state. |
|
Represents a quantum circuit as a directed acyclic graph. |
|
Prepares a coherent state. |
|
Applies the time-evolution operator for a Hamiltonian expressed as a linear combination of mutually commuting Pauli words. |
|
Configuration class. |
|
Controlled addition operation. |
|
Controlled phase operation. |
|
A qubit controlled phase shift. |
|
Apply an arbitrary fixed unitary to |
|
Cross-Kerr interaction. |
|
Cubic phase shift. |
|
Single-qubit symmetrically depolarizing error channel. |
|
Abstract base class for PennyLane devices. |
Exception raised by a |
|
|
Apply an arbitrary fixed diagonal unitary matrix. |
|
Prepares a displaced squeezed vacuum state. |
|
Phase space displacement. |
|
Encodes \(N\) features into the displacement amplitudes \(r\) or phases \(\phi\) of \(M\) modes, where \(N\leq M\). |
|
Double excitation rotation. |
|
Double excitation rotation with negative phase-shift outside the rotation subspace. |
|
Double excitation rotation with positive phase-shift outside the rotation subspace. |
|
An echoed RZX(pi/2) gate. |
|
Create a cost function that gives the expectation value of an input Hamiltonian. |
|
Circuit to exponentiate the tensor product of Pauli matrices representing the double-excitation operator entering the Unitary Coupled-Cluster Singles and Doubles (UCCSD) ansatz. |
|
Circuit to exponentiate the tensor product of Pauli matrices representing the single-excitation operator entering the Unitary Coupled-Cluster Singles and Doubles (UCCSD) ansatz. |
|
Prepare subsystems using the given density matrix in the Fock basis. |
|
Prepares a single Fock state. |
|
The number state observable \(\ket{n}\bra{n}\). |
|
Prepare subsystems using the given ket vector in the Fock basis. |
|
Implements a local, expressive, and quantum-number-preserving ansatz proposed by Anselmetti et al. (2021). |
|
Prepare subsystems in a given Gaussian state. |
|
Single-qubit generalized amplitude damping error channel. |
|
Basic gradient-descent optimizer. |
|
Performs the Grover Diffusion Operator. |
|
The Hadamard operator |
|
Operator representing a Hamiltonian. |
|
An arbitrary Hermitian observable. |
|
Create a Hilbert-Schmidt template that can be used to compute the Hilbert-Schmidt Test (HST). |
|
Encodes \(n\) features into \(n\) qubits using diagonal gates of an IQP circuit. |
|
The i-swap operator |
|
The identity observable \(\I\). |
|
General linear interferometer, an array of beamsplitters and phase shifters. |
|
A linear interferometer transforming the bosonic operators according to the unitary matrix \(U\). |
|
Ising XX coupling gate |
|
Ising (XX + YY) coupling gate |
|
Ising YY coupling gate |
|
Ising ZZ coupling gate |
|
Kerr interaction. |
|
Lie algebra optimizer. |
|
Create a Local Hilbert-Schmidt template that can be used to compute the Local Hilbert-Schmidt Test (LHST). |
|
The MERA template broadcasts an input circuit across many wires following the architecture of a multi-scale entanglement renormalization ansatz tensor network. |
|
The MPS template broadcasts an input circuit across many wires following the architecture of a Matrix Product State tensor network. |
|
Gradient-descent optimizer with momentum. |
|
Prepares an arbitrary state on the given wires using a decomposition into gates developed by Möttönen et al. (2004). |
|
Apply a Pauli X gate controlled on an arbitrary computational basis state. |
|
Arbitrary multi Z rotation. |
|
Gradient-descent optimizer with Nesterov momentum. |
|
The photon number observable \(\langle \hat{n}\rangle\). |
|
Spin-adapted spatial orbital rotation. |
|
The momentum quadrature observable \(\hat{p}\). |
|
Implements the heuristic VQE ansatz for quantum chemistry simulations using the particle-conserving gate \(U_{1,\mathrm{ex}}\) proposed by Barkoutsos et al. in arXiv:1805.04340. |
|
Implements the heuristic VQE ansatz for Quantum Chemistry simulations using the particle-conserving entangler \(U_\mathrm{ent}(\vec{\theta}, \vec{\phi})\) proposed in arXiv:1805.04340. |
|
Pauli operator error channel for an arbitrary number of qubits. |
|
Arbitrary Pauli word rotation. |
|
The Pauli X operator |
|
The Pauli Y operator |
|
The Pauli Z operator |
|
Applies a permutation to a set of wires. |
|
Single-qubit phase damping error channel. |
|
Single-qubit bit flip (Pauli \(Z\)) error channel. |
|
Arbitrary single qubit local phase shift |
|
An arbitrary second-order polynomial observable. |
|
Observable corresponding to the computational basis state projector \(P=\ket{i}\bra{i}\). |
|
Encodes \(N\) features into \(n>N\) qubits, using a layered, trainable quantum circuit that is inspired by the QAOA ansatz. |
|
Apply a quantum Fourier transform (QFT). |
|
Optimizer with adaptive learning rate, via calculation of the diagonal or block-diagonal approximation to the Fubini-Study metric tensor. |
|
Represents a quantum node in the hybrid computational graph. |
|
Represents a sequence of independent QNodes that all share the same signature. |
|
The generalized quadrature observable \(\x_\phi = \x cos\phi+\p\sin\phi\). |
|
Quadratic phase shift. |
Exception raised when an illegal operation is defined in a quantum function. |
|
|
Performs the quantum Monte Carlo estimation algorithm. |
|
Performs the quantum phase estimation circuit. |
|
Apply the |
|
Apply an arbitrary fixed quantum channel. |
|
Prepare subsystems using the given density matrix. |
|
Abstract base class for PennyLane qubit devices. |
|
Prepare subsystems using the given ket vector in the computational basis. |
|
Apply a |
|
Apply an arbitrary fixed unitary matrix. |
Abstract base class for classes that exposes a queue for objects. |
|
|
Apply an arbitrary, fixed unitary matrix. |
|
Root mean squared propagation optimizer. |
|
The single qubit X rotation |
|
The single qubit Y rotation |
|
The single qubit Z rotation |
|
Layers of randomly chosen single qubit rotations and 2-qubit entangling gates, acting on randomly chosen qubits. |
|
Single-qubit Reset error channel. |
|
Arbitrary single qubit rotation |
|
Phase space rotation. |
|
Rotoselect gradient-free optimizer. |
|
Rotosolve gradient-free optimizer. |
|
The single-qubit phase gate |
|
The square root of i-swap operator. |
|
The Simultaneous Perturbation Stochastic Approximation method (SPSA) is a stochastic approximation algorithm for optimizing cost functions whose evaluation may involve noise. |
alias of |
|
|
The swap operator |
|
The single-qubit Square-Root X operator. |
|
Optimizer where the shot rate is adaptively calculated using the variances of the parameter-shift gradient. |
|
Layers consisting of a simplified 2-design architecture of Pauli-Y rotations and controlled-Z entanglers proposed in Cerezo et al. (2021). |
|
Single excitation rotation. |
|
Single excitation rotation with negative phase-shift outside the rotation subspace. |
|
Single excitation rotation with positive phase-shift outside the rotation subspace. |
|
The Snapshot operation saves the internal simulator state at specific execution steps of a quantum function. |
|
A Hamiltonian represented directly as a sparse matrix in Compressed Sparse Row (CSR) format. |
|
Prepares a squeezed vacuum state. |
|
Phase space squeezing. |
|
Encodes \(N\) features into the squeezing amplitudes \(r \geq 0\) or phases \(\phi \in [0, 2\pi)\) of \(M\) modes, where \(N\leq M\). |
|
Layers consisting of single qubit rotations and entanglers, inspired by the circuit-centric classifier design arXiv:1804.00633. |
|
The single-qubit T gate |
|
The TTN template broadcasts an input circuit across many wires following the architecture of a tree tensor network. |
|
The tensor product of the |
|
Thermal relaxation error channel. |
|
Prepares a thermal state. |
|
Toffoli (controlled-controlled-X) gate. |
|
This class stores information about device executions and allows users to interact with that data upon individual executions and batches, even within parameter-shift gradients and optimization steps. |
|
Phase space two-mode squeezing. |
|
U1 gate. |
|
U2 gate. |
|
Arbitrary single qubit unitary. |
|
Implements the Unitary Coupled-Cluster Singles and Doubles (UCCSD) ansatz. |
|
Create a cost function that gives the expectation value of an input Hamiltonian. |
|
The wire cut operation, used to manually mark locations for wire cuts. |
|
The position quadrature observable \(\hat{x}\). |
|
Class for registering a tape transform that takes a tape, and outputs a batch of tapes to be independently executed on a quantum device. |
|
Returns the gradient as a callable function of (functions of) QNodes. |
|
Implements the k-Unitary Pair Coupled-Cluster Generalized Singles and Doubles (k-UpCCGSD) ansatz. |
|
Convert a function that applies to operators into a functional transform. |
|
For registering a tape transform that takes a tape and outputs a single new tape. |
Variables¶
Class Inheritance Diagram¶
