Skip to content

Add lightllm kernel #925

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

Open
wants to merge 17 commits into
base: main
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "third-party/cutlass"]
path = third-party/cutlass
url = https://github.com/NVIDIA/cutlass.git
11 changes: 11 additions & 0 deletions docs/CN/source/getting_started/multimodal_model_quickstart.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
..multimodal_model_quickstart.rst
-------------------------

下载多模态模型(如llava系列、internvl系列、qwen_vl系列等)的模型以后,在终端使用下面的代码部署API服务:

.. code-block:: console

$ python -m lightllm.server.api_server --model_dir ~/models/llava-7b-chat --use_dynamic_prompt_cache --enable_multimodal

.. note::
上面代码中的 ``--model_dir`` 参数需要修改为你本机实际的模型路径。
65 changes: 65 additions & 0 deletions lightllm-kernel/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
cmake_minimum_required(VERSION 3.22)
project(lightllm_kernel LANGUAGES CXX CUDA)

# GPU 架构:缺省支持 A100(80)、Ampere(86)、Ada/L40s/4090(89)、Hopper(90),
if(NOT CMAKE_CUDA_ARCHITECTURES)
set(CMAKE_CUDA_ARCHITECTURES 80;86;89;90)
endif()

# 找 PyTorch & Python
find_package(Torch REQUIRED)
find_package(Python REQUIRED COMPONENTS Development)
find_package(CUDAToolkit REQUIRED)

# 收集 csrc 下的 .cpp/.cu
file(GLOB_RECURSE SRC_CPP CONFIGURE_DEPENDS "${PROJECT_SOURCE_DIR}/csrc/*.cpp")
file(GLOB_RECURSE SRC_CUDA CONFIGURE_DEPENDS "${PROJECT_SOURCE_DIR}/csrc/*.cu")
Comment on lines +15 to +16

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Using file(GLOB_RECURSE) can be convenient during development, but it's generally discouraged for production CMake builds. If new source files are added, CMake won't automatically detect them unless it's re-run, which can lead to build issues. Explicitly listing source files is more robust. Could you consider if explicitly listing sources would be more appropriate here, or if the current approach is preferred for ease of development within this kernel library?


# 编译生成 Python 扩展, _C.so
if (NOT TARGET _C)
add_library(_C SHARED ${SRC_CPP} ${SRC_CUDA})

# C++17 更方便调度宏
target_compile_features(_C PRIVATE cxx_std_17)
target_include_directories(_C PRIVATE
${TORCH_INCLUDE_DIRS}
${CUDAToolkit_INCLUDE_DIRS}
${PROJECT_SOURCE_DIR}/include
${PROJECT_SOURCE_DIR}/csrc
${PROJECT_SOURCE_DIR}/../third-party/cutlass/include
)
target_link_libraries(_C
PRIVATE
${TORCH_LIBRARIES}
Python::Python
CUDA::cudart
CUDA::cuda_driver)


# 输出文件名 _C.so,无前缀
set_target_properties(_C PROPERTIES
PREFIX ""
OUTPUT_NAME "_C"
BUILD_RPATH "\$ORIGIN;\$ORIGIN/../torch/lib"
INSTALL_RPATH "\$ORIGIN;\$ORIGIN/../torch/lib"
)
endif()
# 安装:把 _C.so、Python 包和 csrc 一起拷到 site-packages
include(GNUInstallDirs)

# 1) 计算 Python site-packages 路径

message(STATUS "Installing to ARCH = ${Python_SITEARCH}")
message(STATUS "Installing to PURE = ${Python_SITELIB}")

# 2) 安装编译好的 _C.so 到 lightllm_kernel 目录
install(TARGETS _C
LIBRARY DESTINATION ${Python_SITEARCH}/lightllm_kernel)

# 3) 安装 Python 源码包
install(DIRECTORY ${PROJECT_SOURCE_DIR}/lightllm_kernel
DESTINATION ${Python_SITELIB})

# 4) 安装 csrc 源码以供 JIT fallback
install(DIRECTORY ${PROJECT_SOURCE_DIR}/csrc
DESTINATION ${Python_SITELIB}/lightllm_kernel)
202 changes: 202 additions & 0 deletions lightllm-kernel/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
14 changes: 14 additions & 0 deletions lightllm-kernel/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.PHONY: build clean submodule

SUBMODULE_DIR = third-party/cutlass

submodule:
git submodule update --init --recursive

