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 **kwargs argument description for models #454

Merged
merged 20 commits into from
Aug 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 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
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 `**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))
-
-
-
Expand Down
4 changes: 4 additions & 0 deletions etna/models/catboost.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
8 changes: 8 additions & 0 deletions etna/models/linear.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Loading