Commit Graph

130 Commits

Author SHA1 Message Date
Robert Caulk 860a4d2390
update doc to reflect better empty dataframe check 2021-05-17 11:40:57 +02:00
Rokas Kupstys 330fb538a9
Couple tweaks for docs. 2021-05-14 10:43:48 +03:00
Rokas Kupstys 9bb6ba086b
Update docs/strategy-advanced.md
Co-authored-by: Matthias <xmatthias@outlook.com>
2021-05-12 17:15:38 +03:00
Rokas Kupstys ad4c51b3c5 * Added "Dataframe access" section showcasing how to obtain dataframe and use it to get last-available and trade-open candles.
* Fix custom_sell() example to use rsi from last-available instead of trade-open candle, add a pointer to "Dataframe access" section for more info.
* Simplify "Custom stoploss using an indicator from dataframe example" greatly, add a pointer to "Dataframe access" section for more info.
2021-05-12 09:30:35 +03:00
Matthias bcab44560a Fix doc typo 2021-05-11 06:25:23 +02:00
Robert Davey 425d97719a
Update strategy-advanced.md
Update custom_sell() example to comment that the current trade row is at trade open as written. Change "abstain" to something clearer for non-fluent English speakers.
2021-05-10 19:42:37 +01:00
Matthias 00e93dad02 Fix mistake in the docs 2021-05-09 10:04:56 +02:00
Rokas Kupstys 17b9e898d2 Update docs displaying how to get last available and trade-open candles. 2021-05-08 18:40:49 +03:00
Rokas Kupstys 6af4de8fe8 Remove dataframe parameter from docs. 2021-05-08 10:29:47 +03:00
Matthias 6b6270db13 Add hint about "sell_profit_only" to docs 2021-05-02 10:37:54 +02:00
Matthias e01bc7717b
Merge pull request #4832 from JoeSchr/patch-3
Add to custom_sell() documentation
2021-05-01 17:34:10 +02:00
Matthias ca0749dfdd
Update strategy-advanced.md 2021-05-01 16:58:14 +02:00
JoeSchr f2bd70dfc2
Add sentence about how it differs from custom_stoploss() 2021-04-29 13:07:22 +02:00
JoeSchr cf839e36f3
Add to custom_sell() documentation
- Flesh out infos about return type 
- give quick example at beginning to get reader in right mindset what this does and why it's useful
2021-04-29 12:49:51 +02:00
JoeSchr 83708ae045
Update strategy-advanced.md
Remove untrue comment probably left-over from more intricate example
2021-04-29 12:16:02 +02:00
Matthias 5bc908870f Fix documentation comment missalignment 2021-04-29 09:07:47 +02:00
Matthias 3285f6caa3 Improve wording in Note box 2021-04-28 20:42:15 +02:00
Matthias 7c8a367442 Update docs to not promote stoploss / take-profit 2021-04-28 20:36:06 +02:00
Matthias dbf33271b5 Small doc changes 2021-04-26 19:52:26 +02:00
Rokas Kupstys 9c21c75cf5 Fix inaccuracy in docs. 2021-04-25 13:18:35 +03:00
Rokas Kupstys e58fe7a8cb Update custom_sell documentation. 2021-04-25 09:48:40 +03:00
Rokas Kupstys 004550529e Document dataframe parameter in custom_stoploss(). 2021-04-25 09:48:40 +03:00
Rokas Kupstys a77337e424 Document IStrategy.custom_sell. 2021-04-25 09:48:40 +03:00
JoeSchr c9c039d640
remove `copy()` from `custom_info` example
`set_index` automatically copies if not stated otherwise with `inplace=True`
> inplacebool, default False
If True, modifies the DataFrame in place (do not create a new object).

