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

[DOC] Update the ElasticEnsemble documentation #1544

Merged
merged 3 commits into from
May 21, 2024

Conversation

itsdivya1309
Copy link
Contributor

@itsdivya1309 itsdivya1309 commented May 20, 2024

Reference Issues/PRs

Closes: #1496

What does this implement/fix? Explain your changes.

  • Changes dwdtw to wddtw in the Parameters section of distance_measures
  • Header changed from Notes to References
  • Modifies docstring for get_metric_params()
  • Adds docstring for _get_100_param_options()

@aeon-actions-bot aeon-actions-bot bot added classification Classification package documentation Improvements or additions to documentation labels May 20, 2024
@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{#F3B9F8}{\textsf{documentation}}$ ].
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.

@itsdivya1309 itsdivya1309 marked this pull request as ready for review May 20, 2024 15:58
Copy link
Member

@baraline baraline left a comment

Choose a reason for hiding this comment

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

Other than the these two comments, it solves the described issue, distances and references sections are correctly reformatted. Nice job !

aeon/classification/distance_based/_elastic_ensemble.py Outdated Show resolved Hide resolved
aeon/classification/distance_based/_elastic_ensemble.py Outdated Show resolved Hide resolved
Copy link
Member

@baraline baraline left a comment

Choose a reason for hiding this comment

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

LGTM ! Did you have anything else in mind @MatthewMiddlehurst ?

@MatthewMiddlehurst
Copy link
Member

Nope, LGTM.

@MatthewMiddlehurst MatthewMiddlehurst merged commit cce4522 into aeon-toolkit:main May 21, 2024
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
classification Classification package documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] ElasticEnsemble API documentation could be improved
3 participants