aeon icon indicating copy to clipboard operation
aeon copied to clipboard

[DOC] Add API Reference for distance profiles in Similarity Search module

Open itsdivya1309 opened this issue 1 year ago • 0 comments

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 avatar Apr 15 '24 09:04 itsdivya1309