From c6f2877d6b1c7ef175757044a3f5b03cdd71b2d1 Mon Sep 17 00:00:00 2001 From: Julia Shenshina Date: Thu, 28 Jul 2022 17:11:47 +0300 Subject: [PATCH 1/3] Add known_future to cli docs --- docs/source/commands.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/source/commands.rst b/docs/source/commands.rst index 321b45480..d1185c035 100644 --- a/docs/source/commands.rst +++ b/docs/source/commands.rst @@ -7,7 +7,7 @@ Basic ``forecast`` usage: .. code-block:: console Usage: etna forecast [OPTIONS] CONFIG_PATH TARGET_PATH FREQ OUTPUT_PATH [EXOG_PATH] - [FORECAST_CONFIG_PATH] [RAW_OUTPUT] + [FORECAST_CONFIG_PATH] [RAW_OUTPUT] [KNOWN_FUTURE] Command to make forecast with etna without coding. @@ -19,6 +19,7 @@ Basic ``forecast`` usage: [EXOG_PATH] path to csv with exog data [FORECAST_CONFIG_PATH] path to yaml config with forecast params [RAW_OUTPUT] by default we return only forecast without features [default: False] + [KNOWN_FUTURE] list of all known_future columns (regressor columns); If not specified then all exog_columns considered known_future [default: None] **How to create config?** @@ -81,7 +82,7 @@ Basic ``backtest`` usage: .. code-block:: console - Usage: etna backtest [OPTIONS] CONFIG_PATH BACKTEST_CONFIG_PATH TARGET_PATH FREQ OUTPUT_PATH [EXOG_PATH] + Usage: etna backtest [OPTIONS] CONFIG_PATH BACKTEST_CONFIG_PATH TARGET_PATH FREQ OUTPUT_PATH [EXOG_PATH] [KNOWN_FUTURE] Command to run backtest with etna without coding. @@ -92,6 +93,7 @@ Basic ``backtest`` usage: FREQ frequency of timestamp in files in pandas format [required] OUTPUT_PATH where to save forecast [required] [EXOG_PATH] path to csv with exog data + [KNOWN_FUTURE] list of all known_future columns (regressor columns); If not specified then all exog_columns considered known_future [default: None] **How to create configs?** From 6b10a01c78bd6faaa17f84b68bf0b178609610c2 Mon Sep 17 00:00:00 2001 From: Julia Shenshina Date: Fri, 29 Jul 2022 09:03:51 +0300 Subject: [PATCH 2/3] Fix punctuation --- docs/source/commands.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/commands.rst b/docs/source/commands.rst index d1185c035..1b7d229a0 100644 --- a/docs/source/commands.rst +++ b/docs/source/commands.rst @@ -19,7 +19,7 @@ Basic ``forecast`` usage: [EXOG_PATH] path to csv with exog data [FORECAST_CONFIG_PATH] path to yaml config with forecast params [RAW_OUTPUT] by default we return only forecast without features [default: False] - [KNOWN_FUTURE] list of all known_future columns (regressor columns); If not specified then all exog_columns considered known_future [default: None] + [KNOWN_FUTURE] list of all known_future columns (regressor columns). If not specified then all exog_columns considered known_future [default: None] **How to create config?** @@ -93,7 +93,7 @@ Basic ``backtest`` usage: FREQ frequency of timestamp in files in pandas format [required] OUTPUT_PATH where to save forecast [required] [EXOG_PATH] path to csv with exog data - [KNOWN_FUTURE] list of all known_future columns (regressor columns); If not specified then all exog_columns considered known_future [default: None] + [KNOWN_FUTURE] list of all known_future columns (regressor columns). If not specified then all exog_columns considered known_future [default: None] **How to create configs?** From c547c3f84b0562b17f1ec2deb5243d583c2d3e3d Mon Sep 17 00:00:00 2001 From: Martin Gabdushev <33594071+martins0n@users.noreply.github.com> Date: Fri, 29 Jul 2022 06:59:30 +0000 Subject: [PATCH 3/3] FIX:changelog --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8b5523630..ddbcd2510 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -41,7 +41,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - - - -- +- Add known_future to cli docs ([#823](https://github.com/tinkoff-ai/etna/pull/823)) - - -