Yi-1.5-6B-Chat-GGUF / README.md
MoMonir's picture
Update README.md
a7bf147 verified
metadata
license: apache-2.0
tags:
  - llama-cpp
  - gguf-my-repo

MoMonir/Yi-1.5-6B-Chat-GGUF

This model was converted to GGUF format from 01-ai/Yi-1.5-6B-Chat using llama.cpp via the ggml.ai's GGUF-my-repo space. Refer to the original model card for more details on the model.

About GGUF (TheBloke Description)

GGUF is a new format introduced by the llama.cpp team on August 21st 2023. It is a replacement for GGML, which is no longer supported by llama.cpp.

Here is an incomplete list of clients and libraries that are known to support GGUF:

  • llama.cpp. The source project for GGUF. Offers a CLI and a server option.
  • text-generation-webui, the most widely used web UI, with many features and powerful extensions. Supports GPU acceleration.
  • KoboldCpp, a fully featured web UI, with GPU accel across all platforms and GPU architectures. Especially good for story telling.
  • GPT4All, a free and open source local running GUI, supporting Windows, Linux and macOS with full GPU accel.
  • LM Studio, an easy-to-use and powerful local GUI for Windows and macOS (Silicon), with GPU acceleration. Linux available, in beta as of 27/11/2023.
  • LoLLMS Web UI, a great web UI with many interesting and unique features, including a full model library for easy model selection.
  • Faraday.dev, an attractive and easy to use character-based chat GUI for Windows and macOS (both Silicon and Intel), with GPU acceleration.
  • llama-cpp-python, a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
  • candle, a Rust ML framework with a focus on performance, including GPU support, and ease of use.
  • ctransformers, a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server. Note, as of time of writing (November 27th 2023), ctransformers has not been updated in a long time and does not support many recent models.

Use with llama.cpp

Install llama.cpp through brew.

brew install ggerganov/ggerganov/llama.cpp

Invoke the llama.cpp server or the CLI.

CLI:

llama-cli --hf-repo MoMonir/Yi-1.5-6B-Chat-GGUF --model yi-1.5-6b-chat.Q4_K_M.gguf -p "The meaning to life and the universe is"

Server:

llama-server --hf-repo MoMonir/Yi-1.5-6B-Chat-GGUF --model yi-1.5-6b-chat.Q4_K_M.gguf -c 2048

Note: You can also use this checkpoint directly through the usage steps listed in the Llama.cpp repo as well.

git clone https://github.com/ggerganov/llama.cpp &&             cd llama.cpp &&             make &&             ./main -m yi-1.5-6b-chat.Q4_K_M.gguf -n 128