EstimatorResult

class cinnabar.estimators.EstimatorResult

Simple base class for estimator results with provenance fields.

This is the base class for all estimator results and should be used to store any additional metadata that is not appropriate for the returned measurements but might be useful for downstream analysis, like the covariance matrix of the MLE estimator. Subclasses should define specific typed fields for this metadata to help IDEs.

Variables:

• estimator (str) – The class name of the estimator that produced this result, e.g. "MLEEstimator". Set automatically by Estimator.estimate.

• source (str) – The composed source label stamped on the output measurements, e.g. "MLE" for a single-source map or "MLE(openff-sage)" when multiple input sources are present. Set automatically by Estimator.estimate.

Attributes

estimator
source