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

Add etna.datasets.load_dataset to public API #484

Merged
merged 24 commits into from
Oct 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
99d12ce
Fix a typo in examples for set_params method
ArtemLiA Jun 21, 2024
32f526a
Update pipelines docs (#372)
ArtemLiA Jun 22, 2024
648cd3b
Fix typo in EDA tutorial (#271)
ArtemLiA Jun 22, 2024
5910b9e
Update pipelines documentation (#372)
ArtemLiA Jun 27, 2024
ff14d8c
Fix typo in EDA tutorial (#271)
ArtemLiA Jun 27, 2024
37474e6
Merge branch 'master' into master
ArtemLiA Jun 29, 2024
78140c5
Add valid links in `Pipeline`, `AutoRegressivePipeline`, `DirectEnsem…
ArtemLiA Jul 1, 2024
beaf8a8
Fix typos with links in pipelines and ensemble docs
ArtemLiA Jul 1, 2024
f8222fe
Merge branch 'etna-team:master' into master
ArtemLiA Jul 2, 2024
d9422f5
Merge branch 'etna-team:master' into master
ArtemLiA Jul 31, 2024
d0216bb
Merge branch 'etna-team:master' into master
ArtemLiA Aug 6, 2024
a899fd7
Merge branch 'etna-team:master' into master
ArtemLiA Aug 13, 2024
d7bccc9
Add `kwargs` parameter description for `CatBoostPerSegmentModel`
ArtemLiA Aug 13, 2024
4b291bb
Add `kwargs` parameter description for `CatBoostMultiSegmentModel`
ArtemLiA Aug 13, 2024
935694f
Add `kwargs` argument description for `ElasticPerSegmentModel`
ArtemLiA Aug 13, 2024
b57427f
Add `kwargs` argument description for `ElasticMultiSegmentModel`
ArtemLiA Aug 13, 2024
11dc1bc
Add `kwargs` argument description for `LinearPerSegmentModel`
ArtemLiA Aug 13, 2024
2b04d8d
Add `kwargs` argument description for `LinearMultiSegmentModel`
ArtemLiA Aug 13, 2024
3da6646
Update CHANGELOG.md
ArtemLiA Aug 13, 2024
de42274
Add external links to models
ArtemLiA Aug 23, 2024
3357f27
Merge branch 'etna-team:master' into master
ArtemLiA Oct 1, 2024
5bed928
Add `etna.datasets.load_dataset` to public API
ArtemLiA Oct 1, 2024
0634c48
Update CHANGELOG.md
ArtemLiA Oct 1, 2024
87363cd
Fix minor typos
ArtemLiA Oct 2, 2024
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
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## Unreleased
### Added
-
- Add `load_dataset` to public API ([#484](https://github.com/etna-team/etna/pull/484))
-
-
-
Expand Down
8 changes: 8 additions & 0 deletions docs/source/api_reference/datasets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,11 @@ Utilities for data manipulation:
infer_alignment
apply_alignment
make_timestamp_df_from_alignment

Utilities for working with internal datasets:

.. autosummary::
:toctree: api/
:template: base.rst

load_dataset
3 changes: 2 additions & 1 deletion docs/source/internal_datasets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ models. To load them you choose dataset name and use the following code:

The first time, it will take some time to download and save the dataset locally, the next times the data will be read from a file.
In the example above, we load ``tourism`` dataset with monthly frequency. We also use ``parts="full"``, which means that we load
the full dataset (each dataset has predefined parts to load).
the full dataset (each dataset has predefined parts to load). For more details you can check
:py:func:`etna.datasets.load_dataset` API reference.

List of internal datasets
-------------------------
Expand Down
4 changes: 2 additions & 2 deletions etna/datasets/internal_datasets.py
Original file line number Diff line number Diff line change
Expand Up @@ -108,14 +108,14 @@ def load_dataset(
parts: Union[str, Tuple[str, ...]] = "full",
) -> Union[TSDataset, List[TSDataset]]:
"""
Load internal dataset.
Load internal dataset. Full list of available datasets you can see on :ref:`internal datasets page <internal_datasets>`.

Parameters
----------
name:
Name of the dataset.
download_path:
The path for saving dataset locally.
The path for saving dataset locally. By default it is directory "~/.etna/internal_datasets".
rebuild_dataset:
Whether to rebuild the dataset from the original source. If ``rebuild_dataset=False`` and the dataset was saved
locally, then it would be loaded from disk. If ``rebuild_dataset=True``, then the dataset will be downloaded and
Expand Down
Loading