Skip to content

Commit 3233e2c

Browse files
committed
Update: docstring
1 parent d7b4bc1 commit 3233e2c

1 file changed

Lines changed: 6 additions & 1 deletion

File tree

uncertaintyx/interface/core.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -328,7 +328,12 @@ def __init__(
328328
@property
329329
def cost(self) -> Any:
330330
r"""
331-
Returns the value of the cost function.
331+
Returns the value of the cost function at its minimum.
332+
333+
The standard convention in maximum likelihood and inverse
334+
problem theory implies, that the minimum cost is equal to
335+
half the degrees of freedom of the fitting problem, for a
336+
closed uncertainty budget.
332337
"""
333338
return self._cost
334339

0 commit comments

Comments
 (0)