Hugging Face's logo

TheBloke
/
SUS-Chat-34B-GGUF

Text Generation
Transformers
GGUF
yi
Model card Files Community
2
Edit model card
TheBlokeAI

TheBloke's LLM work is generously supported by a grant from andreessen horowitz (a16z)

SUS Chat 34B - GGUF

Description

This repo contains GGUF format model files for Southern university of science and technology's SUS Chat 34B.

These files were quantised using hardware kindly provided by Massed Compute.

About GGUF

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.

Repositories available

Prompt template: SUS 

### Human: {prompt}

### Assistant:

Compatibility

These quantised GGUFv2 files are compatible with llama.cpp from August 27th onwards, as of commit d0cee0d

They are also compatible with many third party UIs and libraries - please see the list at the top of this README.

Explanation of quantisation methods

Click to see details

The new methods available are:

  • GGML_TYPE_Q2_K - "type-1" 2-bit quantization in super-blocks containing 16 blocks, each block having 16 weight. Block scales and mins are quantized with 4 bits. This ends up effectively using 2.5625 bits per weight (bpw)
  • GGML_TYPE_Q3_K - "type-0" 3-bit quantization in super-blocks containing 16 blocks, each block having 16 weights. Scales are quantized with 6 bits. This end up using 3.4375 bpw.
  • GGML_TYPE_Q4_K - "type-1" 4-bit quantization in super-blocks containing 8 blocks, each block having 32 weights. Scales and mins are quantized with 6 bits. This ends up using 4.5 bpw.
  • GGML_TYPE_Q5_K - "type-1" 5-bit quantization. Same super-block structure as GGML_TYPE_Q4_K resulting in 5.5 bpw
  • GGML_TYPE_Q6_K - "type-0" 6-bit quantization. Super-blocks with 16 blocks, each block having 16 weights. Scales are quantized with 8 bits. This ends up using 6.5625 bpw

Refer to the Provided Files table below to see what files use which methods, and how.

Provided files

Name Quant method Bits Size Max RAM required Use case
sus-chat-34b.Q2_K.gguf Q2_K 2 14.56 GB 17.06 GB smallest, significant quality loss - not recommended for most purposes
sus-chat-34b.Q3_K_S.gguf Q3_K_S 3 14.96 GB 17.46 GB very small, high quality loss
sus-chat-34b.Q3_K_M.gguf Q3_K_M 3 16.64 GB 19.14 GB very small, high quality loss
sus-chat-34b.Q3_K_L.gguf Q3_K_L 3 18.14 GB 20.64 GB small, substantial quality loss
sus-chat-34b.Q4_0.gguf Q4_0 4 19.47 GB 21.97 GB legacy; small, very high quality loss - prefer using Q3_K_M
sus-chat-34b.Q4_K_S.gguf Q4_K_S 4 19.54 GB 22.04 GB small, greater quality loss
sus-chat-34b.Q4_K_M.gguf Q4_K_M 4 20.66 GB 23.16 GB medium, balanced quality - recommended
sus-chat-34b.Q5_0.gguf Q5_0 5 23.71 GB 26.21 GB legacy; medium, balanced quality - prefer using Q4_K_M
sus-chat-34b.Q5_K_S.gguf Q5_K_S 5 23.71 GB 26.21 GB large, low quality loss - recommended
sus-chat-34b.Q5_K_M.gguf Q5_K_M 5 24.32 GB 26.82 GB large, very low quality loss - recommended
sus-chat-34b.Q6_K.gguf Q6_K 6 28.21 GB 30.71 GB very large, extremely low quality loss
sus-chat-34b.Q8_0.gguf Q8_0 8 36.54 GB 39.04 GB very large, extremely low quality loss - not recommended

Note: the above RAM figures assume no GPU offloading. If layers are offloaded to the GPU, this will reduce RAM usage and use VRAM instead.

How to download GGUF files

Note for manual downloaders: You almost never want to clone the entire repo! Multiple different quantisation formats are provided, and most users only want to pick and download a single file.

