You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
What does this implement/fix? Explain your changes.
Adds the "Raises" section to the __init__ docstring of KNeighborsTimeSeriesClassifier.
Documents the verified ValueError raised during initialization when an unsupported string or an invalid callable is provided to the weights parameter.
This update improves user guidance by clarifying expected exceptions and aligns with Aeon's documentation standards.
Does your contribution introduce a new dependency? If yes, which one?
No new dependencies introduced.
Any other comments?
This contribution is part of my preparation and engagement for GSoC 2025, aligned with Aeon's project list.
I am grateful for any feedback to improve this PR and my future contributions.
PR checklist
The PR title starts with [DOC] as per contribution guidelines.
The change improves documentation clarity without introducing code changes.
…assifier (aeon-toolkit#1766)
Document the ValueError raised during initialization when an unsupported value is passed to the 'weights' parameter.
Clarifies expected exceptions for users and improves API documentation consistency.
I have added the following labels to this PR based on the title: [ $\color{#F3B9F8}{\textsf{documentation}}$ ].
I have added the following labels to this PR based on the changes made: [ $\color{#BCAE15}{\textsf{classification}}$ ]. Feel free to change these if they do not properly represent the PR.
The Checks tab will show the status of our automated tests. You can click on individual test runs in the tab or "Details" in the panel below to see more information if there is a failure.
If our pre-commit code quality check fails, any trivial fixes will automatically be pushed to your PR unless it is a draft.
Don't hesitate to ask questions on the aeonSlack channel if you have any.
PR CI actions
These checkboxes will add labels to enable/disable CI functionality for this PR. This may not take effect immediately, and a new commit may be required to run the new configuration.
Run pre-commit checks for all files
Run mypy typecheck tests
Run all pytest tests and configurations
Run all notebook example tests
Run numba-disabled codecov tests
Stop automatic pre-commit fixes (always disabled for drafts)
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.
SomtoOnyekwelu
requested review from
MatthewMiddlehurst and
TonyBagnall
as code owners
aeon-actions-bot
bot
added
classification
Reference Issues/PRs
Addresses part of #1766.
What does this implement/fix? Explain your changes.
Adds the "Raises" section to the
__init__docstring ofKNeighborsTimeSeriesClassifier.Documents the verified
ValueErrorraised during initialization when an unsupported string or an invalid callable is provided to theweightsparameter.This update improves user guidance by clarifying expected exceptions and aligns with Aeon's documentation standards.
Does your contribution introduce a new dependency? If yes, which one?
No new dependencies introduced.
Any other comments?
This contribution is part of my preparation and engagement for GSoC 2025, aligned with Aeon's project list.
I am grateful for any feedback to improve this PR and my future contributions.
PR checklist