pennylane_orquestra.OrquestraDevice¶

class
pennylane_orquestra.
OrquestraDevice
(wires, shots=10000, analytic=True, **kwargs)[source]¶ Bases:
pennylane._qubit_device.QubitDevice
,abc.ABC
The Orquestra base device.
Provides the
execute()
andbatch_execute()
methods which allows remote device executions by generating, submitting Orquestra workflows and processing their results.The
batch_execute()
method can be utilized to send workflows that contain several circuits which are computed in parallel on a remote device.The workflow files generated are placed into a user specific data folder specified by the output of
appdirs.user_data_dir("pennylaneorquestra", "Xanadu")
. By default, such files are removed (seekeep_files
keyword argument). After each device execution, filenames for the generated workflows are stored in thefilenames
attribute.Computing the expectation value of the identity operator does not involve a workflow submission (hence no files are created).
 Parameters
wires (int, Iterable[Number, str]]) – Number of subsystems represented by the device, or iterable that contains unique labels for the subsystems as numbers (i.e.,
[1, 0, 2]
) or strings (['ancilla', 'q1', 'q2']
). Default 1 if not specified.shots (int) – number of circuit evaluations/random samples used to estimate expectation values of observables
analytic (bool) – If
True
, the device calculates expectation values analytically. IfFalse
, a finite number of samples set by the argumentshots
are used to estimate these quantities.
 Keyword Arguments
backend=None (str) – the Orquestra backend device to use for the specific Orquestra backend, if applicable
batch_size=10 (int) – the size of each circuit batch when using the
batch_execute()
method to send multiple workflowskeep_files=False (bool) – whether or not the workflow files generated during the circuit execution should be kept or deleted
resources=None (dict) – an option for Orquestra, specifies the resources provisioned for the clusters running each workflow step
timeout=300 (int) – the maximum time until a job will timeout after getting no response from Orquestra (in seconds)
Attributes
The backend specifications defined for the device.
Number of device executions to store in a cache to speed up subsequent executions.
The hash of the circuit upon the last execution.
Returns the names of the workflow files created during device executions.
Returns the latest workflow ID that has been executed.
Number of times this device is executed by the evaluation of QNodes running on this device
The observables to be measured and returned.
The operation queue to be applied.
Mapping from free parameter index to the list of
Operations
in the device queue that depend on it.Device specific Orquestra component name used in the backend specification.
Device specific Orquestra function name used in the backend specification.
Device specific Orquestra module name used in the backend specification.
Number of circuit evaluations/random samples used to estimate expectation values of observables
Returns the state vector of the circuit prior to measurement.
Ordered dictionary that defines the map from userprovided wire labels to the wire labels used on this device
All wires that can be addressed on this device

backend_specs
¶ The backend specifications defined for the device.
 Returns
the backend specifications represented as a string
 Return type
str

cache
¶ Number of device executions to store in a cache to speed up subsequent executions. If set to zero, no caching occurs.
 Type
int

circuit_hash
¶ The hash of the circuit upon the last execution.
This can be used by devices in
apply()
for parametric compilation.

filenames
¶ Returns the names of the workflow files created during device executions.
 Returns
the workflow filenames
 Return type
list

latest_id
¶ Returns the latest workflow ID that has been executed.
 Returns
the ID of the latest workflow that has been submitted
 Return type
str

name
= 'Orquestra base device for PennyLane'¶

num_executions
¶ Number of times this device is executed by the evaluation of QNodes running on this device
 Returns
number of executions
 Return type
int

obs_queue
¶ The observables to be measured and returned.
Note that this property can only be accessed within the execution context of
execute()
. Raises
ValueError – if outside of the execution context
 Returns
list[~.operation.Observable]

observables
= {'Hadamard', 'Identity', 'PauliX', 'PauliY', 'PauliZ'}¶

op_queue
¶ The operation queue to be applied.
Note that this property can only be accessed within the execution context of
execute()
. Raises
ValueError – if outside of the execution context
 Returns
list[~.operation.Operation]

