RWKV_Pytorch

这是一个用纯Pytorch原生实现的RWKV大语言模型的推理框架，官方的原生实现过于复杂且无法拓展生态，让我们加入灵活的Pytorch阵营，一起开源起来吧！

This is an inference framework for the RWKV large language model implemented purely in native PyTorch. The official native implementation is overly complex and lacks extensibility. Let's join the flexible PyTorch ecosystem and open-source it together!

特性

• 原生pytorch实现！
• 支持batch推理！
• 支持并行推理！充分发挥RWKV优势！
• 代码整洁，容易阅读和二次开发！
• 支持导出并推理onnx格式模型！

Features

• Native PyTorch implementation!
• Supports batch inference!
• Support parallel inference! Fully leverage the advantages of RWKV!
• Clean codebase, easy to read and extend!
• Supports exporting and inference with ONNX format models!

使用方法

1. 克隆仓库 git clone -b dev https://github.com/yuunnn-w/RWKV_Pytorch.git
2. 执行 cd RWKV_Pytorch 进入仓库目录，执行 pip install -r requirements.txt 安装依赖。
3. 下载 RWKV6 模型，官方仓库地址：BlinkDL/rwkv-6-world，将模型权重放置在weight文件夹中。
4. 修改 main.py 文件的 MODEL_NAME 参数。
5. 执行 python main.py，即可看到batch推理效果。

   流水并行（pipeline parallel）使用方法

6. 克隆仓库 git clone -b pipeline https://github.com/yuunnn-w/RWKV_Pytorch.git
7. 执行 cd RWKV_Pytorch 进入仓库目录，执行 pip install -r requirements.txt 安装依赖。
8. 下载 RWKV6 模型，官方仓库地址：BlinkDL/rwkv-6-world，将模型权重放置在weight文件夹中。
9. 修改 train/params.json 文件的 MODEL_NAME 参数。
10. 执行 torchrun --nproc-per-node 3 train/train-parallel.py开始训练。

Usage

1. Clone the repository: git clone https://github.com/yuunnn-w/RWKV_Pytorch.git
2. Navigate to the repository directory: cd RWKV_Pytorch, then install the dependencies: pip install -r requirements.txt.
3. Download the RWKV6 model from the official repository: BlinkDL/rwkv-6-world, and place the model weights in the weight directory.
4. Modify the MODEL_NAME parameter in the main.py file.
5. Run python main.py to see the batch inference results.

导出onnx方法

1. 修改 onnx_export.py 文件参数为你想导出的模型。
2. 执行 python onnx_export.py 即可导出到./onnx路径。
3. （可选）执行 mkdir ONNX_Simplified 创建一个用于存放简化算子模型的目录。
4. （可选）执行 python simplify_large_onnx.py -m onnx/{model name}.onnx -o ONNX_Simplified/{model name}.onnx 来简化模型，简化后的模型将存放在ONNX_Simplified目录。
5. （可选）修改 onnx_infer.py 文件内的模型路径参数，执行 python onnx_infer.py 即可推理onnx格式模型。

ONNX Export Method

1. Modify the parameters in the onnx_export.py file to specify the model you want to export.
2. Run python onnx_export.py to export the model to the ./onnx directory.
3. (Optional) Create a directory for storing simplified operator models by running mkdir ONNX_Simplified.
4. (Optional) Simplify the model by running python simplify_large_onnx.py -m onnx/{model name}.onnx -o ONNX_Simplified/{model name}.onnx. The simplified model will be stored in the ONNX_Simplified directory.
5. (Optional) Modify the model path parameter in the onnx_infer.py file, then run python onnx_infer.py to perform inference on the ONNX format model.

本地部署体验

1. 修改 openai_api.py 文件中的模型配置参数。
2. 执行 python openai_api.py 即可启动后端。
3. 用任意符合 OpenAI API 规范的客户端，填入 http://127.0.0.1:8848 作为 API_URL 参数，即可体验。

Local Deployment Experience

1. Modify the model configuration parameters in the openai_api.py file.
2. Execute python openai_api.py to start the backend.
3. Use any client that conforms to the OpenAI API specifications, and fill in http://127.0.0.1:8848 as the API_URL parameter to experience it.

已知的问题：

• 已知op17版本才支持LayerNorm算子，op18版本才支持GroupNorm算子，目前torch的preview版本支持op18，但是无法导出，current版本只支持op17，能够正常导出含LayerNorm算子的模型。你可以参照main.py 使用opset参数指定

Known Issues:

• LayerNorm operators are supported in op17 version, while GroupNorm operators are supported in op18 version. The current torch preview version supports op18 but cannot be exported. The current version only supports op17 and can export models containing LayerNorm operators. You can use parameter similar in main.py to support lower op_set versions.

注意，本框架目前仅支持RWKV v6模型，具体版本号为x060

Please note that this framework currently only supports RWKV v6 models, specifically version x060.

预计未来基于本项目适配香橙派推出的AI Pro开发板，实现在昇腾的生态上推理国产大语言模型RWKV！！！

In the future, based on this project, adaptation for the AI Pro development board launched by Xunlong Orange Pi is planned to enable inference of the domestic large language model RWKV on the Ascend ecosystem!!!

另外，经过测试，v6 1.6B导出并优化后的onnx模型含有如下算子：

Additionally, after testing, the ONNX model exported and optimized from v6 1.6B contains the following operators:

• Operator Type: Gather, Count: 145
• Operator Type: Squeeze, Count: 121
• Operator Type: ReduceMean, Count: 148
• Operator Type: Sub, Count: 122
• Operator Type: Mul, Count: 484
• Operator Type: Add, Count: 675
• Operator Type: Sqrt, Count: 74
• Operator Type: Div, Count: 74
• Operator Type: Shape, Count: 240
• Operator Type: Expand, Count: 240
• Operator Type: Range, Count: 72
• Operator Type: Reshape, Count: 384
• Operator Type: Equal, Count: 72
• Operator Type: Where, Count: 72
• Operator Type: Unsqueeze, Count: 192
• Operator Type: Concat, Count: 192
• Operator Type: ScatterND, Count: 72
• Operator Type: MatMul, Count: 337
• Operator Type: Tanh, Count: 48
• Operator Type: Split, Count: 24
• Operator Type: Exp, Count: 48
• Operator Type: Neg, Count: 24
• Operator Type: Sigmoid, Count: 48
• Operator Type: Slice, Count: 24
• Operator Type: Flatten, Count: 24
• Operator Type: Relu, Count: 24

优化模型用到的仓库：onnxsim_large_model

贡献者 (Contributors)

Yuunnn_w

WuTianyi

Zhiyuan Li

Null

技术交流群 (Technical exchange group)

感谢各位大佬做出的贡献！欢迎各路大神为本项目提PR和Issue！你们的贡献对本项目十分有价值！！！

We warmly invite everyone to contribute to the project by submitting PRs and raising Issues! Your input and contributions are highly valued and play a vital role in improving the project for the entire community. Let's collaborate and make this project even better together!