statsmodels.discrete.discrete_model.BinaryModel.predict#

BinaryModel.predict(params, exog=None, which='mean', offset=None)[source]#

Predict response variable of a model given exogenous variables.

Parameters:
paramsarray_like

Fitted parameters of the model.

exogarray_like

1d or 2d array of exogenous values. If not supplied, the whole exog attribute of the model is used.

which{‘mean’, ‘linear’, ‘var’, ‘prob’}, optional

Statistic to predict. Default is ‘mean’.

  • ‘mean’ returns the conditional expectation of endog E(y | x), i.e., exp of linear predictor.

  • ‘linear’ returns the linear predictor of the mean function.

  • ‘var’ returns the estimated variance of endog implied by the model.

offsetarray_like, optional

Offset is added to the linear predictor with coefficient equal to 1. If offset is not provided and exog is None, uses the model’s offset if present. If not, uses 0 as the default value.

Returns:
array

Fitted values at exog.