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] Distance function notebook #2395

Open
TonyBagnall opened this issue Nov 25, 2024 · 6 comments
Open

[DOC] Distance function notebook #2395

TonyBagnall opened this issue Nov 25, 2024 · 6 comments
Assignees
Labels
distances Distances package documentation Improvements or additions to documentation

Comments

@TonyBagnall
Copy link
Contributor

Describe the issue linked to the documentation

the notebook distances.ipyb is very nice, but there is a lot more now in the distances module, and it would be good to

  1. add a top page distances
  2. add sub pages for elastic, mindist, pointwise and "others"

Suggest a potential alternative/fix

No response

@TonyBagnall TonyBagnall added documentation Improvements or additions to documentation distances Distances package labels Nov 25, 2024
@tanishy7777
Copy link

Hey, could you elaborate a bit more about this issue, I would love to work on it

@chrisholder
Copy link
Contributor

Hi @tanishy7777 the distance notebook only covers the elastic distances. We have since added a lot more "new" distances. It would be good to add examples of the other distances.

@tanishy7777
Copy link

tanishy7777 commented Nov 29, 2024

ok got it. I am assuming by "new" distances you mean the distances in the aeon/distances folder that arent in the docs?
I will start working on it, could you assign it to me? @chrisholder @TonyBagnall

@MatthewMiddlehurst
Copy link
Member

I would have a read through of the contributor guide in the docs, this should give you some help and tell you how to assign yourself.

@kevinzb56
Copy link
Contributor

kevinzb56 commented Jan 9, 2025

Hi, I’d like to work on this issue by adding the new distances (mindist, pointwise, and others) to the distances notebook.

@aeon-actions-bot assign @kevinzb56

@kevinzb56
Copy link
Contributor

@SebastianSchmidl @TonyBagnall Could you review the PR #2487 I submitted for this issue please. Thank you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
distances Distances package documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

5 participants