Merge pull request #511 from gcarq/hyperopt_selectable_spaces

Allow selecting Hyperopt search space

docs/hyperopt.md

@@ -51,12 +51,12 @@ def populate_buy_trend(dataframe: DataFrame) -> DataFrame:
     return dataframe
 ```
 
-Your hyperopt file must contains `guards` to find the right value for 
+Your hyperopt file must contain `guards` to find the right value for 
 `(dataframe['adx'] > 65)` & and `(dataframe['plus_di'] > 0.5)`. That 
 means you will need to enable/disable triggers.
  
 In our case the `SPACE` and `populate_buy_trend` in your strategy file 
-will be look like:
+will look like:
 ```python
 space = {
     'rsi': hp.choice('rsi', [
@@ -105,7 +105,7 @@ def populate_buy_trend(self, dataframe: DataFrame) -> DataFrame:
 
 
 ### 2. Update the hyperopt config file
-Hyperopt is using a dedicated config file. At this moment hyperopt 
+Hyperopt is using a dedicated config file. Currently hyperopt 
 cannot use your config file. It is also made on purpose to allow you
 testing your strategy with different configurations.
 
@@ -127,19 +127,21 @@ If it's a guard, you will add a line like this:
     {'enabled': True, 'value': hp.quniform('rsi-value', 20, 40, 1)}
 ]),
 ```
-This says, "*one of guards is RSI, it can have two values, enabled or 
+This says, "*one of the guards is RSI, it can have two values, enabled or 
 disabled. If it is enabled, try different values for it between 20 and 40*".
 
 So, the part of the strategy builder using the above setting looks like 
 this:
+
 ```
 if params['rsi']['enabled']:
     conditions.append(dataframe['rsi'] < params['rsi']['value'])
 ```
+
 It checks if Hyperopt wants the RSI guard to be enabled for this 
 round `params['rsi']['enabled']` and if it is, then it will add a 
-condition that says RSI must be < than the value hyperopt picked 
+condition that says RSI must be smaller than the value hyperopt picked 
-for this evaluation, that is given in the `params['rsi']['value']`.
+for this evaluation, which is given in the `params['rsi']['value']`.
 
 That's it. Now you can add new parts of strategies to Hyperopt and it 
 will try all the combinations with all different values in the search 
@@ -148,8 +150,7 @@ for best working algo.
 
 ### Add a new Indicators
 If you want to test an indicator that isn't used by the bot currently, 
-you need to add it to your strategy file (example: [user_data/strategies/test_strategy.py](https://github.com/gcarq/freqtrade/blob/develop/user_data/strategies/test_strategy.py))
+you need to add it to the `populate_indicators()` method in `hyperopt.py`.
-inside the `populate_indicators()` method.
 
 ## Execute Hyperopt
 Once you have updated your hyperopt configuration you can run it. 
@@ -158,17 +159,19 @@ it will take time you will have the result (more than 30 mins).
 
 We strongly recommend to use `screen` to prevent any connection loss.
 ```bash
-python3 ./freqtrade/main.py -c config.json hyperopt
+python3 ./freqtrade/main.py -c config.json hyperopt -e 5000
 ```
 
+The `-e` flag will set how many evaluations hyperopt will do. We recommend
+running at least several thousand evaluations.
+
 ### Execute hyperopt with different ticker-data source
-If you would like to learn parameters using an alternate ticke-data that
+If you would like to hyperopt parameters using an alternate ticker data that
 you have on-disk, use the `--datadir PATH` option. Default hyperopt will
 use data from directory `user_data/data`.
 
 ### Running hyperopt with smaller testset
-
+Use the `--timeperiod` argument to change how much of the testset
-Use the --timeperiod argument to change how much of the testset
 you want to use. The last N ticks/timeframes will be used.
 Example:
 
@@ -176,6 +179,21 @@ Example:
 python3 ./freqtrade/main.py hyperopt --timeperiod -200
 ```
 
+### Running hyperopt with smaller search space
+Use the `--spaces` argument to limit the search space used by hyperopt.
+Letting Hyperopt optimize everything is a huuuuge search space. Often it 
+might make more sense to start by just searching for initial buy algorithm. 
+Or maybe you just want to optimize your stoploss or roi table for that awesome 
+new buy strategy you have.
+
+Legal values are:
+
+- `all`: optimize everything
+- `buy`: just search for a new buy strategy
+- `roi`: just optimize the minimal profit table for your strategy
+- `stoploss`: search for the best stoploss value
+- space-separated list of any of the above values for example `--spaces roi stoploss`
+
 ### 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. 
@@ -267,7 +285,6 @@ customizable value.
 - You should **ignore** the guard "mfi" (`"mfi"` is `"enabled": false`)
 - and so on...
 
-
 You have to look inside your strategy file into `buy_strategy_generator()` 
 method, what those values match to.   
   
@@ -277,7 +294,7 @@ at `adx`-block, that translates to the following code block:
 (dataframe['adx'] > 15.0)
 ```
   
-So translating your whole hyperopt result to as the new buy-signal 
+Translating your whole hyperopt result to as the new buy-signal 
 would be the following:
 ```
 def populate_buy_trend(self, dataframe: DataFrame) -> DataFrame:

freqtrade/misc.py

@@ -280,6 +280,15 @@ def hyperopt_options(parser: argparse.ArgumentParser) -> None:
         type=str,
         dest='timerange',
     )
+    parser.add_argument(
+        '-s', '--spaces',
+        help='Specify which parameters to hyperopt. Space separate list. \
+              Default: %(default)s',
+        choices=['all', 'buy', 'roi', 'stoploss'],
+        default='all',
+        nargs='+',
+        dest='spaces',
+    )
 
 
 def parse_timerange(text):

