---
title: Samplomatic API documentation (latest version)
description: Index of all the modules in the latest version of samplomatic.
source: https://quantum.cloud.ibm.com/docs/en/api/samplomatic
---

# API Reference

Samplomatic

## Functions

|                                                                                    |                                                                      |
| ---------------------------------------------------------------------------------- | -------------------------------------------------------------------- |
| [`build`](/docs/api/samplomatic/auto/build "samplomatic.build")(circuit\[, debug]) | Build a circuit template and samplex for the given boxed-up circuit. |

## Classes

|                                                                                                                           |                                                            |
| ------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| [`ChangeBasis`](/docs/api/samplomatic/auto/change-basis "samplomatic.ChangeBasis")(\[decomposition, mode, ref, dressing]) | Directive to add basis changing gates.                     |
| [`InjectNoise`](/docs/api/samplomatic/auto/inject-noise "samplomatic.InjectNoise")(ref\[, modifier\_ref, site])           | Directive to inject noise into a `box` instruction.        |
| [`Tag`](/docs/api/samplomatic/auto/tag "samplomatic.Tag")(\[ref])                                                         | Annotation to tag and instruction with a string reference. |
| [`Twirl`](/docs/api/samplomatic/auto/twirl "samplomatic.Twirl")(\[group, dressing, decomposition])                        | Directive to twirl the contents of a `box` instruction.    |

## Submodules

- [samplomatic.aliases](/docs/api/samplomatic/aliases)

- [samplomatic.annotations](/docs/api/samplomatic/annotations)

  - [ChangeBasisMode](/docs/api/samplomatic/auto/annotations-change-basis-mode)
  - [DecompositionMode](/docs/api/samplomatic/auto/annotations-decomposition-mode)
  - [DressingMode](/docs/api/samplomatic/auto/annotations-dressing-mode)
  - [GroupMode](/docs/api/samplomatic/auto/annotations-group-mode)
  - [InjectLocalClifford](/docs/api/samplomatic/auto/annotations-inject-local-clifford)
  - [InjectionSite](/docs/api/samplomatic/auto/annotations-injection-site)
  - [samplomatic.ChangeBasis](/docs/api/samplomatic/auto/change-basis)
  - [samplomatic.InjectNoise](/docs/api/samplomatic/auto/inject-noise)
  - [samplomatic.Tag](/docs/api/samplomatic/auto/tag)
  - [samplomatic.Twirl](/docs/api/samplomatic/auto/twirl)

- [samplomatic.builders](/docs/api/samplomatic/builders)

  - [pre\_build](/docs/api/samplomatic/auto/builders-pre-build)
  - [samplomatic.build](/docs/api/samplomatic/auto/build)

- [samplomatic.constants](/docs/api/samplomatic/constants)

  - [Direction](/docs/api/samplomatic/auto/constants-direction)

- [samplomatic.distributions](/docs/api/samplomatic/distributions)

  - [BalancedUniformPauli](/docs/api/samplomatic/auto/distributions-balanced-uniform-pauli)
  - [Distribution](/docs/api/samplomatic/auto/distributions-distribution)
  - [HaarU2](/docs/api/samplomatic/auto/distributions-haar-u-2)
  - [UniformC1](/docs/api/samplomatic/auto/distributions-uniform-c-1)
  - [UniformLocalC1](/docs/api/samplomatic/auto/distributions-uniform-local-c-1)
  - [UniformPauli](/docs/api/samplomatic/auto/distributions-uniform-pauli)
  - [UniformPauliSubset](/docs/api/samplomatic/auto/distributions-uniform-pauli-subset)

- [samplomatic.exceptions](/docs/api/samplomatic/exceptions)

  - [BuildError](/docs/api/samplomatic/auto/exceptions-build-error)
  - [DeserializationError](/docs/api/samplomatic/auto/exceptions-deserialization-error)
  - [ParameterError](/docs/api/samplomatic/auto/exceptions-parameter-error)
  - [SamplexBuildError](/docs/api/samplomatic/auto/exceptions-samplex-build-error)
  - [SamplexConstructionError](/docs/api/samplomatic/auto/exceptions-samplex-construction-error)
  - [SamplexError](/docs/api/samplomatic/auto/exceptions-samplex-error)
  - [SamplexInputError](/docs/api/samplomatic/auto/exceptions-samplex-input-error)
  - [SamplexRuntimeError](/docs/api/samplomatic/auto/exceptions-samplex-runtime-error)
  - [SerializationError](/docs/api/samplomatic/auto/exceptions-serialization-error)
  - [SynthError](/docs/api/samplomatic/auto/exceptions-synth-error)
  - [TemplateBuildError](/docs/api/samplomatic/auto/exceptions-template-build-error)
  - [VirtualGateError](/docs/api/samplomatic/auto/exceptions-virtual-gate-error)