The following clients/libraries will automatically download models for you, providing a list of available models to choose from:

  • LM Studio
  • LoLLMS Web UI
  • Faraday.dev

In text-generation-webui

Under Download Model, you can enter the model repo: TheBloke/SUS-Chat-34B-GGUF and below it, a specific filename to download, such as: sus-chat-34b.Q4_K_M.gguf.

Then click Download.

On the command line, including multiple files at once

I recommend using the huggingface-hub Python library:

pip3 install huggingface-hub

Then you can download any individual model file to the current directory, at high speed, with a command like this:

huggingface-cli download TheBloke/SUS-Chat-34B-GGUF sus-chat-34b.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
More advanced huggingface-cli download usage (click to read)

You can also download multiple files at once with a pattern:

huggingface-cli download TheBloke/SUS-Chat-34B-GGUF --local-dir . --local-dir-use-symlinks False --include='*Q4_K*gguf'

For more documentation on downloading with huggingface-cli, please see: HF -> Hub Python Library -> Download files -> Download from the CLI.

To accelerate downloads on fast connections (1Gbit/s or higher), install hf_transfer:

pip3 install hf_transfer

And set environment variable HF_HUB_ENABLE_HF_TRANSFER to 1:

HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/SUS-Chat-34B-GGUF sus-chat-34b.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False

Windows Command Line users: You can set the environment variable by running set HF_HUB_ENABLE_HF_TRANSFER=1 before the download command.

Example llama.cpp command

Make sure you are using llama.cpp from commit d0cee0d or later.

./main -ngl 35 -m sus-chat-34b.Q4_K_M.gguf --color -c 8192 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "### Human: {prompt}\n\n### Assistant:"

Change -ngl 32 to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.

Change -c 8192 to the desired sequence length. For extended sequence models - eg 8K, 16K, 32K - the necessary RoPE scaling parameters are read from the GGUF file and set by llama.cpp automatically. Note that longer sequence lengths require much more resources, so you may need to reduce this value.

If you want to have a chat-style conversation, replace the -p <PROMPT> argument with -i -ins

For other parameters and how to use them, please refer to the llama.cpp documentation

How to run in text-generation-webui

Further instructions can be found in the text-generation-webui documentation, here: text-generation-webui/docs/04 ‐ Model Tab.md.

How to run from Python code

You can use GGUF models from Python using the llama-cpp-python or ctransformers libraries. Note that at the time of writing (Nov 27th 2023), ctransformers has not been updated for some time and is not compatible with some recent models. Therefore I recommend you use llama-cpp-python.

How to load this model in Python code, using llama-cpp-python

For full documentation, please see: llama-cpp-python docs.

First install the package

Run one of the following commands, according to your system:

# 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

Simple llama-cpp-python example code 

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="./sus-chat-34b.Q4_K_M.gguf",  # Download the model file first
  n_ctx=8192,  # 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(
  "### Human: {prompt}\n\n### 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="./sus-chat-34b.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."
        }
    ]
)

How to use with LangChain

Here are guides on using llama-cpp-python and ctransformers with LangChain:

Discord

For further support, and discussions on these models and AI in general, join us at:

TheBloke AI's Discord server

Thanks, and how to contribute

Thanks to the chirper.ai team!

Thanks to Clay from gpus.llm-utils.org!

I've had a lot of people ask if they can contribute. I enjoy providing models and helping people, and would love to be able to spend even more time doing it, as well as expanding into new projects like fine tuning/training.

If you're able and willing to contribute it will be most gratefully received and will help me to keep providing more models, and to start work on new AI projects.

Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.

Special thanks to: Aemon Algiz.

