Skip to content
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

Break up options classes in docs #1806

Merged
merged 3 commits into from
Jul 19, 2024
Merged

Break up options classes in docs #1806

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9950102
break up options classes
jyu00 Jul 17, 2024
c09cb06
use lower case
jyu00 Jul 17, 2024
d64a6f8
Merge branch 'main' into separate-options-in-docs
jyu00 Jul 19, 2024
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
39 changes: 33 additions & 6 deletions qiskit_ibm_runtime/options/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

.. currentmodule:: qiskit_ibm_runtime.options

Options that can be passed to the primitives.
Options that can be passed to the Qiskit Runtime primitives.

V2 Primitives
=============
Expand Down Expand Up @@ -75,11 +75,23 @@
Classes
=======

Base primitive options
----------------------

.. autosummary::
:toctree: ../stubs/

EstimatorOptions
SamplerOptions
Options


Suboptions for V2 primitives only
---------------------------------

.. autosummary::
:toctree: ../stubs/

DynamicalDecouplingOptions
ResilienceOptionsV2
LayerNoiseLearningOptions
Expand All @@ -88,13 +100,28 @@
ZneOptions
TwirlingOptions
ExecutionOptionsV2
Options
TranspilationOptions
ResilienceOptions
ExecutionOptions
SamplerExecutionOptionsV2


Suboptions for both V1 and V2 primitives
----------------------------------------

.. autosummary::
:toctree: ../stubs/

EnvironmentOptions
SimulatorOptions
SamplerExecutionOptionsV2


Suboptions for V1 primitives only
---------------------------------

.. autosummary::
:toctree: ../stubs/

TranspilationOptions
ExecutionOptions
ResilienceOptions

"""

Expand Down
2 changes: 1 addition & 1 deletion qiskit_ibm_runtime/options/options.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ def _set_if_exists(name: str, _inputs: dict, _options: dict) -> None:

@dataclass
class Options(BaseOptions):
"""Options for the primitives, used by V1 primitives.
"""Options for V1 primitives.

Args:
optimization_level: How much optimization to perform on the circuits.
Expand Down