llm

图片由 @darthdeus 提供，使用 Stable Diffusion

llm 是一个 Rust 生态系统，用于在大型语言模型上运行推理，灵感来源于 llama.cpp.

主要的 crate 是 llm crate，它封装了 llm-base 和受支持的模型 crate。

在 llm 的基础上，还有一个 CLI 应用程序，llm-cli，它为受支持的模型提供方便的接口。此 CLI 可从最新的 GitHub 版本中获得。

它由 ggml 张量库提供支持，旨在将 Rust 的稳健性和易用性带给大型语言模型的世界。

目前，以下模型受到支持

• GPT-2
• GPT-J
• LLaMA: LLaMA、Alpaca、Vicuna、Koala、GPT4All v1、GPT4-X、Wizard
• GPT-NeoX: GPT-NeoX、StableLM、Dolly v2（部分，不是相同的张量名称？）
• BLOOM: BLOOMZ

入门指南

确保您已安装 Rust 1.65.0 或更高版本和 C 工具链[^1]。

llm 是一个 Rust 库，它重新导出 llm-base 和模型 crate（例如 bloom、gpt2 llama）。

llm-cli（二进制名称为 llm）是一个基本应用程序，它为库提供 CLI 接口。

注意：为了获得最佳结果，请确保以发布模式构建和运行。调试构建将会非常慢。

使用 cargo 构建

运行

cargo install --git https://github.com/rustformers/llm llm-cli

将 llm 安装到您的 Cargo bin 目录，该目录 rustup 可能已添加到您的 PATH 中。

然后可以通过 llm 运行 CLI 应用程序。

从仓库构建

克隆仓库，然后使用以下命令构建：

git clone --recurse-submodules [email protected]:rustformers/llm.git
cargo build --release

生成的二进制文件位于 target/release/llm[.exe]。

也可以直接通过 Cargo 运行，使用

cargo run --release -- <ARGS>

这对开发很有用。

获取模型

GGML 文件易于获取。有关已测试模型的列表，请参阅 已知良好的模型。

本项目不支持某些较旧的 GGML 格式，但目标是与上游 GGML 项目的功能保持一致。有关加载模型的问题，或请求支持 支持的 GGML 模型类型，请 提交一个问题。

从 Hugging Face

Hugging Face 🤗 是开源机器学习的领导者，托管了数百个 GGML 模型。 在 Hugging Face 🤗 上搜索 GGML 模型。

r/LocalLLaMA

这个 Reddit 社区维护了一个与 GGML 模型相关的 维基，包括获取 GGML 模型 的组织良好的链接列表（大多数来自 Hugging Face 🤗）。

LLaMA 原始权重

目前，获取原始权重的唯一合法来源是 此仓库。

获取权重后，需要将它们转换为与 ggml 兼容的格式。为此，请按照以下步骤操作

警告

要运行 Python 脚本，需要 Python 3.9 或 3.10 版本。截至编写时，3.11 不受支持。

# Convert the model to f16 ggml format
python3 scripts/convert-pth-to-ggml.py /path/to/your/models/7B/ 1

# Quantize the model to 4-bit ggml format
cargo run --release llama quantize /path/to/your/models/7B/ggml-model-f16.bin /path/to/your/models/7B/ggml-model-q4_0.bin q4_0

未来，我们希望提供 更简便的模型转换方法。

注意

llama.cpp 仓库 包含有关如何获取和运行特定模型的其他信息。

运行

例如，尝试以下提示

llm llama infer -m <path>/ggml-model-q4_0.bin -p "Tell me how cool the Rust programming language is:"

一些其他尝试事项

• 使用 --help 查看可用选项列表。

• 如果您有 alpaca-lora 权重，请尝试 repl 模式！

  llm llama repl -m <path>/ggml-alpaca-7b-q4.bin -f examples/alpaca_prompt.txt
  

• 会话可以加载（使用 --load-session）或保存到文件（使用 --save-session）。要自动加载和保存相同的会话，请使用 --persist-session。这也可以用于缓存提示以减少加载时间。

[^1]: 编译 ggml 需要 C 工具链。通常不需要 C++ 工具链。

Docker

# To build (This will take some time, go grab some coffee):
docker build -t llm .

# To run with prompt:
docker run --rm --name llm -it -v ${PWD}/data:/data -v ${PWD}/examples:/examples llm llama infer -m data/gpt4all-lora-quantized-ggml.bin -p "Tell me how cool the Rust programming language is:"

# To run with prompt file and repl (will wait for user input):
docker run --rm --name llm -it -v ${PWD}/data:/data -v ${PWD}/examples:/examples llm llama repl -m data/gpt4all-lora-quantized-ggml.bin -f examples/alpaca_prompt.txt

Q&A

你为什么这样做？

这不是我的选择。费里斯在我的梦中出现，并要求我以神圣的螃蟹的名义重写它。

说正经的。

快点！我不想陷入争吵。你知道是怎么回事，什么什么 内存 什么什么 cargo 很好，别让我说出来，大家都知道这一点。

我坚持。

哎呀！好吧。在看到 llama.cpp 的巨大潜力后，我首先想到的是将其变成库嵌入到我的项目中要有多难。我开始深入研究代码，意识到繁重的工作是由 ggml（一个C语言库，易于与Rust绑定）完成的，整个项目只是大约2k行C++代码（绑定起来并不容易）。在尝试将HTTP服务器构建到工具中失败了几次之后，我意识到，如果我只是将代码移植到Rust中，我会更加高效。

这是真正的原因吗？

哈哈。当然不是。我只是喜欢收集那些看似人们在我不着边际地重新编写X事物时给予我的虚拟网络积分，形式是小小的星星。

这与 llama.cpp 有什么不同？

这是一个重新实现 llama.cpp 的版本，它与它除了 ggml 之外没有任何代码共享。这样做是出于各种原因

• llama.cpp 需要C++编译器，这可能会在编译到更奇怪的平台上时造成问题。这类平台的一个例子是WebAssembly，它可能需要一个非标准的编译器SDK。
• Rust在开发和开源方面更容易使用；它提供了更好的工具来编写多人合作的大规模代码。此外，我们可以轻松地受益于更大的Rust生态系统。
• 我们希望将 ggml 打造为一个可选的后端（参见这个问题）。

总的来说，我们希望为模型推理构建一个与其他Rust包一样易于使用和部署的解决方案。

哪些应用程序和库使用了 llm？

应用程序

• llmcord：使用 llm 生成消息的Discord机器人。

库

• llm-chain：正在进行中，参见这个PR。