aeon icon indicating copy to clipboard operation
aeon copied to clipboard

[ENH] Correct broken source links for `set_params` and `get_params` in Aeon estimator docs

Open Kaustbh opened this issue 8 months ago • 2 comments

Reference Issues/PRs

Fixes: #2752

What does this implement/fix? Explain your changes.

This PR fixes broken "Source" links in the Aeon documentation for the set_params and get_params methods. Currently, the autogenerated links incorrectly point to sklearn paths such as:

"https://github.com/aeon-toolkit/aeon/blob/main/sklearn/base.py#L255-L297" which leads to a 404 error, since these methods are inherited from sklearn.BaseEstimator and not directly implemented in Aeon code.

Solution: Added set_params and get_params methods in aeon/base/_base.py where the users will be directed from the documentation, which are actually implemented in sklearn.

Does your contribution introduce a new dependency? If yes, which one?

Any other comments?

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.
  • [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.

Kaustbh avatar Apr 18 '25 04:04 Kaustbh