SamplerOptions

class SamplerOptions(_VERSION=2, max_execution_time=Unset, environment=<factory>, simulator=<factory>, default_shots=Unset, dynamical_decoupling=<factory>, execution=<factory>, twirling=<factory>, experimental=Unset)

Bases: OptionsV2

Options for V2 Sampler.

Attributes

Parameters:

• _VERSION (int)

• max_execution_time (UnsetType | int)

• environment (EnvironmentOptions | Dict)

• simulator (SimulatorOptions | Dict)

• default_shots (UnsetType | int)

• dynamical_decoupling (DynamicalDecouplingOptions | Dict)

• execution (SamplerExecutionOptionsV2 | Dict)

• twirling (TwirlingOptions | Dict)

• experimental (UnsetType | dict)

default_shots: UnsetType | int = Unset

The default number of shots to use if none are specified in the PUBs or in the run method.

Default: 4096.

dynamical_decoupling: DynamicalDecouplingOptions | Dict = FieldInfo(annotation=NoneType, required=False, default_factory=DynamicalDecouplingOptions)

Suboptions for dynamical decoupling. See DynamicalDecouplingOptions for all available options.

environment: EnvironmentOptions | Dict = FieldInfo(annotation=NoneType, required=False, default_factory=EnvironmentOptions)

execution: SamplerExecutionOptionsV2 | Dict = FieldInfo(annotation=NoneType, required=False, default_factory=SamplerExecutionOptionsV2)

Execution time options. See SamplerExecutionOptionsV2 for all available options.

experimental: UnsetType | dict = Unset

Experimental options.

max_execution_time: UnsetType | int = Unset

simulator: SimulatorOptions | Dict = FieldInfo(annotation=NoneType, required=False, default_factory=SimulatorOptions)

twirling: TwirlingOptions | Dict = FieldInfo(annotation=NoneType, required=False, default_factory=TwirlingOptions)

Pauli twirling options. See TwirlingOptions for all available options.

Methods

update(**kwargs)

Update the options.

Parameters:

kwargs (Any)

Return type:

None