Patreon special mentions: Michael Levine, 阿明, Trailburnt, Nikolai Manek, John Detwiler, Randy H, Will Dee, Sebastain Graf, NimbleBox.ai, Eugene Pentland, Emad Mostaque, Ai Maven, Jim Angel, Jeff Scroggin, Michael Davis, Manuel Alberto Morcote, Stephen Murray, Robert, Justin Joy, Luke @flexchar, Brandon Frisco, Elijah Stavena, S_X, Dan Guido, Undi ., Komninos Chatzipapas, Shadi, theTransient, Lone Striker, Raven Klaugh, jjj, Cap'n Zoog, Michel-Marie MAUDET (LINAGORA), Matthew Berman, David, Fen Risland, Omer Bin Jawed, Luke Pendergrass, Kalila, OG, Erik Bjäreholt, Rooh Singh, Joseph William Delisle, Dan Lewis, TL, John Villwock, AzureBlack, Brad, Pedro Madruga, Caitlyn Gatomon, K, jinyuan sun, Mano Prime, Alex, Jeffrey Morgan, Alicia Loh, Illia Dulskyi, Chadd, transmissions 11, fincy, Rainer Wilmers, ReadyPlayerEmma, knownsqashed, Mandus, biorpg, Deo Leter, Brandon Phillips, SuperWojo, Sean Connelly, Iucharbius, Jack West, Harry Royden McLaughlin, Nicholas, terasurfer, Vitor Caleffi, Duane Dunston, Johann-Peter Hartmann, David Ziegler, Olakabola, Ken Nordquist, Trenton Dambrowitz, Tom X Nguyen, Vadim, Ajan Kanaga, Leonard Tan, Clay Pascal, Alexandros Triantafyllidis, JM33133, Xule, vamX, ya boyyy, subjectnull, Talal Aujan, Alps Aficionado, wassieverse, Ari Malik, James Bentley, Woland, Spencer Kim, Michael Dempsey, Fred von Graf, Elle, zynix, William Richards, Stanislav Ovsiannikov, Edmond Seymore, Jonathan Leane, Martin Kemka, usrbinkat, Enrico Ros

Thank you to all my generous patrons and donaters!

And thank you again to a16z for their generous grant.

Original model card: Southern university of science and technology's SUS Chat 34B

🐷SUS-Chat: Instruction tuning done right

News

  • 2023-12-05: SUS-Chat is ranked 2nd in Open LLM leaderboard and surpassed all models under 70B.

  • 2023-12-01: SUS-Chat-34B is now avaliable on HuggingFace🤗.

Inrtoduction

Figure 1: DALL·E 2023-12-01 11.03.28 - An imposing, majestic wild boar combined with elements of a futuristic transformer robot. The boar itself should be intricately blended with these tra

SUS-Chat is a 34B bilingual Chinese-English dialogue model, jointly released by the Southern University of Science and Technology and International Digital Economy Academy. The SUS-Chat-34B model has been fine-tuned on millions of high-quality, multilingual instruction data. While maintaining the strong language capabilities of the base model, the SUS-Chat-34B model has improved the model’s response to human instructions through high-quality instruction fine-tuning and excels at imitating human thought processes through chains of thought. It introduces inter-instruction attention sharing in long texts, expanding the window size from 4K to 8K, significantly enhancing the usability of multi-round dialogues.

It has surpassed all models of the same size in almost all benchmark tests and is better suited to meet the practical needs of complex multilingual tasks. Compared to larger models, SUS-Chat-34B remains highly competitive and achieved state-of-the-art performance in our comprehensive evaluations.

SUS-Chat powerfully demonstrates that through the right instruction fine-tuning, academic institutions can achieve better performance without increasing model parameters, using open-source datasets and models. This bridges the gap between academia and industry in large language models and opens new possibilities for collaboration between academic and industrial sectors.

Performance

To better evaluate the performance of the SUS-Chat-34B model, we conducted assessments across multiple benchmark tests and have open-sourced the evaluation framework TLEM to facilitate replication and comparison by other researchers.

In TLEM, we utilized various benchmark tests including MMLU, CMMLU, C-Eval, BBH, GSM-8K, and MATH, focusing on measuring the model’s knowledge and thinking capabilities. In these metrics, the SUS-Chat-34B model achieved state-of-the-art performance. Additionally, we incorporated lm-eval to test SUS-Chat and similar models on winogrande, hellaswag, arc, and truthful-qa, assessing the model’s common-sense reasoning ability and susceptibility to illusions.

