标签:

• 量化
• 2比特
• 3比特
• 4比特
• 5比特
• 6比特
• 8比特
• GGUF
• 变换器
• 安全张量
• 雾凇
• 文本生成
• 法律
• 对话式
• 英语
• arxiv:2403.03883
• 许可证:MIT
• 自动训练兼容
• 端点兼容
• 文本生成推理
• 地区:美国
• 文本生成 模型名称: Saul-Instruct-v1-GGUF 基础模型: Equall/Saul-Instruct-v1 推理: 否 模型创建者: Equall 流水线标签: 文本生成 量化者: MaziyarPanahi

MaziyarPanahi/Saul-Instruct-v1-GGUF

• 模型创建者: Equall
• 原始模型: Equall/Saul-Instruct-v1

描述

MaziyarPanahi/Saul-Instruct-v1-GGUF 包含 Equall/Saul-Instruct-v1 的 GGUF 格式模型文件。

使用方法

感谢 TheBloke 准备了关于如何使用 GGUF 模型的详细说明：

关于 GGUF

GGUF 是由 llama.cpp 团队于 2023 年 8 月 21 日引入的新格式，用于替代不再受支持的 GGML 格式。

以下是已知支持 GGUF 的部分客户端和库的不完整列表：

• llama.cpp。GGUF 的源项目，提供 CLI 和服务器选项。
• text-generation-webui，最广泛使用的 Web UI，具有许多功能和强大扩展，支持 GPU 加速。
• KoboldCpp，功能全面的 Web UI，支持跨平台和 GPU 架构的加速，特别适合故事创作。
• GPT4All，免费开源的本地运行 GUI，支持 Windows、Linux 和 macOS 的完整 GPU 加速。
• LM Studio，易于使用且功能强大的本地 GUI，支持 Windows 和 macOS（Silicon），带 GPU 加速。Linux 版本于 2023 年 11 月 27 日进入测试阶段。
• LoLLMS Web UI，出色的 Web UI，具有许多独特功能，包括完整的模型库以便轻松选择模型。
• Faraday.dev，美观易用的基于角色的聊天 GUI，支持 Windows 和 macOS（Silicon 和 Intel），带 GPU 加速。
• llama-cpp-python，支持 GPU 加速的 Python 库，兼容 LangChain 和 OpenAI 风格的 API 服务器。
• candle，专注于性能的 Rust ML 框架，支持 GPU 并易于使用。
• ctransformers，支持 GPU 加速的 Python 库，兼容 LangChain 和 OpenAI 风格的 AI 服务器。注意：截至 2023 年 11 月 27 日，ctransformers 已长期未更新，不支持许多新模型。

量化方法说明

pip3 install huggingface-hub

huggingface-cli download MaziyarPanahi/Saul-Instruct-v1-GGUF Saul-Instruct-v1-GGUF.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False

huggingface-cli download [MaziyarPanahi/Saul-Instruct-v1-GGUF](https://huggingface.co/MaziyarPanahi/Saul-Instruct-v1-GGUF) --local-dir . --local-dir-use-symlinks False --include='*Q4_K*gguf'

pip3 install hf_transfer

HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download MaziyarPanahi/Saul-Instruct-v1-GGUF Saul-Instruct-v1-GGUF.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False

llama.cpp 命令示例

确保使用 d0cee0d 或更高版本的 llama.cpp。

./main -ngl 35 -m Saul-Instruct-v1-GGUF.Q4_K_M.gguf --color -c 32768 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "<|im_start|>system
{system_message}<|im_end|>
<|im_start|>user
{prompt}<|im_end|>
<|im_start|>assistant"

将 -ngl 32 改为要卸载到 GPU 的层数。如果没有 GPU 加速，请移除此参数。

将 -c 32768 改为所需的序列长度。对于扩展序列模型（如 8K、16K、32K），必要的 RoPE 缩放参数会自动从 GGUF 文件中读取并设置。注意：更长的序列长度需要更多资源，可能需要减少此值。

如需进行聊天式对话，将 -p <PROMPT> 参数替换为 -i -ins。

其他参数及使用方法，请参阅 llama.cpp 文档。

如何在 text-generation-webui 中运行

更多说明可在 text-generation-webui 文档中找到：text-generation-webui/docs/04 ‐ 模型标签.md。

如何从 Python 代码运行

可以使用 llama-cpp-python 或 ctransformers 库从 Python 中加载 GGUF 模型。注意：截至 2023 年 11 月 27 日，ctransformers 已长期未更新，不兼容部分新模型。因此推荐使用 llama-cpp-python。

如何在 Python 代码中加载此模型（使用 llama-cpp-python）

完整文档请参阅：llama-cpp-python 文档。

首先安装包

根据系统运行以下命令之一：

# 基础 ctransformers，无 GPU 加速
pip install llama-cpp-python
# 使用 NVIDIA CUDA 加速
CMAKE_ARGS="-DLLAMA_CUBLAS=on" pip install llama-cpp-python
# 或使用 OpenBLAS 加速
CMAKE_ARGS="-DLLAMA_BLAS=ON -DLLAMA_BLAS_VENDOR=OpenBLAS" pip install llama-cpp-python
# 或使用 CLBLast 加速
CMAKE_ARGS="-DLLAMA_CLBLAST=on" pip install llama-cpp-python
# 或使用 AMD ROCm GPU 加速（仅限 Linux）
CMAKE_ARGS="-DLLAMA_HIPBLAS=on" pip install llama-cpp-python
# 或使用 Metal GPU 加速（仅限 macOS）
CMAKE_ARGS="-DLLAMA_METAL=on" pip install llama-cpp-python

# 在 Windows 中，使用 PowerShell 设置 CMAKE_ARGS 变量，例如 NVIDIA CUDA：
$env:CMAKE_ARGS = "-DLLAMA_OPENBLAS=on"
pip install llama-cpp-python

简单的 llama-cpp-python 示例代码

from llama_cpp import Llama

# 设置 gpu_layers 为要卸载到 GPU 的层数。如果系统无 GPU 加速，设为 0。
llm = Llama(
  model_path="./Saul-Instruct-v1-GGUF.Q4_K_M.gguf",  # 先下载模型文件
  n_ctx=32768,  # 最大序列长度，注意更长的序列需要更多资源
  n_threads=8,            # CPU 线程数，根据系统和性能调整
  n_gpu_layers=35         # 卸载到 GPU 的层数，如有 GPU 加速
)

# 简单推理示例
output = llm(
  "<|im_start|>system
{system_message}<|im_end|>
<|im_start|>user
{prompt}<|im_end|>
<|im_start|>assistant", # 提示
  max_tokens=512,  # 最多生成 512 个 token
  stop=["</s>"],   # 停止 token 示例，使用前请确认是否正确
  echo=True        # 是否回显提示
)

# 聊天补全 API

llm = Llama(model_path="./Saul-Instruct-v1-GGUF.Q4_K_M.gguf", chat_format="llama-2")  # 根据模型设置 chat_format
llm.create_chat_completion(
    messages = [
        {"role": "system", "content": "你是一个故事写作助手。"},
        {
            "role": "user",
            "content": "写一个关于羊驼的故事。"
        }
    ]
)

如何与 LangChain 使用

以下是使用 llama-cpp-python 和 ctransformers 与 LangChain 的指南：

• LangChain + llama-cpp-python
• LangChain + ctransformers