operations
= {'BasisState', 'CNOT', 'CRX', 'CRY', 'CRZ', 'CRot', 'CSWAP', 'CY', 'CZ', 'Hadamard', 'MultiRZ', 'PauliX', 'PauliY', 'PauliZ', 'PhaseShift', 'QubitStateVector', 'RX', 'RY', 'RZ', 'Rot', 'S', 'SWAP', 'SX', 'T', 'Toffoli'}¶

parameters
¶ Mapping from free parameter index to the list of
Operations
in the device queue that depend on it.Note that this property can only be accessed within the execution context of
execute()
. Raises
ValueError – if outside of the execution context
 Returns
the mapping
 Return type
dict[int>list[ParameterDependency]]

pennylane_requires
= '>=0.13.0'¶

qe_component
¶ Device specific Orquestra component name used in the backend specification.

qe_function_name
¶ Device specific Orquestra function name used in the backend specification.

qe_module_name
¶ Device specific Orquestra module name used in the backend specification.

short_name
= 'orquestra.base'¶

shots
¶ Number of circuit evaluations/random samples used to estimate expectation values of observables

state
¶ Returns the state vector of the circuit prior to measurement.
Note
Only state vector simulators support this property. Please see the plugin documentation for more details.

version
= '0.13.1'¶

wire_map
¶ Ordered dictionary that defines the map from userprovided wire labels to the wire labels used on this device

wires
¶ All wires that can be addressed on this device
Methods
access_state
([wires])Check that the device has access to an internal state and return it if available.
active_wires
(operators)Returns the wires acted on by a set of operators.
analytic_probability
([wires])Return the (marginal) probability of each computational basis state from the last run of the device.
apply
(operations, **kwargs)Apply quantum operations, rotate the circuit into the measurement basis, and compile and execute the quantum circuit.
batch_execute
(circuits, **kwargs)Execute a batch of quantum circuits on the device.
Get the capabilities of this device class.
check_validity
(queue, observables)Checks whether the operations and observables in queue are all supported by the device.
Create the backend specifications as a dictionary based on the device options.
define_wire_map
(wires)Create the map from userprovided wire labels to the wire labels used by the device.
density_matrix
(wires)Returns the reduced density matrix prior to measurement.
estimate_probability
([wires])Return the estimated probability of each computational basis state using the generated samples.
execute
(circuit, **kwargs)Execute a queue of quantum operations on the device and then measure the given observables.
The device execution context used during calls to
execute()
.expval
(observable)Returns the expectation value of observable on specified wires.
generate_basis_states
(num_wires[, dtype])Generates basis states in binary representation according to the number of wires specified.
Returns the computational basis samples generated for all wires.
insert_identity_res_batch
(results, …)An auxiliary function for inserting values which were not computed using workflows into batch results.
map_wires
(wires)Map the wire labels of wires using this device’s wire map.
marginal_prob
(prob[, wires])Return the marginal probability of the computational basis states by summing the probabiliites on the nonspecified wires.
multi_step_execute
(circuits, file_id, **kwargs)Creates a multistep workflow for executing a batch of circuits.
multiple_steps_results
(workflow_id)Extracts the results of multiple steps obtained for a workflow.
pauliz_operator_string
(wires)Creates an OpenFermion operator string based on the measured wires that can be passed when creating an
openfermion.IsingOperator
.Called during
execute()
after the individual operations have been executed.Called during
execute()
after the individual observables have been measured.Called during
execute()
before the individual operations are executed.Called during
execute()
before the individual observables are measured.probability
([wires])Return either the analytic probability or estimated probability of each computational basis state.
process_observables
(observables)Processes the observables provided with the circuits.
qubit_operator_string
(observable)Serializes a PennyLane observable to a string compatible with the openfermion.QubitOperator class.
reset
()Reset the backend state.
sample
(observable)Return a sample of an observable.
sample_basis_states
(number_of_states, …)Sample from the computational basis states based on the state probability.
serialize_circuit
(circuit)Serializes the circuit before submission according to the backend specified.
serialize_operator
(observable)Serialize the observable specified for the circuit as an OpenFermion operator.
single_step_results
(workflow_id)Extracts the results of a single step obtained for a workflow.
states_to_binary
(samples, num_wires[, dtype])Convert basis states from base 10 to binary representation.
statistics
(observables)Process measurement results from circuit execution and return statistics.
supports_observable
(observable)Checks if an observable is supported by this device. Raises a ValueError,
supports_operation
(operation)Checks if an operation is supported by this device.
var
(observable)Returns the variance of observable on specified wires.

