sktime / sktime

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

[DOC] extend extension templates to cover soft dependencies #1759

Closed fkiraly closed 1 year ago

fkiraly commented 2 years ago

The extension templates (here: https://github.com/alan-turing-institute/sktime/tree/main/extension_templates) should be extended with a preamble that treats soft dependencies.

The challenge is to keep it very brief, and to make clear that adding soft dependencies is only necessary for the case of extending sktime itself. If the template is used in a project/package that has sktime as a dependency, treatment of soft dependencies is not needed (or only arising from the other project).

Examples for how to treat soft dependencies within sktime are the ProphetForecaster or tbats.

fkiraly commented 1 year ago

done by @Aparna-Sakshi and various further changes