convst.utils.checks_utils.check_array_3D¶
- convst.utils.checks_utils.check_array_3D(X, coerce_to_numpy=True, is_univariate=False, min_timestamps=2)¶
Perform checks on the input to verify if it is a 3D array.
- Parameters:
- XDataFrame or array, shape = (n_samples, n_features, n_timestamps)
Input Time series
- coerce_to_numpyboolean, optional
If input is a pandas DataFrame, will convert it to numpy. The default is True.
- is_univariateboolean, optional
If true, will raise an error if X as more than 1 feature. The default is False.
- Returns:
- X(n_samples, n_features, n_timestamps)
Input Time series.
- Raises:
- ValueError
