Skip to content

Commit

Permalink
Added missing documentation for weights parameter in SumOfSquaresError
Browse files Browse the repository at this point in the history
  • Loading branch information
MichaelClerx committed Jul 30, 2024
1 parent aeca7fc commit cbc96fe
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion pints/_error_measures.py
Original file line number Diff line number Diff line change
Expand Up @@ -329,7 +329,7 @@ def n_parameters(self):

class SumOfSquaresError(ProblemErrorMeasure):
r"""
Calculates a sum of squares error:
Calculates the sum of squares error:
.. math::
f = \sum _i^n (y_i - x_i) ^ 2,
Expand All @@ -344,6 +344,12 @@ class SumOfSquaresError(ProblemErrorMeasure):
problem
A :class:`pints.SingleOutputProblem` or
:class:`pints.MultiOutputProblem`.
weights
An optional sequence of (float) weights, exactly one per problem
output. If given, the error in each individual output will be
multiplied by the corresponding weight. If no weights are specified all
outputs will be weighted equally.
"""
def __init__(self, problem, weights=None):
super(SumOfSquaresError, self).__init__(problem)
Expand Down

0 comments on commit cbc96fe

Please sign in to comment.