From 219e9d9e2b747a3df8e8d94ea3aab83023ffcd65 Mon Sep 17 00:00:00 2001 From: misagh Date: Sun, 30 Dec 2018 17:14:03 +0100 Subject: [PATCH] optimization page reformatted --- docs/bot-optimization.md | 34 +++++++--------------------------- mkdocs.yml | 2 +- 2 files changed, 8 insertions(+), 28 deletions(-) diff --git a/docs/bot-optimization.md b/docs/bot-optimization.md index 0fc41a2e3..d4402d157 100644 --- a/docs/bot-optimization.md +++ b/docs/bot-optimization.md @@ -1,28 +1,8 @@ -# Bot Optimization +# Optimization This page explains where to customize your strategies, and add new indicators. -## Table of Contents - -- [Install a custom strategy file](#install-a-custom-strategy-file) -- [Customize your strategy](#change-your-strategy) - - [Anatomy of a strategy](#anatomy-of-a-strategy) - - [Customize indicators](#customize-indicators) - - [Buy signal rules](#buy-signal-rules) - - [Sell signal rules](#sell-signal-rules) - - [Minimal ROI](#minimal-roi) - - [Stoploss](#stoploss) - - [Ticker interval](#ticker-interval) - - [Metadata dict](#metadata-dict) - - [Where is the default strategy](#where-is-the-default-strategy) - - [Specify custom strategy location](#specify-custom-strategy-location) - - [Further strategy ideas](#further-strategy-ideas) - -- [Where is the default strategy](#where-is-the-default-strategy) - -Since the version `0.16.0` the bot allows using custom strategy file. - ## Install a custom strategy file This is very simple. Copy paste your strategy file into the folder @@ -60,7 +40,7 @@ A strategy file contains all the information needed to build a good strategy: The bot also include a sample strategy called `TestStrategy` you can update: `user_data/strategies/test_strategy.py`. You can test it with the parameter: `--strategy TestStrategy` -``` bash +```bash python3 ./freqtrade/main.py --strategy AwesomeStrategy ``` @@ -118,10 +98,10 @@ def populate_indicators(self, dataframe: DataFrame, metadata: dict) -> DataFrame return dataframe ``` -#### Want more indicator examples -Look into the [user_data/strategies/test_strategy.py](https://github.com/freqtrade/freqtrade/blob/develop/user_data/strategies/test_strategy.py). -Then uncomment indicators you need. +!!! Note "Want more indicator examples?" + Look into the [user_data/strategies/test_strategy.py](https://github.com/freqtrade/freqtrade/blob/develop/user_data/strategies/test_strategy.py).
+ Then uncomment indicators you need. ### Buy signal rules @@ -187,7 +167,7 @@ This dict defines the minimal Return On Investment (ROI) a trade should reach be It is of the following format, with the dict key (left side of the colon) being the minutes passed since the trade opened, and the value (right side of the colon) being the percentage. -```python +```python minimal_roi = { "40": 0.0, "30": 0.01, @@ -227,7 +207,7 @@ stoploss = -0.10 ``` This would signify a stoploss of -10%. -If your exchange supports it, it's recommended to also set `"stoploss_on_exchange"` in the order dict, so your stoploss is on the exchange and cannot be missed for network-problems (or other problems). +If your exchange supports it, it's recommended to also set `"stoploss_on_exchange"` in the order dict, so your stoploss is on the exchange and cannot be missed for network-problems (or other problems). For more information on order_types please look [here](https://github.com/freqtrade/freqtrade/blob/develop/docs/configuration.md#understand-order_types). diff --git a/mkdocs.yml b/mkdocs.yml index ae66d098b..521528e4b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,7 +4,7 @@ nav: - Installation: pre-requisite.md - Configuratioon: configuration.md - Start the bot: bot-usage.md - - Bot optimization: bot-optimization.md + - Optimization: bot-optimization.md - Backtesting: backtesting.md - Hyperopt: hyperopt.md - Plotting: plotting.md