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] Add API Reference for distance profiles in Similarity Search module #1425

Open
itsdivya1309 opened this issue Apr 15, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature, improvement request or other non-bug code enhancement

Comments

@itsdivya1309
Copy link
Contributor

Describe the feature or idea you want to propose

The distance profile functions implemented in aeon are:

  1. euclidean_distance_profile
  2. normalized_euclidean_distance_profile
  3. naive_distance_pofile
  4. normalized_naive_distance_profile
  5. squared_distance_profile and
  6. normalized_squared_distance_profile
    But they are not mentioned in the API references: https://www.aeon-toolkit.org/en/latest/api_reference/similarity_search.html

Describe your proposed solution

Add docstrings to the above functions.

Describe alternatives you've considered, if relevant

No response

Additional context

No response

@itsdivya1309 itsdivya1309 added the enhancement New feature, improvement request or other non-bug code enhancement label Apr 15, 2024
@baraline baraline added the documentation Improvements or additions to documentation label Apr 16, 2024
@baraline baraline changed the title [ENH] Add API Reference for distance profiles in Similarity Search module [DOC] Add API Reference for distance profiles in Similarity Search module Apr 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature, improvement request or other non-bug code enhancement
Projects
None yet
Development

No branches or pull requests

2 participants