from: https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.set_index.html?highlight=set_index#pandas.DataFrame.set_index
2021-04-15 15:21:28 +02:00
Matthias 69799532a6 Document usage of open_date_utc
closes #4580
2021-03-20 08:13:56 +01:00
Matthias dd4d1d82d4
Update docs/strategy-advanced.md 2021-03-18 14:19:33 +01:00
Brook Miles bf14796d4c revert "Trailing stoploss with positive offset" example as stoploss_from_open() wasn't adding value 2021-03-18 21:50:54 +09:00
Matthias b6e9e74a8b Add link between stoploss_from_open and custom_stop documentation 2021-03-18 06:46:08 +01:00
Brook Miles 983c0ef118 update stoploss_from_open examples to use helper function 2021-03-18 09:47:03 +09:00
Brook Miles e924416431 correct math used in examples and clarify some terminology regarding custom stoploss functions 2021-03-14 22:02:53 +09:00
JoeSchr 161a4656d5
Update docs/strategy-advanced.md
Co-authored-by: Matthias <xmatthias@outlook.com>
2021-03-04 20:05:21 +01:00
Joe Schr 1304918a29 fix(docs/strategy-advanced/custom_info-storage/example): only add to "custom_info" in backtesting and hyperopt 2021-03-04 20:03:43 +01:00
Joe Schr 900deb663a fix(docs/strategy-advanced/custom_stoploss/example): check if "pair" exists in "custom_info" before requesting 2021-03-04 20:03:43 +01:00
Joe Schr c56b9cd751 fix(docs/strategy-advanced): add warnings 2021-03-04 20:03:43 +01:00
Joe Schr a6ef354a5f fix(docs/strategy-advanced): use `get_analyzed_dataframe()` instead of `custom_info.iloc` 2021-03-04 20:03:43 +01:00
Joe Schr 22a558e331 fix(docs/strategy-advanced): fix link to custom_info storage 2021-03-04 20:03:42 +01:00
Joe Schr 1a02a146a1 feature(docs/strategy-advanced/custom_info-storage/example): add ATR column calculation 2021-03-04 20:03:42 +01:00
Joe Schr 4064f856d1 fix(docs/strategy-customization): add "hyperopt" to runmode check for custom_info in custom_stoploss example 2021-03-04 20:03:42 +01:00
Joe Schr b52698197b refactor(docs/strategy-advanced): extract "Storing information" section from `strategy-customization.md` 2021-03-04 20:03:42 +01:00
Joe Schr d05acc30fa fix(docs/strategy-customization): remove superflous `prints` from example code 2021-03-04 20:03:42 +01:00
Joe Schr 32f35fcd90 fix(docs/strategy-customization): "custom_stoploss indicator" example need to check for RUN_MODE 2021-03-04 20:03:42 +01:00
Joe Schr c5900bbd38 feature(docs/strategy-customization): add example "Custom stoploss using an indicator from dataframe" 2021-03-04 20:03:42 +01:00
Joe Schr 5cf3194fab chore(docs/strategy-customization): clean up left over trailing whitespaces 2021-03-04 20:03:42 +01:00
JoeSchr e791ff6042
Fix: custom_stoploss returns typo
Afaik it should return -0.07 for 7% instead of -0.7.

As a side note, really interesting would also be an example for greater than 100% profits. especially when trailing stoploss, like
* Once profit is > 200% - stoploss will be set to 150%.

