From 43b41324e2517924ae24e9eca35d0568bcf4bd87 Mon Sep 17 00:00:00 2001 From: Matthias Date: Mon, 12 Aug 2019 06:45:27 +0200 Subject: [PATCH] Improve hyperopt-loss docs --- docs/bot-usage.md | 9 +++++---- docs/hyperopt.md | 6 +++++- freqtrade/configuration/cli_options.py | 4 +++- 3 files changed, 13 insertions(+), 6 deletions(-) diff --git a/docs/bot-usage.md b/docs/bot-usage.md index 0ca2f3cc5..9833bb43d 100644 --- a/docs/bot-usage.md +++ b/docs/bot-usage.md @@ -256,12 +256,13 @@ optional arguments: --continue Continue hyperopt from previous runs. By default, temporary files will be removed and hyperopt will start from scratch. - --hyperopt-loss NAME - Specify the class name of the hyperopt loss function + --hyperopt-loss 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. (default: - `DefaultHyperOptLoss`). + target for optimization is different. Built-in + Hyperopt-loss-functions are: DefaultHyperOptLoss, + OnlyProfitHyperOptLoss, SharpeHyperOptLoss. + (default: `DefaultHyperOptLoss`). ``` ## Edge commands diff --git a/docs/hyperopt.md b/docs/hyperopt.md index 6ef68d82f..918361c52 100644 --- a/docs/hyperopt.md +++ b/docs/hyperopt.md @@ -164,7 +164,11 @@ By default, FreqTrade uses a loss function, which has been with freqtrade since A different loss function can be specified by using the `--hyperopt-loss ` argument. This class should be in its own file within the `user_data/hyperopts/` directory. -Currently, the following loss functions are builtin: `DefaultHyperOptLoss` (default legacy Freqtrade hyperoptimization loss function), `SharpeHyperOptLoss` (optimizes Sharpe Ratio calculated on the trade returns) and `OnlyProfitHyperOptLoss` (which takes only amount of profit into consideration). +Currently, the following loss functions are builtin: + +* `DefaultHyperOptLoss` (default legacy Freqtrade hyperoptimization loss function) +* `OnlyProfitHyperOptLoss` (which takes only amount of profit into consideration) +* `SharpeHyperOptLoss` (optimizes Sharpe Ratio calculated on the trade returns) ### Creating and using a custom loss function diff --git a/freqtrade/configuration/cli_options.py b/freqtrade/configuration/cli_options.py index 04554c386..771cdfb80 100644 --- a/freqtrade/configuration/cli_options.py +++ b/freqtrade/configuration/cli_options.py @@ -226,7 +226,9 @@ AVAILABLE_CLI_OPTIONS = { '--hyperopt-loss', help='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. (default: `%(default)s`).', + 'since the target for optimization is different. Built-in Hyperopt-loss-functions are: ' + 'DefaultHyperOptLoss, OnlyProfitHyperOptLoss, SharpeHyperOptLoss.' + '(default: `%(default)s`).', metavar='NAME', default=constants.DEFAULT_HYPEROPT_LOSS, ),