- [samplomatic.graph\_utils](/docs/api/samplomatic/graph-utils)

  - [find\_unreachable\_nodes](/docs/api/samplomatic/auto/graph-utils-find-unreachable-nodes)
  - [get\_clusters](/docs/api/samplomatic/auto/graph-utils-get-clusters)
  - [replace\_edges\_with\_one\_edge](/docs/api/samplomatic/auto/graph-utils-replace-edges-with-one-edge)
  - [replace\_nodes\_with\_one\_node](/docs/api/samplomatic/auto/graph-utils-replace-nodes-with-one-node)
  - [NodeCandidate](/docs/api/samplomatic/auto/graph-utils-node-candidate)

- [samplomatic.partition](/docs/api/samplomatic/partition)

  - [Partition](/docs/api/samplomatic/auto/partition-partition)

- [samplomatic.pre\_samplex](/docs/api/samplomatic/pre-samplex)

  - [DanglerMatch](/docs/api/samplomatic/auto/pre-samplex-dangler-match)
  - [PreChangeBasis](/docs/api/samplomatic/auto/pre-samplex-pre-change-basis)
  - [PreCollect](/docs/api/samplomatic/auto/pre-samplex-pre-collect)
  - [PreEdge](/docs/api/samplomatic/auto/pre-samplex-pre-edge)
  - [PreEmit](/docs/api/samplomatic/auto/pre-samplex-pre-emit)
  - [PreInjectNoise](/docs/api/samplomatic/auto/pre-samplex-pre-inject-noise)
  - [PreMeasure](/docs/api/samplomatic/auto/pre-samplex-pre-measure)
  - [PreNode](/docs/api/samplomatic/auto/pre-samplex-pre-node)
  - [PrePropagate](/docs/api/samplomatic/auto/pre-samplex-pre-propagate)
  - [PrePropagateKey](/docs/api/samplomatic/auto/pre-samplex-pre-propagate-key)
  - [PreSamplex](/docs/api/samplomatic/auto/pre-samplex-pre-samplex)

- [samplomatic.quantum\_program](/docs/api/samplomatic/quantum-program)

  - [ChunkPart](/docs/api/samplomatic/auto/quantum-program-chunk-part)
  - [ChunkSpan](/docs/api/samplomatic/auto/quantum-program-chunk-span)
  - [ChunkTiming](/docs/api/samplomatic/auto/quantum-program-chunk-timing)
  - [CircuitItem](/docs/api/samplomatic/auto/quantum-program-circuit-item)
  - [QuantumProgram](/docs/api/samplomatic/auto/quantum-program-quantum-program)
  - [QuantumProgramItem](/docs/api/samplomatic/auto/quantum-program-quantum-program-item)
  - [QuantumProgramItemResult](/docs/api/samplomatic/auto/quantum-program-quantum-program-item-result)
  - [QuantumProgramResult](/docs/api/samplomatic/auto/quantum-program-quantum-program-result)
  - [SamplexItem](/docs/api/samplomatic/auto/quantum-program-samplex-item)

