mzwing/NSFW_13B_sft-GGUF

NSFW 13B sft - GGUF

• —Model creator: zxbsmk
• —Original model: NSFW 13B sft

<!-- description start -->

Description

This repo contains GGUF format model files for zxbsmk's NSFW 13B sft.

These files were quantised using hardware kindly provided by Google Colab(Free CPU Machine).


You can also check it out easily in my GitHub repo.

<!-- description end -->

<!-- README_GGUF.md-about-gguf start -->

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 incomplate 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.
• —LM Studio, an easy-to-use and powerful local GUI for Windows and macOS (Silicon), with GPU acceleration.
• —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.
• —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.
• —Nitro, a fast, lightweight 3mb inference server to supercharge apps with local AI, and OpenAI-compatible API server.

<!-- README_GGUF.md-about-gguf end -->

<!-- repositories-available start -->

Repositories available

• —2, 3, 4, 5, 6, 8, 16 and 32-bit GGUF models for CPU+GPU inference
• —zxbsmk's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions

<!-- repositories-available end -->

<!-- prompt-template start -->

Prompt template: BLING

System: A chat between a curious human and an artificial intelligence assistant. The assistant gives helpful, detailed, and polite answers to the human's questions.
Human: {prompt}
Assistant:

<!-- prompt-template end -->

<!-- compatibility_gguf start -->

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

<details> <summary>Click to see details</summary>

The new methods available are:

• —GGMLTYPEQ2_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)
• —GGMLTYPEQ3_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.
• —GGMLTYPEQ4_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.
• —GGMLTYPEQ5K - "type-1" 5-bit quantization. Same super-block structure as GGMLTYPEQ4K resulting in 5.5 bpw
• —GGMLTYPEQ6_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. </details>

<!-- compatibility_gguf end -->

<!-- README_GGUF.md-provided-files start -->

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.

<!-- README_GGUF.md-provided-files end -->

<!-- README_GGUF.md-how-to-download start -->

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

<details> <summary>More advanced huggingface-cli download usage</summary>

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

huggingface-cli download mzwing/NSFW_13B_sft-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 mzwing/NSFW_13B_sft-GGUF NSFW_13B_sft.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. </details> <!-- README_GGUF.md-how-to-download end -->

<!-- README_GGUF.md-how-to-run start -->

Example llama.cpp command

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

./main -ngl 32 -m NSFW_13B_sft.Q4_K_M.gguf --color -c 2048 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "System: A chat between a curious human and an artificial intelligence assistant. The assistant gives helpful, detailed, and polite answers to the human's questions.\nHuman: {prompt}\nAssistant:"

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

Change -c 2048 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.

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 here: text-generation-webui/docs/llama.cpp.md.

How to run from Python code

You can use GGUF models from Python using the llama-cpp-python or ctransformers libraries.

How to load this model in Python code, using ctransformers

First install the package

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

# Base ctransformers with no GPU acceleration
pip install ctransformers
# Or with CUDA GPU acceleration
pip install ctransformers[cuda]
# Or with AMD ROCm GPU acceleration (Linux only)
CT_HIPBLAS=1 pip install ctransformers --no-binary ctransformers
# Or with Metal GPU acceleration for macOS systems only
CT_METAL=1 pip install ctransformers --no-binary ctransformers

Simple ctransformers example code

from ctransformers import AutoModelForCausalLM

# 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 = AutoModelForCausalLM.from_pretrained("mzwing/NSFW_13B_sft-GGUF", model_file="NSFW_13B_sft.Q4_K_M.gguf", model_type="phi", gpu_layers=50)

print(llm("AI is going to"))

How to use with LangChain

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

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

<!-- README_GGUF.md-how-to-run end -->

<!-- footer start --> <!-- 200823 -->

Thanks, and how to contribute

Thanks to Google Colab! All the quantised models in this repo are done on the awesome platform. Thanks a lot!

Thanks to llama.cpp! It inspired me to explore the inspiring AI field, thanks!

Thanks to TheBloke! Everything in this repo is a reference to him.

You are welcome to create a PullRequest! Especially for the RAM Usage!

<!-- footer end -->

<!-- original-model-card start -->

A instruction-tuned model of https://huggingface.co/baichuan-inc/Baichuan-13B-Base

• —Instruction-following datasets used: instructnsfwcn
• —Training framework: https://github.com/hiyouga/LLaMA-Efficient-Tuning

Usage:

from transformers import AutoModelForCausalLM, AutoTokenizer, TextStreamer
tokenizer = AutoTokenizer.from_pretrained("zxbsmk/NSFW_13B_sft", trust_remote_code=True)
model = AutoModelForCausalLM.from_pretrained("zxbsmk/NSFW_13B_sft", trust_remote_code=True).cuda()
streamer = TextStreamer(tokenizer, skip_prompt=True, skip_special_tokens=True)
query = "续写。白洁已经动情了，肩带滑落露出香肩。"
inputs = tokenizer([query], return_tensors="pt")
inputs = inputs.to("cuda")
generate_ids = model.generate(**inputs, max_new_tokens=1024, streamer=streamer)

You could also alternatively launch a CLI demo by using the script in https://github.com/hiyouga/LLaMA-Efficient-Tuning

python src/cli_demo.py --template baichuan --model_name_or_path zxbsmk/NSFW_13B_sft

Examples:

Omit part of results for better visualization.

Evaluation

Comparision between Baichuan-13B-Chat and NSFW13Bsft. (Zero-shot CMMLU)

(By the way, Baichuan-13B-Chat gets 50.43 with one-shot which seems much better than 48.86 with zero-shot.)

Contact Us

Join group via https://t.me/+JbovpBG6-gBiNDI1

<!-- original-model-card end -->