Skip to content

Formatting issues in dynamical_decoupling_options.py #2262

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ElePT merged 1 commit into from
May 20, 2025
Merged

Formatting issues in dynamical_decoupling_options.py #2262

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions qiskit_ibm_runtime/options/dynamical_decoupling_options.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,40 +24,40 @@ class DynamicalDecouplingOptions:
enable: Union[UnsetType, bool] = Unset
r"""Whether to enable DD as specified by the other options in this class.

Default: False.
Default: ``False``.
"""
sequence_type: Union[UnsetType, Literal["XX", "XpXm", "XY4"]] = Unset
r"""Which dynamical decoupling sequence to use.

Default: "XX".
Default: ``"XX"``.

* ``"XX"``: use the sequence ``tau/2 - (+X) - tau - (+X) - tau/2``
* ``"XpXm"``: use the sequence ``tau/2 - (+X) - tau - (-X) - tau/2``
* ``"XY4"``: : use the sequence
``tau/2 - (+X) - tau - (+Y) - tau (-X) - tau - (-Y) - tau/2``
* ``"XY4"``: use the sequence
``tau/2 - (+X) - tau - (+Y) - tau (-X) - tau - (-Y) - tau/2``
"""
extra_slack_distribution: Union[UnsetType, Literal["middle", "edges"]] = Unset
r"""Where to put extra timing delays due to rounding issues.
Rounding issues arise because the discrete time step ``dt`` of the system cannot
be divided. This option takes following values.

Default: "middle".
Default: ``"middle"``.

* ``"middle"``: Put the extra slack to the interval at the middle of the sequence.
* ``"edges"``: Divide the extra slack as evenly as possible into intervals at
beginning and end of the sequence.
beginning and end of the sequence.
"""
scheduling_method: Union[UnsetType, Literal["alap", "asap"]] = Unset
r"""Whether to schedule gates as soon as ("asap") or
as late as ("alap") possible.

Default: "alap".
Default: ``"alap"``.
"""
skip_reset_qubits: Union[UnsetType, bool] = Unset
r"""Whether to insert DD on idle periods that immediately follow initialized/reset qubits.

Since qubits in the ground state are less susceptible to decoherence, it can be beneficial
to let them be while they are known to be in this state.

Default: False.
Default: ``False``.
"""