aeon
aeon copied to clipboard
[ENH] Fixes Issue Improve `_check_params` method in `kmeans.py` and `kmedoids.py`
Reference Issues/PRs
Fixes: #2681
What does this implement/fix? Explain your changes.
Adds an else statement in _check_params for both kmeans.py and kmedoids.py. Also adds build initialization documentation.
Does your contribution introduce a new dependency? If yes, which one?
Any other comments?
PR checklist
For all contributions
- [x] 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.
- [x] 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.
For new estimators and functions
- [ ] I've added the estimator/function to the online API documentation.
- [ ] (OPTIONAL) I've added myself as a
__maintainer__at the top of relevant files and want to be contacted regarding its maintenance. Unmaintained files may be removed. This is for the full file, and you should not add yourself if you are just making minor changes or do not want to help maintain its contents.
For developers with write access
- [ ] (OPTIONAL) I've updated aeon's CODEOWNERS to receive notifications about future changes to these files.
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{#4011F3}{\textsf{clustering}}$ ]. 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-commitchecks for all files - [ ] Run
mypytypecheck tests - [ ] Run all
pytesttests and configurations - [ ] Run all notebook example tests
- [ ] Run numba-disabled
codecovtests - [ ] Stop automatic
pre-commitfixes (always disabled for drafts) - [ ] Disable numba cache loading
- [ ] Push an empty commit to re-run CI checks
@MatthewMiddlehurst I wasn't sure if there is any other ways to deal with this other than rebasing and force-with-lease
Is this approach ok?
I did this to move my latest commit 499ba8b on top of the commit history as readthedocs and some pytest tests were failing as they were not able to find my commit in the tree.
Now the tests are passing.
I ran the following commands:
git checkout improve_check_params
git fetch origin
git rebase origin/main
git push --force-with-lease
I do not know, i cannot see an error any more due to the force push.
I do not know, i cannot see an error any more due to the force push.
I was just wondering if force pushing is fine in this case? Or would that be a problem? And if there is a alternative way we could have handled this in?
I do not know enough about the issue or why it happens, not looked into it. See #2723
@MatthewMiddlehurst just a gentle reminder, in case you missed this
what has happened with _dtw_gi.py?
what has happened with
_dtw_gi.py?
Oh I think that was an accident. WIll change it asap.