Skip to content

Create documentation page with links to external resources #1350

Open
wants to merge 5 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))
- Create documentation page with links to external resources ([#1350](https://github.com/tinkoff-ai/etna/pull/1350))

### Changed
-
Expand Down
26 changes: 14 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,32 +208,34 @@ To ask the questions or discuss the library you can join our [telegram chat](htt

## Resources

- [Forecasting with ETNA: Fast and Furious](https://medium.com/its-tinkoff/forecasting-with-etna-fast-and-furious-1b58e1453809) on Medium
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the logic behind such ordering?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried to order this entries by chronological order.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think about this section in README? Should we keep it?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that the importance and usefulness is better for ordering. As a rule people click only first links

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you have any particular order in mind? I don't really know how to order them by importance. We could order them by groups. First there are medium pages in chronological order. Then kaggle pages in chronological order, in the end everything else.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should add resources with 2.0 api on top at least, I think.

- [Forecasting using ETNA library | 60 lines Catboost](https://www.kaggle.com/code/goolmonika/forecasting-using-etna-library-60-lines-catboost) on Kaggle

- [ETNA Regressors](https://medium.com/its-tinkoff/etna-regressors-d2722923e88e) on Medium
- [Прикладные задачи анализа данных, лекция 8 — Временные ряды 2](https://youtu.be/1gXVbidDZck) on YouTube

- [Time series forecasting with ETNA: first steps](https://medium.com/its-tinkoff/time-series-forecasting-with-etna-first-steps-dfaf90c5b919) on Medium
- [Time Series Forecasting Strategies in ETNA](https://medium.com/its-tinkoff/time-series-forecasting-strategies-in-etna-93d7d2f8a911) on Medium

- [ETNA: Time Series Analysis. What, why and how?](https://medium.com/its-tinkoff/etna-time-series-analysis-what-why-and-how-e45557af4f6c) on Medium

- [Time Series Forecasting Strategies in ETNA](https://medium.com/its-tinkoff/time-series-forecasting-strategies-in-etna-93d7d2f8a911) on Medium
- [ETNA Meetup Jun 2022](https://www.youtube.com/watch?v=N1Xy3EqY058&list=PLLrf_044z4JrSsjMd-3dF6VbBLPI_yOxG) on YouTube

- [Tabular Playground Series - Mar 2022 (7th place!)](https://www.kaggle.com/code/chikovalexander/tps-mar-2022-etna/notebook?scriptVersionId=91575908) on Kaggle
- [DUMP May 2022 talk](https://youtu.be/12uuxepdtks) on YouTube

- [Store sales prediction with etna library](https://www.kaggle.com/dmitrybunin/store-sales-prediction-with-etna-library?scriptVersionId=81104235) on Kaggle
- [ETNA Regressors](https://medium.com/its-tinkoff/etna-regressors-d2722923e88e) on Medium

- [Tabular Playground Series - Jan 2022](https://www.kaggle.com/code/chikovalexander/tps-jan-2022-etna/notebook) on Kaggle
- [Time series forecasting with ETNA: first steps](https://medium.com/its-tinkoff/time-series-forecasting-with-etna-first-steps-dfaf90c5b919) on Medium

- [EDA notebook for Ubiquant Market Prediction](https://www.kaggle.com/code/martins0n/ubiquant-eda-toy-predictions-etna) on Kaggle

- [PyCon Russia September 2021 talk](https://youtu.be/VxWHLEFgXnE) on YouTube
- [Tabular Playground Series - Mar 2022 (7th place!)](https://www.kaggle.com/code/chikovalexander/tps-mar-2022-etna/notebook?scriptVersionId=91575908) on Kaggle

- [ETNA Meetup Jun 2022](https://www.youtube.com/watch?v=N1Xy3EqY058&list=PLLrf_044z4JrSsjMd-3dF6VbBLPI_yOxG) on YouTube
- [Tabular Playground Series - Jan 2022](https://www.kaggle.com/code/chikovalexander/tps-jan-2022-etna/notebook) on Kaggle

- [DUMP May 2022 talk](https://youtu.be/12uuxepdtks) on YouTube
- [Forecasting with ETNA: Fast and Furious](https://medium.com/its-tinkoff/forecasting-with-etna-fast-and-furious-1b58e1453809) on Medium

- [Store sales prediction with etna library](https://www.kaggle.com/dmitrybunin/store-sales-prediction-with-etna-library?scriptVersionId=81104235) on Kaggle

- [PyCon Russia September 2021 talk](https://youtu.be/VxWHLEFgXnE) on YouTube

- [Прикладные задачи анализа данных, лекция 8 — Временные ряды 2](https://youtu.be/1gXVbidDZck) on YouTube

## Acknowledgments

### ETNA.Team
Expand Down
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Contents
:maxdepth: 1
:titlesonly:

user_guide
installation
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add external resources here?

At the moment it's not easy to find external resources page

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think that this page is that necessary to be in the header.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How should user find this page?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

He opens "User Guide" section and it will be a page inside this section.

tutorials/quickstart
tutorials
Expand Down
50 changes: 50 additions & 0 deletions docs/source/resources.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
.. _resources:

External resources
==================

There are several external resources related to the library that are available in different languages.

English language
----------------

- `Forecasting using ETNA library | 60 lines Catboost <https://www.kaggle.com/code/goolmonika/forecasting-using-etna-library-60-lines-catboost>`_ on Kaggle

- `Time Series Forecasting Strategies in ETNA <https://medium.com/its-tinkoff/time-series-forecasting-strategies-in-etna-93d7d2f8a911>`_ on Medium

- `ETNA: Time Series Analysis. What, why and how? <https://medium.com/its-tinkoff/etna-time-series-analysis-what-why-and-how-e45557af4f6c>`_ on Medium

- `ETNA Regressors <https://medium.com/its-tinkoff/etna-regressors-d2722923e88e>`_ on Medium

- `Time series forecasting with ETNA: first steps <https://medium.com/its-tinkoff/time-series-forecasting-with-etna-first-steps-dfaf90c5b919>`_ on Medium

- `EDA notebook for Ubiquant Market Prediction <https://www.kaggle.com/code/martins0n/ubiquant-eda-toy-predictions-etna>`_ on Kaggle

- `Tabular Playground Series - Mar 2022 (7th place!) <https://www.kaggle.com/code/chikovalexander/tps-mar-2022-etna/notebook?scriptVersionId=91575908>`_ on Kaggle

- `Tabular Playground Series - Jan 2022 <https://www.kaggle.com/code/chikovalexander/tps-jan-2022-etna/notebook>`_ on Kaggle

- `Forecasting with ETNA: Fast and Furious <https://medium.com/its-tinkoff/forecasting-with-etna-fast-and-furious-1b58e1453809>`_ on Medium

- `Store sales prediction with etna library <https://www.kaggle.com/dmitrybunin/store-sales-prediction-with-etna-library?scriptVersionId=81104235>`_ on Kaggle

Russian language
----------------

- `Прикладные задачи анализа данных, лекция 8 — Временные ряды 2 <https://youtu.be/1gXVbidDZck>`_ on YouTube

- `Стратегии прогнозирования временных рядов в ETNA <https://habr.com/ru/companies/tinkoff/articles/716692/>`_ on Habr

- `Инструменты анализа временных рядов в ETNA <https://habr.com/ru/companies/tinkoff/articles/677186/>`_ on Habr

- `ETNA Meetup Jun 2022 <https://www.youtube.com/watch?v=N1Xy3EqY058&list=PLLrf_044z4JrSsjMd-3dF6VbBLPI_yOxG>`_ on YouTube

- `DUMP May 2022 talk <https://youtu.be/12uuxepdtks>`_ on YouTube

- `Дополнительные временные ряды в ETNA <https://habr.com/ru/companies/tinkoff/articles/665564/>`_ on Habr

- `Как прогнозировать временные ряды с ETNA <https://habr.com/ru/companies/tinkoff/articles/657297/>`_ on Habr

- `Знакомьтесь: ETNA <https://habr.com/ru/companies/tinkoff/articles/598823/>`_ on Habr

- `PyCon Russia September 2021 talk <https://youtu.be/VxWHLEFgXnE>`_ on YouTube
15 changes: 15 additions & 0 deletions docs/source/user_guide.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
.. _user_guide:

User Guide
============

Contents
--------

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

installation
tutorials
resources
Loading