qiskit_ibm_runtime.options_models.SamplerOptions
pydantic model SamplerOptions
Bases: BaseOptionsModel
Options for the client-side Sampler.
Config
- validate_assignment: bool = True
- extra: str = forbid
default_shots
field
Type: int | None
Default value: 4096
The default number of shots to use if none are specified in the PUBs or in the run method.
dynamical_decoupling
field
Type: DynamicalDecouplingOptions
Default value: DynamicalDecouplingOptions(enable=False, sequence_type='XX', extra_slack_distribution='middle', scheduling_method='alap', skip_reset_qubits=False)
Suboptions for dynamical decoupling.
environment
field
Type: EnvironmentOptions
Default value: EnvironmentOptions(log_level='WARNING', job_tags=[], private=False, max_execution_time=None, image=None)
Options related to the execution environment.
execution
field
Type: SamplerExecutionOptions
Default value: SamplerExecutionOptions(init_qubits=True, rep_delay=None, scheduler_timing=False, stretch_values=False, meas_type='classified')
Execution options.
experimental
field
Type: dict
Default value: {}
Experimental options.
max_execution_time
field
Type: int | None
Default value: None
Maximum execution time in seconds.
This value bounds system execution time (not wall clock time). System execution time is the amount of time that the system is dedicated to processing your job. If a job exceeds this time limit, it is forcibly cancelled.
simulator
field
Type: SimulatorOptions
Default value: SimulatorOptions(angle_decimals=5, layer_noise_model=None, seed_simulator=None, warn_absent=True)
Options related to local mode simulations.
twirling
field
Type: TwirlingOptions
Default value: TwirlingOptions(enable_gates=None, enable_measure=None, group='pauli', num_randomizations='auto', shots_per_randomization='auto', strategy='active-accum')
Pauli twirling options.