GGUF
English
Indonesian
asyafiqe's picture
Update README.md
0628ee2
|
raw
history blame
9.81 kB
metadata
inference: false
license: cc-by-nc-sa-4.0
datasets:
  - asyafiqe/orca_mini_v1_indonesia
language:
  - en
  - id

🦚Merak-7B-v3-Mini-Orca-GGUF🐳

Merak Orca

Description

These files are GGUF format model files for Merak-7B-v3-Mini-Orca.

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.

The key benefit of GGUF is that it is a extensible, future-proof format which stores more information about the model as metadata. It also includes significantly improved tokenization code, including for the first time full support for special tokens. This should improve performance, especially with models that use new special tokens and implement custom prompt templates.

Here are a list of clients and libraries that are known to support GGUF:

  • llama.cpp.
  • text-generation-webui, the most widely used web UI, with many features and powerful extensions.
  • KoboldCpp, a fully featured web UI, with full GPU accel across multiple platforms and GPU architectures. Especially good for story telling.
  • LM Studio, an easy-to-use and powerful local GUI with GPU acceleration on both Windows (NVidia and AMD), and macOS.
  • LoLLMS Web UI, a great web UI with many interesting and unique features, including a full model library for easy model selection.
  • ctransformers, a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server.
  • 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.

Prompt template:

You can use Vicuna 1.1 format for Ooobabooga's text generation webui.

SYSTEM: Anda adalah asisten AI. Anda akan diberi tugas. Anda harus memberikan jawaban yang rinci dan panjang.
USER: <prompt> (without the <>)
ASSISTANT:

Compatibility

These quantised GGUF files are compatible with llama.cpp from August 21st 2023 onwards, as of commit 6381d4e110bd0ec02843a60bbeb8b6fc37a9ace9

They are now also compatible with many third party UIs and libraries - please see the list at the top of the 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

Provided files

Name Quant method Bits Use case
Merak-7B-v3-Mini-Orca-Indo.gguf Q2_K 2 smallest, significant quality loss - not recommended for most purposes
Merak-7B-v3-Mini-Orca-Indo.q3_K_S.gguf Q3_K_S 3 very small, high quality loss
Merak-7B-v3-Mini-Orca-Indo.q3_K_M.gguf Q3_K_M 3 very small, high quality loss
Merak-7B-v3-Mini-Orca-Indo.q3_K_L.gguf Q3_K_L 3 small, substantial quality loss
Merak-7B-v3-Mini-Orca-Indo.q4_0.gguf Q4_0 4 legacy; small, very high quality loss - prefer using Q3_K_M
Merak-7B-v3-Mini-Orca-Indo.q4_K_S.gguf Q4_K_S 4 small, greater quality loss
Merak-7B-v3-Mini-Orca-Indo.q4_K_M.gguf Q4_K_M 4 medium, balanced quality - recommended
Merak-7B-v3-Mini-Orca-Indo.q5_0.gguf Q5_0 5 legacy; medium, balanced quality - prefer using Q4_K_M
Merak-7B-v3-Mini-Orca-Indo.q5_K_S.gguf Q5_K_S large, low quality loss - recommended
Merak-7B-v3-Mini-Orca-Indo.q5_K_M.gguf Q5_K_M 5 large, very low quality loss - recommended
Merak-7B-v3-Mini-Orca-Indo.q6_K.gguf Q6_K 6 very large, extremely low quality loss
Merak-7B-v3-Mini-Orca-Indo.q8_0.gguf Q8_0 8 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 run in text-generation-webui

Further instructions here: text-generation-webui/docs/llama.cpp.md.

Original model card: 🦚Merak-7B-v3-Mini-Orca🐳

Merak-7B-v3-Mini-Orca is Ichsan2895's Merak-7B-v3 fine-tuned on Bahasa Indonesia translated psmathur's orca_mini_v1_dataset.

Quantized versions is available:

GPTQ: https://huggingface.co/asyafiqe/Merak-7B-v3-Mini-Orca-Indo-GPTQ

GGML/GGUF: I will try to make this version once GGUF merge is stable.

Start chatting with Merak Mini Orca using the following code snippet:

import torch
from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline
tokenizer = AutoTokenizer.from_pretrained("asyafiqe/Merak-7B-v3-Mini-Orca-Indo")
model = AutoModelForCausalLM.from_pretrained("asyafiqe/Merak-7B-v3-Mini-Orca-Indo", torch_dtype=torch.float16, device_map="auto")

system_prompt = "SYSTEM: 'Anda adalah asisten AI. Anda akan diberi tugas. Anda harus menghasilkan jawaban yang rinci dan panjang.\n"

message = "Buatlah rencana untuk mengurangi penggunaan listrik di rumah."

prompt = f"{system_prompt}USER: {message}\nASSISTANT:"
inputs = tokenizer(prompt, return_tensors="pt").to("cuda")
output = model.generate(**inputs, do_sample=True, temperature=0.1, max_new_tokens=200)

print(tokenizer.decode(output[0], skip_special_tokens=True))

Prompt format

You can use Vicuna 1.1 format for Ooobabooga's text generation webui.

SYSTEM: Anda adalah asisten AI. Anda akan diberi tugas. Anda harus memberikan jawaban yang rinci dan panjang.
USER: <prompt> (without the <>)
ASSISTANT:

Training details

Built with Axolotl

Merak-7B-v3-Mini-Orca was instruction fine-tuned on 2 x 3090-24GB for 6 hours. LoRA, DeepSpeed ZeRO-2, and FlashAttention were implemented during training using Axolotl.

Hyperparameter value
learning rate 0.0004
batch size 16
microbatch size 2
warmup step 100
epochs 2
weight decay 0.0
lr scheduler cosine
lora alpha 16
lora rank 16
lora dropout 0.05
lora target modules q_proj, v_proj, k_proj, o_proj
cutoff length 4096

Training loss

Step Train Loss
1 0.9578
100 0.816
200 0.7819
300 0.7279
400 0.732
500 0.7139
600 0.6829
700 0.6641
800 0.6553

Limitations and bias

Llama 2 and fine-tuned variants are a new technology that carries risks with use. Testing conducted to date has been in English, and has not covered, nor could it cover all scenarios. For these reasons, as with all LLMs, Llama 2 and any fine-tuned varient's potential outputs cannot be predicted in advance, and the model may in some instances produce inaccurate, biased or other objectionable responses to user prompts. Therefore, before deploying any applications of Llama 2 variants, developers should perform safety testing and tuning tailored to their specific applications of the model.

Please see the Responsible Use Guide available at https://ai.meta.com/llama/responsible-use-guide/

Citation

@Paper{arXiv,
  author  = {Touvron, et al},
  title   = {Llama 2: Open Foundation and Fine-Tuned Chat Models},
  journal = {arXiv preprint arXiv:2307.09288},
  year    = {2023}
}
@misc{orca_mini_v3_70b,
  author = {Pankaj Mathur},
  title = {orca_mini_v3_70b: An Orca Style Llama2-70b model},
  year = {2023},
  publisher = {HuggingFace},
  journal = {HuggingFace repository},
  howpublished = {\url{https://https://huggingface.co/psmathur/orca_mini_v3_70b},
}
@article{hu2021lora,
  title={LoRA: Low-Rank Adaptation of Large Language Models},
  author={Hu, Edward J. and Shen, Yelong and Wallis, Phillip and Allen-Zhu, Zeyuan and Li, Yuanzhi and Wang, Shean and Chen, Weizhu},
  journal={CoRR},
  year={2021}
}

readme adapted from TheBloke