TradingGym 开源项目安装与使用指南

TradingGym 开源项目安装与使用指南

TradingGym Trading and Backtesting environment for training reinforcement learning agent or simple rule base algo. 项目地址: https://gitcode.com/gh_mirrors/tr/TradingGym

一、项目概述

TradingGym 是一个专为训练强化学习算法及简单规则基础算法设计的交易和回测环境。本项目受到 OpenAI Gym 的启发，模仿其框架设计，不仅支持训练环境，还提供了回测功能，并计划未来实现集成券商API的实时交易环境。它适用于基于tick数据和OHLC（开盘价、最高价、最低价、收盘价）格式的数据进行策略开发。

二、项目目录结构及介绍

以下是TradingGym的基本目录结构及其简要说明：

TradingGym/
├── dataset       - 存放示例数据集的目录。
├── fig           - 可能存放项目相关的图表或图像文件。
├── trading_env   - 核心交易环境的代码文件夹。
├── .gitignore    - 忽略不需要纳入版本控制的文件列表。
├── travis.yml    - Travis CI 配置文件，用于自动化测试等。
├── LICENSE       - 许可证文件，表明软件遵循MIT协议。
├── README.md     - 项目的主要说明文档，介绍项目详情和快速入门指导。
└── setup.py      - Python包的安装脚本，用于部署项目到本地环境中。

三、项目启动文件介绍

在TradingGym中，并没有一个明确标记为“启动文件”的单一入口点，但通过Python脚本可以很容易地开始使用。一个典型的启动过程涉及导入trading_env模块并创建环境实例。比如，以下是在Python中初始化环境的示例代码段：

import trading_env
df = pd.read_hdf('path_to_your_dataset.h5', 'key_of_df')
env = trading_env.make(env_id='your_environment_id', ..., df=df, ...)

这里，主要通过调用trading_env.make()函数来设置和初始化特定的交易环境。

四、项目配置文件介绍

TradingGym并没有提供传统意义上的独立配置文件，如.ini或.yaml，它的配置是通过调用trading_env.make()时传入的参数进行的。这些参数包括但不限于env_id、观察数据长度(obs_data_len)、步长(step_len)、数据DataFrame(df)、手续费(fee)等，允许用户灵活定制交易环境。因此，在使用时，用户应关注如何在代码中组织这些配置参数，以适应不同的实验需求。

示例配置参数:

• env_id: 环境标识符，定义了不同的训练或回测场景。
• obs_data_len: 观察数据的长度，用于决定状态空间大小。
• step_len: 模拟时间步进的长度。
• df: 包含历史交易数据的数据框，用于构建交易环境的基础数据。
• feature_names: 使用的特征列名列表，影响输入状态的构造。

总结， TradingGym通过动态参数传递而非静态配置文件的方式实现了高度定制化的配置管理，使得开发者能够在代码层面直接调整和优化他们的交易模拟环境。

TradingGym Trading and Backtesting environment for training reinforcement learning agent or simple rule base algo. 项目地址: https://gitcode.com/gh_mirrors/tr/TradingGym