qamomile.qiskit.execution

Configure IBM Runtime execution through Qamomile-owned options.

Overview¶

Class	Description
`QiskitExecutionOptions`	Configure Runtime primitives without constructing Qiskit option objects.

Classes¶

`QiskitExecutionOptions` [source]¶

class QiskitExecutionOptions

Configure Runtime primitives without constructing Qiskit option objects.

Per-request sampling shots and estimation precision remain arguments to the executable. Advanced mappings use Runtime’s option names; the SDK validates their supported fields when the executor is constructed.

Parameters:

Name	Type	Description
`max_execution_time`	`int \| None`	Positive quantum execution time limit in seconds for both primitives, excluding queue time. Defaults to the SDK setting; does not set the local result-wait timeout.
`resilience_level`	`int \| None`	Estimator error mitigation level from zero through two. Defaults to the SDK setting.
`sampler_options`	`Mapping[str, Any]`	Additional sampler settings. Defaults to an empty mapping. Nested values are copied.
`estimator_options`	`Mapping[str, Any]`	Additional estimator settings. Defaults to an empty mapping. Nested values are copied.

Raises:

TypeError — If advanced options are not mappings with string keys.
ValueError — If a numeric setting is invalid or an advanced mapping contains a field exposed directly by this class.

Example:

>>> options = QiskitExecutionOptions(
...     max_execution_time=300,
...     resilience_level=1,
...     sampler_options={"dynamical_decoupling": {"enable": True}},
... )

Constructor¶

def __init__(
    self,
    max_execution_time: int | None = None,
    resilience_level: int | None = None,
    sampler_options: Mapping[str, Any] = dict(),
    estimator_options: Mapping[str, Any] = dict(),
) -> None

Attributes¶

estimator_options: Mapping[str, Any]
max_execution_time: int | None
resilience_level: int | None
sampler_options: Mapping[str, Any]

Methods¶

`estimator_kwargs`¶

def estimator_kwargs(self) -> dict[str, Any]

Build an independent Runtime estimator options dictionary.

Returns:

dict[str, Any] — dict[str, Any]: Estimator settings with execution and mitigation settings when supplied.

`sampler_kwargs`¶

def sampler_kwargs(self) -> dict[str, Any]

Build an independent Runtime sampler options dictionary.

Returns:

dict[str, Any] — dict[str, Any]: Sampler settings with the shared execution limit.