search

statsmodels / statsmodels

Statsmodels: statistical modeling and econometrics in Python
http://www.statsmodels.org/devel/
BSD 3-Clause "New" or "Revised" License
10.03k stars 2.87k forks source link

DOC: Prediction Results, Contrast Results, where in the docs #3753

Closed josef-pkt closed 6 years ago

josef-pkt commented 7 years ago

do we have a docstring for the instance returned by get_prediction, e.g. GLM ?

there is no see also in the get_prediction docstring http://www.statsmodels.org/dev/generated/statsmodels.genmod.generalized_linear_model.GLMResults.get_prediction.html

I guess similar for contrast results returned by t_test, ...

josef-pkt commented 7 years ago

most likely postpone to 0.10, but maybe some improvement (better docs) possible now

astrojuanlu commented 6 years ago

The prediction results were added to the docs, but the fact that the get_prediction method of some results objects returns a wrapper has not been updated, see for instance:

http://www.statsmodels.org/devel/generated/statsmodels.tsa.statespace.sarimax.SARIMAXResults.get_prediction.html?highlight=forecast

but:

https://github.com/statsmodels/statsmodels/blob/3caea9258dc5986178c1ea255db2b14256443c84/statsmodels/tsa/statespace/mlemodel.py#L2388-L2389

Does this deserve its own issue? @lpcampoy