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

BaseEstimator

qiskit.primitives.BaseEstimator(*, options=None)

GitHub(opens in a new tab)

Bases: BasePrimitive, Generic(opens in a new tab)[T]

Estimator base class.

Base class for Estimator that estimates expectation values of quantum circuits and observables.

Creating an instance of an Estimator, or using one in a with context opens a session that holds resources until the instance is close() ed or the context is exited.

Parameters

options (dict(opens in a new tab) | None) – Default options.


Attributes

circuits

Quantum circuits that represents quantum states.

Returns

The quantum circuits.

observables

Observables to be estimated.

Returns

The observables.

options

Return options values for the estimator.

Returns

options

parameters

Parameters of the quantum circuits.

Returns

Parameters, where parameters[i][j] is the j-th parameter of the i-th circuit.


Methods

run

run(circuits, observables, parameter_values=None, **run_options)

Run the job of the estimation of expectation value(s).

circuits, observables, and parameter_values should have the same length. The i-th element of the result is the expectation of observable

obs = observables[i]

for the state prepared by

circ = circuits[i]

with bound parameters

values = parameter_values[i].
Deprecated since version 0.46.0

Implicit conversion from a PauliList to a SparsePauliOp with coeffs=1 in the observables arguments is deprecated as of Qiskit 0.46 and will be removed in Qiskit 1.0. You should explicitly convert to a SparsePauli using SparsePauliOp(pauli_list) to avoid this warning.

Parameters

Returns

The job object of EstimatorResult.

Raises

Return type

T

set_options

set_options(**fields)

Set options values for the estimator.

Parameters

**fields – The fields to update the options

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