From 858fe211b27f0adf41ef82b0f4abc252d06dfaec Mon Sep 17 00:00:00 2001 From: stevenhua0320 Date: Fri, 23 Aug 2024 13:05:01 +0800 Subject: [PATCH] numpydoc build for base.py --- src/diffpy/srmise/modelevaluators/base.py | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/src/diffpy/srmise/modelevaluators/base.py b/src/diffpy/srmise/modelevaluators/base.py index 2e97b3a..179e082 100644 --- a/src/diffpy/srmise/modelevaluators/base.py +++ b/src/diffpy/srmise/modelevaluators/base.py @@ -53,8 +53,14 @@ class ModelEvaluator: worse models.""" def __init__(self, method, higher_is_better): - """method = name of method (string) - higher_is_better = boolean + """Constructor of ModelEvaluator + + Parameters + ---------- + method : str + The name of method + higher_is_better : bool + The boolean to compare higher or lower degree model. """ self.method = method self.higher_is_better = higher_is_better @@ -123,7 +129,16 @@ def __ge__(self, other): return other.stat >= self.stat def chi_squared(self, expected, observed, error): - """Calculates chi-squared statistic.""" + """Calculates chi-squared statistic. + + Parameters + ---------- + expected : float + The expected value. + observed : float + The observed value. + error : float + The error statistic.""" self.chisq = np.sum((expected - observed) ** 2 / error**2) return self.chisq