Saul Instruct V1 GGUF

🚀 Saul-Instruct-v1-GGUF

Saul-Instruct-v1-GGUF 是一個文本生成模型，以 GGUF 格式存儲，基於 Equall/Saul-Instruct-v1 模型，可用於多種文本生成任務。

📚 詳細文檔

模型信息

• 模型創建者：Equall
• 原始模型：Equall/Saul-Instruct-v1
• 量化者：MaziyarPanahi

模型描述

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

關於 GGUF

GGUF 是 llama.cpp 團隊在 2023 年 8 月 21 日推出的一種新格式，它替代了不再被 llama.cpp 支持的 GGML 格式。

以下是已知支持 GGUF 的客戶端和庫的不完全列表：

• llama.cpp：GGUF 的源項目，提供了命令行界面（CLI）和服務器選項。
• text-generation-webui：最廣泛使用的網頁界面，具有許多功能和強大的擴展，支持 GPU 加速。
• KoboldCpp：功能齊全的網頁界面，支持所有平臺和 GPU 架構的 GPU 加速，特別適合用於講故事。
• GPT4All：一個免費開源的本地運行圖形用戶界面（GUI），支持 Windows、Linux 和 macOS 系統，並提供全 GPU 加速。
• LM Studio：一個易於使用且功能強大的本地 GUI，適用於 Windows 和 macOS（Silicon）系統，支持 GPU 加速，截至 2023 年 11 月 27 日，Linux 版本處於測試階段。
• LoLLMS 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 已經很長時間沒有更新，不支持許多最近的模型。

量化方法說明

如何下載 GGUF 文件

⚠️ 重要提示

對於手動下載者來說，幾乎不需要克隆整個倉庫！這裡提供了多種不同的量化格式，大多數用戶只需要選擇並下載單個文件即可。

以下客戶端/庫會自動為你下載模型，並提供可用模型列表供你選擇：

• LM Studio
• LoLLMS Web UI
• Faraday.dev

在 text-generation-webui 中下載

在“下載模型”選項下，你可以輸入模型倉庫地址：MaziyarPanahi/Saul-Instruct-v1-GGUF，並在下方輸入要下載的具體文件名，例如：Saul-Instruct-v1-GGUF.Q4_K_M.gguf。然後點擊“下載”。

在命令行中下載（可同時下載多個文件）

建議使用 huggingface-hub Python 庫：

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 文件中讀取，並由 llama.cpp 自動設置。請注意，更長的序列長度需要更多的資源，因此你可能需要減小該值。

如果你想進行聊天式對話，請將 -p <PROMPT> 參數替換為 -i -ins。

有關其他參數及其使用方法，請參考 llama.cpp 文檔。

在 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 包

根據你的系統，運行以下命令之一：

# 無 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="./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 個令牌
  stop=["</s>"],   # 示例停止令牌 - 不一定適用於此特定模型！使用前請檢查。
  echo=True        # 是否回顯提示信息
)

# 聊天完成 API

llm = Llama(model_path="./Saul-Instruct-v1-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

📄 許可證

本模型採用 MIT 許可證。