Phi 2 Super GGUF

🚀 MaziyarPanahi/phi-2-super-GGUF

本項目提供了 abacaj/phi-2-super 模型的 GGUF 格式文件，方便用戶在不同客戶端和庫中使用該模型進行文本生成等任務。

🚀 快速開始

模型信息

• 模型創建者：abacaj
• 原始模型：abacaj/phi-2-super

✨ 主要特性

• 多種量化格式：支持 2-bit、3-bit、4-bit、5-bit、6-bit、8-bit 等多種量化格式。
• 廣泛的兼容性：與多個客戶端和庫兼容，如 llama.cpp、text-generation-webui 等。

📦 安裝指南

安裝依賴庫

pip3 install huggingface-hub

若要加速下載（網絡速度 1Gbit/s 或更高），可安裝 hf_transfer：

pip3 install hf_transfer

下載模型文件

在 text-generation-webui 中下載

在“Download Model”處輸入模型倉庫地址 MaziyarPanahi/phi-2-super-GGUF，並在下方輸入具體文件名，如 phi-2-super-GGUF.Q4_K_M.gguf，然後點擊“Download”。

在命令行下載單個文件

huggingface-cli download MaziyarPanahi/phi-2-super-GGUF phi-2-super-GGUF.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False

命令行批量下載

huggingface-cli download [MaziyarPanahi/phi-2-super-GGUF](https://huggingface.co/MaziyarPanahi/phi-2-super-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/phi-2-super-GGUF phi-2-super-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 phi-2-super-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。

Python 代碼示例（使用 llama-cpp-python）

from llama_cpp import Llama

# Set gpu_layers to the number of layers to offload to GPU. Set to 0 if no GPU acceleration is available on your system.
llm = Llama(
  model_path="./phi-2-super-GGUF.Q4_K_M.gguf",  # Download the model file first
  n_ctx=32768,  # The max sequence length to use - note that longer sequence lengths require much more resources
  n_threads=8,            # The number of CPU threads to use, tailor to your system and the resulting performance
  n_gpu_layers=35         # The number of layers to offload to GPU, if you have GPU acceleration available
)

# Simple inference example
output = llm(
  "<|im_start|>system
{system_message}<|im_end|>
<|im_start|>user
{prompt}<|im_end|>
<|im_start|>assistant", # Prompt
  max_tokens=512,  # Generate up to 512 tokens
  stop=["</s>"],   # Example stop token - not necessarily correct for this specific model! Please check before using.
  echo=True        # Whether to echo the prompt
)

# Chat Completion API

llm = Llama(model_path="./phi-2-super-GGUF.Q4_K_M.gguf", chat_format="llama-2")  # Set chat_format according to the model you are using
llm.create_chat_completion(
    messages = [
        {"role": "system", "content": "You are a story writing assistant."},
        {
            "role": "user",
            "content": "Write a story about llamas."
        }
    ]
)

高級用法

安裝不同加速選項的 llama-cpp-python

# Base ctransformers with no GPU acceleration
pip install llama-cpp-python
# With NVidia CUDA acceleration
CMAKE_ARGS="-DLLAMA_CUBLAS=on" pip install llama-cpp-python
# Or with OpenBLAS acceleration
CMAKE_ARGS="-DLLAMA_BLAS=ON -DLLAMA_BLAS_VENDOR=OpenBLAS" pip install llama-cpp-python
# Or with CLBLast acceleration
CMAKE_ARGS="-DLLAMA_CLBLAST=on" pip install llama-cpp-python
# Or with AMD ROCm GPU acceleration (Linux only)
CMAKE_ARGS="-DLLAMA_HIPBLAS=on" pip install llama-cpp-python
# Or with Metal GPU acceleration for macOS systems only
CMAKE_ARGS="-DLLAMA_METAL=on" pip install llama-cpp-python

# In windows, to set the variables CMAKE_ARGS in PowerShell, follow this format; eg for NVidia CUDA:
$env:CMAKE_ARGS = "-DLLAMA_OPENBLAS=on"
pip install llama-cpp-python

📚 詳細文檔

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：一個有吸引力且易於使用的基於角色的聊天 GUI，適用於 Windows 和 macOS（Silicon 和 Intel），支持 GPU 加速。
• llama-cpp-python：一個支持 GPU 加速、LangChain 支持和 OpenAI 兼容 API 服務器的 Python 庫。
• candle：一個注重性能的 Rust ML 框架，包括 GPU 支持，且易於使用。
• ctransformers：一個支持 GPU 加速、LangChain 支持和 OpenAI 兼容 AI 服務器的 Python 庫。截至編寫本文時（2023 年 11 月 27 日），ctransformers 已有很長時間未更新，不支持許多近期模型。

量化方法解釋

在 text-generation-webui 中運行

更多說明可在 text-generation-webui 文檔中找到，地址為：text-generation-webui/docs/04 ‚Äê Model Tab.md。

使用 LangChain

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

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

📄 許可證

本項目採用 MIT 許可證。