Update README.md
Browse files
README.md
CHANGED
@@ -2,78 +2,3 @@
|
|
2 |
license: bigcode-openrail-m
|
3 |
---
|
4 |
|
5 |
-
# CodeLlama 7B - GGUF
|
6 |
-
- Model creator: [Infosys](https://huggingface.co/infosys)
|
7 |
-
- Original model: [NT-Java-1.1B](https://huggingface.co/infosys/NT-Java-1.1B)
|
8 |
-
|
9 |
-
<!-- description start -->
|
10 |
-
## Description
|
11 |
-
|
12 |
-
This repo contains GGUF format model files for [Infosys's NT-Java-1.1B](https://huggingface.co/infosys/NT-Java-1.1B).
|
13 |
-
|
14 |
-
<!-- description end -->
|
15 |
-
<!-- README_GGUF.md-about-gguf start -->
|
16 |
-
### About GGUF
|
17 |
-
|
18 |
-
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. GGUF offers numerous advantages over GGML, such as better tokenisation, and support for special tokens. It is also supports metadata, and is designed to be extensible.
|
19 |
-
|
20 |
-
Here is an incomplate list of clients and libraries that are known to support GGUF:
|
21 |
-
|
22 |
-
* [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
|
23 |
-
* [text-generation-webui](https://github.com/oobabooga/text-generation-webui), the most widely used web UI, with many features and powerful extensions. Supports GPU acceleration.
|
24 |
-
* [KoboldCpp](https://github.com/LostRuins/koboldcpp), a fully featured web UI, with GPU accel across all platforms and GPU architectures. Especially good for story telling.
|
25 |
-
* [LM Studio](https://lmstudio.ai/), an easy-to-use and powerful local GUI for Windows and macOS (Silicon), with GPU acceleration.
|
26 |
-
* [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui), a great web UI with many interesting and unique features, including a full model library for easy model selection.
|
27 |
-
* [Faraday.dev](https://faraday.dev/), an attractive and easy to use character-based chat GUI for Windows and macOS (both Silicon and Intel), with GPU acceleration.
|
28 |
-
* [ctransformers](https://github.com/marella/ctransformers), a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server.
|
29 |
-
* [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
|
30 |
-
* [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
|
31 |
-
|
32 |
-
<!-- README_GGUF.md-about-gguf end -->
|
33 |
-
|
34 |
-
<!-- prompt-template start -->
|
35 |
-
## Prompt template: None
|
36 |
-
|
37 |
-
```
|
38 |
-
{prompt}
|
39 |
-
|
40 |
-
```
|
41 |
-
|
42 |
-
<!-- prompt-template end -->
|
43 |
-
|
44 |
-
|
45 |
-
<!-- compatibility_gguf start -->
|
46 |
-
|
47 |
-
## Explanation of quantisation methods
|
48 |
-
<details>
|
49 |
-
<summary>Click to see details</summary>
|
50 |
-
|
51 |
-
The new methods available are:
|
52 |
-
* 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)
|
53 |
-
* 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.
|
54 |
-
* 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.
|
55 |
-
* GGML_TYPE_Q5_K - "type-1" 5-bit quantization. Same super-block structure as GGML_TYPE_Q4_K resulting in 5.5 bpw
|
56 |
-
* 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
|
57 |
-
|
58 |
-
Refer to the Provided Files table below to see what files use which methods, and how.
|
59 |
-
</details>
|
60 |
-
<!-- compatibility_gguf end -->
|
61 |
-
|
62 |
-
<!-- README_GGUF.md-provided-files start -->
|
63 |
-
## Provided files
|
64 |
-
|
65 |
-
| Name | Quant method | Bits | Size | Max RAM required | Use case |
|
66 |
-
| ---- | ---- | ---- | ---- | ---- | ----- |
|
67 |
-
| [NT-Java-1.1B_Q3_K_M.gguf](https://huggingface.co/infosys/NT-Java-1.1B-GGUF/blob/main/NT-Java-1.1B_Q3_K_M.gguf) | Q3_K_M | 3 | 663 MB| 5.80 GB | very small, high quality loss |
|
68 |
-
| [NT-Java-1.1B_Q4_0.gguf](https://huggingface.co/infosys/NT-Java-1.1B-GGUF/blob/main/NT-Java-1.1B_Q4_0.gguf) | Q4_0 | 4 | 726 MB| 6.33 GB | legacy; small, very high quality loss - prefer using Q3_K_M |
|
69 |
-
| [NT-Java-1.1B_Q4_K_M.gguf](https://huggingface.co/infosys/NT-Java-1.1B-GGUF/blob/main/NT-Java-1.1B_Q4_K_M.gguf) | Q4_K_M | 4 | 792 MB| 6.58 GB | medium, balanced quality - recommended |
|
70 |
-
| [NT-Java-1.1B_Q5_K_M.gguf](https://huggingface.co/infosys/NT-Java-1.1B-GGUF/blob/main/NT-Java-1.1B_Q5_K_M.gguf) | Q5_K_M | 5 | 910 MB| 7.28 GB | large, very low quality loss - recommended |
|
71 |
-
| [NT-Java-1.1B_Q6_K.gguf](https://huggingface.co/infosys/NT-Java-1.1B-GGUF/blob/main/NT-Java-1.1B_Q6_K.gguf) | Q6_K | 6 | 1.02 GB| 8.03 GB | very large, extremely low quality loss |
|
72 |
-
| [NT-Java-1.1B_Q8_0.gguf](https://huggingface.co/infosys/NT-Java-1.1B-GGUF/blob/main/NT-Java-1.1B_Q8_0.gguf) | Q8_0 | 8 | 1.32 GB| 9.66 GB | very large, extremely low quality loss - not recommended |
|
73 |
-
|
74 |
-
**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.
|
75 |
-
|
76 |
-
|
77 |
-
|
78 |
-
|
79 |
-
|
|
|
2 |
license: bigcode-openrail-m
|
3 |
---
|
4 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|