Skip to content
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.

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

[ENH]Use n_jobs parameter in KNeighborsTimeSeriesClassifier. #2687

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

Conversation

steenrotsman
Copy link
Contributor

Reference Issues/PRs

Fixes #2478. See also #2545 and #2578.

What does this implement/fix? Explain your changes.

Uses n_jobs parameter in _predict and predict_proba of KNeighborsTimeSeriesClassifier. Parallelization is done in these methods instead of _kneighbors to potentially allow speedup through upper bounding the distance.

PR checklist

For all contributions
  • I've added myself to the list of contributors. Alternatively, you can use the @all-contributors bot to do this for you after the PR has been merged.
  • The PR title starts with either [ENH], [MNT], [DOC], [BUG], [REF], [DEP] or [GOV] indicating whether the PR topic is related to enhancement, maintenance, documentation, bugs, refactoring, deprecation or governance.

@aeon-actions-bot aeon-actions-bot bot added classification Classification package enhancement New feature, improvement request or other non-bug code enhancement labels Mar 24, 2025
@aeon-actions-bot
Copy link
Contributor

Thank you for contributing to aeon

I have added the following labels to this PR based on the title: [ $\color{#FEF1BE}{\textsf{enhancement}}$ ].
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 aeon Slack 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)
  • Disable numba cache loading
  • Push an empty commit to re-run CI checks

Copy link
Member

@MatthewMiddlehurst MatthewMiddlehurst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, could you verify output is the same from before and show that the mutlithreading does make the classifier faster.

preds[i] = preds[i] / np.sum(preds[i])

return preds
self._check_is_fitted()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not needed

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should I also remove it from 158?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah did not notice it was already there! Yes it should be redundant, this is handled in the base class.

@steenrotsman
Copy link
Contributor Author

In #2478, I've put some benchmarks. These are the entries on three data sets with 1 or 8 cores with only Aeon's builtin DTW:

name avg std min
ACSF1 (1) 110.2201 2.4291 107.7615
ACSF1 (8) 49.2053 1.0859 48.3538
ArrowHead (1) 1.8508 0.0506 1.7939
ArrowHead (8) 0.5634 0.0114 0.5545
GunPoint (1) 0.8112 0.0238 0.7918
GunPoint (8) 1.0206 1.6650 0.2700

For the small GunPoint data set, overhead is larger than gains from parallelization. I expect that for ED, data sets would need to be larger to get a performance increase (if that's even possible) compared to DTW.

Equivalence is tested in aeon/distances/tests/test_sklearn_compatibility.py: previous version tested equivalence with sklearn. The test passes with the new version, so the new output is equal to the old output.

Copy link
Member

@MatthewMiddlehurst MatthewMiddlehurst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. Could you edit the n_jobs docstring and consider implementing the backend parameter found in other threaded classifiers. Don't have to do the second but would be a nice addition I think.

preds[i] = preds[i] / np.sum(preds[i])

return preds
preds = Parallel(n_jobs=self.n_jobs, backend=self.parallel_backend)(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use check_n_jobs for both functions

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
classification Classification package enhancement New feature, improvement request or other non-bug code enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[ENH] functional n_jobs parameter for knn classifier
2 participants