# Chinese-Couplets-Generator-based-on-Transformer

**Repository Path**: marquis03/Chinese-Couplets-Generator-based-on-Transformer

## Basic Information

- **Project Name**: Chinese-Couplets-Generator-based-on-Transformer
- **Description**: 基于 Transformer 的中文对联生成器(Chinese Couplets Generator Based on Transformer)
- **Primary Language**: Python
- **License**: GPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 1
- **Created**: 2024-02-28
- **Last Updated**: 2025-07-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: PyTorch

## README

# 基于 Transformer 的中文对联生成器(Chinese Couplets Generator Based on Transformer)

## 目录(Table of Contents)

- [基于 Transformer 的中文对联生成器(Chinese Couplets Generator Based on Transformer)](#基于-transformer-的中文对联生成器chinese-couplets-generator-based-on-transformer)
  - [目录(Table of Contents)](#目录table-of-contents)
  - [简介(Introduction)](#简介introduction)
    - [项目结构(Structure)](#项目结构structure)
  - [部署(Deployment)](#部署deployment)
    - [克隆项目(Clone Project)](#克隆项目clone-project)
    - [安装依赖(Requirements)](#安装依赖requirements)
    - [训练模型(Train Model)](#训练模型train-model)
    - [启动 Web UI(Start Web UI)](#启动-web-uistart-web-ui)
  - [项目演示(Demo)](#项目演示demo)
    - [Web UI](#web-ui)
    - [学习率变化(Learning Rate Schedule)](#学习率变化learning-rate-schedule)
    - [训练历史(Training History)](#训练历史training-history)
  - [Star History Chart](#star-history-chart)

## 简介(Introduction)

本项目是一个**基于 Transformer 的中文对联生成器**，使用 PyTorch 构建模型，使用 Gradio 构建 Web UI。

数据集：[https://www.kaggle.com/datasets/marquis03/chinese-couplets-dataset](https://www.kaggle.com/datasets/marquis03/chinese-couplets-dataset)

GitHub 仓库：[https://github.com/Marquis03/Chinese-Couplets-Generator-based-on-Transformer](https://github.com/Marquis03/Chinese-Couplets-Generator-based-on-Transformer)

Gitee 仓库：[https://gitee.com/marquis03/Chinese-Couplets-Generator-based-on-Transformer](https://gitee.com/marquis03/Chinese-Couplets-Generator-based-on-Transformer)

---

This project is a **Chinese Couplets Generator** based on Transformer, using PyTorch to build the model and Gradio to build the Web UI.

Dataset: [https://www.kaggle.com/datasets/marquis03/chinese-couplets-dataset](https://www.kaggle.com/datasets/marquis03/chinese-couplets-dataset)

GitHub Repository: [https://github.com/Marquis03/Chinese-Couplets-Generator-based-on-Transformer](https://github.com/Marquis03/Chinese-Couplets-Generator-based-on-Transformer)

Gitee Repository: [https://gitee.com/marquis03/Chinese-Couplets-Generator-based-on-Transformer](https://gitee.com/marquis03/Chinese-Couplets-Generator-based-on-Transformer)

### 项目结构(Structure)

```text
.
├── config
│   ├── __init__.py
│   └── config.py
├── data
│   ├── fixed_couplets_in.txt
│   └── fixed_couplets_out.txt
├── dataset
│   ├── __init__.py
│   └── dataset.py
├── img
│   ├── history.png
│   ├── lr_schedule.png
│   └── webui.gif
├── model
│   ├── __init__.py
│   └── model.py
├── trained
│   ├── vocab.pkl
│   └── CoupletsTransformer_best.pth
├── utils
│   ├── __init__.py
│   └── EarlyStopping.py
├── LICENSE
├── README.md
├── requirements.txt
├── train.py
└── webui.py
```

## 部署(Deployment)

### 克隆项目(Clone Project)

```bash
git clone https://github.com/Marquis03/Chinese-Couplets-Generator-based-on-Transformer.git
cd Chinese-Couplets-Generator-based-on-Transformer
```

### 安装依赖(Requirements)

```bash
pip install -r requirements.txt
```

### 训练模型(Train Model)

```bash
python train.py
```

Kaggle Notebook: [https://www.kaggle.com/code/marquis03/chinese-couplets-generator-based-on-transformer](https://www.kaggle.com/code/marquis03/chinese-couplets-generator-based-on-transformer)

### 启动 Web UI(Start Web UI)

```bash
python webui.py
```

## 项目演示(Demo)

### Web UI

![Web UI](./img/webui.gif)

### 学习率变化(Learning Rate Schedule)

![Learning Rate Schedule](./img/lr_schedule.png)

### 训练历史(Training History)

![Training History](./img/history.png)

## Star History Chart

[![Star History Chart](https://api.star-history.com/svg?repos=Marquis03/Chinese-Couplets-Generator-based-on-Transformer&type=Date)](https://star-history.com/#Marquis03/Chinese-Couplets-Generator-based-on-Transformer&Date)