diff --git a/main/index.html b/main/index.html index 99ddaa2e..4d8a3fb3 100644 --- a/main/index.html +++ b/main/index.html @@ -550,6 +550,7 @@
Technical is a companion project for Freqtrade. It includes technical indicators, as well as helpful utilities (e.g. timeframe resampling) aimed to assist in strategy development for Freqtrade.
"},{"location":"#what-does-it-do-for-you","title":"What does it do for you","text":"Technical provides easy to use indicators, collected from all over github, as well as custom methods. Over time we plan to provide a simple API wrapper around TA-Lib, PyTi and others, as we find them. So you have one place, to find 100s of indicators.
"},{"location":"#custom-indicators","title":"Custom indicators","text":"The following indicators are available and have been 'wrapped' to be used on a dataframe with the standard open/close/high/low/volume columns:
We will try to add more and more wrappers as we get to it, but please be patient or help out with PR's! It's super easy, but also super boring work.
"},{"location":"#usage","title":"Usage","text":"to use the library, please install it with pip
pip install technical\n
To get the latest version, install directly from github:
pip install git+https://github.com/freqtrade/technical\n
and then import the required packages
from technical.indicators import accumulation_distribution, ...\nfrom technical.util import resample_to_interval, resampled_merge\n\n# Assuming 1h dataframe -resampling to 4h:\ndataframe_long = resample_to_interval(dataframe, 240) # 240 = 4 * 60 = 4h\n\ndataframe_long['rsi'] = ta.RSI(dataframe_long)\n# Combine the 2 dataframes\ndataframe = resampled_merge(dataframe, dataframe_long, fill_na=True)\n\n\"\"\"\nThe resulting dataframe will have 5 resampled columns in addition to the regular columns,\nfollowing the template resample_<interval_in_minutes>_<orig_column_name>.\nSo in the above example:\n['resample_240_open', 'resample_240_high', 'resample_240_low','resample_240_close', 'resample_240_rsi']\n\"\"\"\n
"},{"location":"#contributions","title":"Contributions","text":"We will happily add your custom indicators to this repo! Just clone this repository and implement your favorite indicator to use with Freqtrade and create a Pull Request.
Have fun!
"},{"location":"developer/","title":"Developer documentation","text":"This page is intended for developers of the technical
library, people who want to contribute to the technical
codebase or documentation, or people who want to understand the source code of the application they're running.
All contributions, bug reports, bug fixes, documentation improvements, enhancements and ideas are welcome. We track issues on GitHub. For generic questions, please use the discord server, where you can ask questions.
"},{"location":"developer/#releases","title":"Releases","text":"Bump the __version__
naming in technical/__init__.py
and create a new release on github with a matching tag.
Note
Version numbers must follow allowed versions from PEP0440 to avoid failures pushing to pypi.
"},{"location":"developer/#pypi","title":"Pypi","text":"Pypi releases happen automatically on a new release through github actions.
"},{"location":"general-usage/","title":"General Usage","text":"After installation, technical can be imported and used in your code.
We recommend to import freqtrade.indicators as ftt to avoid conflicts with other libraries, and to help determining where indicator calculations came from.
import technical.indicators as ftt\n\n# The indicator calculations can now be used as follows:\n\ndataframe['cmf'] = ftt.chaikin_money_flow(dataframe)\n
"},{"location":"general-usage/#indicator-functions","title":"Indicator functions","text":"All built in indicators are designed to work with a pandas DataFrame as provided by freqtrade, containing the standard columns: open, high, low, close and volume. This dataframe should be provided as the first argument to the indicator function. Depending on the indicator, additional parameters may be required.
"},{"location":"general-usage/#return-type","title":"Return type","text":"Depending on the indicator, the return type may be a pandas Series, a tuple of pandas Series, or a pandas DataFrame.
"},{"location":"general-usage/#resample-to-interval","title":"Resample to interval","text":"The helper methods resample_to_interval
and resampled_merge
are used to resample a dataframe to a higher timeframe and merge the resampled dataframe back into the original dataframe. This is an alternative approach to using informative pairs and reduces the amount of data needed from the exchange (you don't need to download 4h candles in the below example).
from pandas import DataFrame\nfrom technical.util import resample_to_interval, resampled_merge\nimport technical.indicators as ftt\n\ntimeframe = '1h'\n\ndef populate_indicators(self, dataframe: DataFrame, metadata: dict) -> DataFrame:\n\n # Resampling to 4h:\n dataframe_long = resample_to_interval(dataframe, 240) # 240 = 4 * 60 = 4h\n\n dataframe_long['cmf'] = ftt.chaikin_money_flow(dataframe_long)\n # Combine the 2 dataframes\n dataframe = resampled_merge(dataframe, dataframe_long, fill_na=True)\n\n\n # The resulting dataframe will have 5 resampled columns in addition to the regular columns,\n # following the template resample_<interval_in_minutes>_<orig_column_name>.\n # So in the above example, the column names would be:\n # ['resample_240_open', 'resample_240_high', 'resample_240_low','resample_240_close', 'resample_240_cmf']\n\n return dataframe\n
"}]}
\ No newline at end of file
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Technical","text":"Technical is a companion project for Freqtrade. It includes technical indicators, as well as helpful utilities (e.g. timeframe resampling) aimed to assist in strategy development for Freqtrade.
"},{"location":"#what-does-it-do-for-you","title":"What does it do for you","text":"Technical provides easy to use indicators, collected from all over github, as well as custom methods. Over time we plan to provide a simple API wrapper around TA-Lib, PyTi and others, as we find them. So you have one place, to find 100s of indicators.
"},{"location":"#custom-indicators","title":"Custom indicators","text":"The following indicators are available and have been 'wrapped' to be used on a dataframe with the standard open/close/high/low/volume columns:
We will try to add more and more wrappers as we get to it, but please be patient or help out with PR's! It's super easy, but also super boring work.
"},{"location":"#usage","title":"Usage","text":"to use the library, please install it with pip
pip install technical\n
To get the latest version, install directly from github:
pip install git+https://github.com/freqtrade/technical\n
and then import the required packages
from technical.indicators import accumulation_distribution, ...\nfrom technical.util import resample_to_interval, resampled_merge\n\n# Assuming 1h dataframe -resampling to 4h:\ndataframe_long = resample_to_interval(dataframe, 240) # 240 = 4 * 60 = 4h\n\ndataframe_long['rsi'] = ta.RSI(dataframe_long)\n# Combine the 2 dataframes\ndataframe = resampled_merge(dataframe, dataframe_long, fill_na=True)\n\n\"\"\"\nThe resulting dataframe will have 5 resampled columns in addition to the regular columns,\nfollowing the template resample_<interval_in_minutes>_<orig_column_name>.\nSo in the above example:\n['resample_240_open', 'resample_240_high', 'resample_240_low','resample_240_close', 'resample_240_rsi']\n\"\"\"\n
"},{"location":"#contributions","title":"Contributions","text":"We will happily add your custom indicators to this repo! Just clone this repository and implement your favorite indicator to use with Freqtrade and create a Pull Request.
Have fun!
"},{"location":"developer/","title":"Developer documentation","text":"This page is intended for developers of the technical
library, people who want to contribute to the technical
codebase or documentation, or people who want to understand the source code of the application they're running.
All contributions, bug reports, bug fixes, documentation improvements, enhancements and ideas are welcome. We track issues on GitHub. For generic questions, please use the discord server, where you can ask questions.
"},{"location":"developer/#releases","title":"Releases","text":"Bump the __version__
naming in technical/__init__.py
and create a new release on github with a matching tag.
Note
Version numbers must follow allowed versions from PEP0440 to avoid failures pushing to pypi.
"},{"location":"developer/#pypi","title":"Pypi","text":"Pypi releases happen automatically on a new release through github actions.
"},{"location":"general-usage/","title":"General Usage","text":"After installation, technical can be imported and used in your code.
We recommend to import freqtrade.indicators as ftt to avoid conflicts with other libraries, and to help determining where indicator calculations came from.
import technical.indicators as ftt\n\n# The indicator calculations can now be used as follows:\n\ndataframe['cmf'] = ftt.chaikin_money_flow(dataframe)\n
"},{"location":"general-usage/#indicator-functions","title":"Indicator functions","text":"All built in indicators are designed to work with a pandas DataFrame as provided by freqtrade, containing the standard columns: open, high, low, close and volume. This dataframe should be provided as the first argument to the indicator function. Depending on the indicator, additional parameters may be required.
"},{"location":"general-usage/#return-type","title":"Return type","text":"Depending on the indicator, the return type may be a pandas Series, a tuple of pandas Series, or a pandas DataFrame.
"},{"location":"general-usage/#resample-to-interval","title":"Resample to interval","text":"The helper methods resample_to_interval
and resampled_merge
are used to resample a dataframe to a higher timeframe and merge the resampled dataframe back into the original dataframe. This is an alternative approach to using informative pairs and reduces the amount of data needed from the exchange (you don't need to download 4h candles in the below example).
from pandas import DataFrame\nfrom technical.util import resample_to_interval, resampled_merge\nimport technical.indicators as ftt\n\ntimeframe = '1h'\n\ndef populate_indicators(self, dataframe: DataFrame, metadata: dict) -> DataFrame:\n\n # Resampling to 4h:\n dataframe_long = resample_to_interval(dataframe, 240) # 240 = 4 * 60 = 4h\n\n dataframe_long['cmf'] = ftt.chaikin_money_flow(dataframe_long)\n # Combine the 2 dataframes\n dataframe = resampled_merge(dataframe, dataframe_long, fill_na=True)\n\n\n # The resulting dataframe will have 5 resampled columns in addition to the regular columns,\n # following the template resample_<interval_in_minutes>_<orig_column_name>.\n # So in the above example, the column names would be:\n # ['resample_240_open', 'resample_240_high', 'resample_240_low','resample_240_close', 'resample_240_cmf']\n\n return dataframe\n
"}]}
\ No newline at end of file