Forecast `start_timestamp` for CLI command #1265

brsnw250 · 2023-05-18T09:36:35Z

Before submitting (must do checklist)

Did you read the contribution guide?
Did you update the docs? We use Numpy format for all the methods and classes.
Did you write any new necessary tests?
Did you update the CHANGELOG?

Proposed Changes

Closing issues

closes #1247

github-actions · 2023-05-18T09:40:40Z

🚀 Deployed on https://deploy-preview-1265--etna-docs.netlify.app

codecov-commenter · 2023-05-18T09:56:29Z

Codecov Report

Merging #1265 (b0e5c83) into master (372ee0f) will increase coverage by 0.24%.
The diff coverage is 100.00%.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

@@            Coverage Diff             @@
##           master    #1265      +/-   ##
==========================================
+ Coverage   87.78%   88.02%   +0.24%     
==========================================
  Files         175      186      +11     
  Lines       10439    10774     +335     
==========================================
+ Hits         9164     9484     +320     
- Misses       1275     1290      +15

Impacted Files	Coverage Δ
etna/commands/forecast_command.py	`96.82% <100.00%> (+1.95%)`	⬆️

... and 16 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Mr-Geekman · 2023-05-22T08:05:53Z

CHANGELOG.md

@@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Notebook `forecast_interpretation.ipynb` with forecast decomposition ([#1220](https://github.com/tinkoff-ai/etna/pull/1220))
 - Exogenous variables shift transform `ExogShiftTransform`([#1254](https://github.com/tinkoff-ai/etna/pull/1254))
-
+- `start_timestamp` parameter to forecast CLI command ([#1265](https://github.com/tinkoff-ai/etna/pull/1265))


I would prefer to put the word parameter at the beginning.

docs/source/commands.rst

Mr-Geekman · 2023-05-22T08:09:31Z

docs/source/commands.rst

+
+* :code:`prediction_interval` - whether to estimate prediction interval for forecast.
+* :code:`quantiles` - levels of prediction distribution. By default 2.5% and 97.5% are taken to form a 95% prediction interval.
+* :code:`n_folds` - number of folds to use in the backtest for prediction interval estimation.


May be we should give here a link to the class where this parameters are explained in documentation.

Mr-Geekman · 2023-05-22T08:11:56Z

etna/commands/forecast_command.py

+    horizon = compute_horizon(horizon=horizon, forecast_params=forecast_params, tsdataset=tsdataset)
+    pipeline_configs["horizon"] = horizon  # type: ignore
+
+    forecast_args = drop_additional_forecast_params(forecast_params)


It a difficult to understand naming. May be it is better to name it forecast_call_params or forecast_method_params.

Sorry, I meant variable forecast_args, not method name.

Probably new name for method is also good, but it should be named get_forecast_call_params. Replace forecast_args with forecast_call_params. And update the name of the tests accordingly.

Mr-Geekman · 2023-05-22T08:21:11Z

tests/test_commands/test_forecast.py

@@ -100,3 +106,112 @@ def test_forecast_use_exog_correct(
    pd.testing.assert_series_equal(
        df_output["target"], pd.Series(data=[3.0, 3.0, 3.0], name="target"), check_less_precise=1
    )
+
+
+@pytest.fixture()


We usually don't add () on fixtures.

Mr-Geekman · 2023-05-22T08:22:36Z

tests/test_commands/test_forecast.py

+
+
+@pytest.mark.parametrize("forecast_params", ({"start_timestamp": "2020-04-09"}, {"start_timestamp": "2019-04-10"}))
+def test_update_horizon_error(example_tsds, forecast_params, pipeline_dummy_config):


test_update_horizon_error -> test_compute_horizon_error?

Mr-Geekman · 2023-05-22T08:22:49Z

tests/test_commands/test_forecast.py

+        ({"start_timestamp": "2023-06-01"}, "ms_tsds", 4),
+    ),
+)
+def test_update_horizon(forecast_params, tsdataset_name, expected, request, pipeline_dummy_config):


test_update_horizon -> test_compute_horizon?

Mr-Geekman · 2023-05-23T09:08:15Z

CHANGELOG.md

@@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Notebook `forecast_interpretation.ipynb` with forecast decomposition ([#1220](https://github.com/tinkoff-ai/etna/pull/1220))
 - Exogenous variables shift transform `ExogShiftTransform`([#1254](https://github.com/tinkoff-ai/etna/pull/1254))
-
+- Parameter `start_timestamp` parameter to forecast CLI command ([#1265](https://github.com/tinkoff-ai/etna/pull/1265))


Probably, the second word "parameter" should be removed.

Mr-Geekman · 2023-05-23T09:10:53Z

etna/commands/forecast_command.py

+    horizon = compute_horizon(horizon=horizon, forecast_params=forecast_params, tsdataset=tsdataset)
+    pipeline_configs["horizon"] = horizon  # type: ignore
+
+    forecast_args = drop_additional_forecast_params(forecast_params)


Sorry, I meant variable forecast_args, not method name.

Mr-Geekman

Little changes to do.

Mr-Geekman · 2023-05-23T09:30:09Z

tests/test_commands/test_forecast.py

+        ),
+    ),
+)
+def test_drop_additional_forecast_params(params, expected):


test_get_forecast_call_params.

brsnw250 added 4 commits May 18, 2023 12:34

added start_timestamp to forecast CLI

a8fd5d4

added tests

dcf8999

updated documentation

09bb721

updated changelog

7908d6b

github-actions bot temporarily deployed to pull request May 18, 2023 09:55 Inactive

Mr-Geekman self-requested a review May 22, 2023 07:38

Mr-Geekman suggested changes May 22, 2023

View reviewed changes

brsnw250 added 2 commits May 23, 2023 11:57

updated doc

49b5a3e

review fixes

63e8ebe

brsnw250 requested a review from Mr-Geekman May 23, 2023 09:00

github-actions bot temporarily deployed to pull request May 23, 2023 09:03 Inactive

Mr-Geekman reviewed May 23, 2023

View reviewed changes

Mr-Geekman suggested changes May 23, 2023

View reviewed changes

renamed method

4502991

brsnw250 requested a review from Mr-Geekman May 23, 2023 09:21

github-actions bot temporarily deployed to pull request May 23, 2023 09:25 Inactive

Mr-Geekman reviewed May 23, 2023

View reviewed changes

fixed test name

59695bd

Mr-Geekman approved these changes May 23, 2023

View reviewed changes

github-actions bot temporarily deployed to pull request May 23, 2023 09:45 Inactive

Merge branch 'master' into issue-1247

1c506c8

brsnw250 enabled auto-merge (squash) May 23, 2023 11:31

github-actions bot temporarily deployed to pull request May 23, 2023 11:35 Inactive

Merge branch 'master' into issue-1247

b0e5c83

github-actions bot temporarily deployed to pull request May 23, 2023 12:21 Inactive

brsnw250 merged commit 0e6d87a into master May 23, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Forecast `start_timestamp` for CLI command #1265

Forecast `start_timestamp` for CLI command #1265

brsnw250 commented May 18, 2023 •

edited

Loading

github-actions bot commented May 18, 2023 •

edited

Loading

codecov-commenter commented May 18, 2023 •

edited

Loading

Mr-Geekman May 22, 2023

Mr-Geekman May 22, 2023

Mr-Geekman May 22, 2023

Mr-Geekman May 23, 2023

brsnw250 May 23, 2023

Mr-Geekman May 23, 2023

Mr-Geekman May 22, 2023

Mr-Geekman May 22, 2023

Mr-Geekman May 22, 2023

Mr-Geekman May 23, 2023

Mr-Geekman May 23, 2023

Mr-Geekman left a comment

Mr-Geekman May 23, 2023



		@pytest.mark.parametrize("forecast_params", ({"start_timestamp": "2020-04-09"}, {"start_timestamp": "2019-04-10"}))
		def test_update_horizon_error(example_tsds, forecast_params, pipeline_dummy_config):

Forecast start_timestamp for CLI command #1265

Forecast start_timestamp for CLI command #1265

Conversation

brsnw250 commented May 18, 2023 • edited Loading

Before submitting (must do checklist)

Proposed Changes

Closing issues

github-actions bot commented May 18, 2023 • edited Loading

codecov-commenter commented May 18, 2023 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Mr-Geekman left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Forecast `start_timestamp` for CLI command #1265

Forecast `start_timestamp` for CLI command #1265

brsnw250 commented May 18, 2023 •

edited

Loading

github-actions bot commented May 18, 2023 •

edited

Loading

codecov-commenter commented May 18, 2023 •

edited

Loading