I assume it could be as simple as
```py
if current_profit > 2:
            return (-1.50 + current_profit)
````
to achieve it

But I'm not quite confident, if the bot can handle stuff smaller than `-1`, since `1` and `-1` seem to have some special meaning and are often used to disable stoploss etc.
2021-02-27 23:28:26 +01:00
Matthias a9f1c871dd Add path loading snippet to derived strategies
closes #4279
2021-02-01 19:48:29 +01:00
Matthias 30e5c01cb1 Improve formatting of custom_stoploss docs 2021-01-30 19:59:14 +01:00
Matthias 86b3306a3b Small doc refactoring 2021-01-19 22:07:10 +01:00
hoeckxer 1cf6e2c957 Changed documentation based on review comments
Signed-off-by: hoeckxer <hawkeyenl@yahoo.com>
2021-01-04 14:37:22 +01:00
hoeckxer 0704cfb05b Added an example with a positive offset for a custom stoploss
Signed-off-by: hoeckxer <hawkeyenl@yahoo.com>
2021-01-04 14:14:52 +01:00
Matthias 11f36fbaee Fix all custom stoploss samples 2021-01-02 09:14:31 +01:00
Erwin Hoeckx 67ced6a53c
Update docs/strategy-advanced.md
Co-authored-by: Matthias <xmatthias@outlook.com>
2021-01-01 20:49:04 +01:00
hoeckxer e5840abaf9 Added imports to documentation for clarification when using custom stoploss
Signed-off-by: hoeckxer <hawkeyenl@yahoo.com>
2020-12-31 21:05:47 +01:00
Matthias 512e163355 change docstring to better reflect what the method is for 2020-12-31 09:48:49 +01:00
Matthias fc0d14c1b5 Improve documentation 2020-12-20 19:14:18 +01:00
Matthias 676dd0d664 Improve documentation 2020-12-20 11:22:15 +01:00
Matthias 9d5961e224 Rename method to custom_stoploss 2020-12-20 11:17:50 +01:00
Matthias 277342f167 Rename flag to "use_custom_stoposs" 2020-12-20 11:12:22 +01:00
Matthias 8574751a07 Add stoploss_value to strategy template 2020-12-20 10:49:22 +01:00
Matthias 11e2915621 Fix documentation problem 2020-12-19 17:44:39 +01:00
Matthias b2c1098316 more docs for dynamic stoploss method 2020-12-19 12:03:18 +01:00
Matthias f7b54c2415 Allow and document time-based custom stoploss
closes #3206
2020-12-19 11:46:49 +01:00
Matthias f235ab8cf4 Fix some typos in docs 2020-12-19 11:39:21 +01:00
Matthias 18795844d8 Add initial set of custom stoploss documentation 2020-12-19 11:37:20 +01:00
Matthias 768a24c375 Add stoplossvalue interface 2020-12-18 06:56:56 +01:00
Matthias 5e1032c4af Simplify strategy documentation, move "substrategies" to advanced page 2020-08-08 17:08:38 +02:00
Matthias 75318525a9
Update docs/strategy-advanced.md
Co-authored-by: hroff-1902 <47309513+hroff-1902@users.noreply.github.com>
2020-07-04 16:41:19 +02:00
Matthias c4a9a79be0
Apply suggested documentation changes from code review
Co-authored-by: hroff-1902 <47309513+hroff-1902@users.noreply.github.com>
2020-07-04 09:43:49 +02:00
Matthias eef3c01da7 Fix function header formatting 2020-06-18 19:49:05 +02:00
Matthias e5f7610b5d Add bot basics documentation 2020-06-18 06:50:06 +02:00
Matthias 8b186dbe0e Add additional test scenarios 2020-06-18 06:50:06 +02:00
Matthias 84329ad2ca Add confirm_trade* methods to abort buying or selling 2020-06-18 06:50:06 +02:00
Matthias bc821c7c20 Add documentation for bot_loop_start 2020-06-18 06:50:06 +02:00
hroff-1902 f1367b38a4 Docs: Fix the fix 2020-05-12 14:42:33 +03:00
hroff-1902 e2b9c24856 Docs: Fix sample in strategy-advanced 2020-05-12 13:54:13 +03:00
Matthias 255a43c98e Update price timeout example 2020-04-25 17:25:18 +02:00
Matthias 4d8430c687 Use string typehints to avoid import errors 2020-03-01 09:43:20 +01:00
Matthias d44f6651c4 Fix small parenteses bug 2020-02-25 19:55:23 +01:00
Matthias 47e46bf205 Add second example using dataprovider and current price 2020-02-25 14:48:46 +01:00
Matthias 4a188525ec Fix documentation note syntax 2020-02-22 11:28:13 +01:00
Matthias 63502ed976 Add new advanced-strategy documentation file 2020-02-22 08:14:08 +01:00