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

& matthewmiddlehurst [DOC] improved docstring for dtw_distance #4028

Merged
merged 4 commits into from Jan 31, 2023

Conversation

fkiraly
Copy link
Collaborator

@fkiraly fkiraly commented Dec 31, 2022

This improves the docstring of dtw_distance with mathematical detail, and adds related information to DtwDist.

Based on @MatthewMiddlehurst's PR #3852, with following changes:

  • clarifies assumptions, e.g., equal length, only Euclidean distance
  • links to more general time warping distance in sktime
  • mathematic formalism is clarified and corrected in some places
  • valuative formulations, e.g., "most researched" or "most common", are removed

@fkiraly fkiraly added the documentation Documentation & tutorials label Dec 31, 2022
@fkiraly fkiraly changed the title & matthewmiddlehurst [DOC] docstring for dtw_distance & matthewmiddlehurst [DOC] improved docstring for dtw_distance Dec 31, 2022
@fkiraly
Copy link
Collaborator Author

fkiraly commented Dec 31, 2022

failures unrelated to this PR, see #4033

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation & tutorials
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant