review comments

Co-authored-by: Daniel J. Egger <[email protected]>

Author: nkanazawa1989

qiskit_experiments/curve_analysis/__init__.py

@@ -20,7 +20,7 @@
 Curve analysis provides the analysis base class for a variety of experiments with
 a single experimental parameter sweep. This analysis subclasses can override
 several class attributes to customize the behavior from data processing to post-processing,
-including providing systematic initial guess for parameters tailred to the experiment.
+including providing systematic initial guess for parameters tailored to the experiment.
 Here we describe how code developers can create new analysis inheriting from the base class.
 
 

qiskit_experiments/curve_analysis/base_curve_analysis.py

@@ -122,8 +122,8 @@ def _default_options(cls) -> Options:
         Analysis Options:
             curve_plotter (BaseCurveDrawer): A curve drawer instance to visualize
                 the analysis result.
-            plot_raw_data (bool): Set ``True`` to draw un-formatted data points on canvas.
-                This is ``False`` by default.
+            plot_raw_data (bool): Set ``True`` to draw processed data points,
+                dataset without formatting, on canvas. This is ``False`` by default.
             plot (bool): Set ``True`` to create figure for fit result.
                 This is ``True`` by default.
             return_fit_parameters (bool): Set ``True`` to return all fit model parameters
@@ -257,7 +257,7 @@ def _format_data(
         """Post-processing for fit data collection.
 
         Args:
-            curve_data: Raw data collection created from experiment results.
+            curve_data: Processed data collection created from experiment results.
 
         Returns:
             Formatted data.
@@ -318,7 +318,7 @@ def _run_data_processing(
             series: List of series definition defining filtering condition.
 
         Returns:
-            Collection of curve data extracted from the experiment result.
+            Processed data that will be sent to the formatter method.
 
         Raises:
             DataProcessorError: When key for x values is not found in the metadata.
@@ -365,7 +365,7 @@ def _run_curve_fit(
         """Perform curve fitting on given data collection and fit models.
 
         Args:
-            curve_data: A formatted data collection to fit.
+            curve_data: Formatted data to fit.
             series: A list of fit models.
 
         Returns:
@@ -493,7 +493,7 @@ def _create_curve_data(
         """Create analysis results for raw curve data.
 
         Args:
-            curve_data: Full curve dataset used for the fitting.
+            curve_data: Formatted data that is used for the fitting.
             series: List of series definition associated with the curve data.
 
         Returns:

qiskit_experiments/curve_analysis/curve_analysis.py

@@ -33,7 +33,11 @@
 
 
 class CurveAnalysis(BaseCurveAnalysis):
-    """Base class for curve analyis."""
+    """Base class for curve analysis with single curve group.
+
+    The fit parameters from the series defined under the analysis class are all shared
+    and the analysis performs a single multi-objective function optimization.
+    """
 
     #: List[SeriesDef]: List of mapping representing a data series
     __series__ = list()
@@ -156,37 +160,37 @@ def _run_analysis(
         analysis_results = []
 
         # Run data processing
-        raw_curve_data = self._run_data_processing(experiment_data.data(), self.__series__)
+        processed_data = self._run_data_processing(experiment_data.data(), self.__series__)
 
         if self.options.plot and self.options.plot_raw_data:
             for s in self.__series__:
-                raw_data = raw_curve_data.get_subset_of(s.name)
+                sub_data = processed_data.get_subset_of(s.name)
                 self.drawer.draw_raw_data(
-                    x_data=raw_data.x,
-                    y_data=raw_data.y,
+                    x_data=sub_data.x,
+                    y_data=sub_data.y,
                     ax_index=s.canvas,
                 )
         # for backward compatibility, will be removed in 0.4.
-        self.__processed_data_set["raw_data"] = raw_curve_data
+        self.__processed_data_set["raw_data"] = processed_data
 
         # Format data
-        formatted_curve_data = self._format_data(raw_curve_data)
+        formatted_data = self._format_data(processed_data)
         if self.options.plot:
             for s in self.__series__:
                 self.drawer.draw_formatted_data(
-                    x_data=formatted_curve_data.x,
-                    y_data=formatted_curve_data.y,
-                    y_err_data=formatted_curve_data.y_err,
+                    x_data=formatted_data.x,
+                    y_data=formatted_data.y,
+                    y_err_data=formatted_data.y_err,
                     name=s.name,
                     ax_index=s.canvas,
                     color=s.plot_color,
                     marker=s.plot_symbol,
                 )
         # for backward compatibility, will be removed in 0.4.
-        self.__processed_data_set["fit_ready"] = formatted_curve_data
+        self.__processed_data_set["fit_ready"] = formatted_data
 
         # Run fitting
-        fit_data = self._run_curve_fit(formatted_curve_data, self.__series__)
+        fit_data = self._run_curve_fit(formatted_data, self.__series__)
 
         # Create figure and result data
         if fit_data:
@@ -252,7 +256,7 @@ def _run_analysis(
                     self.drawer.draw_fit_report(description=report_description)
 
         # Add raw data points
-        analysis_results.extend(self._create_curve_data(formatted_curve_data, self.__series__))
+        analysis_results.extend(self._create_curve_data(formatted_data, self.__series__))
 
         # Finalize plot
         if self.options.plot:

releasenotes/notes/cleanup-curve-analysis-96d7ff706cae5b4e.yaml

@@ -6,13 +6,13 @@ developer:
     see qiskit-experiments/#737 for details.
     
     According to this update, several protected methods that are
-    originally designed to be overridden by subclass have been deprecated or upgraded.
+    originally designed to be overridden by subclasses have been deprecated or upgraded.
     Check the following list of changes you may need to upgrade your analysis subclass.
     
     - :meth:`CurveAnalysis._generate_fit_guesses`
     
     The signature of method has been upgraded. Now this method should be called with
-    ``curve_data`` and calling ``self._data()`` to get curve data has been deprecated.
+    ``curve_data`` to get the curve data instead of calling ``self._data()`` which has been deprecated.
     
     - :meth:`CurveAnalysis._data`