sktime.utils.validation.panel¶
-
sktime.utils.validation.panel.
check_X
(X, enforce_univariate=False, enforce_min_instances=1, enforce_min_columns=1, coerce_to_numpy=False, coerce_to_pandas=False)[source]¶ Validate input data. :param X: Input data :type X: pd.DataFrame or np.array :param enforce_univariate: Enforce that X is univariate. :type enforce_univariate: bool, optional (default=False) :param enforce_min_instances: Enforce minimum number of instances. :type enforce_min_instances: int, optional (default=1) :param enforce_min_columns: Enforce minimum number of columns (or time-series variables). :type enforce_min_columns: int, optional (default=1) :param coerce_to_numpy: If True, X will be coerced to a 3-dimensional numpy array. :type coerce_to_numpy: bool, optional (default=False) :param coerce_to_pandas: If True, X will be coerced to a nested pandas DataFrame. :type coerce_to_pandas: bool, optional (default=False)
- Returns
X – Checked and possibly converted input data
- Return type
pd.DataFrame or np.array
- Raises
ValueError – If X is invalid input data
-
sktime.utils.validation.panel.
check_X_y
(X, y, enforce_univariate=False, enforce_min_instances=1, enforce_min_columns=1, coerce_to_numpy=False, coerce_to_pandas=False)[source]¶ Validate input data. :param X: :type X: pd.DataFrame :param y: :type y: pd.Series or np.array :param enforce_univariate: Enforce that X is univariate. :type enforce_univariate: bool, optional (default=False) :param enforce_min_instances: Enforce minimum number of instances. :type enforce_min_instances: int, optional (default=1) :param enforce_min_columns: Enforce minimum number of columns (or time-series variables). :type enforce_min_columns: int, optional (default=1) :param coerce_to_numpy: If True, X will be coerced to a 3-dimensional numpy array. :type coerce_to_numpy: bool, optional (default=False) :param coerce_to_pandas: If True, X will be coerced to a nested pandas DataFrame. :type coerce_to_pandas: bool, optional (default=False)
- Returns
X (pd.DataFrame or np.array)
y (pd.Series)
- Raises
ValueError – If y or X is invalid input data
-
sktime.utils.validation.panel.
check_y
(y, enforce_min_instances=1, coerce_to_numpy=False)[source]¶ Validate input data. :param y: :type y: pd.Series or np.array :param enforce_min_instances: Enforce minimum number of instances. :type enforce_min_instances: int, optional (default=1) :param coerce_to_numpy: If True, y will be coerced to a numpy array. :type coerce_to_numpy: bool, optional (default=False)
- Returns
y
- Return type
pd.Series or np.array
- Raises
ValueError – If y is an invalid input