docs

2 files changed, 17 insertions, 1 deletions

diff --git a/lib/parameters.py b/lib/parameters.py
index 3f75d04..a5fe86c 100644
--- a/lib/parameters.py
+++ b/lib/parameters.py
@@ -351,6 +351,18 @@ class ParallelParamStats:
 
 
 class ParamStats:
+    """
+    Statistics.
+
+    :var std_static: static parameter-unaware model error (standard deviation of raw data)
+    :var std_param_lut:  static parameter-aware model error (mean standard deviation of data partitioned by parameter)
+    :var std_by_param: static parameter-aware model error ignoring a single parameter.
+        dict mapping parameter name -> mean std of data partitioned so that all parameters but "parameter name" are constant.
+    :var sty_by_arg: list, argument index -> mean std of data partition so that all parameters but "argument index" are constant
+    :var _depends_on_param: dict, parameter name -> bool, True if the modeled behaviour likely depends on parameter name
+    :var _depends_on_arg: list, argument index -> bool, True if the modeled behaviour likely depends on argument index
+    """
+
     def __init__(self, data):
         self.__dict__.update(data)
 
diff --git a/lib/paramfit.py b/lib/paramfit.py
index 5fdaf7a..8cfd486 100644
--- a/lib/paramfit.py
+++ b/lib/paramfit.py
@@ -26,7 +26,11 @@ class ParamFit:
     """
 
     def __init__(self, parallel=True):
-        """Create a new ParamFit object."""
+        """
+        Create a new ParamFit object.
+
+        :param parallel: Perform parallel fitting using multiprocessing. default true.
+        """
         self.fit_queue = list()
         self.parallel = parallel