Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,126 @@
+---
+base_model: bigcode/starcoderbase-1b
+datasets:
+- bigcode/the-stack-dedup
+library_name: transformers
+license: bigcode-openrail-m
+metrics:
+- code_eval
+pipeline_tag: text-generation
+tags:
+- code
+- llama-cpp
+- gguf-my-repo
+inference: true
+widget:
+- text: 'def print_hello_world():'
+  example_title: Hello world
+  group: Python
+extra_gated_prompt: "## Model License Agreement\nPlease read the BigCode [OpenRAIL-M\
+  \ license](https://huggingface.co/spaces/bigcode/bigcode-model-license-agreement)\
+  \ agreement before accepting it.\n  "
+extra_gated_fields:
+  ? I accept the above license agreement, and will use the Model complying with the
+    set of use restrictions and sharing requirements
+  : checkbox
+duplicated_from: bigcode-data/starcoderbase-1b
+model-index:
+- name: StarCoderBase-1B
+  results:
+  - task:
+      type: text-generation
+    dataset:
+      name: HumanEval
+      type: openai_humaneval
+    metrics:
+    - type: pass@1
+      value: 15.17
+      name: pass@1
+      verified: false
+  - task:
+      type: text-generation
+    dataset:
+      name: MultiPL-HumanEval (C++)
+      type: nuprl/MultiPL-E
+    metrics:
+    - type: pass@1
+      value: 11.68
+      name: pass@1
+      verified: false
+    - type: pass@1
+      value: 14.2
+      name: pass@1
+      verified: false
+    - type: pass@1
+      value: 13.38
+      name: pass@1
+      verified: false
+    - type: pass@1
+      value: 9.94
+      name: pass@1
+      verified: false
+    - type: pass@1
+      value: 12.52
+      name: pass@1
+      verified: false
+    - type: pass@1
+      value: 10.24
+      name: pass@1
+      verified: false
+    - type: pass@1
+      value: 3.92
+      name: pass@1
+      verified: false
+    - type: pass@1
+      value: 11.31
+      name: pass@1
+      verified: false
+    - type: pass@1
+      value: 5.37
+      name: pass@1
+      verified: false
+---
+
+# wsxiaoys/starcoderbase-1b-Q2_K-GGUF
+This model was converted to GGUF format from [`bigcode/starcoderbase-1b`](https://huggingface.co/bigcode/starcoderbase-1b) using llama.cpp via the ggml.ai's [GGUF-my-repo](https://huggingface.co/spaces/ggml-org/gguf-my-repo) space.
+Refer to the [original model card](https://huggingface.co/bigcode/starcoderbase-1b) for more details on the model.
+
+## Use with llama.cpp
+Install llama.cpp through brew (works on Mac and Linux)
+
+```bash
+brew install llama.cpp
+
+```
+Invoke the llama.cpp server or the CLI.
+
+### CLI:
+```bash
+llama-cli --hf-repo wsxiaoys/starcoderbase-1b-Q2_K-GGUF --hf-file starcoderbase-1b-q2_k.gguf -p "The meaning to life and the universe is"
+```
+
+### Server:
+```bash
+llama-server --hf-repo wsxiaoys/starcoderbase-1b-Q2_K-GGUF --hf-file starcoderbase-1b-q2_k.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.
+
+Step 1: Clone llama.cpp from GitHub.
+```
+git clone https://github.com/ggerganov/llama.cpp
+```
+
+Step 2: Move into the llama.cpp folder and build it with `LLAMA_CURL=1` flag along with other hardware-specific flags (for ex: LLAMA_CUDA=1 for Nvidia GPUs on Linux).
+```
+cd llama.cpp && LLAMA_CURL=1 make
+```
+
+Step 3: Run inference through the main binary.
+```
+./llama-cli --hf-repo wsxiaoys/starcoderbase-1b-Q2_K-GGUF --hf-file starcoderbase-1b-q2_k.gguf -p "The meaning to life and the universe is"
+```
+or 
+```
+./llama-server --hf-repo wsxiaoys/starcoderbase-1b-Q2_K-GGUF --hf-file starcoderbase-1b-q2_k.gguf -c 2048
+```