Sauerkrautlm 7b HerO Mistral 7B Instruct V0.1 GGUF

🚀 SauerkrautLM-7b-HerO-Mistral-7B-Instruct-v0.1-GGUF

SauerkrautLM-7b-HerO-Mistral-7B-Instruct-v0.1-GGUF 是一个包含特定格式模型文件的项目，用于文本生成任务。它基于 Mistral 模型，支持多种量化方式，可在不同环境中运行，为文本生成提供了高效且灵活的解决方案。

🚀 快速开始

模型信息

• 模型创建者：MaziyarPanahi
• 原始模型：MaziyarPanahi/SauerkrautLM-7b-HerO-Mistral-7B-Instruct-v0.1
• 模型链接：MaziyarPanahi/SauerkrautLM-7b-HerO-Mistral-7B-Instruct-v0.1-GGUF

模型描述

MaziyarPanahi/SauerkrautLM-7b-HerO-Mistral-7B-Instruct-v0.1-GGUF 包含了 MaziyarPanahi/SauerkrautLM-7b-HerO-Mistral-7B-Instruct-v0.1 的 GGUF 格式模型文件。

✨ 主要特性

• 多量化支持：支持 2 - 8 位的量化方式，如 GGML_TYPE_Q2_K、GGML_TYPE_Q3_K 等，可根据需求选择合适的量化级别。
• 多工具兼容：与多种客户端和库兼容，如 llama.cpp、text-generation-webui、KoboldCpp 等，方便在不同环境中使用。
• 多语言支持：支持英语和德语等语言，适用于不同语言场景。

📦 安装指南

安装依赖库

推荐使用 huggingface-hub Python 库来下载模型文件：

pip3 install huggingface-hub

若要加速下载（网络速度 1Gbit/s 或更高），可安装 hf_transfer：

pip3 install hf_transfer

下载模型文件

单个文件下载

使用以下命令将单个模型文件下载到当前目录：

huggingface-cli download MaziyarPanahi/SauerkrautLM-7b-HerO-Mistral-7B-Instruct-v0.1-GGUF SauerkrautLM-7b-HerO-Mistral-7B-Instruct-v0.1-GGUF.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False

多个文件下载

使用模式匹配下载多个文件：

