pmdarima.utils.check_exog

pmdarima.utils.check_exog(X, dtype=<class 'numpy.float64'>, copy=True, force_all_finite=True)[source][source]

A wrapper for check_array for 2D arrays

Parameters:

X : array-like, shape=(n_samples, n_features)

The exogenous array. If a Pandas frame, a Pandas frame will be returned as well. Otherwise, a numpy array will be returned.

dtype : string, type or None (default=np.float64)

Data type of result. If None, the dtype of the input is preserved. If “numeric”, dtype is preserved unless array.dtype is object.

copy : bool, optional (default=True)

Whether a forced copy will be triggered. If copy=False, a copy might still be triggered by a conversion.

force_all_finite : bool, optional (default=True)

Whether to raise an error on np.inf and np.nan in an array. The possibilities are:

  • True: Force all values of array to be finite.
  • False: accept both np.inf and np.nan in array.
Returns:

X : pd.DataFrame or np.ndarray, shape=(n_samples, n_features)

Either a 2-d numpy array or pd.DataFrame