- [samplomatic.samplex](/docs/api/samplomatic/samplex)

  - [ParameterExpressionTable](/docs/api/samplomatic/auto/samplex-parameter-expression-table)

  - [Samplex](/docs/api/samplomatic/auto/samplex-samplex)

  - [SamplexOutput](/docs/api/samplomatic/auto/samplex-samplex-output)

  - [samplomatic.samplex.nodes](/docs/api/samplomatic/samplex-nodes)

    - [ChangeBasisNode](/docs/api/samplomatic/auto/samplex-nodes-change-basis-node)
    - [CollectTemplateValues](/docs/api/samplomatic/auto/samplex-nodes-collect-template-values)
    - [CollectZ2ToOutputNode](/docs/api/samplomatic/auto/samplex-nodes-collect-z-2-to-output-node)
    - [CollectionNode](/docs/api/samplomatic/auto/samplex-nodes-collection-node)
    - [CombineRegistersNode](/docs/api/samplomatic/auto/samplex-nodes-combine-registers-node)
    - [ConversionNode](/docs/api/samplomatic/auto/samplex-nodes-conversion-node)
    - [DistributionSamplingNode](/docs/api/samplomatic/auto/samplex-nodes-distribution-sampling-node)
    - [EvaluationNode](/docs/api/samplomatic/auto/samplex-nodes-evaluation-node)
    - [InjectNoiseNode](/docs/api/samplomatic/auto/samplex-nodes-inject-noise-node)
    - [LeftMultiplicationNode](/docs/api/samplomatic/auto/samplex-nodes-left-multiplication-node)
    - [LeftU2ParametricMultiplicationNode](/docs/api/samplomatic/auto/samplex-nodes-left-u-2-parametric-multiplication-node)
    - [Node](/docs/api/samplomatic/auto/samplex-nodes-node)
    - [PauliPastCliffordNode](/docs/api/samplomatic/auto/samplex-nodes-pauli-past-clifford-node)
    - [PropagateLocalC1Node](/docs/api/samplomatic/auto/samplex-nodes-propagate-local-c-1-node)
    - [PropagateLocalPauliNode](/docs/api/samplomatic/auto/samplex-nodes-propagate-local-pauli-node)
    - [RightMultiplicationNode](/docs/api/samplomatic/auto/samplex-nodes-right-multiplication-node)
    - [RightU2ParametricMultiplicationNode](/docs/api/samplomatic/auto/samplex-nodes-right-u-2-parametric-multiplication-node)
    - [SamplingNode](/docs/api/samplomatic/auto/samplex-nodes-sampling-node)
    - [SliceRegisterNode](/docs/api/samplomatic/auto/samplex-nodes-slice-register-node)
    - [TwirlSamplingNode](/docs/api/samplomatic/auto/samplex-nodes-twirl-sampling-node)
    - [U2ParametricMultiplicationNode](/docs/api/samplomatic/auto/samplex-nodes-u-2-parametric-multiplication-node)

- [samplomatic.serialization](/docs/api/samplomatic/serialization)

  - [samplex\_from\_json](/docs/api/samplomatic/auto/serialization-samplex-from-json)
  - [samplex\_to\_json](/docs/api/samplomatic/auto/serialization-samplex-to-json)

- [samplomatic.synths](/docs/api/samplomatic/synths)

  - [get\_synth](/docs/api/samplomatic/auto/synths-get-synth)
  - [RzRxSynth](/docs/api/samplomatic/auto/synths-rz-rx-synth)
  - [RzSxSynth](/docs/api/samplomatic/auto/synths-rz-sx-synth)
  - [Synth](/docs/api/samplomatic/auto/synths-synth)

- [samplomatic.tensor\_interface](/docs/api/samplomatic/tensor-interface)

  - [PauliLindbladMapSpecification](/docs/api/samplomatic/auto/tensor-interface-pauli-lindblad-map-specification)
  - [Specification](/docs/api/samplomatic/auto/tensor-interface-specification)
  - [TensorInterface](/docs/api/samplomatic/auto/tensor-interface-tensor-interface)
  - [TensorSpecification](/docs/api/samplomatic/auto/tensor-interface-tensor-specification)

- [samplomatic.transpiler](/docs/api/samplomatic/transpiler)

  - [generate\_boxing\_pass\_manager](/docs/api/samplomatic/auto/transpiler-generate-boxing-pass-manager)

  - [samplomatic.transpiler.passes](/docs/api/samplomatic/transpiler-passes)

    - [AbsorbSingleQubitGates](/docs/api/samplomatic/auto/transpiler-passes-absorb-single-qubit-gates)
    - [AddInjectNoise](/docs/api/samplomatic/auto/transpiler-passes-add-inject-noise)
    - [AddTags](/docs/api/samplomatic/auto/transpiler-passes-add-tags)
    - [AddTerminalRightDressedBoxes](/docs/api/samplomatic/auto/transpiler-passes-add-terminal-right-dressed-boxes)
    - [GroupGatesIntoBoxes](/docs/api/samplomatic/auto/transpiler-passes-group-gates-into-boxes)
    - [GroupMeasIntoBoxes](/docs/api/samplomatic/auto/transpiler-passes-group-meas-into-boxes)
    - [InlineBoxes](/docs/api/samplomatic/auto/transpiler-passes-inline-boxes)
    - [samplomatic.transpiler.passes.insert\_noops](/docs/api/samplomatic/transpiler-passes-insert-noops)

