Skip to content

[DOC] Add 'Raises' section to docstring of ContractableBOSS (#1766) #2484

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

Merged
MatthewMiddlehurst merged 12 commits into from
Feb 12, 2025
Merged

[DOC] Add 'Raises' section to docstring of ContractableBOSS (#1766) #2484

Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
17d2eb1
Fix line endings
Nikitas100 Jan 7, 2025
fd2d124
Moved test_cboss.py to testing/tests directory
Nikitas100 Jan 7, 2025
1770319
Updated docstring comments and made methods protected
Nikitas100 Jan 14, 2025
5c878d4
Fix line endings
Nikitas100 Jan 7, 2025
87dfffd
Moved test_cboss.py to testing/tests directory
Nikitas100 Jan 7, 2025
7e4af72
Updated docstring comments and made methods protected
Nikitas100 Jan 14, 2025
08840ab
Updated
Nikitas100 Jan 16, 2025
99fbe58
Merge branch 'add-docstring-raises' of https://github.com/Nikitas100/…
Nikitas100 Jan 16, 2025
6fd01f9
Updated
Nikitas100 Jan 16, 2025
563fe17
Removed test_cboss.py
Nikitas100 Jan 16, 2025
2f5a4e6
Updated
Nikitas100 Jan 23, 2025
09bf1c3
Updated
Nikitas100 Jan 26, 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
8 changes: 7 additions & 1 deletion aeon/classification/dictionary_based/_cboss.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,13 @@ class ContractableBOSS(BaseClassifier):
weights_ :
Weight of each classifier in the ensemble.

Raises
------
ValueError
Raised when ``min_window`` is greater than ``max_window + 1``.
This ensures that ``min_window`` does not exceed ``max_window``,
preventing invalid window size configurations.

See Also
--------
BOSSEnsemble, IndividualBOSS
Expand Down Expand Up @@ -305,7 +312,6 @@ def _predict(self, X) -> np.ndarray:
-------
1D np.ndarray
Predicted class labels shape = (n_cases).

"""
rng = check_random_state(self.random_state)
return np.array(
Expand Down