Gym-Trading-Env 项目使用教程-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00682/article/details/142609768

Gym-Trading-Env 项目使用教程

Gym-Trading-Env A simple, easy, customizable Gymnasium environment for trading. 项目地址: https://gitcode.com/gh_mirrors/gy/Gym-Trading-Env

1. 项目目录结构及介绍

Gym-Trading-Env/
├── docs/
│   └── ...
├── examples/
│   └── ...
├── readme_images/
│   └── ...
├── src/
│   └── gym_trading_env/
│       ├── __init__.py
│       ├── environment.py
│       └── ...
├── .gitignore
├── readthedocs.yaml
├── LICENSE.txt
├── MANIFEST.in
├── README.md
└── pyproject.toml

目录结构介绍

docs/: 存放项目的文档文件，通常包含项目的详细说明、API文档等。
examples/: 存放项目的示例代码，帮助用户快速上手和理解项目。
readme_images/: 存放README文件中使用的图片资源。
src/gym_trading_env/: 项目的核心代码目录，包含环境定义、交易逻辑等。
- init.py: 模块初始化文件。
- environment.py: 定义交易环境的文件。
.gitignore: Git忽略文件，指定哪些文件或目录不需要被Git管理。
readthedocs.yaml: 用于配置ReadTheDocs文档服务的文件。
LICENSE.txt: 项目的开源许可证文件。
MANIFEST.in: 用于指定在打包时需要包含的非Python文件。
README.md: 项目的介绍文件，通常包含项目的基本信息、安装方法、使用说明等。
pyproject.toml: 项目的配置文件，用于指定项目的依赖、构建工具等。

2. 项目启动文件介绍

项目的启动文件通常是指用户在安装并配置好项目后，直接运行的文件。在 Gym-Trading-Env 项目中，启动文件可能是一个示例脚本，位于 examples/ 目录下。

例如，假设有一个启动文件 examples/run_example.py，其内容可能如下：

from src.gym_trading_env import TradingEnv

# 创建环境实例
env = TradingEnv()

# 运行环境
env.run()

启动文件介绍

examples/run_example.py: 这是一个示例启动脚本，用户可以通过运行此脚本来启动交易环境并执行交易策略。

3. 项目的配置文件介绍

在 Gym-Trading-Env 项目中，配置文件通常用于指定项目的依赖、构建工具、文档生成工具等。主要的配置文件是 pyproject.toml。

`pyproject.toml` 配置文件介绍

[build-system]
requires = ["setuptools>=42", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "gym-trading-env"
version = "0.1.0"
description = "A simple, easy, customizable Gymnasium environment for trading"
authors = [
    { name="Clement Perroud", email="clement.perroud@example.com" }
]
dependencies = [
    "numpy",
    "pandas",
    "gymnasium"
]

[tool.setuptools]
packages = ["gym_trading_env"]