Merge branch 'master' into issue-452

etna-team · Aug 27, 2024 · 754a27d · 754a27d
2 parents d91f99d + e5cc8d6
commit 754a27d
Show file tree

Hide file tree

Showing 6 changed files with 90 additions and 19 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -77,7 +77,9 @@ jobs:
           poetry run pytest etna -v --doctest-modules --ignore=etna/libs --durations=10
 
       - name: Upload coverage
-        uses: codecov/codecov-action@v2
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
 
   test-pandas-versions:
     runs-on: ubuntu-latest
@@ -116,6 +118,3 @@ jobs:
           poetry run pytest tests/test_datasets -v --cov=etna --cov-report=xml --durations=10
           poetry run pytest tests/test_transforms -v --cov=etna --cov-report=xml --durations=10
           poetry run pytest tests/test_models/test_utils.py -v --cov=etna --cov-report=xml --durations=10
-
-      - name: Upload coverage
-        uses: codecov/codecov-action@v2
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,73 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 ### Added
+- Add `**kwargs` argument description for models based on `LinearRegression`, `ElasticNet` and `CatBoostRegressor` ([#454](https://github.com/etna-team/etna/pull/454https://github.com/etna-team/etna/pull/454))  
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+
+### Changed
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+
+### Fixed
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+- 
+-
+
+## [2.8.0] - 2024-08-13
+### Added
 - Add `get_anomalies_iqr` function for anomaly detection ([#374](https://github.com/etna-team/etna/pull/374))
 - Add `get_anomalies_isolation_forest` method for anomaly detection ([#375](https://github.com/etna-team/etna/pull/375))
 - Add `IForestOutlierTransform` ([#381](https://github.com/etna-team/etna/pull/381))
@@ -18,35 +85,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add `MeanEncoderTransform` ([#413](https://github.com/etna-team/etna/pull/413))
 - Add `FourierDecomposeTransform` transform for series decomposition using DFT ([#430](https://github.com/etna-team/etna/pull/430))
 - Add `ModelDecomposeTransform` transform for series decomposition using ETNA models ([#427](https://github.com/etna-team/etna/pull/427))
--
 
 ### Changed
 - Allow to change `device`, `batch_size` and `num_workers` of embedding models ([#396](https://github.com/etna-team/etna/pull/396))
-- 
-- 
-- 
--
 - Update pipelines documentation ([#408](https://github.com/etna-team/etna/pull/408))
 - Update formulas for metrics in documentation ([#406](https://github.com/etna-team/etna/pull/406))
-- 
 - Update documentation to explain how to contribute and work with discussions, update templates for issues ([#395](https://github.com/etna-team/etna/pull/395))
 - Remove "Other issue" template, update links to discussions in issue creation menu ([#401](https://github.com/etna-team/etna/pull/401))
-- 
 
 ### Fixed
 - Fix rendering in 210 tutorial ([#386](https://github.com/etna-team/etna/pull/386))
 - Fix typo in 103 tutorial ([#408](https://github.com/etna-team/etna/pull/408))
 - Remove sorting of `ts.df` by timestamps in `plot_forecast` and `plot_forecast_decomposition` ([#410](https://github.com/etna-team/etna/pull/410))
 - Fix forecast visualization with `horizon=1` ([#426](https://github.com/etna-team/etna/pull/426))
 - Set upper bound `<2` on numpy version ([#431](https://github.com/etna-team/etna/pull/431))
-- 
 - Fix `VotingEnsemble`, `StackingEnsemble`, `DirectEnsemble` have a valid `params_to_tune` that returns empty dict ([#432](https://github.com/etna-team/etna/pull/432))
 - Fix passing custom model to `STLTransform` ([#412](https://github.com/etna-team/etna/pull/412))
-- 
 - Update `TSDataset.describe`, `TSDataset.info` to exclude target intervals and target components in `num_exogs` ([#405](https://github.com/etna-team/etna/pull/405))
-- 
-- 
-- 
 
 ## [2.7.1] - 2024-06-05
 ### Fixed

diff --git a/docs/source/_static/switcher.json b/docs/source/_static/switcher.json
@@ -5,10 +5,15 @@
         "url": "https://docs.etna.ai/latest/"
     },
     {
-        "name": "2.7.1 (stable)",
-        "version": "2.7.1",
+        "name": "2.8.0 (stable)",
+        "version": "2.8.0",
         "url": "https://docs.etna.ai/stable/"
     },
+    {
+        "name": "2.7.1",
+        "version": "2.7.1",
+        "url": "https://docs.etna.ai/2.7.1/"
+    },
     {
         "name": "2.7.0",
         "version": "2.7.0",

diff --git a/etna/models/catboost.py b/etna/models/catboost.py
@@ -283,6 +283,8 @@ def __init__(
             * For GPU. The given value is used for reading the data from the hard drive and does
               not affect the training.
               During the training one main thread and one thread for each GPU are used.
+        **kwargs:
+            Additional parameters passed to :py:class:`catboost.CatBoostRegressor` model.
         """
         self.iterations = iterations
         self.depth = depth
@@ -422,6 +424,8 @@ def __init__(
             * For GPU. The given value is used for reading the data from the hard drive and does
               not affect the training.
               During the training one main thread and one thread for each GPU are used.
+        **kwargs:
+            Additional parameters passed to :py:class:`catboost.CatBoostRegressor` model.
         """
         self.iterations = iterations
         self.depth = depth

diff --git a/etna/models/linear.py b/etna/models/linear.py
@@ -72,6 +72,8 @@ def __init__(self, fit_intercept: bool = True, **kwargs):
         fit_intercept:
             Whether to calculate the intercept for this model. If set to False, no intercept will be used in
             calculations (i.e. data is expected to be centered).
+        **kwargs:
+            Additional parameters passed to :py:class:`sklearn.linear_model.LinearRegression` model.
         """
         self.fit_intercept = fit_intercept
         self.kwargs = kwargs
@@ -126,6 +128,8 @@ def __init__(self, alpha: float = 1.0, l1_ratio: float = 0.5, fit_intercept: boo
         fit_intercept:
             Whether to calculate the intercept for this model. If set to False, no intercept will be used in
             calculations (i.e. data is expected to be centered).
+        **kwargs:
+            Additional parameters passed to :py:class:`sklearn.linear_model.ElasticNet` model.
         """
         self.alpha = alpha
         self.l1_ratio = l1_ratio
@@ -175,6 +179,8 @@ def __init__(self, fit_intercept: bool = True, **kwargs):
         fit_intercept:
             Whether to calculate the intercept for this model. If set to False, no intercept will be used in
             calculations (i.e. data is expected to be centered).
+        **kwargs:
+            Additional parameters passed to :py:class:`sklearn.linear_model.LinearRegression` model.
         """
         self.fit_intercept = fit_intercept
         self.kwargs = kwargs
@@ -229,6 +235,8 @@ def __init__(self, alpha: float = 1.0, l1_ratio: float = 0.5, fit_intercept: boo
         fit_intercept:
             Whether to calculate the intercept for this model. If set to False, no intercept will be used in
             calculations (i.e. data is expected to be centered).
+        **kwargs:
+            Additional parameters passed to :py:class:`sklearn.linear_model.ElasticNet` model.
         """
         self.alpha = alpha
         self.l1_ratio = l1_ratio

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "etna"
-version = "2.7.1"
+version = "2.8.0"
 repository = "https://github.com/etna-team/etna"
 readme = "README.md"
 description = "ETNA is the first python open source framework of T-Bank AI Center. It is designed to make working with time series simple, productive, and fun."