Skip to content

[DOC] Add DLinear v2 tutorial notebook - #2445

Open
chetana1410 wants to merge 1 commit into
sktime:mainfrom
chetana1410:doc-dlinear-v2-tutorial
Open

chetana1410 wants to merge 1 commit into
sktime:mainfrom
chetana1410:doc-dlinear-v2-tutorial

Conversation

@chetana1410

Copy link
Copy Markdown
Contributor

Reference Issues/PRs

Fixes #2390.

What does this implement/fix? Explain your changes.

Adds a v2 tutorial notebook for DLinear and registers it in docs/source/tutorials_v2.rst.

The notebook builds a small numeric dataset, then walks through:

  • TimeSeries
  • TslibDataModule (context window, forecast horizon, scalers, metadata)
  • DLinear_pkg_v2.fit and DLinear_pkg_v2.predict

DLinear's current v2 implementation uses continuous features only, so the toy series has no categorical columns. The split is by series, with enough series for a non-empty train, validation, and test slice.

Ran the notebook locally. Training completed for 5 epochs, and predict returned forecasts of shape (290, 4).

What should a reviewer concentrate their feedback on?

  • Whether the notebook matches the intended v2 tutorial style next to the TFT and TimeXer notebooks.
  • The trainer settings (accelerator="cpu", no checkpoint, no logger) used so the example stays small.

Did you add any tests for the change?

No. This is a documentation-only change. nbsphinx_execute is never, so the notebook is not executed in the docs build. It was executed locally.

Any other comments?

Pre-commit hooks were run on the changed files (nbqa-black, nbqa-ruff, nbqa-check-ast).

PR checklist

  • The PR title starts with either [ENH], [MNT], [DOC], or [BUG]. [BUG] - bugfix, [MNT] - CI, test framework, [ENH] - adding or improving code, [DOC] - writing or improving documentation or docstrings.
  • Added/modified tests
  • Used pre-commit hooks when committing to ensure that code is compliant with hooks. Install hooks with pre-commit install.
    To run hooks independent of commit, execute pre-commit run --all-files

Show TimeSeries, TslibDataModule, and DLinear_pkg_v2 fit and predict
on toy data, and register the notebook in the v2 tutorials page.
@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

@codecov

codecov Bot commented Oct 3, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@5a8c20f). Learn more about missing BASE report.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2445   +/-   ##
=======================================
  Coverage        ?   88.81%           
=======================================
  Files           ?      218           
  Lines           ?    11671           
  Branches        ?        0           
=======================================
  Hits            ?    10366           
  Misses          ?     1305           
  Partials        ?        0           
Flag Coverage Δ
cpu 88.81% <ø> (?)
pytest 88.81% <ø> (?)

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.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOC] Add DLinear v2 tutorial notebook

1 participant