AmpyFin 项目的安装与使用指南

1. 项目目录结构及介绍

AmpyFin 项目是一个开源的机器学习交易系统，其目录结构如下：

AmpyFin/
├── .github/
│   └── workflows/
├── helper_files/
├── strategies/
├── utils/
├── wandb/
├── .gitignore
├── .isort.cfg
├── .pre-commit-config.yaml
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── MIT_LICENSE.txt
├── README.md
├── control.py
├── logo.png
├── pyproject.toml
├── ranking_client.py
├── requirements.txt
├── setup.py
├── trading_client.py

• .github/workflows/: 存放 GitHub Actions 工作流文件，用于自动化项目的一些操作，如自动执行测试等。
• helper_files/: 包含一些辅助函数，用于客户端操作。
• strategies/: 实现了各种交易策略的模块。
• utils/: 包含一些通用的数据处理的工具函数。
• wandb/: 用于存储 Weights & Biases 实验的数据。
• .gitignore: 指定 Git 忽略的文件和目录。
• .isort.cfg: Python 代码导入排序配置文件。
• .pre-commit-config.yaml: pre-commit 配置文件，用于自动化代码风格检查。
• CODE_OF_CONDUCT.md: 项目行为准则。
• CONTRIBUTING.md: 贡献指南，描述如何为项目做贡献。
• MIT_LICENSE.txt: 项目使用的 MIT 许可证。
• README.md: 项目说明文件。
• control.py: 配置接口，用于设置交易参数。
• logo.png: 项目图标。
• pyproject.toml: 项目配置文件。
• ranking_client.py: 评估和排名交易策略的客户端。
• requirements.txt: 项目依赖的 Python 包列表。
• setup.py: 项目设置文件，用于初始化数据库结构。
• trading_client.py: 根据算法决策执行交易的客户端。

2. 项目的启动文件介绍

项目的启动主要通过以下两个脚本文件进行：

• ranking_client.py: 此文件用于启动排名系统，它会评估各个交易策略的表现，并根据表现动态调整策略的权重。
• trading_client.py: 此文件用于启动交易系统，它会根据算法决策执行实际的交易操作。

这两个脚本通常需要在不同的终端中分别运行，以实现系统的并行工作。

3. 项目的配置文件介绍

项目的配置主要通过 config.py 文件进行，以下是配置文件的一些基本内容：

# API 密钥配置
POLYGON_API_KEY = "your_polygon_api_key"
FINANCIAL_PREP_API_KEY = "your_fmp_api_key"
API_KEY = "your_alpaca_api_key"
API_SECRET = "your_alpaca_secret_key"
BASE_URL = "https://paper-api.alpaca.markets"  # 默认为纸交易环境

# MongoDB 配置
MONGO_DB_USER = "your_mongo_user"
MONGO_DB_PASS = "your_mongo_password"
mongo_url = "your_mongo_connection_string"

在开始使用项目之前，需要将上述配置中的占位符替换为实际的 API 密钥和 MongoDB 连接信息。此外，如果需要进行实盘交易，需要将 BASE_URL 修改为 "https://api.alpaca.markets"。

以上是 AmpyFin 项目的安装与使用的基础指南，确保按照以上步骤操作后，您可以顺利地运行该项目。