access_state
(wires=None)¶ Check that the device has access to an internal state and return it if available.
 Parameters
wires (Wires) – wires of the reduced system
 Raises
QuantumFunctionError – if the device is not capable of returning the state
 Returns
the state or the density matrix of the device
 Return type
array or tensor

static
active_wires
(operators)¶ Returns the wires acted on by a set of operators.
 Parameters
operators (list[Operation]) – operators for which we are gathering the active wires
 Returns
wires activated by the specified operators
 Return type
Wires

analytic_probability
(wires=None)¶ Return the (marginal) probability of each computational basis state from the last run of the device.
PennyLane uses the convention \(q_0,q_1,\dots,q_{N1}\rangle\) where \(q_0\) is the most significant bit.
If no wires are specified, then all the basis states representable by the device are considered and no marginalization takes place.
Note
marginal_prob()
may be used as a utility method to calculate the marginal probability distribution. Parameters
wires (Iterable[Number, str], Number, str, Wires) – wires to return marginal probabilities for. Wires not provided are traced out of the system.
 Returns
list of the probabilities
 Return type
List[float]

apply
(operations, **kwargs)[source]¶ Apply quantum operations, rotate the circuit into the measurement basis, and compile and execute the quantum circuit.
This method receives a list of quantum operations queued by the QNode, and should be responsible for:
Constructing the quantum program
(Optional) Rotating the quantum circuit using the rotation operations provided. This diagonalizes the circuit so that arbitrary observables can be measured in the computational basis.
Compile the circuit
Execute the quantum circuit
Both arguments are provided as lists of PennyLane
Operation
instances. Useful properties includename
,wires
, andparameters
, andinverse
:>>> op = qml.RX(0.2, wires=[0]) >>> op.name # returns the operation name "RX" >>> op.wires # returns a Wires object representing the wires that the operation acts on <Wires = [0]> >>> op.parameters # returns a list of parameters [0.2] >>> op.inverse # check if the operation should be inverted False >>> op = qml.RX(0.2, wires=[0]).inv >>> op.inverse True
 Parameters
operations (list[Operation]) – operations to apply to the device
 Keyword Arguments
rotations (list[Operation]) – operations that rotate the circuit premeasurement into the eigenbasis of the observables.
hash (int) – the hash value of the circuit constructed by CircuitGraph.hash

batch_execute
(circuits, **kwargs)[source]¶ Execute a batch of quantum circuits on the device.
The circuits are represented by tapes, and they are executed onebyone using the device’s
execute
method. The results are collected in a list.For plugin developers: This function should be overwritten if the device can efficiently run multiple circuits on a backend, for example using parallel and/or asynchronous executions.
 Parameters
circuits (list[tapes.QuantumTape]) – circuits to execute on the device
 Returns
list of measured value(s)
 Return type
list[array[float]]

classmethod
capabilities
()[source]¶ Get the capabilities of this device class.
Inheriting classes that change or add capabilities must override this method, for example via
@classmethod def capabilities(cls): capabilities = super().capabilities().copy() capabilities.update( supports_inverse_operations=False, supports_a_new_capability=True, ) return capabilities
 Returns
results
 Return type
dict[str>*]

check_validity
(queue, observables)¶ Checks whether the operations and observables in queue are all supported by the device. Includes checks for inverse operations.
 Parameters
queue (Iterable[Operation]) – quantum operation objects which are intended to be applied on the device
observables (Iterable[Observable]) – observables which are intended to be evaluated on the device
 Raises
DeviceError – if there are operations in the queue or observables that the device does not support

create_backend_specs
()[source]¶ Create the backend specifications as a dictionary based on the device options.
Backend specifications are dictionaries submitted in a serialized json string format to Orquestra to specify which
QuantumBackend
to run quantum circuits on. Data specified include details such as the name of the external framework, the exact device to be used when several availabe, the number of samples to obtain (if not exact computation). Returns
the backend specifications represented as a dictionary
 Return type
