Upload README.md with huggingface_hub

README.md

@@ -1,216 +1,17 @@
 ---
-pipeline_tag: text-generation
-base_model: ibm-granite/granite-20b-code-base
-inference: true
-license: apache-2.0
-datasets:
-- bigcode/commitpackft
-- TIGER-Lab/MathInstruct
-- meta-math/MetaMathQA
-- glaiveai/glaive-code-assistant-v3
-- glaive-function-calling-v2
-- bugdaryan/sql-create-context-instruction
-- garage-bAInd/Open-Platypus
-- nvidia/HelpSteer
-metrics:
-- code_eval
-library_name: transformers
-tags:
-- code
-- granite
-model-index:
-- name: granite-20b-code-instruct
-  results:
-  - task:
-      type: text-generation
-    dataset:
-        type: bigcode/humanevalpack 
-        name: HumanEvalSynthesis(Python)
-    metrics:
-    - name: pass@1
-      type: pass@1
-      value: 60.4
-      veriefied: false
-  - task:
-      type: text-generation
-    dataset:
-        type: bigcode/humanevalpack  
-        name: HumanEvalSynthesis(JavaScript)
-    metrics:
-    - name: pass@1
-      type: pass@1
-      value: 53.7
-      veriefied: false
-  - task:
-      type: text-generation
-    dataset:
-        type: bigcode/humanevalpack  
-        name: HumanEvalSynthesis(Java)
-    metrics:
-    - name: pass@1
-      type: pass@1
-      value: 58.5
-      veriefied: false
-  - task:
-      type: text-generation
-    dataset:
-        type: bigcode/humanevalpack  
-        name: HumanEvalSynthesis(Go)
-    metrics:
-    - name: pass@1
-      type: pass@1
-      value: 42.1
-      veriefied: false
-  - task:
-      type: text-generation
-    dataset:
-        type: bigcode/humanevalpack  
-        name: HumanEvalSynthesis(C++)
-    metrics:
-    - name: pass@1
-      type: pass@1
-      value: 45.7
-      veriefied: false
-  - task:
-      type: text-generation
-    dataset:
-        type: bigcode/humanevalpack  
-        name: HumanEvalSynthesis(Rust)
-    metrics:
-    - name: pass@1
-      type: pass@1
-      value: 42.7
-      veriefied: false
-  - task:
-      type: text-generation
-    dataset:
-        type: bigcode/humanevalpack  
-        name:  HumanEvalExplain(Python)
-    metrics:
-    - name: pass@1
-      type: pass@1
-      value: 44.5
-      veriefied: false
-  - task:
-      type: text-generation
-    dataset:
-        type: bigcode/humanevalpack  
-        name:  HumanEvalExplain(JavaScript)
-    metrics:
-    - name: pass@1
-      type: pass@1
-      value: 42.7
-      veriefied: false
-  - task:
-      type: text-generation
-    dataset:
-        type: bigcode/humanevalpack  
-        name:  HumanEvalExplain(Java)
-    metrics:
-    - name: pass@1
-      type: pass@1
-      value: 49.4
-      veriefied: false
-  - task:
-      type: text-generation
-    dataset:
-        type: bigcode/humanevalpack  
-        name:  HumanEvalExplain(Go)
-    metrics:
-    - name: pass@1
-      type: pass@1
-      value: 32.3
-      veriefied: false
-  - task:
-      type: text-generation
-    dataset:
-        type: bigcode/humanevalpack  
-        name:  HumanEvalExplain(C++)
-    metrics:
-    - name: pass@1
-      type: pass@1
-      value: 42.1
-      veriefied: false
-  - task:
-      type: text-generation
-    dataset:
-        type: bigcode/humanevalpack  
-        name:  HumanEvalExplain(Rust)
-    metrics:
-    - name: pass@1
-      type: pass@1
-      value: 18.3
-      veriefied: false
-  - task:
-      type: text-generation
-    dataset:
-        type: bigcode/humanevalpack  
-        name:  HumanEvalFix(Python)
-    metrics:
-    - name: pass@1
-      type: pass@1
-      value: 43.9
-      veriefied: false
-  - task:
-      type: text-generation
-    dataset:
-        type: bigcode/humanevalpack  
-        name:  HumanEvalFix(JavaScript)
-    metrics:
-    - name: pass@1
-      type: pass@1
-      value: 43.9
-      veriefied: false
-  - task:
-      type: text-generation
-    dataset:
-        type: bigcode/humanevalpack  
-        name:  HumanEvalFix(Java)
-    metrics:
-    - name: pass@1
-      type: pass@1
-      value: 45.7
-      veriefied: false
-  - task:
-      type: text-generation
-    dataset:
-        type: bigcode/humanevalpack  
-        name:  HumanEvalFix(Go)
-    metrics:
-    - name: pass@1
-      type: pass@1
-      value: 41.5
-      veriefied: false
-  - task:
-      type: text-generation
-    dataset:
-        type: bigcode/humanevalpack  
-        name:  HumanEvalFix(C++)
-    metrics:
-    - name: pass@1
-      type: pass@1
-      value: 41.5
-      veriefied: false
-  - task:
-      type: text-generation
-    dataset:
-        type: bigcode/humanevalpack  
-        name:  HumanEvalFix(Rust)
-    metrics:
-    - name: pass@1
-      type: pass@1
-      value: 29.9
-      veriefied: false
 quantized_by: bartowski
