DOC: Improve model results

Improve model results documentation
bashtage · Nov 22, 2019 · 217ee8e · 217ee8e
1 parent 6f4b4e4
commit 217ee8e
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 30 deletions.
diff --git a/arch/univariate/base.py b/arch/univariate/base.py
@@ -860,28 +860,14 @@ class ARCHModelFixedResult(_SummaryRepr):
         Whether the original input was pandas
     model : ARCHModel
         The model object used to estimate the parameters
-
-    Methods
-    -------
-    summary
-        Produce a summary of the results
-    plot
-        Produce a plot of the volatility and standardized residuals
-    forecast
-        Construct forecasts from a model
-
-    Attributes
-    ----------
-    model : ARCHModel
-        Model instance used to produce the fit
     """
 
     def __init__(self, params, resid, volatility, dep_var, names,
                  loglikelihood, is_pandas, model):
         self._params = params
         self._resid = resid
         self._is_pandas = is_pandas
-        self.model = model
+        self._model = model
         self._datetime = dt.datetime.now()
         self._dep_var = dep_var
         self._dep_name = dep_var.name
@@ -995,6 +981,13 @@ def summary(self):
         smry.add_extra_txt(extra_text)
         return smry
 
+    @cached_property
+    def model(self):
+        """
+        Model instance used to produce the fit
+        """
+        return self._model
+
     @cached_property
     def loglikelihood(self):
         """Model loglikelihood"""
@@ -1395,22 +1388,7 @@ class ARCHModelResult(ARCHModelFixedResult):
         slice notation `fit_start:fit_stop`
     model : ARCHModel
         The model object used to estimate the parameters
-
-    Methods
-    -------
-    summary
-        Produce a summary of the results
-    plot
-        Produce a plot of the volatility and standardized residuals
-    conf_int
-        Confidence intervals
-
-    Attributes
-    ----------
-    model : ARCHModel
-        Model instance used to produce the fit
     """
-
     def __init__(self, params, param_cov, r2, resid, volatility, cov_type,
                  dep_var, names, loglikelihood, is_pandas, optim_output,
                  fit_start, fit_stop, model):

diff --git a/doc/source/univariate/univariate.rst b/doc/source/univariate/univariate.rst
@@ -20,5 +20,6 @@ residual Bootstrap).
     Volatility Processes <volatility>
     Using the Fixed Variance Process <univariate_using_fixed_variance.ipynb>
     Distributions <distribution>
+    Results <results>
     Utilities <utility>
     Background and References <background>