dict

define_wire_map
(wires)¶ Create the map from userprovided wire labels to the wire labels used by the device.
The default wire map maps the user wire labels to wire labels that are consecutive integers.
However, by overwriting this function, devices can specify their preferred, nonconsecutive and/or noninteger wire labels.
 Parameters
wires (Wires) – userprovided wires for this device
 Returns
dictionary specifying the wire map
 Return type
OrderedDict
Example
>>> dev = device('my.device', wires=['b', 'a']) >>> dev.wire_map() OrderedDict( [(<Wires = ['a']>, <Wires = [0]>), (<Wires = ['b']>, <Wires = [1]>)])

density_matrix
(wires)¶ Returns the reduced density matrix prior to measurement.
Note
Only state vector simulators support this property. Please see the plugin documentation for more details.

estimate_probability
(wires=None)¶ Return the estimated probability of each computational basis state using the generated samples.
 Parameters
wires (Iterable[Number, str], Number, str, Wires) – wires to calculate marginal probabilities for. Wires not provided are traced out of the system.
 Returns
list of the probabilities
 Return type
List[float]

execute
(circuit, **kwargs)[source]¶ Execute a queue of quantum operations on the device and then measure the given observables.
For plugin developers: instead of overwriting this, consider implementing a suitable subset of
Additional keyword arguments may be passed to the this method that can be utilised by
apply()
. An example would be passing theQNode
hash that can be used later for parametric compilation. Parameters
circuit (CircuitGraph) – circuit to execute on the device
 Raises
QuantumFunctionError – if the value of
return_type
is not supported Returns
measured value(s)
 Return type
array[float]

execution_context
()¶ The device execution context used during calls to
execute()
.You can overwrite this function to return a context manager in case your quantum library requires that; all operations and method calls (including
apply()
andexpval()
) are then evaluated within the context of this context manager (see the source ofDevice.execute()
for more details).

expval
(observable)¶ Returns the expectation value of observable on specified wires.
Note: all arguments accept _lists_, which indicate a tensor product of observables.
 Parameters
observable (str or list[str]) – name of the observable(s)
wires (Wires) – wires the observable(s) are to be measured on
par (tuple or list[tuple]]) – parameters for the observable(s)
 Returns
expectation value \(\expect{A} = \bra{\psi}A\ket{\psi}\)
 Return type
float

static
generate_basis_states
(num_wires, dtype=<class 'numpy.uint32'>)¶ Generates basis states in binary representation according to the number of wires specified.
The states_to_binary method creates basis states faster (for larger systems at times over x25 times faster) than the approach using
itertools.product
, at the expense of using slightly more memory.Due to the large size of the integer arrays for more than 32 bits, memory allocation errors may arise in the states_to_binary method. Hence we constraint the dtype of the array to represent unsigned integers on 32 bits. Due to this constraint, an overflow occurs for 32 or more wires, therefore this approach is used only for fewer wires.
For smaller number of wires speed is comparable to the next approach (using
itertools.product
), hence we resort to that one for testing purposes. Parameters
num_wires (int) – the number wires
dtype=np.uint32 (type) – the data type of the arrays to use
 Returns
the sampled basis states
 Return type
np.ndarray

generate_samples
()¶ Returns the computational basis samples generated for all wires.
Note that PennyLane uses the convention \(q_0,q_1,\dots,q_{N1}\rangle\) where \(q_0\) is the most significant bit.
Warning
This method should be overwritten on devices that generate their own computational basis samples, with the resulting computational basis samples stored as
self._samples
. Returns
array of samples in the shape
(dev.shots, dev.num_wires)
 Return type
array[complex]

static
insert_identity_res_batch
(results, empty_obs_list, identity_indices)[source]¶ An auxiliary function for inserting values which were not computed using workflows into batch results.
Computations involving the identity observable are given by theoretical values rather than as part of a workflow. Therefore, such values need to be inserted into the results later.
 Parameters
