docs and option name

Author: nkanazawa1989

qiskit_experiments/curve_analysis/__init__.py

@@ -312,7 +312,7 @@ class AnalysisB(CurveAnalysis):
 compute custom quantities based on the raw fit parameters.
 See :ref:`curve_analysis_results` for details.
 Afterwards, the analysis draws several curves in the Matplotlib figure.
-User can set custom drawer to the option ``curve_plotter``.
+User can set custom drawer to the option ``curve_drawer``.
 The drawer defaults to the :class:`MplCurveDrawer`.
 Finally, it returns the list of created analysis results and Matplotlib figure.
 

qiskit_experiments/curve_analysis/base_curve_analysis.py

@@ -111,14 +111,14 @@ def parameters(self) -> List[str]:
     @property
     def drawer(self) -> BaseCurveDrawer:
         """A short-cut for curve drawer instance."""
-        return self._options.curve_plotter
+        return self._options.curve_drawer
 
     @classmethod
     def _default_options(cls) -> Options:
         """Return default analysis options.
 
         Analysis Options:
-            curve_plotter (BaseCurveDrawer): A curve drawer instance to visualize
+            curve_drawer (BaseCurveDrawer): A curve drawer instance to visualize
                 the analysis result.
             plot_raw_data (bool): Set ``True`` to draw processed data points,
                 dataset without formatting, on canvas. This is ``False`` by default.
@@ -156,7 +156,7 @@ def _default_options(cls) -> Options:
         """
         options = super()._default_options()
 
-        options.curve_plotter = MplCurveDrawer()
+        options.curve_drawer = MplCurveDrawer()
         options.plot_raw_data = False
         options.plot = True
         options.return_fit_parameters = True
@@ -173,7 +173,7 @@ def _default_options(cls) -> Options:
 
         # Set automatic validator for particular option values
         options.set_validator(field="data_processor", validator_value=DataProcessor)
-        options.set_validator(field="curve_plotter", validator_value=BaseCurveDrawer)
+        options.set_validator(field="curve_drawer", validator_value=BaseCurveDrawer)
 
         return options
 
@@ -187,23 +187,25 @@ def set_options(self, **fields):
             KeyError: When removed option ``curve_fitter`` is set.
         """
         # TODO remove this in Qiskit Experiments v0.4
-        if "curve_plotter" in fields and isinstance(fields["curve_plotter"], str):
-            plotter_str = fields["curve_plotter"]
+        if "curve_plotter" in fields:
             warnings.warn(
-                f"The curve plotter '{plotter_str}' has been deprecated. "
-                "The option is replaced with 'MplCurveDrawer' instance. "
+                f"The analysis option 'curve_plotter' has been deprecated. "
+                "The option is replaced with 'curve_drawer' that takes 'MplCurveDrawer' instance. "
                 "If this is a loaded analysis, please save this instance again to update option value. "
-                "This warning will be removed with backport in Qiskit Experiments 0.4.",
+                "The 'curve_plotter' argument along with this warning will be removed "
+                "in Qiskit Experiments 0.4.",
                 DeprecationWarning,
                 stacklevel=2,
             )
-            fields["curve_plotter"] = MplCurveDrawer()
+            del fields["curve_plotter"]
 
         if "curve_fitter" in fields:
             warnings.warn(
                 "Setting curve fitter to analysis options has been deprecated and "
                 "the option has been removed. The fitter setting is dropped. "
-                "Now you can directly override '_run_curve_fit' method to apply custom fitter.",
+                "Now you can directly override '_run_curve_fit' method to apply custom fitter. "
+                "The `curve_fitter` argument along with this warning will be removed "
+                "in Qiskit Experiments 0.4.",
                 DeprecationWarning,
                 stacklevel=2,
             )
@@ -217,7 +219,8 @@ def set_options(self, **fields):
                 f"Option(s) {deprecated} have been moved to draw_options and will be removed soon. "
                 "Use self.drawer.set_options instead. "
                 "If this is a loaded analysis, please save this instance again to update option value. "
-                "This warning will be removed with backport in Qiskit Experiments 0.4.",
+                "These arguments along with this warning will be removed "
+                "in Qiskit Experiments 0.4.",
                 DeprecationWarning,
                 stacklevel=2,
             )

qiskit_experiments/curve_analysis/curve_data.py

@@ -27,7 +27,7 @@
 class SeriesDef:
     """A dataclass to describe the definition of the curve.
 
