Fix LCSS documentation - Githubissues

YannCabanes commented 3 months ago

Fix a few mistakes in the LCSS documentation:

Fix a typo in epsilon and delta mathematical symbols
Fix an error in epsilon and delta data types
In the pseudocode of the function lcss, normalize the returned result by dividing by min(n, m)
Precise that the values returned by LCSS range from 0 to 1, the value 1 being taken when the two time series completely match. It was written that for all x, lcss(x, x) = 0 instead of lcss(x, x) = 1. This mistake has been noticed in Issue https://github.com/tslearn-team/tslearn/issues/509
Remove a wrong sentence saying that the clustering algorithm TimeSeriesKMeans can be used with the lcss metric

rtavenar commented 3 months ago

Thanks @YannCabanes !

It seems the $\delta$ parameter is not implemented in practice (cf docs for the LCSS function) since it plays the same role as the Sakoe-Chiba band. Could you remove all references to this $\delta$ parameter in the docs page you edited?

rtavenar commented 3 months ago

LGTM!

Closes #509

tslearn-team / tslearn

Fix LCSS documentation #513