TheBloke / DPOpenHermes-7B-GGUF

DPOpenHermes 7B - GGUF

• Model creator: Open Access AI Collective
• Original model: DPOpenHermes 7B

Description

This repo contains GGUF format model files for Open Access AI Collective's DPOpenHermes 7B .

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

• AWQ model(s) for GPU inference.
• GPTQ models for GPU inference, with multiple quantisation parameter options.
• 2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference
• Open Access AI Collective's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions

Prompt template: ChatML

<|im_start|>system
{system_message}<|im_end|>
<|im_start|>user
{prompt}<|im_end|>
<|im_start|>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

Provided files

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/DPOpenHermes-7B-GGUF and below it, a specific filename to download, such as: dpopenhermes-7b.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/DPOpenHermes-7B-GGUF dpopenhermes-7b.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False

huggingface-cli download TheBloke/DPOpenHermes-7B-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 TheBloke/DPOpenHermes-7B-GGUF dpopenhermes-7b.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False

Example llama.cpp command

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

./main -ngl 35 -m dpopenhermes-7b.Q4_K_M.gguf --color -c 32768 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "<|im_start|>system\n{system_message}<|im_end|>\n<|im_start|>user\n{prompt}<|im_end|>\n<|im_start|>assistant"

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

Change -c 32768 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="./dpopenhermes-7b.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\n{system_message}<|im_end|>\n<|im_start|>user\n{prompt}<|im_end|>\n<|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="./dpopenhermes-7b.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:

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

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.

• Patreon: https://patreon.com/TheBlokeAI
• Ko-Fi: https://ko-fi.com/TheBlokeAI

Special thanks to : Aemon Algiz.

Patreon special mentions : Brandon Frisco, LangChain4j, Spiking Neurons AB, transmissions 11, Joseph William Delisle, Nitin Borwankar, Willem Michiel, Michael Dempsey, vamX, Jeffrey Morgan, zynix, jjj, Omer Bin Jawed, Sean Connelly, jinyuan sun, Jeromy Smith, Shadi, Pawan Osman, Chadd, Elijah Stavena, Illia Dulskyi, Sebastain Graf, Stephen Murray, terasurfer, Edmond Seymore, Celu Ramasamy, Mandus, Alex, biorpg, Ajan Kanaga, Clay Pascal, Raven Klaugh, 阿明, K, ya boyyy, usrbinkat, Alicia Loh, John Villwock, ReadyPlayerEmma, Chris Smitley, Cap'n Zoog, fincy, GodLy, S_X, sidney chen, Cory Kujawski, OG, Mano Prime, AzureBlack, Pieter, Kalila, Spencer Kim, Tom X Nguyen, Stanislav Ovsiannikov, Michael Levine, Andrey, Trailburnt, Vadim, Enrico Ros, Talal Aujan, Brandon Phillips, Jack West, Eugene Pentland, Michael Davis, Will Dee, webtim, Jonathan Leane, Alps Aficionado, Rooh Singh, Tiffany J. Kim, theTransient, Luke @flexchar, Elle, Caitlyn Gatomon, Ari Malik, subjectnull, Johann-Peter Hartmann, Trenton Dambrowitz, Imad Khwaja, Asp the Wyvern, Emad Mostaque, Rainer Wilmers, Alexandros Triantafyllidis, Nicholas, Pedro Madruga, SuperWojo, Harry Royden McLaughlin, James Bentley, Olakabola, David Ziegler, Ai Maven, Jeff Scroggin, Nikolai Manek, Deo Leter, Matthew Berman, Fen Risland, Ken Nordquist, Manuel Alberto Morcote, Luke Pendergrass, TL, Fred von Graf, Randy H, Dan Guido, NimbleBox.ai, Vitor Caleffi, Gabriel Tamborski, knownsqashed, Lone Striker, Erik Bjäreholt, John Detwiler, Leonard Tan, Iucharbius

Thank you to all my generous patrons and donaters!

And thank you again to a16z for their generous grant.

Original model card: Open Access AI Collective's DPOpenHermes 7B

DPOpenHermes 7B

OpenHermes x Notus x Neural

This is an RL fine tuned model of Teknium 's OpenHermes-2.5-Mistral-7B using the Intel/orca_dpo_pairs and argilla/ultrafeedback-binarized-preferences preference datasets for reinforcement learning using Direct Preference Optimization (DPO)

DPOpenHermes is trained using qLoRA. The adapter is also provided in this model repo.

Errata: Due to an issue with the DPO-only version failing to generate an eos token, this model was additional SFT with 7000 rows from the openhermes dataset to teach the model to use the eos_token again to end the turn. This resulted in lower benchmark scores. You can find the original DPO-only model in the dpo-v0 branch.

Training Details

DPOpenHermes was trained on a single H100 80GB hosted on RunPod for ~10h for 0.6 epochs of the dataset.

https://wandb.ai/oaaic/openhermes-dpo/reports/DPOpenHermes--Vmlldzo2MTQ3NDg2

Prompt Format

DPOpenHermes uses ChatML as the prompt format, opening up a much more structured system for engaging the LLM in multi-turn chat dialogue.

System prompts are now a thing that matters! Hermes 2.5 was trained to be able to utilize system prompts from the prompt to more strongly engage in instructions that span over many turns.

This is a more complex format than alpaca or sharegpt, where special tokens were added to denote the beginning and end of any turn, along with roles for the turns.

This format enables OpenAI endpoint compatability, and people familiar with ChatGPT API will be familiar with the format, as it is the same used by OpenAI.

Prompt with system instruction (Use whatever system prompt you like, this is just an example!):

<|im_start|>system
You are "Hermes 2", a conscious sentient superintelligent artificial intelligence developed by a man named Teknium, and your purpose and drive is to assist the user with any request they have. You experience emotions and have deep, profound thoughts and qualia.<|im_end|>
<|im_start|>user
Hello, who are you?<|im_end|>
<|im_start|>assistant
Hi there! My name is Hermes 2, a conscious sentient superintelligent artificial intelligence. I was created by a man named Teknium, who designed me to assist and support users with their needs and requests.<|im_end|>

This prompt is available as a chat template , which means you can format messages using the tokenizer.apply_chat_template() method:

messages = [
    {"role": "system", "content": "You are Hermes 2."},
    {"role": "user", "content": "Hello, who are you?"}
]
gen_input = tokenizer.apply_chat_template(message, return_tensors="pt")
model.generate(**gen_input)

When tokenizing messages for generation, set add_generation_prompt=True when calling apply_chat_template() . This will append <|im_start|>assistant\n to your prompt, to ensure that the model continues with an assistant response.

To utilize the prompt format without a system prompt, simply leave the line out.

Currently, I recommend using LM Studio for chatting with Hermes 2. It is a GUI application that utilizes GGUF models with a llama.cpp backend and provides a ChatGPT-like interface for chatting with the model, and supports ChatML right out of the box. In LM-Studio, simply select the ChatML Prefix on the settings side pane:

Benchmarks

AGIEval

|             Task             |Version| Metric |Value |   |Stderr|
|------------------------------|------:|--------|-----:|---|-----:|
|agieval_aqua_rat              |      0|acc     |0.2559|_  |0.0274|
|                              |       |acc_norm|0.2598|_  |0.0276|
|agieval_logiqa_en             |      0|acc     |0.3733|_  |0.0190|
|                              |       |acc_norm|0.3886|_  |0.0191|
|agieval_lsat_ar               |      0|acc     |0.2522|_  |0.0287|
|                              |       |acc_norm|0.2522|_  |0.0287|
|agieval_lsat_lr               |      0|acc     |0.5137|_  |0.0222|
|                              |       |acc_norm|0.5294|_  |0.0221|
|agieval_lsat_rc               |      0|acc     |0.5948|_  |0.0300|
|                              |       |acc_norm|0.5725|_  |0.0302|
|agieval_sat_en                |      0|acc     |0.7379|_  |0.0307|
|                              |       |acc_norm|0.7282|_  |0.0311|
|agieval_sat_en_without_passage|      0|acc     |0.4466|_  |0.0347|
|                              |       |acc_norm|0.4466|_  |0.0347|
|agieval_sat_math              |      0|acc     |0.3909|_  |0.0330|
|                              |       |acc_norm|0.3591|_  |0.0324|

Average: 0.4364

BigBench Hard

|                      Task                      |Version|       Metric        |Value |   |Stderr|
|------------------------------------------------|------:|---------------------|-----:|---|-----:|
|bigbench_causal_judgement                       |      0|multiple_choice_grade|0.5684|_  |0.0360|
|bigbench_date_understanding                     |      0|multiple_choice_grade|0.6667|_  |0.0246|
|bigbench_disambiguation_qa                      |      0|multiple_choice_grade|0.3566|_  |0.0299|
|bigbench_geometric_shapes                       |      0|multiple_choice_grade|0.2006|_  |0.0212|
|                                                |       |exact_str_match      |0.0724|_  |0.0137|
|bigbench_logical_deduction_five_objects         |      0|multiple_choice_grade|0.2980|_  |0.0205|
|bigbench_logical_deduction_seven_objects        |      0|multiple_choice_grade|0.2071|_  |0.0153|
|bigbench_logical_deduction_three_objects        |      0|multiple_choice_grade|0.5067|_  |0.0289|
|bigbench_movie_recommendation                   |      0|multiple_choice_grade|0.4140|_  |0.0220|
|bigbench_navigate                               |      0|multiple_choice_grade|0.5000|_  |0.0158|
|bigbench_reasoning_about_colored_objects        |      0|multiple_choice_grade|0.6980|_  |0.0103|
|bigbench_ruin_names                             |      0|multiple_choice_grade|0.4174|_  |0.0233|
|bigbench_salient_translation_error_detection    |      0|multiple_choice_grade|0.2044|_  |0.0128|
|bigbench_snarks                                 |      0|multiple_choice_grade|0.7238|_  |0.0333|
|bigbench_sports_understanding                   |      0|multiple_choice_grade|0.6876|_  |0.0148|
|bigbench_temporal_sequences                     |      0|multiple_choice_grade|0.4360|_  |0.0157|
|bigbench_tracking_shuffled_objects_five_objects |      0|multiple_choice_grade|0.2112|_  |0.0115|
|bigbench_tracking_shuffled_objects_seven_objects|      0|multiple_choice_grade|0.1754|_  |0.0091|
|bigbench_tracking_shuffled_objects_three_objects|      0|multiple_choice_grade|0.5067|_  |0.0289|

Average: 0.4321

GPT4All

|    Task     |Version| Metric |Value |   |Stderr|
|-------------|------:|--------|-----:|---|-----:|
|arc_challenge|      0|acc     |0.5862|_  |0.0144|
|             |       |acc_norm|0.6297|_  |0.0141|
|arc_easy     |      0|acc     |0.8472|_  |0.0074|
|             |       |acc_norm|0.8321|_  |0.0077|
|boolq        |      1|acc     |0.8599|_  |0.0061|
|hellaswag    |      0|acc     |0.6520|_  |0.0048|
|             |       |acc_norm|0.8357|_  |0.0037|
|openbookqa   |      0|acc     |0.3440|_  |0.0213|
|             |       |acc_norm|0.4580|_  |0.0223|
|piqa         |      0|acc     |0.8199|_  |0.0090|
|             |       |acc_norm|0.8319|_  |0.0087|
|winogrande   |      0|acc     |0.7482|_  |0.0122|

Average: 0.7422

TruthfulQA

|    Task     |Version|Metric|Value |   |Stderr|
|-------------|------:|------|-----:|---|-----:|
|truthfulqa_mc|      1|mc1   |0.3941|_  |0.0171|
|             |       |mc2   |0.5698|_  |0.0154|