adelorenzo/stable
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Reorganise multipage doc

Browse Source
This commit is contained in:
th0rntwig
2022-09-17 17:43:39 +02:00
parent ede282392f
commit c210d6614c
10 changed files with 359 additions and 392 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
docs/freqai-developers.md
View File

@@ -1,28 +1,15 @@
# Development
The class structure and details algorithmic overview is depicted in the following diagram:
The architechture and functions of FreqAI are generalized to encourage users to develop their own features, functions, models, etc.
The class structure and a detailed algorithmic overview is depicted in the following diagram:
![image](assets/freqai_algorithm-diagram.jpg)
As shown, there are three distinct objects comprising `FreqAI`:
As shown, there are three distinct objects comprising FreqAI:
* IFreqaiModel
* Singular persistent object containing all the necessary logic to collect data, store data, process data, engineer features, run training, and inference models.
* FreqaiDataKitchen
* A non-persistent object which is created uniquely for each unique asset/model. Beyond metadata, it also contains a variety of data processing tools.
* FreqaiDataDrawer
* Singular persistent object containing all the historical predictions, models, and save/load methods.
* **IFreqaiModel** - A singular persistent object containing all the necessary logic to collect, store, and process data, engineer features, run training, and inference models.
* **FreqaiDataKitchen** - A non-persistent object which is created uniquely for each unique asset/model. Beyond metadata, it also contains a variety of data processing tools.
* **FreqaiDataDrawer** - A singular persistent object containing all the historical predictions, models, and save/load methods.
There are a variety of built-in prediction models which inherit directly from `IFreqaiModel` including:
* CatboostRegressor
* CatboostRegressorMultiTarget
* CatboostClassifier
* LightGBMRegressor
* LightGBMRegressorMultiTarget
* LightGBMClassifier
* XGBoostRegressor
* XGBoostRegressorMultiTarget
* XGBoostClassifier
Each of these have full access to all methods in `IFreqaiModel`. And can therefore, override any of those functions at will. However, advanced users will likely stick to overriding `fit()`, `train()`, `predict()`, and `data_cleaning_train/predict()`.
There are a variety of built-in [prediction models](freqai-configuration.md#using-different-prediction-models) which inherit directly from `IFreqaiModel`. Each of these models have full access to all methods in `IFreqaiModel` and can therefore override any of those functions at will. However, advanced users will likely stick to overriding `fit()`, `train()`, `predict()`, and `data_cleaning_train/predict()`.