-    Args:
+    Attributes:
         fit_func: A callable that defines the fit model of this curve. The argument names
             in the callable are parsed to create the fit parameter list, which will appear
             in the analysis results. The first argument should be ``x`` that represents
@@ -78,7 +78,7 @@ class CurveData:
     This dataset can consist of X, Y values from multiple series.
     To extract curve data of the particular series, :meth:`get_subset_of` can be used.
 
-    Args:
+    Attributes:
         x: X-values that experiment sweeps.
         y: Y-values that observed and processed by the data processor.
         y_err: Uncertainty of the Y-values which is created by the data processor.
@@ -130,7 +130,7 @@ def get_subset_of(self, index: Union[str, int]) -> "CurveData":
 class FitData:
     """A dataclass to store the outcome of the fitting.
 
-    Args:
+    Attributes:
         popt: List of optimal parameter values with uncertainties if available.
         popt_keys: List of parameter names being fit.
         pcov: Covariance matrix from the least square fitting.
@@ -182,7 +182,7 @@ def fitval(self, key: str) -> uncertainties.UFloat:
 class ParameterRepr:
     """Detailed description of fitting parameter.
 
-    Args:
+    Attributes:
         name: Original name of the fit parameter being defined in the fit model.
         repr: Optional. Human-readable parameter name shown in the analysis result and in the figure.
         unit: Optional. Physical unit of this parameter if applicable.

qiskit_experiments/curve_analysis/standard_analysis/error_amplification_analysis.py

@@ -106,7 +106,7 @@ def _default_options(cls):
                 considered as good. Defaults to :math:`\pi/2`.
         """
         default_options = super()._default_options()
-        default_options.curve_plotter.set_options(
+        default_options.curve_drawer.set_options(
             xlabel="Number of gates (n)",
             ylabel="Population",
             ylim=(0, 1.0),

qiskit_experiments/curve_analysis/standard_analysis/gaussian.py

@@ -71,7 +71,7 @@ class GaussianAnalysis(curve.CurveAnalysis):
     @classmethod
     def _default_options(cls) -> Options:
         options = super()._default_options()
-        options.curve_plotter.set_options(
+        options.curve_drawer.set_options(
             xlabel="Frequency",
             ylabel="Signal (arb. units)",
             xval_unit="Hz",

qiskit_experiments/curve_analysis/standard_analysis/resonance.py

@@ -71,7 +71,7 @@ class ResonanceAnalysis(curve.CurveAnalysis):
     @classmethod
     def _default_options(cls) -> Options:
         options = super()._default_options()
-        options.curve_plotter.set_options(
+        options.curve_drawer.set_options(
             xlabel="Frequency",
             ylabel="Signal (arb. units)",
             xval_unit="Hz",

qiskit_experiments/library/characterization/analysis/cr_hamiltonian_analysis.py

@@ -196,7 +196,7 @@ class CrossResonanceHamiltonianAnalysis(curve.CurveAnalysis):
     def _default_options(cls):
         """Return the default analysis options."""
         default_options = super()._default_options()
-        default_options.curve_plotter.set_options(
+        default_options.curve_drawer.set_options(
             subplots=(3, 1),
             xlabel="Flat top width",
             ylabel=[

qiskit_experiments/library/characterization/analysis/drag_analysis.py

@@ -120,7 +120,7 @@ def _default_options(cls):
         descriptions of analysis options.
         """
         default_options = super()._default_options()
-        default_options.curve_plotter.set_options(
+        default_options.curve_drawer.set_options(
             xlabel="Beta",
             ylabel="Signal (arb. units)",
         )

qiskit_experiments/library/characterization/analysis/ramsey_xy_analysis.py

@@ -95,7 +95,7 @@ def _default_options(cls):
         descriptions of analysis options.
         """
         default_options = super()._default_options()
-        default_options.curve_plotter.set_options(
+        default_options.curve_drawer.set_options(
             xlabel="Delay",
             ylabel="Signal (arb. units)",
             xval_unit="s",

qiskit_experiments/library/characterization/analysis/t1_analysis.py

@@ -30,7 +30,7 @@ class T1Analysis(curve.DecayAnalysis):
     def _default_options(cls) -> Options:
         """Default analysis options."""
         options = super()._default_options()
-        options.curve_plotter.set_options(
+        options.curve_drawer.set_options(
             xlabel="Delay",
             ylabel="P(1)",
             xval_unit="s",