Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,37 @@
+---
+license: llama3
+library_name: transformers
+tags:
+- openchat
+- llama3
+- C-RLFT
+- llama-cpp
+- gguf-my-repo
+base_model: meta-llama/Meta-Llama-3-8B
+pipeline_tag: text-generation
+---
+
+# NikolayKozloff/openchat-3.6-8b-20240522-Q8_0-GGUF
+This model was converted to GGUF format from [`openchat/openchat-3.6-8b-20240522`](https://huggingface.co/openchat/openchat-3.6-8b-20240522) 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/openchat/openchat-3.6-8b-20240522) 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 NikolayKozloff/openchat-3.6-8b-20240522-Q8_0-GGUF --model openchat-3.6-8b-20240522-q8_0.gguf -p "The meaning to life and the universe is"
+```
+Server:
+```bash
+llama-server --hf-repo NikolayKozloff/openchat-3.6-8b-20240522-Q8_0-GGUF --model openchat-3.6-8b-20240522-q8_0.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 openchat-3.6-8b-20240522-q8_0.gguf -n 128
+```