Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,114 @@
+---
+language:
+- multilingual
+- ar
+- bg
+- ca
+- cs
+- da
+- de
+- el
+- en
+- es
+- et
+- fa
+- fi
+- fr
+- gl
+- gu
+- he
+- hi
+- hr
+- hu
+- hy
+- id
+- it
+- ja
+- ka
+- ko
+- ku
+- lt
+- lv
+- mk
+- mn
+- mr
+- ms
+- my
+- nb
+- nl
+- pl
+- pt
+- ro
+- ru
+- sk
+- sl
+- sq
+- sr
+- sv
+- th
+- tr
+- uk
+- ur
+- vi
+license: apache-2.0
+library_name: sentence-transformers
+tags:
+- sentence-transformers
+- feature-extraction
+- sentence-similarity
+- transformers
+- text-embeddings-inference
+- llama-cpp
+- gguf-my-repo
+language_bcp47:
+- fr-ca
+- pt-br
+- zh-cn
+- zh-tw
+pipeline_tag: sentence-similarity
+base_model: sentence-transformers/paraphrase-multilingual-mpnet-base-v2
+---
+
+# MagicalAlchemist/paraphrase-multilingual-mpnet-base-v2-Q8_0-GGUF
+This model was converted to GGUF format from [`sentence-transformers/paraphrase-multilingual-mpnet-base-v2`](https://huggingface.co/sentence-transformers/paraphrase-multilingual-mpnet-base-v2) 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/sentence-transformers/paraphrase-multilingual-mpnet-base-v2) 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 MagicalAlchemist/paraphrase-multilingual-mpnet-base-v2-Q8_0-GGUF --hf-file paraphrase-multilingual-mpnet-base-v2-q8_0.gguf -p "The meaning to life and the universe is"
+```
+
+### Server:
+```bash
+llama-server --hf-repo MagicalAlchemist/paraphrase-multilingual-mpnet-base-v2-Q8_0-GGUF --hf-file paraphrase-multilingual-mpnet-base-v2-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 MagicalAlchemist/paraphrase-multilingual-mpnet-base-v2-Q8_0-GGUF --hf-file paraphrase-multilingual-mpnet-base-v2-q8_0.gguf -p "The meaning to life and the universe is"
+```
+or 
+```
+./llama-server --hf-repo MagicalAlchemist/paraphrase-multilingual-mpnet-base-v2-Q8_0-GGUF --hf-file paraphrase-multilingual-mpnet-base-v2-q8_0.gguf -c 2048
+```