iqm.error_reduction_tools.rem.rem_api

iqm.error_reduction_tools.rem.rem_api#

High level REM (Readout Error Mitigation) workflow API.

Combines readout error characterization, circuit twirling and post-processing into a single lifecycle-oriented interface.

Typical usage:

from iqm.error_reduction_tools.rem import REMWorkflow, WorkflowConfiguration
from iqm.error_reduction_tools.twirling.twirling_api import TwirlingConfiguration

config = WorkflowConfiguration(shots=20_000, twirling=TwirlingConfiguration(readout_twirl_strategy="LOCAL"))
results = REMWorkflow(client, config=config).run(circuits, observables=["ZZII", "IIZZ"])

print(results.mitigated_counts)
print(results.expectation_values)

Classes

REMMetadata(timestamp, shots, ...)

Metadata about a completed REM workflow run.

REMResults(mitigated_counts, ...)

Output of a completed REM workflow.

REMWorkflow(client, *[, config, ...])

End-to-end readout error mitigation workflow.

WorkflowConfiguration([rec, twirling, ...])

Configuration for the full readout error mitigation (REM) workflow.

Inheritance

Inheritance diagram of iqm.error_reduction_tools.rem.rem_api