Skip to main contentIBM Quantum Documentation
You are viewing the API reference for an old version of Qiskit SDK. Switch to latest version

CircuitSampler

qiskit.opflow.converters.CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')

GitHub(opens in a new tab)

Bases: ConverterBase

Deprecated: The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. Note that in order to approximate the value of the CircuitStateFn, it must 1) send state function through a depolarizing channel, which will destroy all phase information and 2) replace the sampled frequencies with square roots of the frequency, rather than the raw probability of sampling (which would be the equivalent of sampling the square of the state function, per the Born rule.

The CircuitSampler aggressively caches transpiled circuits to handle re-parameterization of the same circuit efficiently. If you are converting multiple different Operators, you are better off using a different CircuitSampler for each Operator to avoid cache thrashing.

Deprecated since version 0.24.0

The class qiskit.opflow.converters.circuit_sampler.CircuitSampler is deprecated as of qiskit-terra 0.24.0. It will be removed in the Qiskit 1.0 release. For code migration guidelines, visit https://qisk.it/opflow_migration(opens in a new tab).

Parameters

  • backend (Backend |QuantumInstance) – The quantum backend or QuantumInstance to use to sample the circuits.
  • statevector (bool(opens in a new tab) | None) – If backend is a statevector backend, whether to replace the CircuitStateFns with DictStateFns (from the counts) or VectorStateFns (from the statevector). None will set this argument automatically based on the backend.
  • attach_results (bool(opens in a new tab)) – Whether to attach the data from the backend Results object for a given CircuitStateFn` to an execution_results field added the converted DictStateFn or VectorStateFn.
  • param_qobj (bool(opens in a new tab)) – Whether to use Aer’s parameterized Qobj capability to avoid re-assembling the circuits.
  • caching (str(opens in a new tab)) – The caching strategy. Can be ‘last’ (default) to store the last operator that was converted, set to ‘all’ to cache all processed operators.

Raises

ValueError(opens in a new tab) – Set statevector or param_qobj True when not supported by backend.


Attributes

quantum_instance

Returns the quantum instance.

Returns

The QuantumInstance used by the CircuitSampler


Methods

clear_cache

clear_cache()

Clear the cache of sampled operator expressions.

convert

convert(operator, params=None)

Converts the Operator to one in which the CircuitStateFns are replaced by DictStateFns or VectorStateFns. Extracts the CircuitStateFns out of the Operator, caches them, calls sample_circuits below to get their converted replacements, and replaces the CircuitStateFns in operator with the replacement StateFns.

Parameters

Returns

The converted Operator with CircuitStateFns replaced by DictStateFns or VectorStateFns.

Raises

OpflowError – if extracted circuits are empty.

Return type

OperatorBase

sample_circuits

sample_circuits(circuit_sfns=None, param_bindings=None)

Samples the CircuitStateFns and returns a dict associating their id() values to their replacement DictStateFn or VectorStateFn. If param_bindings is provided, the CircuitStateFns are broken into their parameterizations, and a list of StateFns is returned in the dict for each circuit id(). Note that param_bindings is provided here in a different format than in convert, and lists of parameters within the dict is not supported, and only binding dicts which are valid to be passed into Terra can be included in this list.

Parameters

Returns

The dictionary mapping ids of the CircuitStateFns to their replacement StateFns.

Raises

OpflowError – if extracted circuits are empty.

Return type

Dict(opens in a new tab)[int(opens in a new tab), List(opens in a new tab)[StateFn]]

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