Skip to content

Commit 3a989dc

Browse files
authored
Merge pull request statsmodels#5986 from bashtage/count-model-predict-doc
DOC: Add parameters for CountModel predict
2 parents b22c977 + 6abe44a commit 3a989dc

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

statsmodels/discrete/discrete_model.py

+21-1
Original file line numberDiff line numberDiff line change
@@ -766,7 +766,27 @@ def _get_init_kwds(self):
766766
def predict(self, params, exog=None, exposure=None, offset=None,
767767
linear=False):
768768
"""
769-
Predict response variable of a count model given exogenous variables.
769+
Predict response variable of a count model given exogenous variables
770+
771+
Parameters
772+
----------
773+
params : array_like
774+
Model parameters
775+
exog : array_like, optional
776+
Design / exogenous data. Is exog is None, model exog is used.
777+
exposure : array_like, optional
778+
Log(exposure) is added to the linear prediction with
779+
coefficient equal to 1. If exposure is not provided and exog
780+
is None, uses the model's exposure if present. If not, uses
781+
0 as the default value.
782+
offset : array_like, optional
783+
Offset is added to the linear prediction with coefficient
784+
equal to 1. If offset is not provided and exog
785+
is None, uses the model's offset if present. If not, uses
786+
0 as the default value.
787+
linear : bool
788+
If True, returns the linear predicted values. If False,
789+
returns the exponential of the linear predicted value.
770790
771791
Notes
772792
-----

0 commit comments

Comments
 (0)