🎉 快速上手

欢迎使用 BasicTS 教程！本指南将带您逐步完成使用 BasicTS 1.0 训练和评估模型的过程。

在深入之前，我们先简单介绍一下 BasicTS。

什么是 BasicTS？

谁应该使用 BasicTS？

核心功能

现在，让我们开始探索如何通过 BasicTS 实现您的时间序列分析项目吧！

📦 安装 BasicTS

我们建议在 Linux 系统（如 Ubuntu 或 CentOS）上，在 Python 3.8 或更高版本上安装 BasicTS：

pip install basicts

我们推荐使用 Miniconda 或 Anaconda 来创建虚拟 Python 环境。

🔧 安装依赖项

PyTorch

BasicTS 对 PyTorch 版本非常灵活。您可以根据 Python 版本安装 PyTorch。我们建议使用 pip 进行安装。

示例设置

示例 1：Python 3.11 + PyTorch 2.5.1 + CUDA 12.4 (推荐)

# 安装 Python
conda create -n BasicTS python=3.11
conda activate BasicTS
# 安装 PyTorch
pip install torch==2.5.1 torchvision==0.20.1 torchaudio==2.5.1 --index-url https://download.pytorch.org/whl/cu124

示例 2：Python 3.9 + PyTorch 1.10.0 + CUDA 11.1

# 安装 Python
conda create -n BasicTS python=3.9
conda activate BasicTS
# 安装 PyTorch
pip install torch==1.10.0+cu111 torchvision==0.11.0+cu111 torchaudio==0.10.0 -f https://download.pytorch.org/whl/torch_stable.html

🔍 下载数据集

请先从 Google Drive or 百度网盘 下载 datasets.zip 文件。将文件解压到 datasets/ 目录：

cd /path/to/YourProject # not BasicTS/basicts
unzip /path/to/datasets.zip -d datasets/

这些数据集已预处理完毕，可以直接使用。

🎯 快速教程：三句代码训练并评估您的模型

# train.py

from basicts.models.DLinear import DLinear, DLinearConfig
from basicts.configs import BasicTSForecastingConfig
from basicts import BasicTSLauncher

def main():

    # 1. 配置模型
    model_config = DLinearConfig(input_len=336, output_len=336)

    # 2. 配置任务
    cfg = BasicTSForecastingConfig(
        model=DLinear,
        model_config=model_config,
        dataset_name="ETTh1",
        gpus="0",
        ...
    )

    # 3.启动训练
    BasicTSLauncher.launch_training(cfg)

第一步：配置您的模型

BasicTS在basicts.models中提供了大量常用模型，您可以直接使用。BasicTS使用配置类来配置模型，每个配置类包含了对构造模型需要的每个参数的详细描述。例如，DLinear模型的配置类为 DLinearConfig。您可以在 dinear_config.py 中找到DLinearConfig类。

如果您想要使用自己的模型，则需要遵循 BasicTS 的规范，详情请见🧠 深入了解模型设计并构建自定义模型。

第二步：配置您的任务

BasicTS 支持多种时间序列任务，包括预测、插补、分类等。任务配置类是 BasicTS的核心，关于 BasicTS 任务的一切信息都囊括在了任务配置类中，几乎全部配置项都有常用的默认值，您只需配置关键的参数（1️⃣模型，2️⃣数据集），并修改少量配置（如batch size，学习率等），就能运行代码。

进一步，在 BasicTS 的配置类中，您还可以指定回调（callbacks）和任务流（taskflow）用于在训练过程中执行额外的操作（如课程学习）和自定义数据处理流程。关于BasicTS配置类的进阶用法，请见📜 解析配置类设计与进阶配置。

第三步：启动训练

BasicTSLauncher.launch_training 是训练的入口点，调用该方法并传入任务配置即可启动训练。

🥳 运行它！

在您项目的目录下，运行以下命令即可启动训练：

python train.py

在训练中，BasicTS会默认将训练好的模型保存到 checkpoints/ 目录下，并在训练完成后执行评估（可以通过配置更改），您也可以选择将评估指标和结果保存到 checkpoints/ 目录下。

您可以在示例目录中找到更多可运行的实例。

如何评估您的模型

当然，您也可以在训练结束后手动评估模型：BasicTSLauncher.launch_evaluation 是评估的入口点，您可以通过执行下面的Python代码来评估您的模型。

BasicTSLauncher.launch_evaluation(cfg, "checkpoints/your_checkpoint.pt")

🧑‍💻 进一步探索

本教程为您提供了 BasicTS 的基础知识，但还有更多内容等待您探索。在深入其他主题之前，我们先更详细地了解 BasicTS 的结构：

BasicTS 的核心组件包括 Dataset、Scaler、Model、Metrics、Runner 和 Config。

以下是一些高级主题和附加功能，帮助您充分利用 BasicTS：

• 🎉 快速上手
• 💡 了解 BasicTS 的设计理念
• 📦 探索数据集设计并自定义数据集
• 🛠️ 了解数据缩放器设计并创建自定义缩放器
• 🧠 深入了解模型设计并构建自定义模型
• 📉 了解评估指标设计并开发自定义损失函数与评估指标
• 🏃‍♂️ 掌握执行器设计并创建自定义执行器
• 📜 解析配置类设计与进阶配置
• 🎯 探索使用BasicTS进行时间序列分类
• 🔍 探索多种基线模型