tfq.layers.Sample

View source on GitHub

A Layer that samples from a quantum circuit.

Given an input circuit and set of parameter values, output samples taken from the end of the circuit.

First lets define a simple circuit to sample from:

def get_circuit():
    q0 = cirq.GridQubit(0, 0)
    q1 = cirq.GridQubit(1, 0)
    circuit = cirq.Circuit(
        cirq.X(q0),
        cirq.CNOT(q1)
    )

    return circuit

When printed:

get_circuit()
(0, 0): ───X───@───

(1, 0): ───────X───

Using tfq.layers.Sample, it's possible to sample outputs from a given circuit. The circuit above will put both qubits in the |1> state.

To retrieve samples of the output state:

sample_layer = tfq.layers.Sample()
output = sample_layer(get_circuit(), repetitions=4)
output
<tf.RaggedTensor [[[1, 1], [1, 1], [1, 1], [1, 1]]]>

Notice above that there were no parameters passed as input into the layer, because the circuit wasn't parameterized. If instead the circuit had parameters, e.g.

def get_parameterized_circuit(symbols):
    q0 = cirq.GridQubit(0, 0)
    q1 = cirq.GridQubit(1, 0)
    circuit = cirq.Circuit(
        cirq.X(q0) ** symbols[0],
        cirq.CNOT(q1)
    )

    return circuit

Then it becomes necessary to provide a value for the symbol using symbol_names and symbol_values.

symbols = sympy.symbols(['x'])
sample_layer = tfq.layers.Sample()
output = sample_layer(get_parameterized_circuit(),
    symbol_names=symbols, symbol_values=[[0.5]], repetitions=4)
tf.shape(output.to_tensor())
tf.Tensor([1 4 2], shape=(3,), dtype=int32)

Note that using multiple sets of parameters returns multiple independent samples on the same circuit.

symbols = sympy.symbols(['x'])
sample_layer = tfq.layers.Sample()
params = tf.convert_to_tensor([[0.5], [0.4]],
                              dtype=tf.dtypes.float32)
output = sample_layer(get_parameterized_circuit(),
    symbol_names=symbols, symbol_values=params, repetitions=4)
tf.shape(output.to_tensor())
tf.Tensor([2 4 2], shape=(3,), dtype=int32)

The sample layer can also be used without explicitly passing in a circuit, but instead using the layer with a batch of circuits. This layer will then sample the circuits provided in the batch with multiple sets of parameters, at the same time. Note that the parameters will not be crossed along all circuits, the circuit at index i will be run with the parameters at index i.

symbols = sympy.symbols(['x'])
sample_layer = tfq.layers.Sample()

With the sample layer defined, just define both the circuit and parameter inputs.

q0 = cirq.GridQubit(0, 0)
q1 = cirq.GridQubit(1, 0)
circuits = tfq.convert_to_tensor([
    cirq.Circuit(
        cirq.X(q0) ** s[0],
        cirq.CNOT(q0, q1),
    ),
    cirq.Circuit(
        cirq.Y(q0) ** s[0],
        cirq.CNOT(q0, q1),
    )
])
params = tf.convert_to_tensor([[0.5], [0.4]],
                             dtype=tf.dtypes.float32)

The layer can be used as usual:

output = sample_layer(circuits,
    symbol_names=symbols, symbol_values = params, repetitions=4)
tf.shape(output.to_tensor())
    tf.Tensor([2 4 2], shape=(3,), dtype=int32)

backend Optional Backend to use to simulate this state. Defaults to the native Tensorflow simulator (None), however users may also specify a preconfigured cirq execution object to use instead, which must inherit cirq.SimulatesSamples or a cirq.Sampler.

activity_regularizer Optional regularizer function for the output of this layer.
dtype

dynamic

input Retrieves the input tensor(s) of a layer.

Only applicable if the layer has exactly one input, i.e. if it is connected to one incoming layer.

input_mask Retrieves the input mask tensor(s) of a layer.

Only applicable if the layer has exactly one inbound node, i.e. if it is connected to one incoming layer.

input_shape Retrieves the input shape(s) of a layer.

Only applicable if the layer has exactly one input, i.e. if it is connected to one incoming layer, or if all inputs have the same shape.

input_spec

losses Losses which are associated with this Layer.

Variable regularization tensors are created when this property is accessed, so it is eager safe: accessing losses under a tf.GradientTape will propagate gradients back to the corresponding variables.

metrics

name Returns the name of this module as passed or determined in the ctor.

name_scope Returns a tf.name_scope instance for this class.
non_trainable_variables

non_trainable_weights

output Retrieves the output tensor(s) of a layer.

Only applicable if the layer has exactly one output, i.e. if it is connected to one incoming layer.

output_mask Retrieves the output mask tensor(s) of a layer.

Only applicable if the layer has exactly one inbound node, i.e. if it is connected to one incoming layer.

output_shape Retrieves the output shape(s) of a layer.

Only applicable if the layer has one output, or if all outputs have the same shape.

submodules Sequence of all sub-modules.

Submodules are modules which are properties of this module, or found as properties of modules which are properties of this module (and so on).

a = tf.Module()
b = tf.Module()
c = tf.Module()
a.b = b
b.c = c
assert list(a.submodules) == [b, c]
assert list(b.submodules) == [c]
assert list(c.submodules) == []

trainable

trainable_variables Sequence of trainable variables owned by this module and its submodules.

trainable_weights

updates

variables Returns the list of all layer variables/weights.

Alias of self.weights.

weights Returns the list of all layer variables/weights.

Methods

build

Creates the variables of the layer (optional, for subclass implementers).

