Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add triton kernel docs #575

Open
wants to merge 3 commits into
base: docs
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
94 changes: 94 additions & 0 deletions docs/zh_cn/acceleration/triton_kernels.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
.. _triton_kernels:

使用 Triton Kernel 加速训练
===============================

`Triton <https://github.com/openai/triton>`_ 是一种用于编写高效深度学习算子的编程语言。XTuner 支持使用 Triton Kernel 加速训练。

可通过在环境变量中加入 `USE_TRITON_KERNEL=1` 来启动 Triton Kernel:

.. code:: bash

# 单卡
xtuner train ${CONFIG_NAME_OR_PATH} --deepspeed deepspeed_zero1
# 多卡
(DIST) USE_TRITON_KERNEL=1 NPROC_PER_NODE=${GPU_NUM} xtuner train ${CONFIG_NAME_OR_PATH} --deepspeed deepspeed_zero1
(SLURM) USE_TRITON_KERNEL=1 srun ${SRUN_ARGS} xtuner train ${CONFIG_NAME_OR_PATH} --launcher slurm --deepspeed deepspeed_zero1


RMS Norm Triton Kernel
------------------------

RMS Norm Triton Kernel 支持情况
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. list-table::
:widths: 25 50
:header-rows: 1

* - 模型
- 支持情况
* - internlm 1/2
- ✅
* - llama 2
- ✅
* - mistral
- ✅
* - mixtral
- ✅
* - qwen 1/1.5
- ✅
* - starcoder
- ✅
* - yi
- ✅
* - zephyr
- ✅
* - deepseek
- ✅
* - baichuan 1/2
- ❌
* - chatglm 2/3
- ❌
* - gemma
- ❌
* - cohere (no RMS Norm)
- ❌


加速情况
~~~~~~~~~~~

下表展示了 Qwen 1.5 0.5B 在 Alpaca 数据集上的训练效率对比:

.. list-table::
:widths: 50 25 50 50 25
:header-rows: 1

* - 模型
- 序列长度
- 是否使用 Triton Kernel
- 是否使用 Varlen Attention
- Tokens per Second
* - Qwen 1.5 0.5B
- 32k
- ❌
- ❌
- 13712.7
* - Qwen 1.5 0.5B
- 32k
- ✅
- ❌
- 14690.3
* - Qwen 1.5 0.5B
- 32k
- ❌
- ✅
- 28451.7
* - Qwen 1.5 0.5B
- 32k
- ✅
- ✅
- 33027.5

XTuner 未来会支持更多的 Triton Kernel 以进一步加速训练。
1 change: 1 addition & 0 deletions docs/zh_cn/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@
acceleration/length_grouped_sampler.rst
acceleration/train_large_scale_dataset.rst
acceleration/train_extreme_long_sequence.rst
acceleration/triton_kernels.rst
acceleration/benchmark.rst

.. toctree::
Expand Down