Skip to content

Commit f536e23

Browse files
authored
Update core.py
1 parent 3f3937e commit f536e23

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

uncertaintyx/interface/core.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -237,8 +237,9 @@ class Result:
237237
- The uncertainty tensor of the optimized parameter values
238238
:math:`U(p) \in \mathbb{R}^{k \times k}`
239239
- The irreducible residual variance
240-
:math:`u_{\mu}^{2}(f(p, X) - Y) \in \mathbb{R}^{n}` with
241-
:math:`\mu = M - \|k\|` degrees of freedom
240+
:math:`u^{2}(R) \in \mathbb{R}^{n}` with residuals
241+
:math:`R = f(p, X) - Y \in \mathbb{R}^{n}` and
242+
:math:`M - \|k\|` degrees of freedom
242243
- The value of the cost function at its minimum
243244
- The exit status, a nonzero value indicating failure
244245
@@ -431,15 +432,15 @@ def yvar_x(self, x: np.ndarray, u: np.ndarray) -> np.ndarray:
431432
def yunc_r(self) -> np.ndarray:
432433
r"""
433434
Returns the residual standard uncertainty
434-
:math:`u_{\mu} \in \mathbb{R}^{n}`.
435+
:math:`u(R) \in \mathbb{R}^{n}`.
435436
"""
436437
return np.sqrt(self._rvar)
437438

438439
@property
439440
def yvar_r(self) -> np.ndarray:
440441
r"""
441442
Returns the residual variance
442-
:math:`u_{\mu}^{2} \in \mathbb{R}^{n}`.
443+
:math:`u^{2}(R) \in \mathbb{R}^{n}`.
443444
"""
444445
return self._rvar
445446

0 commit comments

Comments
 (0)