- [samplomatic.utils](/docs/api/samplomatic/utils)

  - [count\_unique\_box\_instructions](/docs/api/samplomatic/auto/utils-count-unique-box-instructions)
  - [deprecate\_arg](/docs/api/samplomatic/auto/utils-deprecate-arg)
  - [extend\_annotations](/docs/api/samplomatic/auto/utils-extend-annotations)
  - [filter\_annotations](/docs/api/samplomatic/auto/utils-filter-annotations)
  - [find\_unique\_box\_instructions](/docs/api/samplomatic/auto/utils-find-unique-box-instructions)
  - [get\_annotation](/docs/api/samplomatic/auto/utils-get-annotation)
  - [map\_annotations](/docs/api/samplomatic/auto/utils-map-annotations)
  - [replace\_annotations](/docs/api/samplomatic/auto/utils-replace-annotations)
  - [strip\_annotations](/docs/api/samplomatic/auto/utils-strip-annotations)
  - [unbox](/docs/api/samplomatic/auto/utils-unbox)
  - [undress\_box](/docs/api/samplomatic/auto/utils-undress-box)
  - [validate\_literals](/docs/api/samplomatic/auto/utils-validate-literals)
  - [BoxKey](/docs/api/samplomatic/auto/utils-box-key)
  - [FrozenDict](/docs/api/samplomatic/auto/utils-frozen-dict)

- [samplomatic.virtual\_registers](/docs/api/samplomatic/virtual-registers)

  - [C1Register](/docs/api/samplomatic/auto/virtual-registers-c-1-register)
  - [GroupRegister](/docs/api/samplomatic/auto/virtual-registers-group-register)
  - [PauliRegister](/docs/api/samplomatic/auto/virtual-registers-pauli-register)
  - [U2Register](/docs/api/samplomatic/auto/virtual-registers-u-2-register)
  - [VirtualRegister](/docs/api/samplomatic/auto/virtual-registers-virtual-register)
  - [VirtualType](/docs/api/samplomatic/auto/virtual-registers-virtual-type)
  - [Z2Register](/docs/api/samplomatic/auto/virtual-registers-z-2-register)

- [samplomatic.visualization](/docs/api/samplomatic/visualization)

  - [plot\_graph](/docs/api/samplomatic/auto/visualization-plot-graph)


## Contents

- [API index](/docs/api/samplomatic)
- [Release notes](/docs/api/samplomatic/release-notes)
- samplomatic
  - [Module overview](/docs/api/samplomatic)
  - [build](/docs/api/samplomatic/auto/build)
  - [ChangeBasis](/docs/api/samplomatic/auto/change-basis)
  - [InjectNoise](/docs/api/samplomatic/auto/inject-noise)
  - [Tag](/docs/api/samplomatic/auto/tag)
  - [Twirl](/docs/api/samplomatic/auto/twirl)
- [samplomatic.aliases](/docs/api/samplomatic/aliases)
- samplomatic.annotations
  - [Module overview](/docs/api/samplomatic/annotations)
  - [ChangeBasisMode](/docs/api/samplomatic/auto/annotations-change-basis-mode)
  - [DecompositionMode](/docs/api/samplomatic/auto/annotations-decomposition-mode)
  - [DressingMode](/docs/api/samplomatic/auto/annotations-dressing-mode)
  - [GroupMode](/docs/api/samplomatic/auto/annotations-group-mode)
  - [InjectionSite](/docs/api/samplomatic/auto/annotations-injection-site)
  - [InjectLocalClifford](/docs/api/samplomatic/auto/annotations-inject-local-clifford)
- samplomatic.builders
  - [Module overview](/docs/api/samplomatic/builders)
  - [pre_build](/docs/api/samplomatic/auto/builders-pre-build)
- samplomatic.constants
  - [Module overview](/docs/api/samplomatic/constants)
  - [Direction](/docs/api/samplomatic/auto/constants-direction)