results (list) – workflow results of the batched execution
empty_obs_list (list) – list of indices where every observable is the identity
identity_indices (dict) – maps the index of a sublist to the the list of indices where the observable is an identity
 Returns
list of results
 Return type
list

map_wires
(wires)¶ Map the wire labels of wires using this device’s wire map.
 Parameters
wires (Wires) – wires whose labels we want to map to the device’s internal labelling scheme
 Returns
wires with new labels
 Return type
Wires

marginal_prob
(prob, wires=None)¶ Return the marginal probability of the computational basis states by summing the probabiliites on the nonspecified wires.
If no wires are specified, then all the basis states representable by the device are considered and no marginalization takes place.
Note
If the provided wires are not in the order as they appear on the device, the returned marginal probabilities take this permutation into account.
For example, if the addressable wires on this device are
Wires([0, 1, 2])
and this function gets passedwires=[2, 0]
, then the returned marginal probability vector will take this ‘reversal’ of the two wires into account:\[\mathbb{P}^{(2, 0)} = \left[ 00\rangle, 10\rangle, 01\rangle, 11\rangle \right]\] Parameters
prob – The probabilities to return the marginal probabilities for
wires (Iterable[Number, str], Number, str, Wires) – wires to return marginal probabilities for. Wires not provided are traced out of the system.
 Returns
array of the resulting marginal probabilities.
 Return type
array[float]

multi_step_execute
(circuits, file_id, **kwargs)[source]¶ Creates a multistep workflow for executing a batch of circuits.
 Parameters
circuits (list[QuantumTape]) – circuits to execute on the device
file_id (str) – the file id to be used for naming the workflow file
 Returns
list of measured value(s) for the batch
 Return type
list[array[float]]

multiple_steps_results
(workflow_id)[source]¶ Extracts the results of multiple steps obtained for a workflow.
This method assumes that the workflow had multiple steps and that the structure of the result corresponds to results sent by Orquestra API v1.0.0.
Orquestra doesn’t necessarily execute parallel steps in the order they were defined in a workflow file. Therefore, due to parallel execution, results might have been written in any order, so results are sorted by the step name.
 Parameters
workflow_id (str) – the ID of the workflow to extract results for
 Returns
a list of workflow results for each step
 Return type
results (list)

static
pauliz_operator_string
(wires)[source]¶ Creates an OpenFermion operator string based on the measured wires that can be passed when creating an
openfermion.IsingOperator
.This method is used if rotations are needed for the backend specified. In such a case a string that represents measuring PauliZ on each of the affected wires is used.
Example
>>> dev = QeQiskitDevice(wires=2) >>> wires = [0, 1, 2] >>> op_str = dev.pauliz_operator_string(wires) >>> print(op_str) [Z0 Z1 Z2] >>> print(openfermion.IsingOperator(op_str)) 1.0 [Z0 Z1 Z2]
 Parameters
wires (Wires) – the wires the observable of the quantum function acts on
 Returns
the
openfermion.IsingOperator
string representation Return type
str

probability
(wires=None)¶ Return either the analytic probability or estimated probability of each computational basis state.
If no
analytic
attributes exists for the device, then return the estimated probability. Parameters
wires (Iterable[Number, str], Number, str, Wires) – wires to return marginal probabilities for. Wires not provided are traced out of the system.
 Returns
list of the probabilities
 Return type
List[float]

process_observables
(observables)[source]¶ Processes the observables provided with the circuits.
If the observable defined is the identity, then no serialization happens. Instead, the index of the observable is saved.
 Parameters
observables (list) – a list of observables to process
 Returns
the serialized nonidentity operators
the indices of the identity operators
 Return type
tuple

qubit_operator_string
(observable)[source]¶ Serializes a PennyLane observable to a string compatible with the openfermion.QubitOperator class.
This method decomposes an observable into a sum of Pauli terms and identities, if needed.
Example
>>> dev = QeQiskitDevice(wires=2) >>> obs = qml.PauliZ(0) >>> op_str = dev.qubit_operator_string(obs) >>> print(op_str) 1 [Z0] >>> obs = qml.Hadamard(0) >>> op_str = dev.qubit_operator_string(obs) >>> print(op_str) 0.7071067811865475 [X0] + 0.7071067811865475 [Z0]
 Parameters
