SamplerOptions

class SamplerOptions(*args, **kwargs)

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 SamplerExecutionOptionsV2 for all available options.
twirling – Pauli twirling options. See TwirlingOptions for all available options.
experimental – Experimental options.

Attributes

Type: UnsetType | int

Default value: Unset

Type: DynamicalDecouplingOptions | Dict

Default value: FieldInfo(annotation=Union[DynamicalDecouplingOptions, Dict], required=False, default_factory=DynamicalDecouplingOptions)

Type: EnvironmentOptions | Dict

Default value: FieldInfo(annotation=Union[EnvironmentOptions, Dict], required=False, default_factory=EnvironmentOptions)

Type: SamplerExecutionOptionsV2 | Dict

Default value: FieldInfo(annotation=Union[SamplerExecutionOptionsV2, Dict], required=False, default_factory=SamplerExecutionOptionsV2)

Type: UnsetType | dict

Default value: Unset

Type: UnsetType | int

Default value: Unset

Type: SimulatorOptions | Dict

Default value: FieldInfo(annotation=Union[SimulatorOptions, Dict], required=False, default_factory=SimulatorOptions)

Type: TwirlingOptions | Dict

Default value: FieldInfo(annotation=Union[TwirlingOptions, Dict], required=False, default_factory=TwirlingOptions)

update(**kwargs)

Update the options.

Return type

None

Was this page helpful?

Report a bug or request content on GitHub.