- samplomatic.distributions
  - [Module overview](/docs/api/samplomatic/distributions)
  - [BalancedUniformPauli](/docs/api/samplomatic/auto/distributions-balanced-uniform-pauli)
  - [Distribution](/docs/api/samplomatic/auto/distributions-distribution)
  - [HaarU2](/docs/api/samplomatic/auto/distributions-haar-u-2)
  - [UniformC1](/docs/api/samplomatic/auto/distributions-uniform-c-1)
  - [UniformLocalC1](/docs/api/samplomatic/auto/distributions-uniform-local-c-1)
  - [UniformPauli](/docs/api/samplomatic/auto/distributions-uniform-pauli)
  - [UniformPauliSubset](/docs/api/samplomatic/auto/distributions-uniform-pauli-subset)
- samplomatic.exceptions
  - [Module overview](/docs/api/samplomatic/exceptions)
  - [BuildError](/docs/api/samplomatic/auto/exceptions-build-error)
  - [DeserializationError](/docs/api/samplomatic/auto/exceptions-deserialization-error)
  - [ParameterError](/docs/api/samplomatic/auto/exceptions-parameter-error)
  - [SamplexBuildError](/docs/api/samplomatic/auto/exceptions-samplex-build-error)
  - [SamplexConstructionError](/docs/api/samplomatic/auto/exceptions-samplex-construction-error)
  - [SamplexError](/docs/api/samplomatic/auto/exceptions-samplex-error)
  - [SamplexInputError](/docs/api/samplomatic/auto/exceptions-samplex-input-error)
  - [SamplexRuntimeError](/docs/api/samplomatic/auto/exceptions-samplex-runtime-error)
  - [SerializationError](/docs/api/samplomatic/auto/exceptions-serialization-error)
  - [SynthError](/docs/api/samplomatic/auto/exceptions-synth-error)
  - [TemplateBuildError](/docs/api/samplomatic/auto/exceptions-template-build-error)
  - [VirtualGateError](/docs/api/samplomatic/auto/exceptions-virtual-gate-error)
- samplomatic.graph_utils
  - [Module overview](/docs/api/samplomatic/graph-utils)
  - [find_unreachable_nodes](/docs/api/samplomatic/auto/graph-utils-find-unreachable-nodes)
  - [get_clusters](/docs/api/samplomatic/auto/graph-utils-get-clusters)
  - [NodeCandidate](/docs/api/samplomatic/auto/graph-utils-node-candidate)
  - [replace_edges_with_one_edge](/docs/api/samplomatic/auto/graph-utils-replace-edges-with-one-edge)
  - [replace_nodes_with_one_node](/docs/api/samplomatic/auto/graph-utils-replace-nodes-with-one-node)
- samplomatic.partition
  - [Module overview](/docs/api/samplomatic/partition)
  - [Partition](/docs/api/samplomatic/auto/partition-partition)
- samplomatic.pre_samplex
  - [Module overview](/docs/api/samplomatic/pre-samplex)
  - [DanglerMatch](/docs/api/samplomatic/auto/pre-samplex-dangler-match)
  - [PreChangeBasis](/docs/api/samplomatic/auto/pre-samplex-pre-change-basis)
  - [PreCollect](/docs/api/samplomatic/auto/pre-samplex-pre-collect)
  - [PreEdge](/docs/api/samplomatic/auto/pre-samplex-pre-edge)
  - [PreEmit](/docs/api/samplomatic/auto/pre-samplex-pre-emit)
  - [PreInjectNoise](/docs/api/samplomatic/auto/pre-samplex-pre-inject-noise)
  - [PreMeasure](/docs/api/samplomatic/auto/pre-samplex-pre-measure)
  - [PreNode](/docs/api/samplomatic/auto/pre-samplex-pre-node)
  - [PrePropagate](/docs/api/samplomatic/auto/pre-samplex-pre-propagate)
  - [PrePropagateKey](/docs/api/samplomatic/auto/pre-samplex-pre-propagate-key)
  - [PreSamplex](/docs/api/samplomatic/auto/pre-samplex-pre-samplex)
- samplomatic.quantum_program
  - [Module overview](/docs/api/samplomatic/quantum-program)
  - [ChunkPart](/docs/api/samplomatic/auto/quantum-program-chunk-part)
  - [ChunkSpan](/docs/api/samplomatic/auto/quantum-program-chunk-span)
  - [ChunkTiming](/docs/api/samplomatic/auto/quantum-program-chunk-timing)
  - [CircuitItem](/docs/api/samplomatic/auto/quantum-program-circuit-item)
  - [QuantumProgram](/docs/api/samplomatic/auto/quantum-program-quantum-program)
  - [QuantumProgramItem](/docs/api/samplomatic/auto/quantum-program-quantum-program-item)
  - [QuantumProgramItemResult](/docs/api/samplomatic/auto/quantum-program-quantum-program-item-result)
  - [QuantumProgramResult](/docs/api/samplomatic/auto/quantum-program-quantum-program-result)
  - [SamplexItem](/docs/api/samplomatic/auto/quantum-program-samplex-item)
