Skip to main content
IBM Quantum Platform
This page is from a dev version of Qiskit Runtime client. This is a new interface that does not exist in the stable version.

SamplexItem

class SamplexItem(circuit, samplex, *, samplex_arguments=None, shape=None, chunk_size=None)

GitHub

Bases: QuantumProgramItem

An item of a QuantumProgram containing a circuit and samplex to feed it arguments.

Parameters

  • circuit (QuantumCircuit) – The circuit to be executed.
  • samplex (Samplex) – A samplex to draw random parameters for the circuit.
  • samplex_arguments (dict[str, Any] | None) – A map from argument names to argument values for the samplex. Each argument array has intrinsic axes determined by its type (e.g., parameter_values has intrinsic shape (n,) for n parameters, while scalar inputs like noise_scale have intrinsic shape ()). The extrinsic shapes of all arguments are broadcasted together following NumPy conventions.
  • shape (tuple[int, ...] | None) – A shape that the item’s extrinsic shape must be broadcastable to. Axes where shape exceeds the shape implicit in samplex_arguments enumerate independent randomizations.
  • chunk_size (int | None) – The maximum number of bound circuits in each shot loop execution, or None to use a server-side heuristic to optimize speed. When not executing in a session, the server-side heuristic is always used and this value is ignored.

Attributes

shape

The extrinsic shape of this item, i.e. the broadcasted extrinsic shapes of all inputs.


Methods

size

size()

GitHub

The total number elements in this item; the product of the entries of shape.

Return type

int

Was this page helpful?
Report a bug, typo, or request content on GitHub.