Skip to content

Add Raises Section to cBOSS docstring #1766 #2782

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add Raises Section to cBOSS docstring #1766 #2782

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8d7f6d4
Add Raises Section to cBOSS docstring #1766
hiteshkarvil May 6, 2025
a0f3a6b
Merge branch 'main' into doc-raises-cboss
MatthewMiddlehurst May 7, 2025
762fb3d
Automatic `pre-commit` fixes
MatthewMiddlehurst May 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions aeon/classification/dictionary_based/_cboss.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,15 @@ def _fit(self, X, y, keep_train_preds=True):
-----
Changes state by creating a fitted model that updates attributes
ending in "_" and sets is_fitted flag to True.

Raises
------
_ _ _ _
TypeError
If X is not a numpy.ndarray,pandas.Dataframe, or list of numpy.ndarray/pandas.DataFrame.
ValueError
If min_window is greater than the computed max_window, which is based on the series length.
This can occur if the series is too short or min_window is set too large in the constructor.
"""
time_limit = self.time_limit_in_minutes * 60
self.n_cases_, _, self.n_timepoints_ = X.shape
Expand Down
Loading