sktime - registry - adding new models

[RobotPsychologist]

Adding New Models

Walkthrough

A walkthrough example of how to add new models to the registry:

• Developer Guide: https://www.sktime.net/en/latest/developer_guide/add_estimators.html
• Notebook by Felipe: https://github.com/sktime/sktime-tutorial-euroscipy2024/blob/main/notebooks/04_customization.ipynb
• Generalities: for adding to sktime, open a new issue ("feature request", "implementing estimator" or "interfacing estimator" if in other library)
• Adding a new concrete class -> automatically adds to registry
• "howto" = "fill out extension template", see developer guide
• If the class is maintained in a different package, use "placeholder record" pattern, see HierarchicalProphet
• CAVEAT with detectors: extension template was recently updated to follow the new API, recommend to stay in conversation with owner of API issue to ensure extension template is also consistent with any changes
  • unified API changes usually require changes to
    • base class public and private API
    • test class
    • extension template (documents the private API)
    • example notebook (documents the public API)
  • and require changes to be consistent to avoid trouble
• Felipe recommendation: understand the tags!
  • FK: tags are documented here https://www.sktime.net/en/latest/api_reference/tags.html
  • Unfortunately, this does not include detector tags (yet)

Algorithms List

• [ ]

[gavinkatz001]

commenting to get assigned