mirror of
https://github.com/freqtrade/freqtrade.git
synced 2026-02-19 10:50:50 +00:00
Deployed 706955e to develop in en with MkDocs 1.6.1 and mike 2.1.3
This commit is contained in:
@@ -2525,133 +2525,131 @@ The legacy method was supported up to 2021.8 and has been removed in 2021.9.</p>
|
||||
pip<span class="w"> </span>install<span class="w"> </span>-r<span class="w"> </span>requirements-hyperopt.txt
|
||||
</code></pre></div>
|
||||
<h2 id="hyperopt-command-reference">Hyperopt command reference<a class="headerlink" href="#hyperopt-command-reference" title="Permanent link">¶</a></h2>
|
||||
<div class="highlight"><pre><span></span><code>usage: freqtrade hyperopt [-h] [-v] [--no-color] [--logfile FILE] [-V]
|
||||
[-c PATH] [-d PATH] [--userdir PATH] [-s NAME]
|
||||
[--strategy-path PATH] [--recursive-strategy-search]
|
||||
[--freqaimodel NAME] [--freqaimodel-path PATH]
|
||||
[-i TIMEFRAME] [--timerange TIMERANGE]
|
||||
[--data-format-ohlcv {json,jsongz,feather,parquet}]
|
||||
[--max-open-trades INT]
|
||||
[--stake-amount STAKE_AMOUNT] [--fee FLOAT]
|
||||
[-p PAIRS [PAIRS ...]] [--hyperopt-path PATH]
|
||||
[--eps] [--enable-protections]
|
||||
[--dry-run-wallet DRY_RUN_WALLET]
|
||||
[--timeframe-detail TIMEFRAME_DETAIL] [-e INT]
|
||||
[--spaces SPACES [SPACES ...]] [--print-all]
|
||||
[--print-json] [-j JOBS] [--random-state INT]
|
||||
[--min-trades INT] [--hyperopt-loss NAME]
|
||||
[--disable-param-export] [--ignore-missing-spaces]
|
||||
[--analyze-per-epoch] [--early-stop INT]
|
||||
<div class="highlight"><pre><span></span><code><span class="go">usage: freqtrade hyperopt [-h] [-v] [--no-color] [--logfile FILE] [-V]</span>
|
||||
<span class="go"> [-c PATH] [-d PATH] [--userdir PATH] [-s NAME]</span>
|
||||
<span class="go"> [--strategy-path PATH] [--recursive-strategy-search]</span>
|
||||
<span class="go"> [--freqaimodel NAME] [--freqaimodel-path PATH]</span>
|
||||
<span class="go"> [-i TIMEFRAME] [--timerange TIMERANGE]</span>
|
||||
<span class="go"> [--data-format-ohlcv {json,jsongz,feather,parquet}]</span>
|
||||
<span class="go"> [--max-open-trades INT]</span>
|
||||
<span class="go"> [--stake-amount STAKE_AMOUNT] [--fee FLOAT]</span>
|
||||
<span class="go"> [-p PAIRS [PAIRS ...]] [--hyperopt-path PATH]</span>
|
||||
<span class="go"> [--eps] [--enable-protections]</span>
|
||||
<span class="go"> [--dry-run-wallet DRY_RUN_WALLET]</span>
|
||||
<span class="go"> [--timeframe-detail TIMEFRAME_DETAIL] [-e INT]</span>
|
||||
<span class="go"> [--spaces SPACES [SPACES ...]] [--print-all]</span>
|
||||
<span class="go"> [--print-json] [-j JOBS] [--random-state INT]</span>
|
||||
<span class="go"> [--min-trades INT] [--hyperopt-loss NAME]</span>
|
||||
<span class="go"> [--disable-param-export] [--ignore-missing-spaces]</span>
|
||||
<span class="go"> [--analyze-per-epoch] [--early-stop INT]</span>
|
||||
|
||||
options:
|
||||
-h, --help show this help message and exit
|
||||
-i TIMEFRAME, --timeframe TIMEFRAME
|
||||
Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`).
|
||||
--timerange TIMERANGE
|
||||
Specify what timerange of data to use.
|
||||
--data-format-ohlcv {json,jsongz,feather,parquet}
|
||||
Storage format for downloaded candle (OHLCV) data.
|
||||
(default: `feather`).
|
||||
--max-open-trades INT
|
||||
Override the value of the `max_open_trades`
|
||||
configuration setting.
|
||||
--stake-amount STAKE_AMOUNT
|
||||
Override the value of the `stake_amount` configuration
|
||||
setting.
|
||||
--fee FLOAT Specify fee ratio. Will be applied twice (on trade
|
||||
entry and exit).
|
||||
-p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...]
|
||||
Limit command to these pairs. Pairs are space-
|
||||
separated.
|
||||
--hyperopt-path PATH Specify additional lookup path for Hyperopt Loss
|
||||
functions.
|
||||
--eps, --enable-position-stacking
|
||||
Allow buying the same pair multiple times (position
|
||||
stacking).
|
||||
--enable-protections, --enableprotections
|
||||
Enable protections for backtesting. Will slow
|
||||
backtesting down by a considerable amount, but will
|
||||
include configured protections
|
||||
--dry-run-wallet DRY_RUN_WALLET, --starting-balance DRY_RUN_WALLET
|
||||
Starting balance, used for backtesting / hyperopt and
|
||||
dry-runs.
|
||||
--timeframe-detail TIMEFRAME_DETAIL
|
||||
Specify detail timeframe for backtesting (`1m`, `5m`,
|
||||
`30m`, `1h`, `1d`).
|
||||
-e INT, --epochs INT Specify number of epochs (default: 100).
|
||||
--spaces SPACES [SPACES ...]
|
||||
Specify which parameters to hyperopt. Space-separated
|
||||
list. Available builtin options (custom spaces will
|
||||
not be listed here): default, all, buy, sell, enter,
|
||||
exit, roi, stoploss, trailing, protection, trades.
|
||||
Default: `default` - which includes all spaces except
|
||||
for 'trailing', 'protection', and 'trades'.
|
||||
--print-all Print all results, not only the best ones.
|
||||
--print-json Print output in JSON format.
|
||||
-j JOBS, --job-workers JOBS
|
||||
The number of concurrently running jobs for
|
||||
hyperoptimization (hyperopt worker processes). If -1
|
||||
(default), all CPUs are used, for -2, all CPUs but one
|
||||
are used, etc. If 1 is given, no parallel computing
|
||||
code is used at all.
|
||||
--random-state INT Set random state to some positive integer for
|
||||
reproducible hyperopt results.
|
||||
--min-trades INT Set minimal desired number of trades for evaluations
|
||||
in the hyperopt optimization path (default: 1).
|
||||
--hyperopt-loss NAME, --hyperoptloss NAME
|
||||
Specify the class name of the hyperopt loss function
|
||||
class (IHyperOptLoss). Different functions can
|
||||
generate completely different results, since the
|
||||
target for optimization is different. Built-in
|
||||
Hyperopt-loss-functions are:
|
||||
ShortTradeDurHyperOptLoss, OnlyProfitHyperOptLoss,
|
||||
SharpeHyperOptLoss, SharpeHyperOptLossDaily,
|
||||
SortinoHyperOptLoss, SortinoHyperOptLossDaily,
|
||||
CalmarHyperOptLoss, MaxDrawDownHyperOptLoss,
|
||||
MaxDrawDownRelativeHyperOptLoss,
|
||||
MaxDrawDownPerPairHyperOptLoss,
|
||||
ProfitDrawDownHyperOptLoss, MultiMetricHyperOptLoss
|
||||
--disable-param-export
|
||||
Disable automatic hyperopt parameter export.
|
||||
--ignore-missing-spaces, --ignore-unparameterized-spaces
|
||||
Suppress errors for any requested Hyperopt spaces that
|
||||
do not contain any parameters.
|
||||
--analyze-per-epoch Run populate_indicators once per epoch.
|
||||
--early-stop INT Early stop hyperopt if no improvement after (default:
|
||||
0) epochs.
|
||||
<span class="go">options:</span>
|
||||
<span class="go"> -h, --help show this help message and exit</span>
|
||||
<span class="go"> -i, --timeframe TIMEFRAME</span>
|
||||
<span class="go"> Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`).</span>
|
||||
<span class="go"> --timerange TIMERANGE</span>
|
||||
<span class="go"> Specify what timerange of data to use.</span>
|
||||
<span class="go"> --data-format-ohlcv {json,jsongz,feather,parquet}</span>
|
||||
<span class="go"> Storage format for downloaded candle (OHLCV) data.</span>
|
||||
<span class="go"> (default: `feather`).</span>
|
||||
<span class="go"> --max-open-trades INT</span>
|
||||
<span class="go"> Override the value of the `max_open_trades`</span>
|
||||
<span class="go"> configuration setting.</span>
|
||||
<span class="go"> --stake-amount STAKE_AMOUNT</span>
|
||||
<span class="go"> Override the value of the `stake_amount` configuration</span>
|
||||
<span class="go"> setting.</span>
|
||||
<span class="go"> --fee FLOAT Specify fee ratio. Will be applied twice (on trade</span>
|
||||
<span class="go"> entry and exit).</span>
|
||||
<span class="go"> -p, --pairs PAIRS [PAIRS ...]</span>
|
||||
<span class="go"> Limit command to these pairs. Pairs are space-</span>
|
||||
<span class="go"> separated.</span>
|
||||
<span class="go"> --hyperopt-path PATH Specify additional lookup path for Hyperopt Loss</span>
|
||||
<span class="go"> functions.</span>
|
||||
<span class="go"> --eps, --enable-position-stacking</span>
|
||||
<span class="go"> Allow buying the same pair multiple times (position</span>
|
||||
<span class="go"> stacking).</span>
|
||||
<span class="go"> --enable-protections, --enableprotections</span>
|
||||
<span class="go"> Enable protections for backtesting. Will slow</span>
|
||||
<span class="go"> backtesting down by a considerable amount, but will</span>
|
||||
<span class="go"> include configured protections</span>
|
||||
<span class="go"> --dry-run-wallet, --starting-balance DRY_RUN_WALLET</span>
|
||||
<span class="go"> Starting balance, used for backtesting / hyperopt and</span>
|
||||
<span class="go"> dry-runs.</span>
|
||||
<span class="go"> --timeframe-detail TIMEFRAME_DETAIL</span>
|
||||
<span class="go"> Specify detail timeframe for backtesting (`1m`, `5m`,</span>
|
||||
<span class="go"> `30m`, `1h`, `1d`).</span>
|
||||
<span class="go"> -e, --epochs INT Specify number of epochs (default: 100).</span>
|
||||
<span class="go"> --spaces SPACES [SPACES ...]</span>
|
||||
<span class="go"> Specify which parameters to hyperopt. Space-separated</span>
|
||||
<span class="go"> list. Available builtin options (custom spaces will</span>
|
||||
<span class="go"> not be listed here): default, all, buy, sell, enter,</span>
|
||||
<span class="go"> exit, roi, stoploss, trailing, protection, trades.</span>
|
||||
<span class="go"> Default: `default` - which includes all spaces except</span>
|
||||
<span class="go"> for 'trailing', 'protection', and 'trades'.</span>
|
||||
<span class="go"> --print-all Print all results, not only the best ones.</span>
|
||||
<span class="go"> --print-json Print output in JSON format.</span>
|
||||
<span class="go"> -j, --job-workers JOBS</span>
|
||||
<span class="go"> The number of concurrently running jobs for</span>
|
||||
<span class="go"> hyperoptimization (hyperopt worker processes). If -1</span>
|
||||
<span class="go"> (default), all CPUs are used, for -2, all CPUs but one</span>
|
||||
<span class="go"> are used, etc. If 1 is given, no parallel computing</span>
|
||||
<span class="go"> code is used at all.</span>
|
||||
<span class="go"> --random-state INT Set random state to some positive integer for</span>
|
||||
<span class="go"> reproducible hyperopt results.</span>
|
||||
<span class="go"> --min-trades INT Set minimal desired number of trades for evaluations</span>
|
||||
<span class="go"> in the hyperopt optimization path (default: 1).</span>
|
||||
<span class="go"> --hyperopt-loss, --hyperoptloss NAME</span>
|
||||
<span class="go"> Specify the class name of the hyperopt loss function</span>
|
||||
<span class="go"> class (IHyperOptLoss). Different functions can</span>
|
||||
<span class="go"> generate completely different results, since the</span>
|
||||
<span class="go"> target for optimization is different. Built-in</span>
|
||||
<span class="go"> Hyperopt-loss-functions are:</span>
|
||||
<span class="go"> ShortTradeDurHyperOptLoss, OnlyProfitHyperOptLoss,</span>
|
||||
<span class="go"> SharpeHyperOptLoss, SharpeHyperOptLossDaily,</span>
|
||||
<span class="go"> SortinoHyperOptLoss, SortinoHyperOptLossDaily,</span>
|
||||
<span class="go"> CalmarHyperOptLoss, MaxDrawDownHyperOptLoss,</span>
|
||||
<span class="go"> MaxDrawDownRelativeHyperOptLoss,</span>
|
||||
<span class="go"> MaxDrawDownPerPairHyperOptLoss,</span>
|
||||
<span class="go"> ProfitDrawDownHyperOptLoss, MultiMetricHyperOptLoss</span>
|
||||
<span class="go"> --disable-param-export</span>
|
||||
<span class="go"> Disable automatic hyperopt parameter export.</span>
|
||||
<span class="go"> --ignore-missing-spaces, --ignore-unparameterized-spaces</span>
|
||||
<span class="go"> Suppress errors for any requested Hyperopt spaces that</span>
|
||||
<span class="go"> do not contain any parameters.</span>
|
||||
<span class="go"> --analyze-per-epoch Run populate_indicators once per epoch.</span>
|
||||
<span class="go"> --early-stop INT Early stop hyperopt if no improvement after (default:</span>
|
||||
<span class="go"> 0) epochs.</span>
|
||||
|
||||
Common arguments:
|
||||
-v, --verbose Verbose mode (-vv for more, -vvv to get all messages).
|
||||
--no-color Disable colorization of hyperopt results. May be
|
||||
useful if you are redirecting output to a file.
|
||||
--logfile FILE, --log-file 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, --data-dir PATH
|
||||
Path to the base directory of the exchange with
|
||||
historical backtesting data. To see futures data, use
|
||||
trading-mode additionally.
|
||||
--userdir PATH, --user-data-dir PATH
|
||||
Path to userdata directory.
|
||||
<span class="go">Common arguments:</span>
|
||||
<span class="go"> -v, --verbose Verbose mode (-vv for more, -vvv to get all messages).</span>
|
||||
<span class="go"> --no-color Disable colorization of hyperopt results. May be</span>
|
||||
<span class="go"> useful if you are redirecting output to a file.</span>
|
||||
<span class="go"> --logfile, --log-file FILE</span>
|
||||
<span class="go"> Log to the file specified. Special values are:</span>
|
||||
<span class="go"> 'syslog', 'journald'. See the documentation for more</span>
|
||||
<span class="go"> details.</span>
|
||||
<span class="go"> -V, --version show program's version number and exit</span>
|
||||
<span class="go"> -c, --config PATH Specify configuration file (default:</span>
|
||||
<span class="go"> `userdir/config.json` or `config.json` whichever</span>
|
||||
<span class="go"> exists). Multiple --config options may be used. Can be</span>
|
||||
<span class="go"> set to `-` to read config from stdin.</span>
|
||||
<span class="go"> -d, --datadir, --data-dir PATH</span>
|
||||
<span class="go"> Path to the base directory of the exchange with</span>
|
||||
<span class="go"> historical backtesting data. To see futures data, use</span>
|
||||
<span class="go"> trading-mode additionally.</span>
|
||||
<span class="go"> --userdir, --user-data-dir PATH</span>
|
||||
<span class="go"> Path to userdata directory.</span>
|
||||
|
||||
Strategy arguments:
|
||||
-s NAME, --strategy NAME
|
||||
Specify strategy class name which will be used by the
|
||||
bot.
|
||||
--strategy-path PATH Specify additional strategy lookup path.
|
||||
--recursive-strategy-search
|
||||
Recursively search for a strategy in the strategies
|
||||
folder.
|
||||
--freqaimodel NAME Specify a custom freqaimodels.
|
||||
--freqaimodel-path PATH
|
||||
Specify additional lookup path for freqaimodels.
|
||||
<span class="go">Strategy arguments:</span>
|
||||
<span class="go"> -s, --strategy NAME Specify strategy class name which will be used by the</span>
|
||||
<span class="go"> bot.</span>
|
||||
<span class="go"> --strategy-path PATH Specify additional strategy lookup path.</span>
|
||||
<span class="go"> --recursive-strategy-search</span>
|
||||
<span class="go"> Recursively search for a strategy in the strategies</span>
|
||||
<span class="go"> folder.</span>
|
||||
<span class="go"> --freqaimodel NAME Specify a custom freqaimodels.</span>
|
||||
<span class="go"> --freqaimodel-path PATH</span>
|
||||
<span class="go"> Specify additional lookup path for freqaimodels.</span>
|
||||
</code></pre></div>
|
||||
<h3 id="hyperopt-checklist">Hyperopt checklist<a class="headerlink" href="#hyperopt-checklist" title="Permanent link">¶</a></h3>
|
||||
<p>Checklist on all tasks / possibilities in hyperopt</p>
|
||||
|
||||
Reference in New Issue
Block a user