[Chetansahney]

Reference Issues/PRs

Follows up #2423. Related: #2480.

What does this implement/fix? Explain your changes.

#2423 renamed the datamodules' time_series_dataset argument to time_series, but docs/source/models_v2.rst and both v2 tutorials still used the old name. EncoderDecoderTimeSeriesDataModule has no **kwargs, so ptf_V2_example.ipynb raises

TypeError: EncoderDecoderTimeSeriesDataModule.__init__() got an unexpected keyword argument 'time_series_dataset'

and the "Run notebook tutorials" job fails on v2-dev itself (both of its last two pushes), and therefore on every PR into v2-dev.

This changes the keyword in the models_v2.rst example, in the code cells of both tutorials, and in the two argument lists in ptf_V2_example.ipynb.

tslib_v2_example.ipynb fails even earlier on v2-dev: its TimeSeries lists future_know_feature in num, a typo for the future_known_feature column, and TimeSeries now checks column names, so that cell raises a ValueError. Fixed as well. Its datamodule cell would not have raised on the old keyword, since TslibDataModule takes **kwargs; it would have built a module without data.

Only the changed source lines differ; stored outputs are untouched.

What should a reviewer concentrate their feedback on?

• The tutorials may be rewritten for the new Forecaster API anyway; this just gets them running on v2-dev until then.

Did you add any tests for the change?

No tests; this is docs only. Both notebooks execute end to end with the same command as build_tools/run_examples.sh (jupyter nbconvert --execute, 1200 s timeout): ptf_V2_example.ipynb in 25 s and tslib_v2_example.ipynb in 46 s. Before this change the first failed with the TypeError above and the second with the ValueError. The pre-commit hooks, including the nbqa ones, pass.

Any other comments?

tslib_v2_example.ipynb also passes categorical_encoders= to TslibDataModule, which has no such argument. It is absorbed by **kwargs and ignored, on main as well as v2-dev. I left it alone here since it is not from #2423, but the tutorial suggests it has an effect.

PR checklist

• The PR title starts with either [ENH], [MNT], [DOC], or [BUG].
• Added/modified tests
• Used pre-commit hooks when committing to ensure that code is compliant with hooks.

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (v2-dev@4c9d6bd). Learn more about missing BASE report.

Additional details and impacted files

@@            Coverage Diff            @@
##             v2-dev    #2481   +/-   ##
=========================================
  Coverage          ?   87.95%           
=========================================
  Files             ?      203           
  Lines             ?    11385           
  Branches          ?        0           
=========================================
  Hits              ?    10014           
  Misses            ?     1371           
  Partials          ?        0           

Flag	Coverage Δ
cpu	87.95% <ø> (?)
pytest	87.95% <ø> (?)

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.