build: submodule
# 8.0-> A100, 8.6-> A10, 8.9-> L40s/4090, 9.0+PTX-> Hopper
TORCH_CUDA_ARCH_LIST="8.0;8.6;8.9;9.0+PTX" \
python -m pip install -v .

clean:
rm -rf build dist *.egg-info
42 changes: 42 additions & 0 deletions lightllm-kernel/README-CH.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# LightLLM-Kernel

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

lightllm-kernel 是大模型推理系统 LightLLM 的 CUDA 算子库。它提供了在大型模型推理过程中所需的一系列自定义 GPU 运算算子,以加速关键步骤的计算。

## 功能列表

| Module | Description |
|--------------|-------------------------------------------------------------------------------------------------|
| **Attention** | Optimized Multi-Head Attention kernels with fused QKV operations and efficient softmax |
| **MoE** | Expert routing and computation kernels for Mixture-of-Experts architectures |
| **Quant** | Low-precision quantization support (INT8/INT4) for weights and activations |
| **Extensions**| Continuous expansion of optimized operations for emerging model architectures |

## 安装方法

lightllm_kernel 提供了静态编译以及JIT(Just-In-Time)动态编译的安装方式。推荐使用静态编译安装以获得最佳性能,同时也支持开发者使用可编辑安装进行开发调试。

### System Requirements
- NVIDIA GPU with Compute Capability ≥ 7.0 (Volta+)
- CUDA 11.8 or higher
- Python 3.8+

### Installation Methods

#### Static Compilation (Recommended)
```bash
git clone https://github.com/YourUsername/lightllm_kernel.git

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The Git clone URL https://github.com/YourUsername/lightllm_kernel.git appears to be a placeholder. Could this be updated to the correct repository URL for lightllm_kernel once it's finalized or made public?

cd lightllm_kernel
make build
# Alternative using pip
pip install .
```

## 贡献指南
欢迎社区开发者为 lightllm_kernel 做出贡献!如果您计划新增自定义算子或改进现有功能,请参考以下指南:
- 新增算子实现:在 csrc/ 目录下添加您的 CUDA/C++ 源码文件,添加时建议参考现有算子的代码风格和结构。
- 注册Python接口:在 csrc/ops_bindings.cpp中,将新增的算子通过 PyBind11 或 TORCH_LIBRARY 等机制注册到 Python 接口。
- 导出算子到Python模块:在lightllm_kernel/ops/__init__.py只添加相应的导出代码,使新算子包含在 lightllm_kernel.ops 模块中。
- 本地测试:开发完成后,请在本地对您的更改进行测试。您可以编译安装新的版本并编写简单的脚本调用新算子,检查其功能和性能是否符合预期。如果项目附带了测试用例,也请运行所有测试确保不引入回归。
-

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This line seems to be an unfinished list item, ending with just a hyphen. Was there more content intended here, or should this line be removed/completed?

39 changes: 39 additions & 0 deletions lightllm-kernel/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# LightLLM-Kernel

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

LightLLM-Kernel is a high-performance CUDA kernel library powering the LightLLM inference system. It provides optimized GPU implementations for critical operations in large language model (LLM) inference, delivering significant performance improvements through carefully crafted CUDA kernels.

## Project Overview

LightLLM-Kernel serves as the computational backbone for LightLLM framework, offering:
- **Custom CUDA Kernels**: Highly optimized implementations for transformer-based model operations
- **Memory Efficiency**: Reduced memory footprint through advanced quantization techniques
- **Scalability**: Support for large model architectures including MoE (Mixture-of-Experts) models

## Key Features

### Core Modules
| Module | Description |
|--------------|-------------------------------------------------------------------------------------------------|
| **Attention** | Optimized Multi-Head Attention kernels with fused QKV operations and efficient softmax |
| **MoE** | Expert routing and computation kernels for Mixture-of-Experts architectures |
| **Quant** | Low-precision quantization support (INT8/INT4) for weights and activations |
| **Extensions**| Continuous expansion of optimized operations for emerging model architectures |

## Installation

### System Requirements
- NVIDIA GPU with Compute Capability ≥ 7.0 (Volta+)
- CUDA 11.8 or higher
- Python 3.8+

### Installation Methods

#### Static Compilation (Recommended)
```bash
git clone https://github.com/YourUsername/lightllm_kernel.git

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Similar to the Chinese README, the Git clone URL https://github.com/YourUsername/lightllm_kernel.git here is a placeholder. Could this also be updated?

cd lightllm_kernel
make build
# Alternative using pip
pip install .
Loading
Loading