Update hyperopt samples docstring
This commit is contained in:
parent
bf2dc90c3c
commit
856ba203d9
@ -21,7 +21,7 @@ class {{ hyperopt }}(IHyperOpt):
|
|||||||
"""
|
"""
|
||||||
This is a Hyperopt template to get you started.
|
This is a Hyperopt template to get you started.
|
||||||
|
|
||||||
More information in https://github.com/freqtrade/freqtrade/blob/develop/docs/hyperopt.md
|
More information in the documentation: https://www.freqtrade.io/en/latest/hyperopt/
|
||||||
|
|
||||||
You should:
|
You should:
|
||||||
- Add any lib you need to build your hyperopt.
|
- Add any lib you need to build your hyperopt.
|
||||||
@ -29,11 +29,14 @@ class {{ hyperopt }}(IHyperOpt):
|
|||||||
You must keep:
|
You must keep:
|
||||||
- The prototypes for the methods: populate_indicators, indicator_space, buy_strategy_generator.
|
- The prototypes for the methods: populate_indicators, indicator_space, buy_strategy_generator.
|
||||||
|
|
||||||
The roi_space, generate_roi_table, stoploss_space methods are no longer required to be
|
The methods roi_space, generate_roi_table and stoploss_space are not required
|
||||||
copied in every custom hyperopt. However, you may override them if you need the
|
and are provided by default.
|
||||||
'roi' and the 'stoploss' spaces that differ from the defaults offered by Freqtrade.
|
However, you may override them if you need 'roi' and 'stoploss' spaces that
|
||||||
Sample implementation of these methods can be found in
|
differ from the defaults offered by Freqtrade.
|
||||||
https://github.com/freqtrade/freqtrade/blob/develop/user_data/hyperopts/sample_hyperopt_advanced.py
|
Sample implementation of these methods will be copied to `user_data/hyperopts` when
|
||||||
|
creating the user-data directory using `freqtrade create-userdir --userdir user_data`,
|
||||||
|
or is available online under the following URL:
|
||||||
|
https://github.com/freqtrade/freqtrade/blob/develop/freqtrade/templates/sample_hyperopt_advanced.py.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
|
@ -20,23 +20,28 @@ import freqtrade.vendor.qtpylib.indicators as qtpylib
|
|||||||
class SampleHyperOpt(IHyperOpt):
|
class SampleHyperOpt(IHyperOpt):
|
||||||
"""
|
"""
|
||||||
This is a sample Hyperopt to inspire you.
|
This is a sample Hyperopt to inspire you.
|
||||||
Feel free to customize it.
|
|
||||||
|
|
||||||
More information in https://github.com/freqtrade/freqtrade/blob/develop/docs/hyperopt.md
|
More information in the documentation: https://www.freqtrade.io/en/latest/hyperopt/
|
||||||
|
|
||||||
You should:
|
You should:
|
||||||
- Rename the class name to some unique name.
|
- Rename the class name to some unique name.
|
||||||
- Add any methods you want to build your hyperopt.
|
- Add any methods you want to build your hyperopt.
|
||||||
- Add any lib you need to build your hyperopt.
|
- Add any lib you need to build your hyperopt.
|
||||||
|
|
||||||
|
An easier way to get a new hyperopt file is by using
|
||||||
|
`freqtrade new-hyperopt --hyperopt MyCoolHyperopt`.
|
||||||
|
|
||||||
You must keep:
|
You must keep:
|
||||||
- The prototypes for the methods: populate_indicators, indicator_space, buy_strategy_generator.
|
- The prototypes for the methods: populate_indicators, indicator_space, buy_strategy_generator.
|
||||||
|
|
||||||
The roi_space, generate_roi_table, stoploss_space methods are no longer required to be
|
The methods roi_space, generate_roi_table and stoploss_space are not required
|
||||||
copied in every custom hyperopt. However, you may override them if you need the
|
and are provided by default.
|
||||||
'roi' and the 'stoploss' spaces that differ from the defaults offered by Freqtrade.
|
However, you may override them if you need 'roi' and 'stoploss' spaces that
|
||||||
Sample implementation of these methods can be found in
|
differ from the defaults offered by Freqtrade.
|
||||||
https://github.com/freqtrade/freqtrade/blob/develop/user_data/hyperopts/sample_hyperopt_advanced.py
|
Sample implementation of these methods will be copied to `user_data/hyperopts` when
|
||||||
|
creating the user-data directory using `freqtrade create-userdir --userdir user_data`,
|
||||||
|
or is available online under the following URL:
|
||||||
|
https://github.com/freqtrade/freqtrade/blob/develop/freqtrade/templates/sample_hyperopt_advanced.py.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
|
@ -22,7 +22,7 @@ class AdvancedSampleHyperOpt(IHyperOpt):
|
|||||||
This is a sample hyperopt to inspire you.
|
This is a sample hyperopt to inspire you.
|
||||||
Feel free to customize it.
|
Feel free to customize it.
|
||||||
|
|
||||||
More information in https://github.com/freqtrade/freqtrade/blob/develop/docs/hyperopt.md
|
More information in the documentation: https://www.freqtrade.io/en/latest/hyperopt/
|
||||||
|
|
||||||
You should:
|
You should:
|
||||||
- Rename the class name to some unique name.
|
- Rename the class name to some unique name.
|
||||||
@ -32,8 +32,9 @@ class AdvancedSampleHyperOpt(IHyperOpt):
|
|||||||
You must keep:
|
You must keep:
|
||||||
- The prototypes for the methods: populate_indicators, indicator_space, buy_strategy_generator.
|
- The prototypes for the methods: populate_indicators, indicator_space, buy_strategy_generator.
|
||||||
|
|
||||||
The roi_space, generate_roi_table, stoploss_space methods are no longer required to be
|
The methods roi_space, generate_roi_table and stoploss_space are not required
|
||||||
copied in every custom hyperopt. However, you may override them if you need the
|
and are provided by default.
|
||||||
|
However, you may override them if you need the
|
||||||
'roi' and the 'stoploss' spaces that differ from the defaults offered by Freqtrade.
|
'roi' and the 'stoploss' spaces that differ from the defaults offered by Freqtrade.
|
||||||
|
|
||||||
This sample illustrates how to override these methods.
|
This sample illustrates how to override these methods.
|
||||||
|
Loading…
Reference in New Issue
Block a user