BaseEstimator
class qiskit.primitives.BaseEstimator(*, options=None)
Bases: BaseEstimatorV1[T]
DEPRECATED. Type alias for Estimator V1 base class.
See BaseEstimatorV1 for details.
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.
The class qiskit.primitives.base.base_estimator.BaseEstimator is deprecated as of qiskit 1.2. It will be removed no earlier than 3 months after the release date. The BaseEstimator class is a type alias for the BaseEstimatorV1 interface that has been deprecated in favor of explicitly versioned interface classes. It is recommended to migrate all implementations to use BaseEstimatorV2. However, for implementations incompatible with BaseEstimatorV2, BaseEstimator can be replaced with the explicitly versioned BaseEstimatorV1 class.
Parameters
options (dict(opens in a new tab) | None) – Default options.
Attributes
options
Return options values for the estimator.
Returns
options
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].Parameters
- circuits (Sequence[QuantumCircuit] | QuantumCircuit) – one or more circuit objects.
- observables (Sequence[BaseOperator | str(opens in a new tab)] | BaseOperator | str(opens in a new tab)) – one or more observable objects. Several formats are allowed; importantly,
strshould follow the string representation format forPauliobjects. - parameter_values (Sequence[Sequence[float(opens in a new tab)]] | Sequence[float(opens in a new tab)] | float(opens in a new tab) | None) – concrete parameters to be bound.
- run_options – runtime options used for circuit execution.
Returns
The job object of EstimatorResult.
Raises
- TypeError(opens in a new tab) – Invalid argument type given.
- ValueError(opens in a new tab) – Invalid argument values given.
Return type
T
set_options
set_options(**fields)
Set options values for the estimator.
Parameters
**fields – The fields to update the options