Update README.md

README.md

@@ -1,3 +1,31 @@
----
-license: gemma
----
+---
+license: gemma
+base_model:
+- google/embeddinggemma-300m
+tags:
+- sentence-transformers
+---
+# embeddinggemma-300M Sentence-Transformers GGUF
+
+This GGUF Model includes all sentence-transformers (dense) modules.
+
+Recommended way to run this model:
+
+```sh
+llama-server -hf sabafallah/embeddinggemma-300m-sentence-transformers-gguf --embeddings
+```
+
+Then the endpoint can be accessed at http://localhost:8080/embedding, for
+example using `curl`:
+```console
+curl --request POST \
+    --url http://localhost:8080/embedding \
+    --header "Content-Type: application/json" \
+    --data '{"input": "task: sentence similarity | query: Hello embeddings"}' \
+    --silent
+```
+
+Alternatively, the `llama-embedding` command line tool can be used:
+```sh
+llama-embedding -hf sabafallah/embeddinggemma-300m-sentence-transformers-gguf --verbose-prompt -p "task: sentence similarity | query: Hello embeddings"
+```