Upload README.md with huggingface_hub

README.md

@@ -1,15 +1,16 @@
 ---
-language:
-- en
-license: apache-2.0
-library_name: sentence-transformers
 tags:
 - mteb
 - transformers.js
 - transformers
 - llama-cpp
 - gguf-my-repo
+license: apache-2.0
+language:
+- en
+library_name: sentence-transformers
 pipeline_tag: feature-extraction
+base_model: mixedbread-ai/mxbai-embed-large-v1
 model-index:
 - name: mxbai-angle-large-v1
   results:
@@ -2502,29 +2503,43 @@ model-index:
 # magicunicorn/mxbai-embed-large-v1-Q8_0-GGUF
 This model was converted to GGUF format from [`mixedbread-ai/mxbai-embed-large-v1`](https://huggingface.co/mixedbread-ai/mxbai-embed-large-v1) 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/mixedbread-ai/mxbai-embed-large-v1) for more details on the model.
-## Use with llama.cpp
 
-Install llama.cpp through brew.
+## Use with llama.cpp
+Install llama.cpp through brew (works on Mac and Linux)
 
 ```bash
-brew install ggerganov/ggerganov/llama.cpp
+brew install llama.cpp
+
 ```
 Invoke the llama.cpp server or the CLI.
 
-CLI:
-
+### CLI:
 ```bash
-llama-cli --hf-repo magicunicorn/mxbai-embed-large-v1-Q8_0-GGUF --model mxbai-embed-large-v1.Q8_0.gguf -p "The meaning to life and the universe is"
+llama-cli --hf-repo magicunicorn/mxbai-embed-large-v1-Q8_0-GGUF --hf-file mxbai-embed-large-v1-q8_0.gguf -p "The meaning to life and the universe is"
 ```
 
-Server:
-
+### Server:
 ```bash
-llama-server --hf-repo magicunicorn/mxbai-embed-large-v1-Q8_0-GGUF --model mxbai-embed-large-v1.Q8_0.gguf -c 2048
+llama-server --hf-repo magicunicorn/mxbai-embed-large-v1-Q8_0-GGUF --hf-file mxbai-embed-large-v1-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.
 
+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 magicunicorn/mxbai-embed-large-v1-Q8_0-GGUF --hf-file mxbai-embed-large-v1-q8_0.gguf -p "The meaning to life and the universe is"
+```
+or 
 ```
-git clone https://github.com/ggerganov/llama.cpp &&             cd llama.cpp &&             make &&             ./main -m mxbai-embed-large-v1.Q8_0.gguf -n 128
+./llama-server --hf-repo magicunicorn/mxbai-embed-large-v1-Q8_0-GGUF --hf-file mxbai-embed-large-v1-q8_0.gguf -c 2048
 ```