Skip to content

Commit a7f5375

Browse files
committed
wording edits
1 parent dc20a9c commit a7f5375

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

qiskit_experiments/curve_analysis/curve_analysis.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -245,10 +245,10 @@ def __init_subclass__(cls, **kwargs):
245245
super().__init_subclass__(**kwargs)
246246

247247
# Create fit model:
248-
# The fit model is created once when the sub-class, i.e. type, is initialized.
248+
# The fit model is created only once when the sub-class, i.e. type, is initialized.
249249
# This removes overhead of instantiating the same fit model object multiple times.
250-
# This impact is significant especially when user create parallel experiment instance,
251-
# where the curve analysis subclass is instantiated multiple times.
250+
# Its impact is significant especially when user creates a parallel experiment instance,
251+
# where the curve analysis subclass is instantiated multiple times along with fit model.
252252
model_source = collections.defaultdict(list)
253253
for series in cls.__series__:
254254
model_source["fit_functions"].append(series.fit_func)

qiskit_experiments/curve_analysis/fit_models.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,14 @@ class FitModel(ABC):
4343
Note that :class:`FitModel` subclass is instantiated with a list of
4444
:math:`F_1` and :math:`F_2` (``fit_functions``) together with
4545
a list of :math:`\Theta_1` and :math:`\Theta_2` (``signatures``) and
46-
:math:`\Theta_{\rm fix}` (``fixed_parameters``).
46+
:math:`\Theta_{\rm fix}` (set via :meth:`bind_parameters`).
4747
The signature of new fit model instance will be
4848
:math:`\Theta = (\Theta_1 \cup \Theta_2) - \Theta_{\rm fix} = \{ p_0, p_2, p_3\}`.
4949
The fit function that this model provides is accordingly
5050
5151
.. math::
5252
53-
F(x, \Theta) = F_1(x_0, \Theta_1) \oplus F_2(x_1, \Theta_2) \\
53+
F(x, \Theta) = F_1(x_0, \Theta_1) \oplus F_2(x_1, \Theta_2) \
5454
= F(x_0 \oplus x_1, p_0, p_2, p_3).
5555
5656
This function might be called from the scipy curve fit algorithm
@@ -70,8 +70,8 @@ class FitModel(ABC):
7070
7171
This class is usually instantiated with the :class:`SeriesDef` in the
7272
``__init_subclass__`` method of :class:`CurveAnalysis` subclasses.
73-
User doesn't need to take care of input values to the constructor
74-
unless one manually instantiates the class for debugging purposes.
73+
User doesn't need to take care of how to initialize this class
74+
unless one manually create the instance for debugging purposes.
7575
"""
7676

7777
def __init__(

0 commit comments

Comments
 (0)