Skip to content

[DEP] Deprecate dataset_name in favour of name in load_monster_dataset - #3988

Open
watzal wants to merge 1 commit into
aeon-toolkit:mainfrom
watzal:3407-monster-dataset-name
Open

watzal wants to merge 1 commit into
aeon-toolkit:mainfrom
watzal:3407-monster-dataset-name

Conversation

@watzal

@watzal watzal commented Nov 3, 2026

Copy link
Copy Markdown

Reference Issues/PRs

Fixes #3407.

What does this implement/fix? Explain your changes.

load_monster_dataset used dataset_name while the other dataset loaders (load_classification, load_regression, load_forecasting, load_anomaly_detection etc.) use name.

Following the deprecation policy:

  • Added name as the first parameter, so positional calls are unchanged.
  • dataset_name will still work but it will raise a FutureWarning, with a TODO to remove it in v1.8.0.
  • A ValueError is raised if no name is given, or if both name and dataset_name are passed.
  • The argument handling happens before any network call.
  • Updated the docstring and the existing test to use name instead of dataset_name.
  • Added an offline test for the argument errors and an overnight test for the FutureWarning.

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

No.

Any other comments?

Happy to change the removal version if a different one is preferred.

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 datasets Datasets and data loaders deprecation This issue is related to deprecation or removal of code labels Nov 3, 2026
@aeon-actions-bot

Copy link
Copy Markdown
Contributor

Thank you for contributing to aeon

I have added the following labels to this PR based on the title: deprecation.
I have added the following labels to this PR based on the changes made: datasets. 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, please run pre-commit locally and push the fixes to your PR branch.

Don't hesitate to ask questions on the aeon Discord channel if you have any.

PR CI actions

These checkboxes will add labels to enable or 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
  • Disable numba cache loading
  • Regenerate expected results for testing
  • Push an empty commit to re-run CI checks

@watzal

watzal commented Nov 3, 2026

Copy link
Copy Markdown
Author

The macOS 3.13 job failed because the hosted runner lost communication with the server (infrastructure issue, no test failures in the log). All other test runs pass.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

datasets Datasets and data loaders deprecation This issue is related to deprecation or removal of code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[ENH] load_monster_dataset param dataset_name instead of name

1 participant