From 0c9d862a49e698897443e25aa37dfed9807543aa Mon Sep 17 00:00:00 2001 From: kryofly Date: Sun, 7 Jan 2018 10:15:26 +0100 Subject: [PATCH] docs: --datadir documentation --- docs/backtesting.md | 7 ++++++- docs/bot-usage.md | 5 ++++- docs/hyperopt.md | 5 +++++ 3 files changed, 15 insertions(+), 2 deletions(-) diff --git a/docs/backtesting.md b/docs/backtesting.md index d7073365f..c426e2b5c 100644 --- a/docs/backtesting.md +++ b/docs/backtesting.md @@ -46,6 +46,11 @@ python3 ./freqtrade/main.py backtesting --realistic-simulation --refresh-pairs-c python3 ./freqtrade/main.py backtesting --realistic-simulation --live ``` +**Using a different on-disk ticker-data source** +```bash +python3 ./freqtrade/main.py backtesting --datadir freqtrade/tests/testdata-20180101 +``` + For help about backtesting usage, please refer to [Backtesting commands](#backtesting-commands). @@ -101,4 +106,4 @@ strategies, your configuration, and the crypto-currency you have set up. ## Next step Great, your strategy is profitable. What if the bot can give your the optimal parameters to use for your strategy? -Your next step is to learn [how to find optimal parameters with Hyperopt](https://github.com/gcarq/freqtrade/blob/develop/docs/hyperopt.md) \ No newline at end of file +Your next step is to learn [how to find optimal parameters with Hyperopt](https://github.com/gcarq/freqtrade/blob/develop/docs/hyperopt.md) diff --git a/docs/bot-usage.md b/docs/bot-usage.md index 79044691e..d3dcf8659 100644 --- a/docs/bot-usage.md +++ b/docs/bot-usage.md @@ -26,6 +26,9 @@ optional arguments: specify configuration file (default: config.json) -v, --verbose be verbose --version show program's version number and exit + -dd PATH, --datadir PATH + Path is from where backtesting and hyperopt will load the + ticker data files (default freqdata/tests/testdata). --dynamic-whitelist [INT] dynamically generate and update whitelist based on 24h BaseVolume (Default 20 currencies) @@ -133,4 +136,4 @@ in [misc.py](https://github.com/gcarq/freqtrade/blob/develop/freqtrade/misc.py#L ## Next step The optimal strategy of the bot will change with time depending of the market trends. The next step is to -[optimize your bot](https://github.com/gcarq/freqtrade/blob/develop/docs/bot-optimization.md). \ No newline at end of file +[optimize your bot](https://github.com/gcarq/freqtrade/blob/develop/docs/bot-optimization.md). diff --git a/docs/hyperopt.md b/docs/hyperopt.md index 6cf0d3f90..24a9dbc51 100644 --- a/docs/hyperopt.md +++ b/docs/hyperopt.md @@ -163,6 +163,11 @@ We strongly recommend to use `screen` to prevent any connection loss. python3 ./freqtrade/main.py -c config.json hyperopt ``` +### Execute hyperopt with different ticker-data source +If you would like to learn parameters using an alternate ticke-data that +you have on-disk, use the --datadir PATH option. Default hyperopt will +use data from directory freqtrade/tests/testdata. + ### Hyperopt with MongoDB Hyperopt with MongoDB, is like Hyperopt under steroids. As you saw by executing the previous command is the execution takes a long time.