Add Raises Section to cBOSS docstring #1766 #2782
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reference Issues/PRs
Fixes #1766.
What does this implement/fix? Explain your changes.
This PR adds a Raises section to the docstring of the ContractableBOSS classifier’s _fit method in aeon/classification/dictionary_based/_cboss.py, addressing issue #1766. I documented the following exceptions:
TypeError: Raised when the input X is not a numpy.ndarray, pandas.DataFrame, or a list of numpy.ndarray/pandas.DataFrame.
ValueError: Raised when min_window is greater than the computed max_window, which can occur if the series is too short or min_window is set too large in the constructor.
Does your contribution introduce a new dependency? If yes, which one?
No, this contribution does not introduce any new dependencies.