模型简介
模型特点
模型能力
使用案例
🚀 [MaziyarPanahi/sqlcoder-7b-2-GGUF]
本项目提供了 defog/sqlcoder-7b-2 模型的 GGUF 格式文件,方便用户在不同环境下使用该模型进行文本生成。
🚀 快速开始
模型信息
- 模型创建者:defog
- 原始模型:defog/sqlcoder-7b-2
关于 GGUF
GGUF 是 llama.cpp 团队在 2023 年 8 月 21 日推出的一种新格式,它是 GGML 的替代方案,目前 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:一个易于使用且功能强大的本地 GUI,适用于 Windows 和 macOS(Silicon),支持 GPU 加速,截至 2023 年 11 月 27 日,Linux 版本处于测试阶段。
- LoLLMS Web UI:一个很棒的 Web UI,具有许多有趣和独特的功能,包括一个完整的模型库,方便用户选择模型。
- Faraday.dev:一个有吸引力且易于使用的基于角色的聊天 GUI,适用于 Windows 和 macOS(Silicon 和 Intel),支持 GPU 加速。
- llama-cpp-python:一个支持 GPU 加速的 Python 库,提供 LangChain 支持和与 OpenAI 兼容的 API 服务器。
- candle:一个注重性能的 Rust 机器学习框架,支持 GPU,易于使用。
- ctransformers:一个支持 GPU 加速的 Python 库,提供 LangChain 支持和与 OpenAI 兼容的 AI 服务器。需要注意的是,截至 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。
📦 安装指南
下载 GGUF 文件
手动下载注意事项:几乎不需要克隆整个仓库!项目提供了多种不同的量化格式,大多数用户只需要选择并下载单个文件。
以下客户端/库会自动为你下载模型,并提供可用模型列表供你选择:
- LM Studio
- LoLLMS Web UI
- Faraday.dev
在 text-generation-webui
中下载
在“Download Model”下,你可以输入模型仓库地址:MaziyarPanahi/sqlcoder-7b-2-GGUF,并在下方输入要下载的具体文件名,例如:sqlcoder-7b-2-GGUF.Q4_K_M.gguf,然后点击“Download”。
在命令行中下载(包括一次下载多个文件)
建议使用 huggingface-hub
Python 库:
pip3 install huggingface-hub
然后,你可以使用以下命令将任何单个模型文件高速下载到当前目录:
huggingface-cli download MaziyarPanahi/sqlcoder-7b-2-GGUF sqlcoder-7b-2-GGUF.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
更高级的 huggingface-cli 下载用法(点击查看)
你还可以使用通配符一次下载多个文件:
huggingface-cli download [MaziyarPanahi/sqlcoder-7b-2-GGUF](https://huggingface.co/MaziyarPanahi/sqlcoder-7b-2-GGUF) --local-dir . --local-dir-use-symlinks False --include='*Q4_K*gguf'
有关使用 huggingface-cli
下载的更多文档,请参阅:HF -> Hub Python Library -> Download files -> Download from the CLI。
要在高速连接(1Gbit/s 或更高)上加速下载,请安装 hf_transfer
:
pip3 install hf_transfer
并将环境变量 HF_HUB_ENABLE_HF_TRANSFER
设置为 1
:
HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download MaziyarPanahi/sqlcoder-7b-2-GGUF sqlcoder-7b-2-GGUF.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
Windows 命令行用户:可以在下载命令前运行 set HF_HUB_ENABLE_HF_TRANSFER=1
来设置环境变量。
💻 使用示例
llama.cpp
命令示例
确保你使用的是 d0cee0d 或更高版本的 llama.cpp
。
./main -ngl 35 -m sqlcoder-7b-2-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 文件中读取,并由 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 或 ctransformers 库从 Python 中使用 GGUF 模型。需要注意的是,截至 2023 年 11 月 27 日,ctransformers 已经很长时间没有更新,不支持许多最新的模型,因此建议使用 llama-cpp-python。
使用 llama-cpp-python 在 Python 代码中加载此模型
完整文档请参阅:llama-cpp-python docs。
首先安装包
根据你的系统运行以下命令之一:
# 无 GPU 加速的基础 ctransformers
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 中设置变量 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="./sqlcoder-7b-2-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="./sqlcoder-7b-2-GGUF.Q4_K_M.gguf", chat_format="llama-2") # 根据你使用的模型设置 chat_format
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 的指南:



