johannfaouzi / pyts

A Python package for time series classification

Home Page:https://pyts.readthedocs.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[ENH] making `pyts` searchable via `sktime`, interfaces & collaboration

fkiraly opened this issue · comments

While I'm here, I wanted to point out that at sktime, we've started to interface pyts algorithms, upon popular demand, to have them indexed for users who are searching for TSC and time series transformations.

Users will be able to find interfaced estimators using the indexing utility all_estimators in sktime.registry, and use them as components in sktime pipelines and composites. For this, users will need to install pyts, and they recieve an informative error message to this effect when they attempt to construct pipelines. Proper credit to pyts is of course also given, by name of estimator (uses pyts brand) and in docstring, feedback appreciated.

The estimators are also regularly tested against standard API contracts, that's how we found #158.

If you would like to help out, or observe:

  • issue on sktime is here, feel free to comment: sktime/sktime#5850
  • adding new pyts estimators is formulaic, we have written a general adapter that can be inherited from

We're not sure yet about distances.

Further, the knn classifier is neat, but we're wondering what is the best way to allow it to take abstract distances, which are first order citizens in sktime (also estimators). Perhaps there is a collaboration opportunity here.

PS: we weren't sure about authorship or maintainership - kindly be welcome to add yourself/yourselves to the author or maintainer fields of any of the adapters. Maintainer field only if you would like to take on maintenance of the adapter in sktime, of course. Both fields are shown in the searchable estimator overview and are one of our primary means of giving individual credit: https://www.sktime.net/en/latest/estimator_overview.html

I just went ahead and added you to the author fields, @johannfaouzi: sktime/sktime#6270
You will be visible in the estimator overview in first position.

Let us know of any comments or questions.