Skip to content

[DOC] Update v2 extension templates for forecaster API - #2484

Open
BLVCK-MAMBA-6 wants to merge 35 commits into
sktime:v2-devfrom
BLVCK-MAMBA-6:issue-2474-extension-templates
Open

BLVCK-MAMBA-6 wants to merge 35 commits into
sktime:v2-devfrom
BLVCK-MAMBA-6:issue-2474-extension-templates

Conversation

@BLVCK-MAMBA-6

Copy link
Copy Markdown
Contributor

Reference Issues/PRs

Refs #2474. Stacked on #2434.

What does this implement/fix? Explain your changes.

Updates the extension templates to match the v2 forecaster API:

  • Replaces the model-package template with a BaseForecaster template.
  • Updates model linkage and adds support for data-derived metadata.
  • Uses BaseTimeSeriesDataModule hooks and inherits its constructor to preserve configuration when attaching data.
  • Updates dataset signatures and documents the metric prediction-tensor contract.
  • Updates the extension README.

This covers only the extension-template subtask of #2474.

What should a reviewer concentrate their feedback on?

Whether the templates correctly demonstrate the model, forecaster, and datamodule interfaces introduced in #2434.

The template changes are contained in commit 8aad6a2. The broader diff against v2-dev includes changes inherited from #2434.

Did you add any tests for the change?

No new automated tests were added.

The following checks passed for the changed templates:

  • Ruff lint and formatting.
  • Python compilation.
  • Staged diff whitespace checks.

The runtime configuration-cloning check was blocked during package import by ModuleNotFoundError: No module named 'sklearn', so runtime behavior remains unverified.

Any other comments?

This PR depends on #2434 and should merge after it.

The model and data-processing methods remain intentional fill-in placeholders.

PR checklist

  • The PR title starts with [DOC].
  • Added/modified tests.
  • Used the full pre-commit hook suite.

@phoeenniixx phoeenniixx left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!
Can you please not remove the docstrings and todos instead update them, please follow the exisiting pattern and update the template based on it

@phoeenniixx phoeenniixx added documentation Improvements or additions to documentation ptf-v2 Related to `pytorch-forecasting` v2 labels Oct 27, 2026
@codecov

codecov Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 95.04021% with 37 lines in your changes missing coverage. Please review.
⚠️ Please upload report for BASE (v2-dev@4c9d6bd). Learn more about missing BASE report.

Files with missing lines Patch % Lines
...ytorch_forecasting/models/base/_base_forecaster.py 78.97% 37 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff            @@
##             v2-dev    #2484   +/-   ##
=========================================
  Coverage          ?   88.41%           
=========================================
  Files             ?      202           
  Lines             ?    11683           
  Branches          ?        0           
=========================================
  Hits              ?    10329           
  Misses            ?     1354           
  Partials          ?        0           
Flag Coverage Δ
cpu 88.41% <95.04%> (?)
pytest 88.41% <95.04%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@review-notebook-app

Copy link
Copy Markdown

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@BLVCK-MAMBA-6

Copy link
Copy Markdown
Contributor Author

Thanks! Can you please not remove the docstrings and todos instead update them, please follow the exisiting pattern and update the template based on it

Hi @phoeenniixx, I’ve restored the docstrings and TODOs and updated them for the new API, following the existing template pattern.

Please take another look whenever you're chanced. Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation ptf-v2 Related to `pytorch-forecasting` v2

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants