Update README.md

README.md

@@ -1,3 +1,115 @@
----
-license: apache-2.0
----
+---
+license: apache-2.0
+library_name: transformers
+tags:
+- code
+- llama-cpp
+- gguf-my-repo
+base_model: ibm-granite/granite-8b-code-base
+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
+pipeline_tag: text-generation
+inference: false
+model-index:
+- name: granite-8b-code-instruct
+  results:
+  - task:
+      type: text-generation
+    dataset:
+      name: HumanEvalSynthesis(Python)
+      type: bigcode/humanevalpack
+    metrics:
+    - type: pass@1
+      value: 57.9
+      name: pass@1
+    - type: pass@1
+      value: 52.4
+      name: pass@1
+    - type: pass@1
+      value: 58.5
+      name: pass@1
+    - type: pass@1
+      value: 43.3
+      name: pass@1
+    - type: pass@1
+      value: 48.2
+      name: pass@1
+    - type: pass@1
+      value: 37.2
+      name: pass@1
+    - type: pass@1
+      value: 53.0
+      name: pass@1
+    - type: pass@1
+      value: 42.7
+      name: pass@1
+    - type: pass@1
+      value: 52.4
+      name: pass@1
+    - type: pass@1
+      value: 36.6
+      name: pass@1
+    - type: pass@1
+      value: 43.9
+      name: pass@1
+    - type: pass@1
+      value: 16.5
+      name: pass@1
+    - type: pass@1
+      value: 39.6
+      name: pass@1
+    - type: pass@1
+      value: 40.9
+      name: pass@1
+    - type: pass@1
+      value: 48.2
+      name: pass@1
+    - type: pass@1
+      value: 41.5
+      name: pass@1
+    - type: pass@1
+      value: 39.0
+      name: pass@1
+    - type: pass@1
+      value: 32.9
+      name: pass@1
+---
+
+# Sagicc/granite-8b-code-instruct-Q5_K_M-GGUF
+This model was converted to GGUF format from [`ibm-granite/granite-8b-code-instruct`](https://huggingface.co/ibm-granite/granite-8b-code-instruct) using llama.cpp after addded support for small Granite Code models in b3026 ['llama.cpp release'](https://github.com/ggerganov/llama.cpp/releases/tag/b3026).
+Refer to the [original model card](https://huggingface.co/ibm-granite/granite-8b-code-instruct) for more details on the model.
+## Use with llama.cpp
+
+Install llama.cpp through brew.
+
+```bash
+brew install ggerganov/ggerganov/llama.cpp
+```
+Invoke the llama.cpp server or the CLI.
+
+CLI:
+
+```bash
+llama-cli --hf-repo YorkieOH10/granite-8b-code-instruct-Q4_K_M-GGUF --model granite-8b-code-instruct.Q4_K_M.gguf -p "The meaning to life and the universe is"
+```
+
+Server:
+
+```bash
+llama-server --hf-repo YorkieOH10/granite-8b-code-instruct-Q4_K_M-GGUF --model granite-8b-code-instruct.Q4_K_M.gguf -c 2048
+```
+
+Note: You can also use this checkpoint directly through the [usage steps](https://github.com/ggerganov/llama.cpp?tab=readme-ov-file#usage) listed in the Llama.cpp repo as well.
+
+```
+git clone https://github.com/ggerganov/llama.cpp &&             cd llama.cpp &&             make &&             ./main -m granite-8b-code-instruct.Q4_K_M.gguf -n 128
+```