adelorenzo/stable
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document hyperopt-filename usage

Browse Source
This commit is contained in:
Matthias 2020-09-27 17:09:33 +02:00
parent 3cb1a9a5a9
commit 8de9c46110
3 changed files with 50 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/hyperopt.md
View File

@ -240,7 +240,8 @@ running at least several thousand evaluations.
The `--spaces all` option determines that all possible parameters should be optimized. Possibilities are listed below. The `--spaces all` option determines that all possible parameters should be optimized. Possibilities are listed below.
!!! Note !!! Note
By default, hyperopt will erase previous results and start from scratch. Hyperopt will store hyperopt results with the timestamp of the hyperopt start time.
Reading commands (`hyperopt-list`, `hyperopt-show`) can use `--hyperopt-filename <filename>` to read and display older hyperopt results.
### Execute Hyperopt with different historical data source ### Execute Hyperopt with different historical data source

62
docs/utils.md
View File

@ -423,7 +423,7 @@ freqtrade test-pairlist --config config.json --quote USDT BTC
## List Hyperopt results ## List Hyperopt results
You can list the hyperoptimization epochs the Hyperopt module evaluated previously with the `hyperopt-list` subcommand. You can list the hyperoptimization epochs the Hyperopt module evaluated previously with the `hyperopt-list` sub-command.
``` ```
usage: freqtrade hyperopt-list [-h] [-v] [--logfile FILE] [-V] [-c PATH] usage: freqtrade hyperopt-list [-h] [-v] [--logfile FILE] [-V] [-c PATH]
@ -432,10 +432,11 @@ usage: freqtrade hyperopt-list [-h] [-v] [--logfile FILE] [-V] [-c PATH]
[--max-trades INT] [--min-avg-time FLOAT] [--max-trades INT] [--min-avg-time FLOAT]
[--max-avg-time FLOAT] [--min-avg-profit FLOAT] [--max-avg-time FLOAT] [--min-avg-profit FLOAT]
[--max-avg-profit FLOAT] [--max-avg-profit FLOAT]
[--min-total-profit FLOAT] [--max-total-profit FLOAT] [--min-total-profit FLOAT]
[--max-total-profit FLOAT]
[--min-objective FLOAT] [--max-objective FLOAT] [--min-objective FLOAT] [--max-objective FLOAT]
[--no-color] [--print-json] [--no-details] [--no-color] [--print-json] [--no-details]
[--export-csv FILE] [--hyperopt-filename PATH] [--export-csv FILE]
optional arguments: optional arguments:
-h, --help show this help message and exit -h, --help show this help message and exit
@ -443,24 +444,27 @@ optional arguments:
--profitable Select only profitable epochs. --profitable Select only profitable epochs.
--min-trades INT Select epochs with more than INT trades. --min-trades INT Select epochs with more than INT trades.
--max-trades INT Select epochs with less than INT trades. --max-trades INT Select epochs with less than INT trades.
--min-avg-time FLOAT Select epochs on above average time. --min-avg-time FLOAT Select epochs above average time.
--max-avg-time FLOAT Select epochs on under average time. --max-avg-time FLOAT Select epochs below average time.
--min-avg-profit FLOAT --min-avg-profit FLOAT
Select epochs on above average profit. Select epochs above average profit.
--max-avg-profit FLOAT --max-avg-profit FLOAT
Select epochs on below average profit. Select epochs below average profit.
--min-total-profit FLOAT --min-total-profit FLOAT
Select epochs on above total profit. Select epochs above total profit.
--max-total-profit FLOAT --max-total-profit FLOAT
Select epochs on below total profit. Select epochs below total profit.
--min-objective FLOAT --min-objective FLOAT
Select epochs on above objective (- is added by default). Select epochs above objective.
--max-objective FLOAT --max-objective FLOAT
Select epochs on below objective (- is added by default). Select epochs below objective.
--no-color Disable colorization of hyperopt results. May be --no-color Disable colorization of hyperopt results. May be
useful if you are redirecting output to a file. useful if you are redirecting output to a file.
--print-json Print best result detailization in JSON format. --print-json Print output in JSON format.
--no-details Do not print best epoch details. --no-details Do not print best epoch details.
--hyperopt-filename FILENAME
Hyperopt result filename.Example: `--hyperopt-
filename=hyperopt_results_2020-09-27_16-20-48.pickle`
--export-csv FILE Export to CSV-File. This will disable table print. --export-csv FILE Export to CSV-File. This will disable table print.
Example: --export-csv hyperopt.csv Example: --export-csv hyperopt.csv
@ -480,7 +484,11 @@ Common arguments:
--userdir PATH, --user-data-dir PATH --userdir PATH, --user-data-dir PATH
Path to userdata directory. Path to userdata directory.
``` ```
!!! Note
`hyperopt-list` will automatically use the latest available hyperopt results file.
You can override this using the `--hyperopt-filename` argument, and specify another, available filename (without path!).
### Examples ### Examples
List all results, print details of the best result at the end: List all results, print details of the best result at the end:
@ -501,17 +509,41 @@ You can show the details of any hyperoptimization epoch previously evaluated by
usage: freqtrade hyperopt-show [-h] [-v] [--logfile FILE] [-V] [-c PATH] usage: freqtrade hyperopt-show [-h] [-v] [--logfile FILE] [-V] [-c PATH]
[-d PATH] [--userdir PATH] [--best] [-d PATH] [--userdir PATH] [--best]
[--profitable] [-n INT] [--print-json] [--profitable] [-n INT] [--print-json]
[--no-header] [--hyperopt-filename PATH] [--no-header]
optional arguments: optional arguments:
-h, --help show this help message and exit -h, --help show this help message and exit
--best Select only best epochs. --best Select only best epochs.
--profitable Select only profitable epochs. --profitable Select only profitable epochs.
-n INT, --index INT Specify the index of the epoch to print details for. -n INT, --index INT Specify the index of the epoch to print details for.
--print-json Print best result detailization in JSON format. --print-json Print output in JSON format.
--hyperopt-filename FILENAME
Hyperopt result filename.Example: `--hyperopt-
filename=hyperopt_results_2020-09-27_16-20-48.pickle`
--no-header Do not print epoch details header. --no-header Do not print epoch details header.
Common arguments:
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
--logfile FILE Log to the file specified. Special values are:
'syslog', 'journald'. See the documentation for more
details.
-V, --version show program's version number and exit
-c PATH, --config PATH
Specify configuration file (default:
`userdir/config.json` or `config.json` whichever
exists). Multiple --config options may be used. Can be
set to `-` to read config from stdin.
-d PATH, --datadir PATH
Path to directory with historical backtesting data.
--userdir PATH, --user-data-dir PATH
Path to userdata directory.
``` ```
!!! Note
`hyperopt-show` will automatically use the latest available hyperopt results file.
You can override this using the `--hyperopt-filename` argument, and specify another, available filename (without path!).
### Examples ### Examples
Print details for the epoch 168 (the number of the epoch is shown by the `hyperopt-list` subcommand or by Hyperopt itself during hyperoptimization run): Print details for the epoch 168 (the number of the epoch is shown by the `hyperopt-list` subcommand or by Hyperopt itself during hyperoptimization run):

2
freqtrade/commands/cli_options.py
View File

@ -267,7 +267,7 @@ AVAILABLE_CLI_OPTIONS = {
'--hyperopt-filename', '--hyperopt-filename',
help='Hyperopt result filename.' help='Hyperopt result filename.'
'Example: `--hyperopt-filename=hyperopt_results_2020-09-27_16-20-48.pickle`', 'Example: `--hyperopt-filename=hyperopt_results_2020-09-27_16-20-48.pickle`',
metavar='PATH', metavar='FILENAME',
), ),
# List exchanges # List exchanges
"print_one_column": Arg( "print_one_column": Arg(