文本分类基准测试

PyTorch 中的文本分类基准测试

动机

我们正在构建一个文本分类基准测试，其中包括

许多文本分类 数据集，涵盖情感/主题分类以及多种流行语言（例如英语和中文）。同时，还提供基础的词嵌入。

实现许多流行且最先进的 模型，尤其是在深度神经网络领域。

已完成的工作

我们已经完成了一些数据集和模型。

已完成的数据集

• IMDB
• SST
• TREC

已完成的模型

• FastText
• 基础 CNN（KimCNN、多层 CNN、多视角 CNN）
• InceptionCNN
• LSTM（BiLSTM、StackLSTM）
• 带注意力机制的 LSTM（自注意力 / 量子注意力）
• CNN 和 RNN 的混合模型（RCNN、C-LSTM）
• Transformer - Attention is all you need
• ConS2S
• Capsule
• 量子启发式神经网络

库依赖

您需要安装这些库

python3
torch
torchtext（可选）

数据集

数据集将自动配置在当前路径下，或者您可以按照数据集配置文档中的步骤手动下载数据。

包括：

Glove 词嵌入
IMDB 情感分类数据集

使用方法

使用默认设置运行

python main.py

CNN

python main.py --model cnn

LSTM

python main.py --model lstm

路线图

• 数据预处理框架
• 模型模块
• 损失函数、评估器及超参数调优。
• 测试模块
• 更多数据集
• 更多模型

仓库组织结构

该仓库的核心是模型和数据集。

• dataloader/: 加载所有数据集，如IMDB、SST等。

• models/: 创建所有模型，如FastText、LSTM、CNN、Capsule、QuantumCNN、多头注意力等。

• opts.py: 参数和配置信息。

• utils.py: 工具函数。

• dataHelper: 数据辅助工具。

贡献者

• @Allenzhai
• @JaredWei
• @AlexMeng
• @Lilianwang
• @ZhanSu
• @Wabywang

欢迎提出问题和贡献！！！

TextClassificationBenchmark 快速上手指南

TextClassificationBenchmark 是一个基于 PyTorch 的文本分类基准测试工具，集成了多种主流数据集（如 IMDB、SST、TREC）和前沿深度学习模型（如 CNN、LSTM、Transformer、Capsule 等），支持中英文任务及基础词向量。

环境准备

系统要求

• 操作系统：Linux / macOS / Windows
• Python 版本：Python 3.x

前置依赖 本项目核心依赖如下：

• python3
• torch (PyTorch)
• torchtext (可选，用于简化数据加载)

国内加速建议：安装 PyTorch 时，推荐使用清华或中科大镜像源以提升下载速度。 例如使用 pip 安装：

pip install torch torchvision torchaudio -i https://pypi.tuna.tsinghua.edu.cn/simple

安装步骤

1. 克隆仓库 将项目代码下载到本地：

   git clone <repository_url>
   cd TextClassificationBenchmark
   

2. 安装依赖库 确保已安装 Python 3，然后安装必要的 Python 包：

   pip install torch
   pip install torchtext
   

   (注：若仅需运行基础功能，torchtext 为可选依赖)

3. 配置数据集 数据集将在首次运行时自动配置并下载到当前路径。

   • 默认包含：Glove 词向量、IMDB 情感分类数据集等。
   • 如需手动下载或配置其他数据集（如 SST, TREC），请参考 docs/data_config_en.md 文档。

基本使用

所有实验均通过 main.py 脚本启动。

1. 使用默认设置运行 默认情况下，系统将使用预设模型和数据集进行训练与评估：

python main.py

2. 指定模型运行 您可以通过 --model 参数选择特定的深度学习模型：

• 运行 CNN 模型（包含 KimCNN, MultiLayerCNN 等变体）：

  python main.py --model cnn
  

• 运行 LSTM 模型（包含 BiLSTM, StackLSTM 等变体）：

  python main.py --model lstm
  

提示：更多模型选项（如 transformer, capsule, fasttext 等）可直接替换上述命令中的模型名称，具体支持的模型列表请参阅 models/ 目录。