huggingface-cli download [MaziyarPanahi/SauerkrautLM-7b-HerO-Mistral-7B-Instruct-v0.1-GGUF](https://huggingface.co/MaziyarPanahi/SauerkrautLM-7b-HerO-Mistral-7B-Instruct-v0.1-GGUF) --local-dir . --local-dir-use-symlinks False --include='*Q4_K*gguf'

加速下载

设置环境变量 HF_HUB_ENABLE_HF_TRANSFER 为 1 以加速下载：

HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download MaziyarPanahi/SauerkrautLM-7b-HerO-Mistral-7B-Instruct-v0.1-GGUF SauerkrautLM-7b-HerO-Mistral-7B-Instruct-v0.1-GGUF.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False

Windows 命令行用户可在下载命令前运行 set HF_HUB_ENABLE_HF_TRANSFER=1 来设置环境变量。

💻 使用示例

在 llama.cpp 中运行

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

./main -ngl 35 -m SauerkrautLM-7b-HerO-Mistral-7B-Instruct-v0.1-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"

• GPU 加速设置：将 -ngl 32 更改为要卸载到 GPU 的层数。如果没有 GPU 加速，可移除该参数。
• 序列长度设置：将 -c 32768 更改为所需的序列长度。对于扩展序列模型（如 8K、16K、32K），必要的 RoPE 缩放参数会从 GGUF 文件中读取并由 llama.cpp 自动设置。注意，更长的序列长度需要更多资源，可能需要减小该值。
• 聊天式对话：若要进行聊天式对话，将 -p <PROMPT> 参数替换为 -i -ins。 其他参数的使用请参考 the llama.cpp documentation。

在 text-generation-webui 中运行

更多说明可在 text-generation-webui 文档中找到：text-generation-webui/docs/04 ‐ Model Tab.md。

在 Python 代码中运行

推荐使用 llama-cpp-python 库来使用 GGUF 模型。

安装包

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

# 无 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
# 支持 macOS 系统的 Metal GPU 加速
CMAKE_ARGS="-DLLAMA_METAL=on" pip install llama-cpp-python

# 在 Windows 的 PowerShell 中设置变量，以 NVidia CUDA 为例
$env:CMAKE_ARGS = "-DLLAMA_OPENBLAS=on"
pip install llama-cpp-python

简单示例代码

from llama_cpp import Llama

# 设置要卸载到 GPU 的层数。如果系统没有 GPU 加速，设置为 0。
llm = Llama(
  model_path="./SauerkrautLM-7b-HerO-Mistral-7B-Instruct-v0.1-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 个令牌
  stop=["</s>"],   # 示例停止令牌 - 不一定适用于此特定模型！使用前请检查。
  echo=True        # 是否回显提示信息
)

# 聊天完成 API
llm = Llama(model_path="./SauerkrautLM-7b-HerO-Mistral-7B-Instruct-v0.1-GGUF.Q4_K_M.gguf", chat_format="llama-2")  # 根据使用的模型设置聊天格式
llm.create_chat_completion(
    messages = [
        {"role": "system", "content": "You are a story writing assistant."},
        {
            "role": "user",
            "content": "Write a story about llamas."
        }
    ]
)

与 LangChain 结合使用

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

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

📚 详细文档

关于 GGUF

GGUF 是 llama.cpp 团队在 2023 年 8 月 21 日推出的新格式，它替代了不再受 llama.cpp 支持的 GGML 格式。以下是已知支持 GGUF 的客户端和库：

• llama.cpp：GGUF 的源项目，提供 CLI 和服务器选项。
• text-generation-webui：最广泛使用的 Web UI，具有许多功能和强大的扩展，支持 GPU 加速。
• KoboldCpp：功能齐全的 Web UI，支持所有平台和 GPU 架构的 GPU 加速，特别适合讲故事。
• GPT4All：免费开源的本地运行 GUI，支持 Windows、Linux 和 macOS，具有完整的 GPU 加速。
• LM Studio：适用于 Windows 和 macOS（Silicon）的易用且强大的本地 GUI，支持 GPU 加速。截至 2023 年 11 月 27 日，Linux 版本处于测试阶段。
• LoLLMS Web UI：一个很棒的 Web UI，具有许多有趣和独特的功能，包括一个完整的模型库，便于模型选择。
• Faraday.dev：适用于 Windows 和 macOS（Silicon 和 Intel）的有吸引力且易用的基于角色的聊天 GUI，支持 GPU 加速。
• llama-cpp-python：一个支持 GPU 加速、LangChain 支持和 OpenAI 兼容 API 服务器的 Python 库。
• candle：一个注重性能的 Rust ML 框架，包括 GPU 支持和易用性。
• ctransformers：一个支持 GPU 加速、LangChain 支持和 OpenAI 兼容 AI 服务器的 Python 库。截至 2023 年 11 月 27 日，ctransformers 已有很长时间未更新，不支持许多最新模型。

量化方法说明

新的量化方法如下：

• GGML_TYPE_Q2_K：“type-1” 2 位量化，超级块包含 16 个块，每个块有 16 个权重。块的缩放和最小值用 4 位量化。最终每个权重有效使用 2.5625 位（bpw）。
• GGML_TYPE_Q3_K：“type-0” 3 位量化，超级块包含 16 个块，每个块有 16 个权重。缩放用 6 位量化。最终使用 3.4375 bpw。
• GGML_TYPE_Q4_K：“type-1” 4 位量化，超级块包含 8 个块，每个块有 32 个权重。缩放和最小值用 6 位量化。最终使用 4.5 bpw。
• GGML_TYPE_Q5_K：“type-1” 5 位量化。与 GGML_TYPE_Q4_K 具有相同的超级块结构，最终使用 5.5 bpw。
• GGML_TYPE_Q6_K：“type-0” 6 位量化。超级块有 16 个块，每个块有 16 个权重。缩放用 8 位量化。最终使用 6.5625 bpw。

📄 许可证

该模型使用 Apache-2.0 许可证。