search

sktime / sktime

A unified framework for machine learning with time series
https://www.sktime.net
BSD 3-Clause "New" or "Revised" License
7.99k stars 1.38k forks source link

[ENH] rename `"series-annotator"` scitype to `"detector"` #7352

Closed fkiraly closed 1 week ago

fkiraly commented 4 weeks ago

In line with the general rationale of https://github.com/sktime/sktime/issues/7295, we should rename the "series-annotator" scitype to "detector".

To ensure downwards compatibility though, it is best to simply add the "detector" scitype in the list of scitypes (turning str into a list ot str), in the tag object_type. This will ensure that queries using the old name will still work, while queries with the new name start working, allowing us to transition to using the latter, new queries in tutorials, primary internal access patterns, etc.

jgyfutub commented 3 weeks ago

can I work on this issue?

fkiraly commented 3 weeks ago

Sure!

This one is a bit special though, we were planning to do this with the Waterloo Diabetes project.

However, this issue should be quick and there are many other items, so you would be helping out rather than taking someone´s work. It would be great if you could have a PR ready by Nov 6, so it does not delay scheduling on the Diabetes project - otherwise someone from there will pick it up.

jgyfutub commented 3 weeks ago

@fkiraly ok so shall I just rename series-annotator to detector where ever I find it in the repo?

fkiraly commented 3 weeks ago

Not everywhere - I think estimators should get it as an additional tag to preserve downwards compatibility. In other places, we add a second copy, and then add notes to remove the duplicates in 0.37.0.