tslearn-team / tslearn

The machine learning toolkit for time series analysis in Python
https://tslearn.readthedocs.io
BSD 2-Clause "Simplified" License
2.91k stars 342 forks source link

Improve backend docstrings #482

Closed YannCabanes closed 11 months ago

YannCabanes commented 1 year ago

This PR improves the documentation about the backends to explain how they work.

We will add information about the backends (how it works, how to select the backend, what happens if it is not selected...) in the Quick-start guide: https://github.com/tslearn-team/tslearn/blob/main/docs/quickstart.rst and add a file named backend.rst in the folder main/docs.

We will also add information about the backends and examples in the docstrings of the functions dtw (https://github.com/tslearn-team/tslearn/blob/main/tslearn/metrics/dtw_variants.py) and soft_dtw (https://github.com/tslearn-team/tslearn/blob/main/tslearn/metrics/softdtw_variants.py).

codecov-commenter commented 1 year ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (09441ab) 93.33% compared to head (602268c) 93.64%.

:exclamation: Current head 602268c differs from pull request most recent head 203751a. Consider uploading reports for the commit 203751a to get more accurate results

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #482 +/- ## ========================================== + Coverage 93.33% 93.64% +0.31% ========================================== Files 67 67 Lines 5728 5728 ========================================== + Hits 5346 5364 +18 + Misses 382 364 -18 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

YannCabanes commented 1 year ago

Hello @rtavenar, could you review this PR please?

YannCabanes commented 1 year ago

Pytest documentation to skip doctests when torch is not installed for the linux_without_torch test: https://docs.pytest.org/en/latest/how-to/usage.html# https://stackoverflow.com/questions/36456920/specify-which-pytest-tests-to-run-from-a-file/61869181#61869181 https://stackoverflow.com/questions/38442897/how-do-i-disable-a-test-using-pytest