- samplomatic.samplex
  - [Module overview](/docs/api/samplomatic/samplex)
  - [ParameterExpressionTable](/docs/api/samplomatic/auto/samplex-parameter-expression-table)
  - [Samplex](/docs/api/samplomatic/auto/samplex-samplex)
  - [SamplexOutput](/docs/api/samplomatic/auto/samplex-samplex-output)
- samplomatic.samplex.nodes
  - [Module overview](/docs/api/samplomatic/samplex-nodes)
  - [ChangeBasisNode](/docs/api/samplomatic/auto/samplex-nodes-change-basis-node)
  - [CollectionNode](/docs/api/samplomatic/auto/samplex-nodes-collection-node)
  - [CollectTemplateValues](/docs/api/samplomatic/auto/samplex-nodes-collect-template-values)
  - [CollectZ2ToOutputNode](/docs/api/samplomatic/auto/samplex-nodes-collect-z-2-to-output-node)
  - [CombineRegistersNode](/docs/api/samplomatic/auto/samplex-nodes-combine-registers-node)
  - [ConversionNode](/docs/api/samplomatic/auto/samplex-nodes-conversion-node)
  - [DistributionSamplingNode](/docs/api/samplomatic/auto/samplex-nodes-distribution-sampling-node)
  - [EvaluationNode](/docs/api/samplomatic/auto/samplex-nodes-evaluation-node)
  - [InjectNoiseNode](/docs/api/samplomatic/auto/samplex-nodes-inject-noise-node)
  - [LeftMultiplicationNode](/docs/api/samplomatic/auto/samplex-nodes-left-multiplication-node)
  - [LeftU2ParametricMultiplicationNode](/docs/api/samplomatic/auto/samplex-nodes-left-u-2-parametric-multiplication-node)
  - [Node](/docs/api/samplomatic/auto/samplex-nodes-node)
  - [PauliPastCliffordNode](/docs/api/samplomatic/auto/samplex-nodes-pauli-past-clifford-node)
  - [PropagateLocalC1Node](/docs/api/samplomatic/auto/samplex-nodes-propagate-local-c-1-node)
  - [PropagateLocalPauliNode](/docs/api/samplomatic/auto/samplex-nodes-propagate-local-pauli-node)
  - [RightMultiplicationNode](/docs/api/samplomatic/auto/samplex-nodes-right-multiplication-node)
  - [RightU2ParametricMultiplicationNode](/docs/api/samplomatic/auto/samplex-nodes-right-u-2-parametric-multiplication-node)
  - [SamplingNode](/docs/api/samplomatic/auto/samplex-nodes-sampling-node)
  - [SliceRegisterNode](/docs/api/samplomatic/auto/samplex-nodes-slice-register-node)
  - [TwirlSamplingNode](/docs/api/samplomatic/auto/samplex-nodes-twirl-sampling-node)
  - [U2ParametricMultiplicationNode](/docs/api/samplomatic/auto/samplex-nodes-u-2-parametric-multiplication-node)
- samplomatic.serialization
  - [Module overview](/docs/api/samplomatic/serialization)
  - [samplex_from_json](/docs/api/samplomatic/auto/serialization-samplex-from-json)
  - [samplex_to_json](/docs/api/samplomatic/auto/serialization-samplex-to-json)
- samplomatic.synths
  - [Module overview](/docs/api/samplomatic/synths)
  - [get_synth](/docs/api/samplomatic/auto/synths-get-synth)
  - [RzRxSynth](/docs/api/samplomatic/auto/synths-rz-rx-synth)
  - [RzSxSynth](/docs/api/samplomatic/auto/synths-rz-sx-synth)
  - [Synth](/docs/api/samplomatic/auto/synths-synth)
- samplomatic.tensor_interface
  - [Module overview](/docs/api/samplomatic/tensor-interface)
  - [PauliLindbladMapSpecification](/docs/api/samplomatic/auto/tensor-interface-pauli-lindblad-map-specification)
  - [Specification](/docs/api/samplomatic/auto/tensor-interface-specification)
  - [TensorInterface](/docs/api/samplomatic/auto/tensor-interface-tensor-interface)
  - [TensorSpecification](/docs/api/samplomatic/auto/tensor-interface-tensor-specification)
- samplomatic.transpiler
  - [Module overview](/docs/api/samplomatic/transpiler)
  - [generate_boxing_pass_manager](/docs/api/samplomatic/auto/transpiler-generate-boxing-pass-manager)
- samplomatic.transpiler.passes
  - [Module overview](/docs/api/samplomatic/transpiler-passes)
  - [AbsorbSingleQubitGates](/docs/api/samplomatic/auto/transpiler-passes-absorb-single-qubit-gates)
  - [AddInjectNoise](/docs/api/samplomatic/auto/transpiler-passes-add-inject-noise)
  - [AddTags](/docs/api/samplomatic/auto/transpiler-passes-add-tags)
  - [AddTerminalRightDressedBoxes](/docs/api/samplomatic/auto/transpiler-passes-add-terminal-right-dressed-boxes)
  - [GroupGatesIntoBoxes](/docs/api/samplomatic/auto/transpiler-passes-group-gates-into-boxes)
  - [GroupMeasIntoBoxes](/docs/api/samplomatic/auto/transpiler-passes-group-meas-into-boxes)
  - [InlineBoxes](/docs/api/samplomatic/auto/transpiler-passes-inline-boxes)
- samplomatic.transpiler.passes.insert_noops
  - [Module overview](/docs/api/samplomatic/transpiler-passes-insert-noops)
  - [AddNoops](/docs/api/samplomatic/auto/transpiler-passes-insert-noops-add-noops)
  - [AddNoopsActiveAccum](/docs/api/samplomatic/auto/transpiler-passes-insert-noops-add-noops-active-accum)
  - [AddNoopsActiveCircuit](/docs/api/samplomatic/auto/transpiler-passes-insert-noops-add-noops-active-circuit)
  - [AddNoopsAll](/docs/api/samplomatic/auto/transpiler-passes-insert-noops-add-noops-all)
- samplomatic.utils
  - [Module overview](/docs/api/samplomatic/utils)
  - [BoxKey](/docs/api/samplomatic/auto/utils-box-key)
  - [count_unique_box_instructions](/docs/api/samplomatic/auto/utils-count-unique-box-instructions)
  - [deprecate_arg](/docs/api/samplomatic/auto/utils-deprecate-arg)
  - [extend_annotations](/docs/api/samplomatic/auto/utils-extend-annotations)
  - [filter_annotations](/docs/api/samplomatic/auto/utils-filter-annotations)
  - [find_unique_box_instructions](/docs/api/samplomatic/auto/utils-find-unique-box-instructions)
  - [FrozenDict](/docs/api/samplomatic/auto/utils-frozen-dict)
  - [get_annotation](/docs/api/samplomatic/auto/utils-get-annotation)
  - [map_annotations](/docs/api/samplomatic/auto/utils-map-annotations)
  - [replace_annotations](/docs/api/samplomatic/auto/utils-replace-annotations)
  - [strip_annotations](/docs/api/samplomatic/auto/utils-strip-annotations)
  - [unbox](/docs/api/samplomatic/auto/utils-unbox)
  - [undress_box](/docs/api/samplomatic/auto/utils-undress-box)
  - [validate_literals](/docs/api/samplomatic/auto/utils-validate-literals)
- samplomatic.virtual_registers
  - [Module overview](/docs/api/samplomatic/virtual-registers)
  - [C1Register](/docs/api/samplomatic/auto/virtual-registers-c-1-register)
  - [GroupRegister](/docs/api/samplomatic/auto/virtual-registers-group-register)
  - [PauliRegister](/docs/api/samplomatic/auto/virtual-registers-pauli-register)
  - [U2Register](/docs/api/samplomatic/auto/virtual-registers-u-2-register)
  - [VirtualRegister](/docs/api/samplomatic/auto/virtual-registers-virtual-register)
  - [VirtualType](/docs/api/samplomatic/auto/virtual-registers-virtual-type)
  - [Z2Register](/docs/api/samplomatic/auto/virtual-registers-z-2-register)
- samplomatic.visualization
  - [Module overview](/docs/api/samplomatic/visualization)
  - [plot_graph](/docs/api/samplomatic/auto/visualization-plot-graph)