Skip to content

[DOC] Add developer guide for pytorch-forecasting (v1 + v2) #2351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
echo-xiao wants to merge 11 commits into
base: main
Choose a base branch
from
Open

[DOC] Add developer guide for pytorch-forecasting (v1 + v2) #2351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
993953f
docs: add v2 migration guide skeleton and wire into api_v2 toctree
echo-xiao Jul 21, 2026
2c802f0
docs: add v1 to v2 concept mapping table to migration guide
echo-xiao Jul 21, 2026
25443f7
docs: add TFT before/after example to migration guide
echo-xiao Jul 21, 2026
eb9145b
docs: add prose sections and cross-references to migration guide
echo-xiao Jul 21, 2026
e81ce6a
docs: list v2 models via auto-generated model-overview in migration g…
echo-xiao Jul 21, 2026
d416626
docs: rework v1->v2 migration guide as a developer model-migration gu…
echo-xiao Jul 22, 2026
19914ec
[DOC] surface v1->v2 migration guide in v2 page beta boxes
echo-xiao Jul 25, 2026
fa9bb68
[MNT] [Dependabot](deps): Bump actions/setup-python from 6 to 7 (#2348)
dependabot[bot] Jul 21, 2026
c792114
[DOC] Add developer guide for pytorch-forecasting (v1 + v2)
echo-xiao Jul 22, 2026
0f84175
[DOC] address review: trim dev guide, drop em dashes, link templates,…
echo-xiao Jul 25, 2026
f40315d
[DOC] tighten architecture section to one-line summaries plus diagrams
echo-xiao Jul 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/pypi_release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
steps:
- uses: actions/checkout@v7

- uses: actions/setup-python@v6
- uses: actions/setup-python@v7
with:
python-version: '3.11'

Expand All @@ -38,7 +38,7 @@ jobs:
steps:
- uses: actions/checkout@v7

- uses: actions/setup-python@v6
- uses: actions/setup-python@v7
with:
python-version: '3.11'

Expand Down Expand Up @@ -67,7 +67,7 @@ jobs:
- uses: actions/checkout@v7

- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v6
uses: actions/setup-python@v7
with:
python-version: ${{ matrix.python-version }}

Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
uses: actions/checkout@v7

- name: python environment step
uses: actions/setup-python@v6
uses: actions/setup-python@v7
with:
python-version: "3.11"

Expand Down Expand Up @@ -59,7 +59,7 @@ jobs:
steps:
- uses: actions/checkout@v7
- name: Set up Python
uses: actions/setup-python@v6
uses: actions/setup-python@v7
with:
python-version: "3.11"
- name: Install dependencies
Expand Down Expand Up @@ -88,7 +88,7 @@ jobs:
- uses: actions/checkout@v7

- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v6
uses: actions/setup-python@v7
with:
python-version: ${{ matrix.python-version }}

Expand Down Expand Up @@ -132,7 +132,7 @@ jobs:
enable-cache: true

- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v6
uses: actions/setup-python@v7
with:
python-version: ${{ matrix.python-version }}

Expand Down Expand Up @@ -172,7 +172,7 @@ jobs:
- uses: actions/checkout@v7

- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v6
uses: actions/setup-python@v7
with:
python-version: ${{ matrix.python-version }}

Expand Down
1 change: 1 addition & 0 deletions docs/source/api_v2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ API v2
.. warning::
Please note that the v2 modules are currently in active-development and is in beta right now, so please use this API with caution.
See v1 documentation :doc:`here <api>` - it is stable and can be used in the production pipelines.
Migrating an existing model implementation to v2? See :doc:`migration_v1_to_v2`.

.. currentmodule:: pytorch_forecasting

Expand Down
1 change: 1 addition & 0 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
"sphinx.ext.githubpages",
"sphinx.ext.napoleon",
"model_overview",
"sphinxcontrib.mermaid",
]

# Add any paths that contain templates here, relative to this directory.
Expand Down
1 change: 1 addition & 0 deletions docs/source/data_v2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Data v2
.. warning::
Please note that the v2 modules are currently in active-development and is in beta right now, so please use this API with caution.
See complete documentation for v2 API :doc:`here <api_v2>` and stable v1 documentation :doc:`here <api>`.
Migrating an existing model implementation to v2? See :doc:`migration_v1_to_v2`.

.. currentmodule:: pytorch_forecasting

Expand Down
Loading
Loading