From 7b81be43d0b02cbd484d64acb574893d3461bd94 Mon Sep 17 00:00:00 2001 From: Jessie Yu Date: Fri, 19 Jul 2024 14:45:37 -0400 Subject: [PATCH] Break up options classes in docs (#1806) * break up options classes * use lower case --- qiskit_ibm_runtime/options/__init__.py | 39 ++++++++++++++++++++++---- qiskit_ibm_runtime/options/options.py | 2 +- 2 files changed, 34 insertions(+), 7 deletions(-) diff --git a/qiskit_ibm_runtime/options/__init__.py b/qiskit_ibm_runtime/options/__init__.py index c3a540b8f..4b47dd974 100644 --- a/qiskit_ibm_runtime/options/__init__.py +++ b/qiskit_ibm_runtime/options/__init__.py @@ -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 ============= @@ -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 @@ -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 """ diff --git a/qiskit_ibm_runtime/options/options.py b/qiskit_ibm_runtime/options/options.py index e8e681cce..596d54e61 100644 --- a/qiskit_ibm_runtime/options/options.py +++ b/qiskit_ibm_runtime/options/options.py @@ -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.