From 37a27864e0087fa567304e6575bdf2bbed53e8a8 Mon Sep 17 00:00:00 2001 From: julian fong Date: Wed, 1 Jan 2025 12:44:43 -0500 Subject: [PATCH 1/5] initial commits --- docs/source/tutorials.rst | 54 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) diff --git a/docs/source/tutorials.rst b/docs/source/tutorials.rst index c8282719..cc2a52ca 100644 --- a/docs/source/tutorials.rst +++ b/docs/source/tutorials.rst @@ -5,6 +5,60 @@ Tutorials The following tutorials can be also found as `notebooks on GitHub `_. + +Chapter 1 - Introduction +------------------------ + +.. _chapter1: + +.. list-table:: + :widths: 25 50 15 + :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: + + * - Notebook + - Description + - Link + * - Demand forecasting with the Temporal Fusion Transformer + - Demonstrate the `TemporalFusionTransformer` model on a small example + - `Link `_ + * - Interpretable forecasting with N-Beats + - Training the `NBeats` model on a generated dataset example + - `Link `_ + * - Autoregressive modelling with DeepAR and DeepVAR + - Showcasing the `DeepAR` model or `DeepVAR` on a generated dataset + - `Link `_ + * - Multivariate quantiles and long horizon forecasting with N-HiTS + - Forecasting using the `NHiTS` model + - `Link `_ + + +Chapter 3 - Extra Tutorials +--------------------------- + +.. _chapter3: + + * - 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 `_ + .. toctree:: :titlesonly: :maxdepth: 2 From 15275a70af5ba130e79d4565e3940c6786577ff8 Mon Sep 17 00:00:00 2001 From: julian fong Date: Wed, 1 Jan 2025 13:19:05 -0500 Subject: [PATCH 2/5] fixed table formatting --- docs/source/tutorials.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/source/tutorials.rst b/docs/source/tutorials.rst index cc2a52ca..17398db3 100644 --- a/docs/source/tutorials.rst +++ b/docs/source/tutorials.rst @@ -12,7 +12,7 @@ Chapter 1 - Introduction .. _chapter1: .. list-table:: - :widths: 25 50 15 + :widths: 25 50 10 :header-rows: 1 * - Notebook @@ -30,6 +30,9 @@ Chapter 2 - Time Series Models .. _chapter2: +.. list-table:: + :widths: 25 50 15 + :header-rows: 1 * - Notebook - Description - Link @@ -52,6 +55,9 @@ Chapter 3 - Extra Tutorials .. _chapter3: +.. list-table:: + :widths: 25 50 15 + :header-rows: 1 * - Notebook - Description - Link From c78544d7543330afe60ff6feba1c6c53ec23513e Mon Sep 17 00:00:00 2001 From: julian fong Date: Wed, 1 Jan 2025 13:19:16 -0500 Subject: [PATCH 3/5] fixed table formatting --- docs/source/tutorials.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/tutorials.rst b/docs/source/tutorials.rst index 17398db3..b818f985 100644 --- a/docs/source/tutorials.rst +++ b/docs/source/tutorials.rst @@ -31,7 +31,7 @@ Chapter 2 - Time Series Models .. _chapter2: .. list-table:: - :widths: 25 50 15 + :widths: 25 50 10 :header-rows: 1 * - Notebook - Description @@ -56,7 +56,7 @@ Chapter 3 - Extra Tutorials .. _chapter3: .. list-table:: - :widths: 25 50 15 + :widths: 25 50 10 :header-rows: 1 * - Notebook - Description From 842218ffddbe04ca225976e824be40407ba7aafb Mon Sep 17 00:00:00 2001 From: julian fong Date: Wed, 1 Jan 2025 13:41:50 -0500 Subject: [PATCH 4/5] fixed bug --- docs/source/tutorials.rst | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/source/tutorials.rst b/docs/source/tutorials.rst index b818f985..3ce067aa 100644 --- a/docs/source/tutorials.rst +++ b/docs/source/tutorials.rst @@ -33,6 +33,7 @@ Chapter 2 - Time Series Models .. list-table:: :widths: 25 50 10 :header-rows: 1 + * - Notebook - Description - Link @@ -58,6 +59,7 @@ Chapter 3 - Extra Tutorials .. list-table:: :widths: 25 50 10 :header-rows: 1 + * - Notebook - Description - Link @@ -69,8 +71,8 @@ Chapter 3 - Extra Tutorials :titlesonly: :maxdepth: 2 - tutorials/stallion - tutorials/ar - tutorials/building - tutorials/deepar - tutorials/nhits + .. tutorials/stallion + .. tutorials/ar + .. tutorials/building + .. tutorials/deepar + .. tutorials/nhits From df470cc7fbc440d328facc195e9d6fa531c3b81b Mon Sep 17 00:00:00 2001 From: julian fong Date: Wed, 1 Jan 2025 14:08:55 -0500 Subject: [PATCH 5/5] updates --- docs/source/tutorials.rst | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/source/tutorials.rst b/docs/source/tutorials.rst index 3ce067aa..fb1ec04b 100644 --- a/docs/source/tutorials.rst +++ b/docs/source/tutorials.rst @@ -67,12 +67,13 @@ Chapter 3 - Extra Tutorials - Building your own custom models and metrics using `pytorch-forecasting` - `Link `_ + .. toctree:: :titlesonly: - :maxdepth: 2 + :maxdepth: 1 - .. tutorials/stallion - .. tutorials/ar - .. tutorials/building - .. tutorials/deepar - .. tutorials/nhits + tutorials/stallion + tutorials/ar + tutorials/building + tutorials/deepar + tutorials/nhits