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 社区维护了一个wiki，其中包含与 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 作为可选后端（参见 此问题）。

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

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

应用程序

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

库

• llm-chain：工作正在进行中，请参阅 此PR。