Skip to content
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.

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

[ENH] Improving docs, examples, and tutorials of pytorch-forecasting #1745

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
65 changes: 64 additions & 1 deletion docs/source/tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,72 @@ Tutorials

The following tutorials can be also found as `notebooks on GitHub <https://github.com/sktime/pytorch-forecasting/tree/main/docs/source/tutorials>`_.


Chapter 1 - Introduction
------------------------

.. _chapter1:

.. list-table::
:widths: 25 50 10
:header-rows: 1

* - Notebook
- Description
- Link
* - Getting started
- How to install and import the `pytorch-forecasting` package for the first time and training a simple model.
- Link
* - TimeSeries Dataset
- How to use the `pytorch-forecasting` TimeSeriesDataSet class
- Link

Chapter 2 - Time Series Models
------------------------------

.. _chapter2:

.. list-table::
:widths: 25 50 10
:header-rows: 1

* - Notebook
- Description
- Link
* - Demand forecasting with the Temporal Fusion Transformer
- Demonstrate the `TemporalFusionTransformer` model on a small example
- `Link <https://pytorch-forecasting.readthedocs.io/en/stable/tutorials/stallion.html>`_
* - Interpretable forecasting with N-Beats
- Training the `NBeats` model on a generated dataset example
- `Link <https://pytorch-forecasting.readthedocs.io/en/stable/tutorials/ar.html>`_
* - Autoregressive modelling with DeepAR and DeepVAR
- Showcasing the `DeepAR` model or `DeepVAR` on a generated dataset
- `Link <https://pytorch-forecasting.readthedocs.io/en/stable/tutorials/deepar.html>`_
* - Multivariate quantiles and long horizon forecasting with N-HiTS
- Forecasting using the `NHiTS` model
- `Link <https://pytorch-forecasting.readthedocs.io/en/stable/tutorials/nhits.html>`_


Chapter 3 - Extra Tutorials
---------------------------

.. _chapter3:

.. list-table::
:widths: 25 50 10
:header-rows: 1

* - Notebook
- Description
- Link
* - How to use custom data and implement custom models and metrics
- Building your own custom models and metrics using `pytorch-forecasting`
- `Link <https://pytorch-forecasting.readthedocs.io/en/stable/tutorials/building.html>`_


.. toctree::
:titlesonly:
:maxdepth: 2
:maxdepth: 1

tutorials/stallion
tutorials/ar
Expand Down
Loading