README.md

# GPT2
## 论文
Language Models are Unsupervised Multitask Learners

- https://d4mucfpksywv.cloudfront.net/better-language-models/language-models.pdf

## 模型结构
第二代生成式预训练模型（Generative Pre-Training2），GPT2主要使用Transformer的Decoder模块为特征提取器，并对Transformer Decoder进行了一些改动，原本的Decoder包含了两个Multi-Head Attention结构，而GPT2只保留了Mask Multi-Head Attention。

<img src="./Doc/Images/GPT_03.png" style="zoom:55%;" align=middle>

## 算法原理
GPT-2中使用了掩模自注意力(masked self-attention)，通过屏蔽当前位置的右边token，使模型可以更好的预测下一个token。

<img src="./Doc/Images/GPT_04.png" style="zoom:70%;" align=middle>

## 环境配置
### Docker（方法一）
拉取镜像：
```
docker pull image.sourcefind.cn:5000/dcu/admin/base/migraphx:4.3.0-ubuntu20.04-dtk24.04.1-py3.10
```

创建并启动容器：
```
docker run --shm-size 16g --network=host --name=gpt2_onnxruntime -v /opt/hyhal:/opt/hyhal:ro --privileged --device=/dev/kfd --device=/dev/dri --group-add video --cap-add=SYS_PTRACE --security-opt seccomp=unconfined -v $PWD/gpt2_onnxruntime:/home/gpt2_onnxruntime -it <Your Image ID> /bin/bash

# 激活dtk
source /opt/dtk/env.sh
```
### Dockerfile（方法二）
```
cd ./docker
docker build --no-cache -t gpt2_onnxruntime:2.0 .

docker run --shm-size 16g --network=host --name=gpt2_onnxruntime -v /opt/hyhal:/opt/hyhal:ro --privileged --device=/dev/kfd --device=/dev/dri --group-add video --cap-add=SYS_PTRACE --security-opt seccomp=unconfined -v $PWD/gpt2_onnxruntime:/home/gpt2_onnxruntime -it <Your Image ID> /bin/bash
```

## 数据集
采用交互式界面，通过输入开头诗词，GPT2模型可以推理出后续的诗句。

## 推理
### Python版本推理
本次采用GPT-2模型进行诗词生成任务，模型文件下载链接：https://pan.baidu.com/s/1KWeoUuakCZ5dualK69qCcw , 提取码：4pmh，并将GPT2_shici.onnx模型文件保存在Resource/文件夹下。下面介绍如何运行python代码示例，Python示例的详细说明见Doc目录下的Tutorial_Python.md。
#### 设置Python环境变量
```
export PYTHONPATH=/opt/dtk/lib:$PYTHONPATH
```
#### 安装依赖
```python
# 进入gpt2 onnxruntimet工程根目录
cd <path_to_gpt2_onnxruntime> 

# 进入示例程序目录
cd Python/

# 安装依赖
pip install -r requirements.txt
```
#### 运行示例
```python
python gpt2.py
```
如下所示，采用交互式界面，通过输入开头诗词，GPT2模型可以生成后续的诗句。


### C++版本推理
本次采用GPT-2模型进行诗词生成任务，模型文件下载链接：https://pan.baidu.com/s/1KWeoUuakCZ5dualK69qCcw , 提取码：4pmh ，并将GPT2_shici.onnx模型文件保存在Resource/文件夹下。下面介绍如何运行C++代码示例，C++示例的详细说明见Doc目录下的Tutorial_Cpp.md。
#### 构建工程
```
rbuild build -d depend
```
#### 设置环境变量
将依赖库依赖加入环境变量LD_LIBRARY_PATH，在~/.bashrc中添加如下语句：

```
export LD_LIBRARY_PATH=<path_to_gpt2_onnxruntime>/depend/lib64/:$LD_LIBRARY_PATH
```

然后执行:

```
source ~/.bashrc
source /opt/dtk/env.sh
```
#### 运行示例
```
# 进入gpt2 onnxruntime工程根目录
cd <path_to_gpt2_onnxruntime> 

# 进入build目录
cd build/

# 执行示例程序
./GPT2
```

## result
### python版本
```
user:江上归帆天际开
chatbot:江上归帆天际开，江头别棹日边回。风尘满地音书绝，鸿雁不来春又来。
user:我亦孤山冷淡郎
chatbot:我亦孤山冷淡郎，爱梅不作一般香。水边篱落坡仙笑，羔酒空浇入甲黄。
user:七言绝句
chatbot:七言绝句古无有，五字长城今在前。我欲从君乞妙语，笔端三昧要亲传。
user:春风吹絮满江南
chatbot:春风吹絮满江南，一片离情酒半酣。记得小桥和雪看，梅花无数簇晴岚。
```
### C++版本
```
question：江上归帆天际开
chatbot：江上归帆天际开，江头别棹日边回。风尘满地音书绝，鸿雁不来春又来。
question：我亦孤山冷淡郎
chatbot：我亦孤山冷淡郎，爱梅不作一般香。水边篱落坡仙笑，羔酒空浇入甲黄。
question：七言绝句
chatbot：七言绝句古无有，五字长城今在前。我欲从君乞妙语，笔端三昧要亲传。
question：春风吹絮满江南
chatbot：春风吹絮满江南，一片离情酒半酣。记得小桥和雪看，梅花无数簇晴岚。
```
### 精度
无

## 应用场景

### 算法类别

`对话问答`

### 热点应用行业

`政府`,`零售`,`教育`,`科研`

## 源码仓库及问题反馈

https://developer.sourcefind.cn/codes/modelzoo/gpt2_onnxruntime

## 参考

https://github.com/Morizeyao/GPT2-Chinese