freqtrade/optimize/hyperopt.py

@@ -312,8 +312,21 @@ def indicator_space() -> Dict[str, Any]:
     }
 
 
-def hyperopt_space() -> Dict[str, Any]:
+def has_space(spaces, space):
-    return {**indicator_space(), **roi_space(), **stoploss_space()}
+    if space in spaces or 'all' in spaces:
+        return True
+    return False
+
+
+def hyperopt_space(selected_spaces: str) -> Dict[str, Any]:
+    spaces = {}
+    if has_space(selected_spaces, 'buy'):
+        spaces = {**spaces, **indicator_space()}
+    if has_space(selected_spaces, 'roi'):
+        spaces = {**spaces, **roi_space()}
+    if has_space(selected_spaces, 'stoploss'):
+        spaces = {**spaces, **stoploss_space()}
+    return spaces
 
 
 def buy_strategy_generator(params: Dict[str, Any]) -> Callable:
@@ -393,15 +406,21 @@ def buy_strategy_generator(params: Dict[str, Any]) -> Callable:
 def optimizer(params):
     global _CURRENT_TRIES
 
-    if 'roi_t1' in params:
     strategy = Strategy()
+    if 'roi_t1' in params:
         strategy.minimal_roi = generate_roi_table(params)
 
+    if 'trigger' in params:
         backtesting.populate_buy_trend = buy_strategy_generator(params)
 
+    if 'stoploss' in params:
+        stoploss = params['stoploss']
+    else:
+        stoploss = strategy.stoploss
+
     results = backtest({'stake_amount': OPTIMIZE_CONFIG['stake_amount'],
                         'processed': PROCESSED,
-                        'stoploss': params['stoploss']})
+                        'stoploss': stoploss})
     result_explanation = format_results(results)
 
     total_profit = results.profit_percent.sum()
@@ -475,6 +494,7 @@ def start(args):
     data = optimize.load_data(args.datadir, pairs=pairs,
                               ticker_interval=strategy.ticker_interval,
                               timerange=timerange)
+    if has_space(args.spaces, 'buy'):
         optimize.populate_indicators = populate_indicators
     PROCESSED = optimize.tickerdata_to_dataframe(data)
 
@@ -500,7 +520,7 @@ def start(args):
     try:
         best_parameters = fmin(
             fn=optimizer,
-            space=hyperopt_space(),
+            space=hyperopt_space(args.spaces),
             algo=tpe.suggest,
             max_evals=TOTAL_TRIES,
             trials=TRIALS
@@ -517,7 +537,7 @@ def start(args):
     # Improve best parameter logging display
     if best_parameters:
         best_parameters = space_eval(
-            hyperopt_space(),
+            hyperopt_space(args.spaces),
             best_parameters
         )
 

freqtrade/tests/optimize/test_hyperopt.py

@@ -6,7 +6,7 @@ from unittest.mock import MagicMock
 import pandas as pd
 
 from freqtrade.optimize.hyperopt import calculate_loss, TARGET_TRADES, EXPECTED_MAX_PROFIT, start, \
-    log_results, save_trials, read_trials, generate_roi_table
+    log_results, save_trials, read_trials, generate_roi_table, has_space
 
 import freqtrade.optimize.hyperopt as hyperopt
 
@@ -71,7 +71,7 @@ def test_start_calls_fmin(mocker):
     mock_fmin = mocker.patch('freqtrade.optimize.hyperopt.fmin', return_value={})
 
     args = mocker.Mock(epochs=1, config='config.json.example', mongodb=False,
-                       timerange=None)
+                       timerange=None, spaces='all')
     start(args)
 
     mock_fmin.assert_called_once()
@@ -85,7 +85,7 @@ def test_start_uses_mongotrials(mocker):
     mocker.patch('freqtrade.optimize.hyperopt.fmin', return_value={})
 
     args = mocker.Mock(epochs=1, config='config.json.example', mongodb=True,
-                       timerange=None)
+                       timerange=None, spaces='all')
     start(args)
 
     mock_mongotrials.assert_called_once()
@@ -148,7 +148,7 @@ def test_fmin_best_results(mocker, caplog):
     mocker.patch('freqtrade.optimize.hyperopt.fmin', return_value=fmin_result)
 
     args = mocker.Mock(epochs=1, config='config.json.example',
-                       timerange=None)
+                       timerange=None, spaces='all')
     start(args)
 
     exists = [
@@ -172,7 +172,7 @@ def test_fmin_throw_value_error(mocker, caplog):
     mocker.patch('freqtrade.optimize.hyperopt.fmin', side_effect=ValueError())
 
     args = mocker.Mock(epochs=1, config='config.json.example',
-                       timerange=None)
+                       timerange=None, spaces='all')
     start(args)
 
     exists = [
@@ -207,7 +207,8 @@ def test_resuming_previous_hyperopt_results_succeeds(mocker):
     args = mocker.Mock(epochs=1,
                        config='config.json.example',
                        mongodb=False,
-                       timerange=None)
+                       timerange=None,
+                       spaces='all')
 
     start(args)
 
@@ -279,3 +280,10 @@ def test_signal_handler(mocker):
     mocker.patch('freqtrade.optimize.hyperopt.log_trials_result', m)
     hyperopt.signal_handler(9, None)
     assert m.call_count == 3
+
+
+def test_has_space():
+    assert has_space(['buy', 'roi'], 'roi')
+    assert has_space(['buy', 'roi'], 'buy')
+    assert not has_space(['buy', 'roi'], 'stoploss')
+    assert has_space(['all'], 'buy')