+pipeline_tag: text-generation
 ---
 
 ## Llamacpp imatrix Quantizations of granite-20b-code-instruct
 
-Using <a href="https://github.com/ggerganov/llama.cpp/">llama.cpp</a> release <a href="https://github.com/ggerganov/llama.cpp/releases/tag/b2940">b2940</a> for quantization.
+Using <a href="https://github.com/ggerganov/llama.cpp/">llama.cpp</a> release <a href="https://github.com/ggerganov/llama.cpp/releases/tag/b3634">b3634</a> for quantization.
 
 Original model: https://huggingface.co/ibm-granite/granite-20b-code-instruct
 
-All quants made using imatrix option with dataset from [here](https://gist.github.com/bartowski1182/b6ac44691e994344625687afe3263b3a)
+All quants made using imatrix option with dataset from [here](https://gist.github.com/bartowski1182/eb213dccb3571f863da82e99418f81e8)
+
+Run them in [LM Studio](https://lmstudio.ai/)
 
 ## Prompt format
 
@@ -223,34 +24,62 @@ Question:
 
 Answer:
 
+
+Answer:
 ```
 
+## What's new:
+
+New model update
+
 ## Download a file (not the whole branch) from below:
 
-| Filename | Quant type | File Size | Description |
-| -------- | ---------- | --------- | ----------- |
-| [granite-20b-code-instruct-Q8_0.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-Q8_0.gguf) | Q8_0 | 21.48GB | Extremely high quality, generally unneeded but max available quant. |
-| [granite-20b-code-instruct-Q6_K.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-Q6_K.gguf) | Q6_K | 16.63GB | Very high quality, near perfect, *recommended*. |
-| [granite-20b-code-instruct-Q5_K_M.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-Q5_K_M.gguf) | Q5_K_M | 14.80GB | High quality, *recommended*. |
-| [granite-20b-code-instruct-Q5_K_S.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-Q5_K_S.gguf) | Q5_K_S | 14.01GB | High quality, *recommended*. |
-| [granite-20b-code-instruct-Q4_K_M.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-Q4_K_M.gguf) | Q4_K_M | 12.82GB | Good quality, uses about 4.83 bits per weight, *recommended*. |
-| [granite-20b-code-instruct-Q4_K_S.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-Q4_K_S.gguf) | Q4_K_S | 11.66GB | Slightly lower quality with more space savings, *recommended*. |
-| [granite-20b-code-instruct-IQ4_NL.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-IQ4_NL.gguf) | IQ4_NL | 11.55GB | Decent quality, slightly smaller than Q4_K_S with similar performance *recommended*. |
-| [granite-20b-code-instruct-IQ4_XS.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-IQ4_XS.gguf) | IQ4_XS | 10.93GB | Decent quality, smaller than Q4_K_S with similar performance, *recommended*. |
-| [granite-20b-code-instruct-Q3_K_L.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-Q3_K_L.gguf) | Q3_K_L | 11.73GB | Lower quality but usable, good for low RAM availability. |
-| [granite-20b-code-instruct-Q3_K_M.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-Q3_K_M.gguf) | Q3_K_M | 10.56GB | Even lower quality. |
-| [granite-20b-code-instruct-IQ3_M.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-IQ3_M.gguf) | IQ3_M | 9.58GB | Medium-low quality, new method with decent performance comparable to Q3_K_M. |
-| [granite-20b-code-instruct-IQ3_S.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-IQ3_S.gguf) | IQ3_S | 8.93GB | Lower quality, new method with decent performance, recommended over Q3_K_S quant, same size with better performance. |
-| [granite-20b-code-instruct-Q3_K_S.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-Q3_K_S.gguf) | Q3_K_S | 8.93GB | Low quality, not recommended. |
-| [granite-20b-code-instruct-IQ3_XS.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-IQ3_XS.gguf) | IQ3_XS | 8.65GB | Lower quality, new method with decent performance, slightly better than Q3_K_S. |
-| [granite-20b-code-instruct-IQ3_XXS.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-IQ3_XXS.gguf) | IQ3_XXS | 8.06GB | Lower quality, new method with decent performance, comparable to Q3 quants. |
-| [granite-20b-code-instruct-Q2_K.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-Q2_K.gguf) | Q2_K | 7.92GB | Very low quality but surprisingly usable. |
-| [granite-20b-code-instruct-IQ2_M.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-IQ2_M.gguf) | IQ2_M | 7.05GB | Very low quality, uses SOTA techniques to also be surprisingly usable. |
-| [granite-20b-code-instruct-IQ2_S.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-IQ2_S.gguf) | IQ2_S | 6.52GB | Very low quality, uses SOTA techniques to be usable. |
-| [granite-20b-code-instruct-IQ2_XS.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-IQ2_XS.gguf) | IQ2_XS | 6.15GB | Very low quality, uses SOTA techniques to be usable. |
-| [granite-20b-code-instruct-IQ2_XXS.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-IQ2_XXS.gguf) | IQ2_XXS | 5.57GB | Lower quality, uses SOTA techniques to be usable. |
-| [granite-20b-code-instruct-IQ1_M.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-IQ1_M.gguf) | IQ1_M | 4.91GB | Extremely low quality, *not* recommended. |
-| [granite-20b-code-instruct-IQ1_S.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-IQ1_S.gguf) | IQ1_S | 4.51GB | Extremely low quality, *not* recommended. |
+| Filename | Quant type | File Size | Split | Description |
+| -------- | ---------- | --------- | ----- | ----------- |
+| [granite-20b-code-instruct-f16.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-f16.gguf) | f16 | 40.24GB | false | Full F16 weights. |
+| [granite-20b-code-instruct-Q8_0.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-Q8_0.gguf) | Q8_0 | 21.48GB | false | Extremely high quality, generally unneeded but max available quant. |
+| [granite-20b-code-instruct-Q6_K_L.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-Q6_K_L.gguf) | Q6_K_L | 16.71GB | false | Uses Q8_0 for embed and output weights. Very high quality, near perfect, *recommended*. |
+| [granite-20b-code-instruct-Q6_K.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-Q6_K.gguf) | Q6_K | 16.63GB | false | Very high quality, near perfect, *recommended*. |
+| [granite-20b-code-instruct-Q5_K_L.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-Q5_K_L.gguf) | Q5_K_L | 14.88GB | false | Uses Q8_0 for embed and output weights. High quality, *recommended*. |
+| [granite-20b-code-instruct-Q5_K_M.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-Q5_K_M.gguf) | Q5_K_M | 14.81GB | false | High quality, *recommended*. |
+| [granite-20b-code-instruct-Q5_K_S.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-Q5_K_S.gguf) | Q5_K_S | 14.02GB | false | High quality, *recommended*. |
+| [granite-20b-code-instruct-Q4_K_L.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-Q4_K_L.gguf) | Q4_K_L | 12.89GB | false | Uses Q8_0 for embed and output weights. Good quality, *recommended*. |
+| [granite-20b-code-instruct-Q4_K_M.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-Q4_K_M.gguf) | Q4_K_M | 12.82GB | false | Good quality, default size for must use cases, *recommended*. |
+| [granite-20b-code-instruct-Q3_K_XL.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-Q3_K_XL.gguf) | Q3_K_XL | 11.81GB | false | Uses Q8_0 for embed and output weights. Lower quality but usable, good for low RAM availability. |
+| [granite-20b-code-instruct-Q3_K_L.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-Q3_K_L.gguf) | Q3_K_L | 11.74GB | false | Lower quality but usable, good for low RAM availability. |
+| [granite-20b-code-instruct-Q4_K_S.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-Q4_K_S.gguf) | Q4_K_S | 11.67GB | false | Slightly lower quality with more space savings, *recommended*. |
+| [granite-20b-code-instruct-Q4_0.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-Q4_0.gguf) | Q4_0 | 11.61GB | false | Legacy format, generally not worth using over similarly sized formats |
+| [granite-20b-code-instruct-Q4_0_8_8.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-Q4_0_8_8.gguf) | Q4_0_8_8 | 11.55GB | false | Optimized for ARM inference. Requires 'sve' support (see link below). |
+| [granite-20b-code-instruct-Q4_0_4_8.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-Q4_0_4_8.gguf) | Q4_0_4_8 | 11.55GB | false | Optimized for ARM inference. Requires 'i8mm' support (see link below). |
+| [granite-20b-code-instruct-Q4_0_4_4.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-Q4_0_4_4.gguf) | Q4_0_4_4 | 11.55GB | false | Optimized for ARM inference. Should work well on all ARM chips, pick this if you're unsure. |
+| [granite-20b-code-instruct-IQ4_XS.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-IQ4_XS.gguf) | IQ4_XS | 10.94GB | false | Decent quality, smaller than Q4_K_S with similar performance, *recommended*. |
+| [granite-20b-code-instruct-Q3_K_M.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-Q3_K_M.gguf) | Q3_K_M | 10.57GB | false | Low quality. |
+| [granite-20b-code-instruct-IQ3_M.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-IQ3_M.gguf) | IQ3_M | 9.59GB | false | Medium-low quality, new method with decent performance comparable to Q3_K_M. |
+| [granite-20b-code-instruct-Q3_K_S.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-Q3_K_S.gguf) | Q3_K_S | 8.93GB | false | Low quality, not recommended. |
+| [granite-20b-code-instruct-IQ3_XS.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-IQ3_XS.gguf) | IQ3_XS | 8.66GB | false | Lower quality, new method with decent performance, slightly better than Q3_K_S. |
+| [granite-20b-code-instruct-Q2_K_L.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-Q2_K_L.gguf) | Q2_K_L | 8.00GB | false | Uses Q8_0 for embed and output weights. Very low quality but surprisingly usable. |
+| [granite-20b-code-instruct-Q2_K.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-Q2_K.gguf) | Q2_K | 7.93GB | false | Very low quality but surprisingly usable. |
+| [granite-20b-code-instruct-IQ2_M.gguf](https://huggingface.co/bartowski/granite-20b-code-instruct-GGUF/blob/main/granite-20b-code-instruct-IQ2_M.gguf) | IQ2_M | 7.05GB | false | Relatively low quality, uses SOTA techniques to be surprisingly usable. |
+
+## Q4_0_X_X
+
+If you're using an ARM chip, the Q4_0_X_X quants will have a substantial speedup. Check out Q4_0_4_4 speed comparisons [on the original pull request](https://github.com/ggerganov/llama.cpp/pull/5780#pullrequestreview-21657544660)
+
+To check which one would work best for your ARM chip, you can check [AArch64 SoC features](https://gpages.juszkiewicz.com.pl/arm-socs-table/arm-socs.html)(thanks EloyOn!).
+
+## Embed/output weights
+
+Some of these quants (Q3_K_XL, Q4_K_L etc) are the standard quantization method with the embeddings and output weights quantized to Q8_0 instead of what they would normally default to.
+
+Some say that this improves the quality, others don't notice any difference. If you use these models PLEASE COMMENT with your findings. I would like feedback that these are actually used and useful so I don't keep uploading quants no one is using.
+
+Thanks!
+
+## Credits
+
+Thank you kalomaze and Dampf for assistance in creating the imatrix calibration dataset
+
+Thank you ZeroWw for the inspiration to experiment with embed/output
 
 ## Downloading using huggingface-cli
 
@@ -263,13 +92,13 @@ pip install -U "huggingface_hub[cli]"
 Then, you can target the specific file you want:
 
 ```
-huggingface-cli download bartowski/granite-20b-code-instruct-GGUF --include "granite-20b-code-instruct-Q4_K_M.gguf" --local-dir ./ --local-dir-use-symlinks False
+huggingface-cli download bartowski/granite-20b-code-instruct-GGUF --include "granite-20b-code-instruct-Q4_K_M.gguf" --local-dir ./
 ```
 
 If the model is bigger than 50GB, it will have been split into multiple files. In order to download them all to a local folder, run:
 
 ```
-huggingface-cli download bartowski/granite-20b-code-instruct-GGUF --include "granite-20b-code-instruct-Q8_0.gguf/*" --local-dir granite-20b-code-instruct-Q8_0 --local-dir-use-symlinks False
+huggingface-cli download bartowski/granite-20b-code-instruct-GGUF --include "granite-20b-code-instruct-Q8_0/*" --local-dir ./
 ```
 
 You can either specify a new local-dir (granite-20b-code-instruct-Q8_0) or download them all in place (./)
@@ -299,3 +128,4 @@ These I-quants can also be used on CPU and Apple Metal, but will be slower than
 The I-quants are *not* compatible with Vulcan, which is also AMD, so if you have an AMD card double check if you're using the rocBLAS build or the Vulcan build. At the time of writing this, LM Studio has a preview with ROCm support, and other inference engines have specific builds for ROCm.
 
 Want to support my work? Visit my ko-fi page here: https://ko-fi.com/bartowski
+