Skip to content

[DOC] fix incorrect references of classes in getting started page #2762

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

[DOC] fix incorrect references of classes in getting started page #2762

wants to merge 3 commits into from

Conversation

inclinedadarsh
Copy link
Contributor

Reference Issues/PRs

Fixes #2761

What does this implement/fix? Explain your changes.

The getting started page had a few incorrect references to classes. This PR fixes those incorrect references. Please checkout #2761 to see the list of incorrect references.

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

No.

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 the documentation Improvements or additions to documentation label Apr 24, 2025
@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}}$ ].

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-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
  • Stop automatic pre-commit fixes (always disabled for drafts)
  • Disable numba cache loading
  • Push an empty commit to re-run CI checks

@inclinedadarsh inclinedadarsh mentioned this pull request Apr 24, 2025
Open
Kaustbh
Kaustbh reviewed Apr 24, 2025
View reviewed changes
TonyBagnall
TonyBagnall requested changes Apr 25, 2025
View reviewed changes
docs/getting_started.md
@@ -403,7 +403,7 @@ statistics for each series.
```

There are also series-to-series transformations, such as the
[Padder](transformations.collection) to lengthen
[Padder](transformations.collection.Padder) to lengthen
Copy link
Contributor

Choose a reason for hiding this comment

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

I think transformations.collection is correct, Padder is declared in the init and there is no file Padder, the class is in file _pad

Copy link
Contributor Author

Choose a reason for hiding this comment

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

image

Weird enough, it tries to find a section with transformations.collection in the getting started page when I don't add .Padder in the end.

Also, I built it locally with transformations.collection.Padder and it works perfectly fine.

Here's the page it tries to find when I put transformations.collection.Padder in the link:
image

I have tested this locally, and it works perfectly fine.

Copy link
Contributor

Choose a reason for hiding this comment

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

I have also tested it locally it is working fine with transformations.collection.Padder, I think it requires the class name.

docs/getting_started.md
@@ -385,7 +385,7 @@ Most time series classification and regression algorithms are based on some form
transformation into an alternative feature space. For example, we might extract some
summary time series features from each series, and fit a traditional classifier or
regressor on these features. For example, we could use
[Catch22](transformations.collection.feauture_based), which calculates 22 summary
[Catch22](transformations.collection.feature_based.Catch22), which calculates 22 summary
Copy link
Contributor

Choose a reason for hiding this comment

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

good spot with typo, but it should just be transformations.collection.feature_based, it is declared in the init.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Similar to the padder case, when I just do transformations.collection.feature_based (without .Catch22), it tries to find a local section in the getting started page with the id of transformations.collection.feature_based. But it works perfectly fine when I add .Catch22 in the end (locally tested)

image

I have tested this locally, and transformations.collection.feature_based.Catch22 works perfectly fine.

docs/getting_started.md
@@ -438,7 +438,7 @@ For machine learning tasks such as classification, regression and clustering, th
`scikit-learn` `make_pipeline` functionality can be used if the transformer outputs
a valid input type.

The following example uses the [Catch22](transformations.collection.catch22.Catch22)
The following example uses the [Catch22](transformations.collection.feature_based.Catch22)
Copy link
Contributor

Choose a reason for hiding this comment

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

I think just transformations.collection.feature_based is sufficient.

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

@Kaustbh Kaustbh Kaustbh left review comments

@TonyBagnall TonyBagnall TonyBagnall requested changes

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[DOC] Fix incorrect references from "Getting Started" page
3 participants
@inclinedadarsh @TonyBagnall @Kaustbh