TrendMaster 项目使用教程

TrendMaster 项目使用教程

TrendMaster Using Transformer deep learning architecture to predict stock prices. 项目地址: https://gitcode.com/gh_mirrors/tr/TrendMaster

1. 目录结构及介绍

TrendMaster 项目的目录结构如下：

TrendMaster/
├── examples/             # 示例代码目录
├── docs/                 # 项目文档目录
├── trendmaster/          # 核心代码模块
│   ├── __init__.py
│   ├── DataLoader.py
│   ├── TransAm.py        # Transformer 模型文件
│   ├── Trainer.py
│   ├── Inferencer.py
│   └── ...
├── tests/                # 测试代码目录
├── .gitignore            # Git 忽略文件
├── CODE_OF_CONDUCT.md    # 项目行为准则
├── CONTRIBUTING.md       # 贡献指南
├── LICENSE               # 项目许可证
├── MANIFEST.in           # 打包配置文件
├── README.md             # 项目说明文件
├── requirements.txt      # 项目依赖文件
└── setup.py              # 项目安装脚本

• examples/：包含了一些使用 TrendMaster 的示例代码。
• docs/：存放了项目的文档，用户可以在这里找到详尽的 API 文档和高级使用说明。
• trendmaster/：这是 TrendMaster 的核心模块，包含了模型定义、数据处理和预测相关的所有代码。
• tests/：包含用于确保代码质量和项目功能的测试代码。
• .gitignore：指定了在 Git 仓库中应该忽略的文件和目录。
• CODE_OF_CONDUCT.md：定义了项目维护者和贡献者的行为准则。
• CONTRIBUTING.md：提供了贡献代码的指南和流程。
• LICENSE：项目遵循的 MIT 许可证。
• MANIFEST.in：包含了打包项目时需要包含的文件列表。
• README.md：项目的说明文件，包含了项目简介、功能、安装和使用方法。
• requirements.txt：列出了项目运行所依赖的 Python 包。
• setup.py：用于安装 TrendMaster 的 Python 脚�步。

2. 项目的启动文件介绍

在 TrendMaster 项目中，并没有一个单一的“启动文件”。项目的使用通常是通过在 Python 环境中导入 TrendMaster 模块并使用其提供的类和方法来实现的。以下是一个简单的启动示例，它演示了如何使用 TrendMaster 来进行股票价格预测：

from trendmaster import DataLoader, TransAm, Trainer, Inferencer, set_seed

# 设置随机种子以保证结果可复现
set_seed(42)

# 初始化 DataLoader 并进行身份验证（需要用户名、密码和 TOTP 密钥）
data_loader = DataLoader()
kite = data_loader.authenticate(user_id='YOUR_ZERODHA_USER_ID', password='YOUR_ZERODHA_PASSWORD', twofa='YOUR_TOTP_CODE')

# 准备训练和测试数据
train_data, test_data = data_loader.prepare_data(symbol='RELIANCE', from_date='2023-01-01', to_date='2023-02-27', input_window=30, output_window=10, train_test_split=0.8)

# 初始化模型、训练器和设备
device = 'cuda' if torch.cuda.is_available() else 'cpu'
model = TransAm(num_layers=2, dropout=0.2).to(device)
trainer = Trainer(model, device, learning_rate=0.001)

# 训练模型
train_losses, val_losses = trainer.train(train_data, test_data, epochs=2, batch_size=64)

# 保存训练好的模型
trainer.save_model('transam_model.pth')

# 使用训练好的模型进行预测
inferencer = Inferencer(model, device, data_loader)
predictions = inferencer.predict(symbol='RELIANCE', from_date='2023-02-27', to_date='2023-12-31', input_window=30, future_steps=10)

3. 项目的配置文件介绍

在 TrendMaster 项目中，主要的配置文件是 requirements.txt 和 setup.py。

• requirements.txt：这个文件列出了项目运行所依赖的外部 Python 包。例如：

numpy==1.21.2
pandas==1.3.0
torch==1.10.0
...

• setup.py：这个文件包含了项目的元数据和安装脚本。例如，它定义了项目的名字、版本、描述、依赖项等。以下是一个简化的 setup.py 文件内容：

from setuptools import setup, find_packages

setup(
    name='TrendMaster',
    version='0.1.0',
    description='Advanced Stock Price Prediction using Transformer Deep Learning',
    author='Hemang Joshi',
    author_email='hemangjoshi37a@gmail.com',
    packages=find_packages(),
    install_requires=[
        'numpy',
        'pandas',
        'torch',
        # 其他依赖
    ],
    # 其他配置项
)

这些配置文件确保了项目的依赖和环境可以正确地设置和管理。

TrendMaster Using Transformer deep learning architecture to predict stock prices. 项目地址: https://gitcode.com/gh_mirrors/tr/TrendMaster