observable (pennylane.operation.Observable) – the observable to serialize
 Returns
the
openfermion.QubitOperator
string representation Return type
str

reset
()¶ Reset the backend state.
After the reset, the backend should be as if it was just constructed. Most importantly the quantum state is reset to its initial value.

sample
(observable)¶ Return a sample of an observable.
The number of samples is determined by the value of
Device.shots
, which can be directly modified.Note: all arguments support _lists_, which indicate a tensor product of observables.
 Parameters
observable (str or list[str]) – name of the observable(s)
wires (Wires) – wires the observable(s) is to be measured on
par (tuple or list[tuple]]) – parameters for the observable(s)
 Raises
NotImplementedError – if the device does not support sampling
 Returns
samples in an array of dimension
(shots,)
 Return type
array[float]

sample_basis_states
(number_of_states, state_probability)¶ Sample from the computational basis states based on the state probability.
This is an auxiliary method to the generate_samples method.
 Parameters
number_of_states (int) – the number of basis states to sample from
 Returns
the sampled basis states
 Return type
List[int]

serialize_circuit
(circuit)[source]¶ Serializes the circuit before submission according to the backend specified.
The circuit is represented as an OpenQASM 2.0 program. Measurement instructions are removed from the program as the operator is passed separately.
 Parameters
circuit (CircuitGraph) – circuit to serialize
 Returns
OpenQASM 2.0 representation of the circuit without any measurement instructions
 Return type
str

serialize_operator
(observable)[source]¶ Serialize the observable specified for the circuit as an OpenFermion operator.
 Parameters
observable (pennylane.operation.Observable) – the observable to get the operator representation for
 Returns
string representation of terms making up the observable
 Return type
str

single_step_results
(workflow_id)[source]¶ Extracts the results of a single step obtained for a workflow.
This method assumes that the workflow had a single step and that the structure of the result corresponds to results sent by Orquestra API v1.0.0.
 Parameters
workflow_id (str) – the ID of the workflow to extract results for
 Returns
a list of workflow results
 Return type
results (list)

static
states_to_binary
(samples, num_wires, dtype=<class 'numpy.int64'>)¶ Convert basis states from base 10 to binary representation.
This is an auxiliary method to the generate_samples method.
 Parameters
samples (List[int]) – samples of basis states in base 10 representation
num_wires (int) – the number of qubits
dtype (type) – Type of the internal integer array to be used. Can be important to specify for large systems for memory allocation purposes.
 Returns
basis states in binary representation
 Return type
List[int]

statistics
(observables)¶ Process measurement results from circuit execution and return statistics.
This includes returning expectation values, variance, samples, probabilities, states, and density matrices.
 Parameters
observables (List[Observable]) – the observables to be measured
 Raises
QuantumFunctionError – if the value of
return_type
is not supported Returns
the corresponding statistics
 Return type
Union[float, List[float]]

supports_observable
(observable)¶  Checks if an observable is supported by this device. Raises a ValueError,
if not a subclass or string of an Observable was passed.
 Parameters
observable (type or str) – observable to be checked
 Raises
ValueError – if observable is not a
Observable
class or string Returns
True
iff supplied observable is supported Return type
bool

supports_operation
(operation)¶ Checks if an operation is supported by this device.
 Parameters
operation (type or str) – operation to be checked
 Raises
ValueError – if operation is not a
Operation
class or string Returns
True
iff supplied operation is supported Return type
bool

var
(observable)¶ Returns the variance of observable on specified wires.
Note: all arguments support _lists_, which indicate a tensor product of observables.
 Parameters
observable (str or list[str]) – name of the observable(s)
wires (Wires) – wires the observable(s) is to be measured on
par (tuple or list[tuple]]) – parameters for the observable(s)
 Raises
NotImplementedError – if the device does not support variance computation
 Returns
variance \(\mathrm{var}(A) = \bra{\psi}A^2\ket{\psi}  \bra{\psi}A\ket{\psi}^2\)
 Return type
float
Contents
Usage
API
Downloads