开发¶

项目架构¶

FreqAI 的架构和功能经过通用化设计，旨在鼓励开发独特的功能、函数、模型等。

类结构和详细算法概览如下图所示：

如图所示，FreqAI 由三个独立对象组成：

IFreqaiModel - 一个持久化单体对象，包含所有必要逻辑用于收集、存储和处理数据，特征工程，运行训练和推理模型。
FreqaiDataKitchen - 一个非持久化对象，为每个独特的资产/模型单独创建。除元数据外，还包含多种数据处理工具。
FreqaiDataDrawer - 一个持久化单体对象，包含所有历史预测、模型及保存/加载方法。

系统内置了多种预测模型，这些模型直接继承自 IFreqaiModel。每个模型都可以完全访问 IFreqaiModel 中的所有方法，因此可以随意重写任何函数。但高级用户通常会选择重写 fit()、train()、predict() 以及 data_cleaning_train/predict() 方法。

数据处理¶

FreqAI 旨在以简化后处理并增强崩溃恢复能力的方式组织模型文件、预测数据和元数据，通过自动数据重载实现。数据保存在文件结构 user_data_dir/models/ 中，其中包含与训练和回测相关的所有数据。FreqaiDataKitchen() 高度依赖此文件结构进行正确的训练和推理，因此不应手动修改。

文件结构¶

文件结构基于配置文件中设置的模型 identifier 自动生成。以下结构展示了后处理数据的存储位置：

结构	描述
`config_*.json`	模型特定配置文件的副本。
`historic_predictions.pkl`	包含 `identifier` 模型在实盘部署期间生成的所有历史预测的文件。`historic_predictions.pkl` 用于在崩溃或配置更改后重新加载模型。始终保留一个备份文件以防主文件损坏。FreqAI 自动检测损坏并用备份替换损坏的文件。
`pair_dictionary.json`	包含训练队列以及最新训练模型在磁盘上位置的文件。
`sub-train-*_TIMESTAMP`	包含与单个模型相关的所有文件的文件夹，例如：
	`*_metadata.json` - 模型的元数据，例如归一化最大值/最小值、预期训练特征列表等。
	`_model.` - 保存到磁盘的模型文件，用于从崩溃中重新加载。可以是 `joblib`（典型的 boosting 库）、`zip`（stable_baselines）、`hd5`（keras 类型）等。
	`*_pca_object.pkl` - 主成分分析（PCA）变换（如果在配置中设置了 `principal_component_analysis: True`），将用于转换未见过的预测特征。
	`*_svm_model.pkl` - 支持向量机（SVM）模型（如果在配置中设置了 `use_SVM_to_remove_outliers: True`），用于检测未见过的预测特征中的异常值。
	`*_trained_df.pkl` - 包含用于训练 `identifier` 模型的所有训练特征的数据框。这用于计算相异指数（DI），也可用于后处理。
	`*_trained_dates.df.pkl` - 与 `trained_df.pkl` 相关的日期，对后处理很有用。

示例文件结构如下所示：

├── models
│   └── unique-id
│       ├── config_freqai.example.json
│       ├── historic_predictions.backup.pkl
│       ├── historic_predictions.pkl
│       ├── pair_dictionary.json
│       ├── sub-train-1INCH_1662821319
│       │   ├── cb_1inch_1662821319_metadata.json
│       │   ├── cb_1inch_1662821319_model.joblib
│       │   ├── cb_1inch_1662821319_pca_object.pkl
│       │   ├── cb_1inch_1662821319_svm_model.joblib
│       │   ├── cb_1inch_1662821319_trained_dates_df.pkl
│       │   └── cb_1inch_1662821319_trained_df.pkl
│       ├── sub-train-1INCH_1662821371
│       │   ├── cb_1inch_1662821371_metadata.json
│       │   ├── cb_1inch_1662821371_model.joblib
│       │   ├── cb_1inch_1662821371_pca_object.pkl
│       │   ├── cb_1inch_1662821371_svm_model.joblib
│       │   ├── cb_1inch_1662821371_trained_dates_df.pkl
│       │   └── cb_1inch_1662821371_trained_df.pkl
│       ├── sub-train-ADA_1662821344
│       │   ├── cb_ada_1662821344_metadata.json
│       │   ├── cb_ada_1662821344_model.joblib
│       │   ├── cb_ada_1662821344_pca_object.pkl
│       │   ├── cb_ada_1662821344_svm_model.joblib
│       │   ├── cb_ada_1662821344_trained_dates_df.pkl
│       │   └── cb_ada_1662821344_trained_df.pkl
│       └── sub-train-ADA_1662821399
│           ├── cb_ada_1662821399_metadata.json
│           ├── cb_ada_1662821399_model.joblib
│           ├── cb_ada_1662821399_pca_object.pkl
│           ├── cb_ada_1662821399_svm_model.joblib
│           ├── cb_ada_1662821399_trained_dates_df.pkl
│           └── cb_ada_1662821399_trained_df.pkl