Skip to content

Add gallery of tutorials divided by level #1354

Open
wants to merge 3 commits into
base: docs-prototype
Choose a base branch
from
Open
Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
-
- Implementation of PatchTS model ([#1277](https://github.com/tinkoff-ai/etna/pull/1277))
- Add `quickstart` notebook, add `mechanics_of_forecasting` notebook ([#1343](https://github.com/tinkoff-ai/etna/pull/1343))
- Add gallery of tutorials divided by level ([#1354](https://github.com/tinkoff-ai/etna/pull/1354))

### Changed
-
Expand Down
38 changes: 19 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,25 +177,25 @@ To set up a configuration for your project you should create a `.etna` file at t

We have also prepared a set of tutorials for an easy introduction:

| Notebook | Interactive launch |
|:----------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------:|
| [Get started](https://github.com/tinkoff-ai/etna/tree/master/examples/01-get_started.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/01-get_started.ipynb) |
| [Backtest](https://github.com/tinkoff-ai/etna/tree/master/examples/02-backtest.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/02-backtest.ipynb) |
| [EDA](https://github.com/tinkoff-ai/etna/tree/master/examples/03-EDA.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/03-EDA.ipynb) |
| [Regressors and exogenous data](https://github.com/tinkoff-ai/etna/tree/master/examples/04-exogenous_data.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/04-exogenous_data.ipynb) |
| [Custom model and transform](https://github.com/tinkoff-ai/etna/tree/master/examples/05-custom_transform_and_model.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/05-custom_transform_and_model.ipynb) |
| [Deep learning models](https://github.com/tinkoff-ai/etna/tree/master/examples/06-NN_examples.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/06-NN_examples.ipynb) |
| [Ensembles](https://github.com/tinkoff-ai/etna/tree/master/examples/07-ensembles.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/07-ensembles.ipynb) |
| [Outliers](https://github.com/tinkoff-ai/etna/tree/master/examples/08-outliers.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/08-outliers.ipynb) |
| [Forecasting strategies](https://github.com/tinkoff-ai/etna/tree/master/examples/09-forecasting_strategies.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/09-forecasting_strategies.ipynb) |
| [Forecast interpretation](https://github.com/tinkoff-ai/etna/tree/master/examples/10-forecast_interpretation.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/10-forecast_interpretation.ipynb) |
| [Clustering](https://github.com/tinkoff-ai/etna/tree/master/examples/11-clustering.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/11-clustering.ipynb) |
| [AutoML](https://github.com/tinkoff-ai/etna/tree/master/examples/12-automl.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/12-automl.ipynb) |
| [Inference: using saved pipeline on a new data](https://github.com/tinkoff-ai/etna/tree/master/examples/13-inference.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/13-inference.ipynb) |
| [Hierarchical time series](https://github.com/tinkoff-ai/etna/blob/master/examples/14-hierarchical_pipeline.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/14-hierarchical_pipeline.ipynb) |
| [Classification](https://github.com/tinkoff-ai/etna/blob/master/examples/15-classification.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/15-classification.ipynb) |
| [Feature selection](https://github.com/tinkoff-ai/etna/blob/master/examples/16-feature_selection.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/16-feature_selection.ipynb) |
| [Mechanics of forecasting](https://github.com/tinkoff-ai/etna/blob/master/examples/17-mechanics_of_forecasting.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/17-mechanics_of_forecasting.ipynb) |
| Notebook | Interactive launch |
|:-----------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------:|
| [Get started](https://github.com/tinkoff-ai/etna/tree/master/examples/101-get_started.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/101-get_started.ipynb) |
| [Backtest](https://github.com/tinkoff-ai/etna/tree/master/examples/102-backtest.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/102-backtest.ipynb) |
| [EDA](https://github.com/tinkoff-ai/etna/tree/master/examples/103-EDA.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/103-EDA.ipynb) |
| [Regressors and exogenous data](https://github.com/tinkoff-ai/etna/tree/master/examples/201-exogenous_data.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/201-exogenous_data.ipynb) |
| [Deep learning models](https://github.com/tinkoff-ai/etna/tree/master/examples/202-NN_examples.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/202-NN_examples.ipynb) |
| [Ensembles](https://github.com/tinkoff-ai/etna/tree/master/examples/303-ensembles.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/203-ensembles.ipynb) |
| [Outliers](https://github.com/tinkoff-ai/etna/tree/master/examples/204-outliers.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/204-outliers.ipynb) |
| [AutoML](https://github.com/tinkoff-ai/etna/tree/master/examples/205-automl.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/205-automl.ipynb) |
| [Clustering](https://github.com/tinkoff-ai/etna/tree/master/examples/206-clustering.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/206-clustering.ipynb) |
| [Feature selection](https://github.com/tinkoff-ai/etna/blob/master/examples/207-feature_selection.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/207-feature_selection.ipynb) |
| [Forecasting strategies](https://github.com/tinkoff-ai/etna/tree/master/examples/208-forecasting_strategies.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/208-forecasting_strategies.ipynb) |
| [Mechanics of forecasting](https://github.com/tinkoff-ai/etna/blob/master/examples/209-mechanics_of_forecasting.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/209-mechanics_of_forecasting.ipynb) |
| [Custom model and transform](https://github.com/tinkoff-ai/etna/tree/master/examples/301-custom_transform_and_model.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/301-custom_transform_and_model.ipynb) |
| [Inference: using saved pipeline on a new data](https://github.com/tinkoff-ai/etna/tree/master/examples/302-inference.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/302-inference.ipynb) |
| [Hierarchical time series](https://github.com/tinkoff-ai/etna/blob/master/examples/303-hierarchical_pipeline.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/303-hierarchical_pipeline.ipynb) |
| [Forecast interpretation](https://github.com/tinkoff-ai/etna/tree/master/examples/304-forecast_interpretation.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/304-forecast_interpretation.ipynb) |
| [Classification](https://github.com/tinkoff-ai/etna/blob/master/examples/305-classification.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/305-classification.ipynb) |

## Documentation

Expand Down
12 changes: 12 additions & 0 deletions docs/source/_static/css/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
#tutorials .card-tutorial-basic {
background-color: var(--pst-color-primary);
}

#tutorials .card-tutorial-intermediate {
background-color: var(--pst-color-secondary);
}

#tutorials .card-tutorial-advanced {
background-color: var(--pst-color-target);
}

4 changes: 4 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
extensions = [
"nbsphinx", # integration of notebooks
"myst_parser", # markdown support
"sphinx_design", # for ready styling blocks
"sphinx.ext.napoleon", # support for NumPy and Google style docstrings
"sphinx.ext.autodoc", # include documentation from docstrings
"sphinx.ext.autosummary", # generate autodoc summaries
Expand Down Expand Up @@ -81,6 +82,9 @@
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]
html_css_files = [
"css/custom.css",
]

html_logo = "_static/etna_logo.png"
html_favicon = "_static/etna_favicon.ico"
Expand Down
193 changes: 172 additions & 21 deletions docs/source/tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,175 @@
Tutorials
==========

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

tutorials/01-get_started
tutorials/02-backtest
tutorials/03-EDA
tutorials/04-exogenous_data
tutorials/05-custom_transform_and_model
tutorials/06-NN_examples
tutorials/07-ensembles
tutorials/08-outliers
tutorials/09-forecasting_strategies
tutorials/10-forecast_interpretation
tutorials/11-clustering
tutorials/12-automl
tutorials/13-inference
tutorials/14-hierarchical_pipeline
tutorials/15-classification
tutorials/16-feature_selection
tutorials/17-mechanics_of_forecasting
There are multiple tutorials for different use cases divided by proficiency level.

Basic
-----

.. grid:: 1 2 2 2
:gutter: 2

.. grid-item-card:: Get Started
:text-align: center
:link: tutorials/101-get_started
:link-type: doc
:class-header: card-tutorial-basic

^^^
Get started with the library

.. grid-item-card:: Backtest
:text-align: center
:link: tutorials/102-backtest
:link-type: doc
:class-header: card-tutorial-basic

^^^
How to evaluate a pipeline

.. grid-item-card:: Exploratory data analysis
:text-align: center
:link: tutorials/103-EDA
:link-type: doc
:class-header: card-tutorial-basic

^^^
How to make EDA using the library

Intermediate
------------

.. grid:: 1 2 2 2
:gutter: 2

.. grid-item-card:: Regressors and exogenous data
:text-align: center
:link: tutorials/201-exogenous_data
:link-type: doc
:class-header: card-tutorial-intermediate

^^^
How to use exogenous data in a pipeline

.. grid-item-card:: Deep learning examples
:text-align: center
:link: tutorials/202-NN_examples
:link-type: doc
:class-header: card-tutorial-intermediate

^^^
How to use neural network models

.. grid-item-card:: Ensembles
:text-align: center
:link: tutorials/203-ensembles
:link-type: doc
:class-header: card-tutorial-intermediate

^^^
How to use ensemble pipelines

.. grid-item-card:: Outliers
:text-align: center
:link: tutorials/204-outliers
:link-type: doc
:class-header: card-tutorial-intermediate

^^^
How to handle outliers

.. grid-item-card:: AutoML
:text-align: center
:link: tutorials/205-automl
:link-type: doc
:class-header: card-tutorial-intermediate

^^^
How to work with AutoML utilities

.. grid-item-card:: Clustering
:text-align: center
:link: tutorials/206-clustering
:link-type: doc
:class-header: card-tutorial-intermediate

^^^
How to perform time series clustering

.. grid-item-card:: Feature selection
:text-align: center
:link: tutorials/207-feature_selection
:link-type: doc
:class-header: card-tutorial-intermediate

^^^
How to perform feature selection

.. grid-item-card:: Forecasting strategies
:text-align: center
:link: tutorials/208-forecasting_strategies
:link-type: doc
:class-header: card-tutorial-intermediate

^^^
How to use different forecasting strategies

.. grid-item-card:: Mechanics of forecasting
:text-align: center
:link: tutorials/209-mechanics_of_forecasting
:link-type: doc
:class-header: card-tutorial-intermediate

^^^
How pipelines are making forecasts under the hood

Advanced
--------

.. grid:: 1 2 2 2
:gutter: 2

.. grid-item-card:: Custom model and transform
:text-align: center
:link: tutorials/301-custom_transform_and_model
:link-type: doc
:class-header: card-tutorial-advanced

^^^
How to define your own model and transform

.. grid-item-card:: Inference
:text-align: center
:link: tutorials/302-inference
:link-type: doc
:class-header: card-tutorial-advanced

^^^
How to save pipeline and use it later on new data

.. grid-item-card:: Hierarchical time series
:text-align: center
:link: tutorials/303-hierarchical_pipeline
:link-type: doc
:class-header: card-tutorial-advanced

^^^
How to work with hierarchical time series

.. grid-item-card:: Forecasting interpretation
:text-align: center
:link: tutorials/304-forecasting_interpretation
:link-type: doc
:class-header: card-tutorial-advanced

^^^
How to perform forecast decomposition for interpretation

.. grid-item-card:: Classification
:text-align: center
:link: tutorials/305-classification
:link-type: doc
:class-header: card-tutorial-advanced

^^^
How to perform time series classification
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"source": [
"# Get started\n",
"\n",
"[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/01-get_started.ipynb)"
"[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/101-get_started.ipynb)"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion examples/02-backtest.ipynb → examples/102-backtest.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"source": [
"# Backtest: validation on historical data\n",
"\n",
"[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/02-backtest.ipynb)"
"[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/102-backtest.ipynb)"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion examples/03-EDA.ipynb → examples/103-EDA.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"source": [
"# EDA\n",
"\n",
"[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/03-EDA.ipynb)"
"[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/103-EDA.ipynb)"
]
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"source": [
"# Regressors and exogenous data\n",
"\n",
"[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/04-exogenous_data.ipynb)"
"[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/201-exogenous_data.ipynb)"
]
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"source": [
"# Deep learning examples\n",
"\n",
"[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/06-NN_examples.ipynb)"
"[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/202-NN_examples.ipynb)"
]
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"source": [
"# Ensembles\n",
"\n",
"[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/07-ensembles.ipynb)"
"[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/203-ensembles.ipynb)"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion examples/08-outliers.ipynb → examples/204-outliers.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"source": [
"# Outliers\n",
"\n",
"[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/08-outliers.ipynb)"
"[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tinkoff-ai/etna/master?filepath=examples/204-outliers.ipynb)"
]
},
{
Expand Down
Loading
Loading