[DOC] Fix docstrings and typos in benchmarking module#10501
Merged
fkiraly merged 1 commit intoJul 10, 2026
Conversation
NAME-ASHWANIYADAV
requested review from
SimonBlanke,
benHeid,
felipeangelimvieira,
fkiraly,
geetu040,
jgyasu and
marrov
as code owners
July 4, 2026 07:20
Contributor
Author
fkiraly
approved these changes
Jul 10, 2026
fkiraly
left a comment
Collaborator
There was a problem hiding this comment.
Looks accurate, all correctly fixed! Thanks!
Contributor
Author
|
thank you !! @fkiraly |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 #10500.
What does this implement/fix? Explain your changes.
This PR systematically cleans up docstrings and fixes typos across the
sktime/benchmarkingmodule, as described in #10500. Specifically:classification.py,forecasting.py,_benchmarking_dataclasses.py, and_utils.py.add_taskincorrectly documenteddatainstead of the actualdataset_loaderparameter._SktimeRegistry.registerinbenchmarks.pyby removing legacy parameters that no longer exist._add_estimatorinbenchmarks.pyto accurately state that it accepts a singleBaseEstimator._coerce_data_for_evaluatein_benchmarking_dataclasses.pyto accurately reflect its use across all task types, not just forecasting.Does your contribution introduce a new dependency? If yes, which one?
No.
What should a reviewer concentrate their feedback on?
A quick sanity check to ensure the updated docstrings accurately reflect the method signatures.
Did you add any tests for the change?
No tests were added as this is strictly a documentation/docstring cleanup. However, all existing benchmarking tests and lint checks pass locally.
Any other comments?
N/A
PR checklist
For all contributions
maintainerstag - do this if you want to become the owner or maintainer of an estimator you added.