Skip to main contentIBM Quantum Documentation

SamplerOptions

SamplerOptions(*args, **kwargs)

GitHub(opens in a new tab)

Options for V2 Sampler.

Parameters

  • default_shots – The default number of shots to use if none are specified in the PUBs or in the run method. Default: 4096.
  • dynamical_decoupling – Suboptions for dynamical decoupling. See DynamicalDecouplingOptions for all available options.
  • execution – Execution time options. See ExecutionOptionsV2 for all available options.
  • twirling – Pauli twirling options. See TwirlingOptions for all available options.
  • experimental – Experimental options.

Attributes

default_shots

UnsetType | int = Unset

dynamical_decoupling

DynamicalDecouplingOptions | Dict = FieldInfo(annotation=Union[DynamicalDecouplingOptions, Dict], required=False, default_factory=DynamicalDecouplingOptions)

environment

EnvironmentOptions | Dict = FieldInfo(annotation=Union[EnvironmentOptions, Dict], required=False, default_factory=EnvironmentOptions)

execution

SamplerExecutionOptionsV2 | Dict = FieldInfo(annotation=Union[SamplerExecutionOptionsV2, Dict], required=False, default_factory=SamplerExecutionOptionsV2)

experimental

UnsetType | dict = Unset

max_execution_time

UnsetType | int = Unset

simulator

SimulatorOptions | Dict = FieldInfo(annotation=Union[SimulatorOptions, Dict], required=False, default_factory=SimulatorOptions)

twirling

TwirlingOptions | Dict = FieldInfo(annotation=Union[TwirlingOptions, Dict], required=False, default_factory=TwirlingOptions)


Methods

update

update(**kwargs)

GitHub(opens in a new tab)

Update the options.

Return type

None

Was this page helpful?
Report a bug or request content on GitHub.