estimator Package

Specification for a magic-state distillation unit.

Either select a built-in unit by setting name, or define a custom unit by providing num_input_ts, num_output_ts, failure_probability_formula, output_error_rate_formula, and optionally physical and logical qubit specifications.

Partition of the total error budget across algorithm components.

The three fields must sum to the overall error budget. Defaults to equal thirds of 0.001 (i.e. each component gets ~3.33e-4).

Optional runtime and resource constraints for resource estimation.

At most one of max_duration or max_physical_qubits may be set simultaneously.

An error returned from the resource estimation.

Input parameters for a single resource estimation job.

Contains qubit model, QEC scheme, distillation unit specifications, constraints, and error budget settings. Used directly for single-point estimation or as a base class for batching via EstimatorParams.

Top-level input parameters for the Microsoft Resource Estimator.

Extends EstimatorInputParamsItem with support for batching: pass num_items to create a batching job where each item can override the top-level parameters.

Quantum error correction scheme parameters for resource estimation.

Specify a built-in scheme by setting name to one of the QECScheme constants, or define a custom scheme by setting the threshold and code-distance parameters directly.

Physical qubit parameters for resource estimation.

Specify a built-in qubit model by setting name to one of the QubitParams constants, or fully define a custom model by setting instruction_set and all relevant timing and error-rate fields.

Microsoft Resource Estimator result.

The class represents simple resource estimation results as well as batching resource estimation results. The latter can be indexed by an integer index to access an individual result from the batching result.

Microsoft Resource Estimator Logical Counts.

The class represents logical counts that can be used as input to physical estimation of resources in the Microsoft Resource Estimator.

Measurement error rate specified separately for process and readout errors.

Used as the value of one_qubit_measurement_error_rate or two_qubit_joint_measurement_error_rate in EstimatorQubitParams when process and readout error rates differ.

Protocol-specific specification for a magic-state distillation unit.

Defines the number of physical qubits and the duration (in logical cycle time units) for one round of distillation under a specific QEC code.

Predefined quantum error correction scheme name constants for use with EstimatorQecScheme.

Pass one of these string constants as the name field to select a built-in QEC scheme for resource estimation.

Predefined qubit model name constants for use with EstimatorQubitParams.

Pass one of these string constants as the name field to select a built-in qubit model for resource estimation.