Overall, the SUS-Chat-34B model significantly outperformed models of similar scale and achieved the most advanced comprehensive performance.

model mmlu-chat cmmlu-chat ceval-chat gsm8k BBH MATH winogrande arc hellaswag truthfulqa average
GPT-4 83 71 69.9 91.4 86.7 45.8 87.5 94.5 91.4 nan 80.1333
SUS-Chat-34B 77.35 78.68 82.42 80.06 67.62 28.8 81.22 81.54 83.79 57.47 71.895
Qwen-72B-Chat 74.52 77.02 77.22 76.57 72.63 35.9 80.58 81.29 87.02 50.64 71.339
DeepSeek-67B-Chat 69.43 48.51 59.7 74.45 69.73 29.56 76.09 82.1 86.06 56.37 65.2
OrionStar-34B 68.51 66.88 65.13 54.36 62.88 12.8 77.27 80.19 84.54 53.24 62.58
Yi-34B-Chat 66.96 55.16 77.16 63.76 61.54 10.02 76.64 70.66 82.29 54.57 61.876

Figure 2: Benchmark

Usage

SUS-Chat-34B is a standard LLaMA model and should be seamlessly compatible with the LLaMA ecosystem. We provide the following example to demonstrate how it can be used for multi-turn dialogues.

from transformers import AutoModelForCausalLM, AutoTokenizer


def chat_template(messages):
    history = ""
    for message in messages:
        match message:
            case {"role": "user", "content": message}:
                history += f"### Human: {message}\n\n### Assistant: "
            case {"role": "assistant", "content": message}:
                history += message
    return history


model_path = "SUSTech/SUS-Chat-34B"

tokenizer = AutoTokenizer.from_pretrained(model_path, use_fast=False)
model = AutoModelForCausalLM.from_pretrained(
    model_path, device_map="auto", torch_dtype="auto"
).eval()

messages = [{"role": "user", "content": "hi"}]

input_ids = tokenizer.encode(chat_template(messages), return_tensors="pt").to("cuda")
output_ids = model.generate(input_ids.to("cuda"))
response = tokenizer.decode(
    output_ids[0][input_ids.shape[1] :], skip_special_tokens=True
)

messages.append({"role": "assistant", "content": response})

# Second round

messages.append({"role": "user", "content": "What is the capital of China?"})

input_ids = tokenizer.encode(chat_template(messages), return_tensors="pt").to("cuda")
output_ids = model.generate(input_ids.to("cuda"))
response = tokenizer.decode(
    output_ids[0][input_ids.shape[1] :], skip_special_tokens=True
)

messages.append({"role": "assistant", "content": response})

Limitations

SUS-Chat has only undergone supervised fine-tuning and has not yet been trained on human preference learning. As a result, it may produce unreasonable responses in some situations and exacerbate existing issues in language models, including hallucinations, non-determinism, and cumulative errors. To achieve better performance for downstream tasks, we recommend adjusting the generation configuration parameters accordingly.

Disclaimer

During the training process, we used data compliance check algorithms to ensure the compliance of the training model as much as possible. Due to the complexity of the data and the diverse use cases of language models, we cannot guarantee that the model will produce correct and reasonable outputs in all scenarios. Please be aware that there is still a risk of the model generating problematic outputs. We will not be responsible for any risks or issues arising from misuse, misguidance, illegal use, and related misinformation, as well as data security issues related to the model.

License

This model is developed entirely for academic research and free commercial use, but it must adhere to the license from 01-ai.

Downloads last month
295
GGUF
Model size
34.4B params
Architecture
llama

2-bit

3-bit

4-bit

5-bit

6-bit

8-bit

Inference Examples
Text Generation
Examples
Inference API (serverless) has been turned off for this model.

Model tree for TheBloke/SUS-Chat-34B-GGUF

Base model

SUSTech/SUS-Chat-34B
Quantized
(3)
this model