tslearn-team / tslearn

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

KNeighborsTimeSeriesClassifier not alligned with documentation #86

Closed Xhelas closed 5 years ago

Xhelas commented 5 years ago
rtavenar commented 5 years ago

Hi @Xhelas ,

Thanks for raising this issue. I see two problems there:

So basically, the fix should be 2-steps:

rtavenar commented 5 years ago

OK, so I remove the false claims from the docs, I paste it here to put it back when the problem is solved:

Supervised classification
-------------------------

* :ref:`KNeighborsTimeSeriesClassifier <knn-clf>`

Example
~~~~~~~

.. code-block:: python

    from tslearn.neighbors import KNeighborsTimeSeriesClassifier
    clf = KNeighborsTimeSeriesClassifier(metric="dtw")
    predicted_labels = clf.fit(X, y).predict(X)

And we should definitely find a way to have kNN deal with variable length time series when (soft-)DTW is used as a metric, and similar thing for SVM+GAK. We are working on it, but it may take some time to be fixed, sorry for that.

So the remaining part of this Issue is completely related to #94 , so I suggest we move the discussion there and close this issue.