Add etna.datasets.load_dataset to public API
#484
+13
−4
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1) Wrap step param into double `` in the AutoRegressivePipeline docs. 2) Fix problem with linting. 3) Add a link to the pull request in the CHANGELOG.md
1) Add space between "Autocorrelation function" and (ACF, pho(t)) and the same for PACF. 2) Add a link to the pull request in the CHANGELOG.md
* Fix links in 'See Also' references in `Pipeline` docs * Fix links in 'See Also' references in `AutoRegressivePipeline` docs * Fix links in 'See Also' references in `DirectEnsemble` docs
* Add external links to `CatBoostRegressor` in `CatBoostMultiSegmentModel` and `CatBoostPerSegment` docs. * Add external links to `LinearRegression` in `LinearMultiSegmentModel` and `LinearPerSegmentModel` docs. * Add external links to `ElasticNet` in `ElasticMultiSegmentModel` and `ElasticPerSegmentModel` docs.
* Make in "User Guide" page link to `load_dataset` * Make in `load_dataset` reference to "User Guide" * Add `load_dataset` to datasets.rst * Add in `load_dataset` docs default value description of `download_path`
* Add link to 484 pull request * Remove link to changes of previous release
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #484 +/- ##
==========================================
- Coverage 90.60% 89.35% -1.26%
==========================================
Files 247 247
Lines 16481 16481
==========================================
- Hits 14933 14726 -207
- Misses 1548 1755 +207 ☔ View full report in Codecov by Sentry. |
d-a-bunin
requested changes
Oct 2, 2024
etna/datasets/internal_datasets.py
Outdated
| @@ -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. | |||
There was a problem hiding this comment.
I think we should add this explanation in the extended summary. Also, the link isn't correct:
Load internal dataset.
Full list of available datasets you can see on :ref:`internal datasets page <internal_datasets>`.
docs/source/internal_datasets.rst
Outdated
| @@ -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 References. | |||
There was a problem hiding this comment.
May be it is better to write "API reference" instead of "API References".
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Before submitting (must do checklist)
Proposed Changes
load_datasetreference to "User guide" page for users to see the list of all available datasets.load_datasetto datasets.rst file.load_datasetClosing issues
Closes #465