Skip to content

Latest commit

 

History

History
164 lines (114 loc) · 9.46 KB

README_ZH.md

File metadata and controls

164 lines (114 loc) · 9.46 KB

KTransformers

一个用于体验尖端 LLM 推理优化的灵活框架

🌟 案例展示 | 🚀 快速入门 | 📃 教程 | 💬 讨论 | 🙋 常见问题

🎉 介绍

KTransformers(发音为 Quick Transformers)旨在通过先进的内核优化和放置/并行策略来增强您对 🤗 [Transformers](https://github.com/huggingface/transformers) 的体验。

KTransformers 是一个以 Python 为中心的灵活框架,其核心是可扩展性。通过用一行代码实现并注入优化模块,用户可以获得与 Transformers 兼容的接口、符合 OpenAI 和 Ollama 的 RESTful API,甚至是一个简化的类似 ChatGPT 的 Web 界面。

我们对 KTransformers 的愿景是成为一个用于实验创新 LLM 推理优化的灵活平台。如果您需要任何其他功能,请告诉我们。

🔥 更新

  • 2025 年 2 月 10 日:支持 Deepseek-R1 和 V3 在单个(24GB VRAM)/多 GPU 和 382G DRAM 上运行,速度提升高达 3~28 倍。详细教程请参见 这里
  • 2024 年 8 月 28 日:支持 InternLM2.5-7B-Chat-1M 模型下的 1M 上下文,使用 24GB 的 VRAM 和 150GB 的 DRAM。详细教程请参见 这里
  • 2024 年 8 月 28 日:将 DeepseekV2 所需的 VRAM 从 21G 降低到 11G。
  • 2024 年 8 月 15 日:更新了详细的 教程,介绍注入和多 GPU 的使用。
  • 2024 年 8 月 14 日:支持 llamfile 作为线性后端。
  • 2024 年 8 月 12 日:支持多 GPU;支持新模型:mixtral 8*7B 和 8*22B;支持 q2k、q3k、q5k 在 GPU 上的去量化。
  • 2024 年 8 月 9 日:支持 Windows。

🌟 案例展示

在仅 24GB VRAM 的桌面上运行 GPT-4/o1 级别的本地 VSCode Copilot

v3.up.mov

  • [NEW!!!] 本地 671B DeepSeek-Coder-V3/R1:使用其 Q4_K_M 版本,仅需 14GB VRAM 和 382GB DRAM 即可运行(教程请参见 这里)。

    • 预填充速度(tokens/s):
      • KTransformers:54.21(32 核)→ 74.362(双插槽,2×32 核)→ 255.26(优化的 AMX 基 MoE 内核,仅 V0.3)→ 286.55(选择性使用 6 个专家,仅 V0.3)
      • 与 llama.cpp 在 2×32 核下相比,达到 27.79× 速度提升
    • 解码速度(tokens/s):
      • KTransformers:8.73(32 核)→ 11.26(双插槽,2×32 核)→ 13.69(选择性使用 6 个专家,仅 V0.3)
      • 与 llama.cpp 在 2×32 核下相比,达到 3.03× 速度提升
    • 即将开源发布:
      • AMX 优化和选择性专家激活将在 V0.3 中开源。
      • 目前仅在预览二进制分发中可用,可从 这里 下载。
  • 本地 236B DeepSeek-Coder-V2:使用其 Q4_K_M 版本,仅需 21GB VRAM 和 136GB DRAM 即可运行,甚至在 BigCodeBench 中得分超过 GPT4-0613。

DeepSeek-Coder-V2 Score

  • 更快的速度:通过 MoE 卸载和注入来自 LlamafileMarlin 的高级内核,实现了 2K 提示预填充 126 tokens/s 和生成 13.6 tokens/s 的速度。
  • VSCode 集成:封装成符合 OpenAI 和 Ollama 的 API,可无缝集成到 Tabby 和其他前端的后端。

ktransformers-tabby.mp4

在仅 24GB VRAM 的桌面上进行 1M 上下文本地推理

Ktransformers.long.context.mp4
  • 1M 上下文 InternLM 2.5 7B:以全 bf16 精度运行,使用 24GB VRAM 和 150GB DRAM,可在本地桌面设置中实现。在 1M "针在干草堆中" 测试中达到 92.88% 的成功率,在 128K NIAH 测试中达到 100%。

Single Needle Retrieval 128K

Single Needle Retrieval 1000K

  • 增强的速度:使用稀疏注意力,通过 llamafile 内核实现 1M 上下文生成 16.91 tokens/s 的速度。这种方法比 llama.cpp 的全注意力方法快 10 倍以上。

  • 灵活的稀疏注意力框架:提供了一个灵活的块稀疏注意力框架,用于 CPU 卸载解码。与 SnapKV、Quest 和 InfLLm 兼容。更多信息请参见 这里

更多高级功能即将推出,敬请期待!

🚀 快速入门

KTransformers 的入门非常简单!请参考我们的安装指南进行安装。

📃 简要注入教程

KTransformers 的核心是一个用户友好的、基于模板的注入框架。这使得研究人员可以轻松地将原始 torch 模块替换为优化的变体。它还简化了多种优化的组合过程,允许探索它们的协同效应。

Inject-Struction

鉴于 vLLM 已经是一个用于大规模部署优化的优秀框架,KTransformers 特别关注受资源限制的本地部署。我们特别关注异构计算时机,例如量化模型的 GPU/CPU 卸载。例如,我们支持高效的 Llamafile 和Marlin 内核,分别用于 CPU 和 GPU。 更多详细信息可以在 这里找到。

示例用法

要使用提供的内核,用户只需创建一个基于 YAML 的注入模板,并在使用 Transformers 模型之前添加对 `optimize_and_load_gguf` 的调用。
with torch.device("meta"):
    model = AutoModelForCausalLM.from_config(config, trust_remote_code=True)
optimize_and_load_gguf(model, optimize_rule_path, gguf_path, config)
...
generated = prefill_and_generate(model, tokenizer, input_tensor.cuda(), max_new_tokens=1000)

在这个示例中,首先在 meta 设备上初始化 AutoModel,以避免占用任何内存资源。然后,optimize_and_load_gguf 遍历模型的所有子模块,匹配您的 YAML 规则文件中指定的规则,并将它们替换为指定的高级模块。

注入后,原始的 generate 接口仍然可用,但我们还提供了一个兼容的 prefill_and_generate 方法,这使得可以进一步优化,例如使用 CUDAGraph 提高生成速度。

如何自定义您的模型

一个详细的使用 DeepSeek-V2 作为示例的注入和 multi-GPU 教程在 这里

以下是一个将所有原始 Linear 模块替换为 Marlin 的 YAML 模板示例,Marlin 是一个高级的 4 位量化内核。

- match:
    name: "^model\\.layers\\..*$"  # 正则表达式 
    class: torch.nn.Linear  # 仅匹配同时符合名称和类的模块
  replace:
    class: ktransformers.operators.linear.KTransformerLinear  # 量化数据类型的优化内核
    device: "cpu"   # 初始化时加载该模块的 device
    kwargs:
      generate_device: "cuda"
      generate_linear_type: "QuantizedLinearMarlin"

YAML 文件中的每个规则都有两部分:matchreplacematch 部分指定应替换的模块,replace 部分指定要注入到模型中的模块以及初始化关键字。

您可以在 ktransformers/optimize/optimize_rules 目录中找到用于优化 DeepSeek-V2 和 Qwen2-57B-A14 的示例规则模板。这些模板用于为 local_chat.py 示例提供支持。

如果您对我们的设计原则和注入框架的实现感兴趣,请参考 设计文档

致谢和贡献者

KTransformer 的开发基于 Transformers 提供的灵活和多功能框架。我们还受益于 GGUF/GGML、Llamafile 和 Marlin 等高级内核。我们计划通过向上游贡献我们的修改来回馈社区。

KTransformer 由清华大学 MADSys group 小组的成员以及 Approaching.AI 的成员积极维护和开发。我们欢迎新的贡献者加入我们,使 KTransformer 更快、更易于使用。

讨论

如果您有任何问题,欢迎随时提出 issue。或者,您可以加入我们的微信群进行进一步讨论。二维码: 微信群

🙋 常见问题

一些常见问题的答案可以在 FAQ 中找到。