Skip to content

Add known_future to cli docs #823

Merged
merged 4 commits into from
Jul 29, 2022
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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 @@ -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))
-
-
-
Expand Down
6 changes: 4 additions & 2 deletions docs/source/commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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?**

Expand Down Expand Up @@ -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.

Expand All @@ -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?**
Expand Down