This is a method that implementers of subclasses of Layer or Model can override if they need a state-creation step in-between layer instantiation and layer call.

This is typically used to create the weights of Layer subclasses.

Arguments
input_shape Instance of TensorShape, or list of instances of TensorShape if the layer expects a list of inputs (one instance per input).

compute_mask

Computes an output mask tensor.

Arguments
inputs Tensor or list of tensors.
mask Tensor or list of tensors.

Returns
None or a tensor (or list of tensors, one per output tensor of the layer).

compute_output_shape

Computes the output shape of the layer.

If the layer has not been built, this method will call build on the layer. This assumes that the layer will later be used with inputs that match the input shape provided here.

Arguments
input_shape Shape tuple (tuple of integers) or list of shape tuples (one per output tensor of the layer). Shape tuples can include None for free dimensions, instead of an integer.

Returns
An input shape tuple.

count_params

Count the total number of scalars composing the weights.

Returns
An integer count.

Raises
ValueError if the layer isn't yet built (in which case its weights aren't yet defined).

from_config

Creates a layer from its config.

This method is the reverse of get_config, capable of instantiating the same layer from the config dictionary. It does not handle layer connectivity (handled by Network), nor weights (handled by set_weights).

Arguments
config A Python dictionary, typically the output of get_config.

Returns
A layer instance.

get_config

Returns the config of the layer.

A layer config is a Python dictionary (serializable) containing the configuration of a layer. The same layer can be reinstantiated later (without its trained weights) from this configuration.

The config of a layer does not include connectivity information, nor the layer class name. These are handled by Network (one layer of abstraction above).

Returns
Python dictionary.

get_input_at

Retrieves the input tensor(s) of a layer at a given node.

Arguments
node_index Integer, index of the node from which to retrieve the attribute. E.g. node_index=0 will correspond to the first time the layer was called.

Returns
A tensor (or list of tensors if the layer has multiple inputs).

Raises
RuntimeError If called in Eager mode.

get_input_mask_at

Retrieves the input mask tensor(s) of a layer at a given node.

Arguments
node_index Integer, index of the node from which to retrieve the attribute. E.g. node_index=0 will correspond to the first time the layer was called.

Returns
A mask tensor (or list of tensors if the layer has multiple inputs).

get_input_shape_at

Retrieves the input shape(s) of a layer at a given node.

Arguments
node_index Integer, index of the node from which to retrieve the attribute. E.g. node_index=0 will correspond to the first time the layer was called.

Returns
A shape tuple (or list of shape tuples if the layer has multiple inputs).

Raises
RuntimeError If called in Eager mode.

get_losses_for

Retrieves losses relevant to a specific set of inputs.

Arguments
inputs Input tensor or list/tuple of input tensors.

Returns
List of loss tensors of the layer that depend on inputs.

get_output_at

Retrieves the output tensor(s) of a layer at a given node.

Arguments
node_index Integer, index of the node from which to retrieve the attribute. E.g. node_index=0 will correspond to the first time the layer was called.

Returns
A tensor (or list of tensors if the layer has multiple outputs).

Raises
RuntimeError If called in Eager mode.

get_output_mask_at

Retrieves the output mask tensor(s) of a layer at a given node.

Arguments
node_index Integer, index of the node from which to retrieve the attribute. E.g. node_index=0 will correspond to the first time the layer was called.

Returns
A mask tensor (or list of tensors if the layer has multiple outputs).

get_output_shape_at

Retrieves the output shape(s) of a layer at a given node.

Arguments
node_index Integer, index of the node from which to retrieve the attribute. E.g. node_index=0 will correspond to the first time the layer was called.

Returns
A shape tuple (or list of shape tuples if the layer has multiple outputs).

Raises
RuntimeError If called in Eager mode.

get_updates_for

Retrieves updates relevant to a specific set of inputs.

Arguments
inputs Input tensor or list/tuple of input tensors.

Returns
List of update ops of the layer that depend on inputs.

get_weights

Returns the current weights of the layer.

Returns
Weights values as a list of numpy arrays.

set_weights

Sets the weights of the layer, from Numpy arrays.

Arguments
weights a list of Numpy arrays. The number of arrays and their shape must match number of the dimensions of the weights of the layer (i.e. it should match the output of get_weights).

Raises
ValueError If the provided weights list does not match the layer's specifications.

with_name_scope

Decorator to automatically enter the module name scope.

class MyModule(tf.Module):
  @tf.Module.with_name_scope
  def __call__(self, x):
    if not hasattr(self, 'w'):
      self.w = tf.Variable(tf.random.normal([x.shape[1], 64]))
    return tf.matmul(x, self.w)

Using the above module would produce tf.Variables and tf.Tensors whose names included the module name:

mod = MyModule()
mod(tf.ones([8, 32]))
# ==> <tf.Tensor: ...>
mod.w
# ==> <tf.Variable ...'my_module/w:0'>

Args
method The method to wrap.

Returns
The original method wrapped such that it enters the module's name scope.

__call__

Wraps call, applying pre- and post-processing steps.

Arguments
inputs input tensor(s).
*args additional positional arguments to be passed to self.call.
**kwargs additional keyword arguments to be passed to self.call.

Returns
Output tensor(s).

Note:

  • The following optional keyword arguments are reserved for specific uses:
    • training: Boolean scalar tensor of Python boolean indicating whether the call is meant for training or inference.
    • mask: Boolean input mask.
  • If the layer's call method takes a mask argument (as some Keras layers do), its default value will be set to the mask generated for inputs by the previous layer (if input did come from a layer that generated a corresponding mask, i.e. if it came from a Keras layer with masking support.

Raises
ValueError if the layer's call method returns None (an invalid value).