Create README.md

README.md

@@ -0,0 +1,150 @@
+---
+base_model: Snowflake/snowflake-arctic-embed-m
+inference: false
+language:
+- en
+license: apache-2.0
+model_creator: Snowflake
+model_name: snowflake-arctic-embed-m
+model_type: bert
+quantized_by: ChristianAzinn
+library_name: sentence-transformers
+pipeline_tag: sentence-similarity
+tags:
+- sentence-transformers
+- feature-extraction
+- sentence-similarity
+- mteb
+- arctic
+- snowflake-arctic-embed
+- transformers.js
+- gguf
+---
+
+# MODELNAME-gguf
+
+Model creator: [Snowflake](https://huggingface.co/Snowflake)
+
+Original model: [snowflake-arctic-embed-m](https://huggingface.co/Snowflake/snowflake-arctic-embed-m)
+
+## Original Description
+
+snowflake-arctic-embed is a suite of text embedding models that focuses on creating high-quality retrieval models optimized for performance.
+
+
+The `snowflake-arctic-embedding` models achieve **state-of-the-art performance on the MTEB/BEIR leaderboard** for each of their size variants. Evaluation is performed using these [scripts](https://github.com/Snowflake-Labs/snowflake-arctic-embed/tree/main/src). As shown below, each class of model size achieves SOTA retrieval accuracy compared to other top models.
+
+
+The models are trained by leveraging existing open-source text representation models, such as bert-base-uncased, and are trained in a multi-stage pipeline to optimize their retrieval performance. First, the models are trained with large batches of query-document pairs where negatives are derived in-batch—pretraining leverages about 400m samples of a mix of public datasets and proprietary web search data. Following pretraining models are further optimized with long training on a smaller dataset (about 1m samples) of triplets of query, positive document, and negative document derived from hard harmful mining. Mining of the negatives and data curation is crucial to retrieval accuracy. A detailed technical report will be available shortly.
+
+
+| Name                                                                    | MTEB Retrieval Score (NDCG @ 10) | Parameters (Millions) | Embedding Dimension |
+| ----------------------------------------------------------------------- | -------------------------------- | --------------------- | ------------------- |
+| [snowflake-arctic-embed-xs](https://huggingface.co/Snowflake/snowflake-arctic-embed-xs/)     | 50.15                            | 22                    | 384                 |
+| [snowflake-arctic-embed-s](https://huggingface.co/Snowflake/snowflake-arctic-embed-s/)      | 51.98                            | 33                    | 384                 |
+| [snowflake-arctic-embed-m](https://huggingface.co/Snowflake/snowflake-arctic-embed-m/)      | 54.90                            | 110                   | 768                 |
+| [snowflake-arctic-embed-m-long](https://huggingface.co/Snowflake/snowflake-arctic-embed-m-long/) | 54.83                            | 137                   | 768                 |
+| [snowflake-arctic-embed-l](https://huggingface.co/Snowflake/snowflake-arctic-embed-l/)      | 55.98                            | 335                   | 1024                |
+
+
+### [snowflake-arctic-embed-m](https://huggingface.co/Snowflake/snowflake-arctic-embed-m/)
+
+
+Based on the [intfloat/e5-base-unsupervised](https://huggingface.co/intfloat/e5-base-unsupervised) model, this medium model is the workhorse that provides the best retrieval performance without slowing down inference.
+
+
+| Model Name                                                         | MTEB Retrieval Score (NDCG @ 10) |
+| ------------------------------------------------------------------ | -------------------------------- |
+| [snowflake-arctic-embed-m](https://huggingface.co/Snowflake/snowflake-arctic-embed-m/) | 54.90                            |
+| bge-base-en-v1.5                                                   | 53.25                            |
+| nomic-embed-text-v1.5                                              | 53.25                            |
+| GIST-Embedding-v0                                                  | 52.31                            |
+| gte-base                                                           | 52.31                            |
+
+## Description
+
+This repo contains GGUF format files for the snowflake-arctic-embed-m embedding model.
+
+These files were converted and quantized with llama.cpp [PR 5500](https://github.com/ggerganov/llama.cpp/pull/5500), commit [34aa045de](https://github.com/ggerganov/llama.cpp/pull/5500/commits/34aa045de44271ff7ad42858c75739303b8dc6eb), on a consumer RTX 4090.
+
+This model supports up to 512 tokens of context.
+
+## Compatibility
+
+These files are compatible with [llama.cpp](https://github.com/ggerganov/llama.cpp) as of commit [4524290e8](https://github.com/ggerganov/llama.cpp/commit/4524290e87b8e107cc2b56e1251751546f4b9051), as well as [LM Studio](https://lmstudio.ai/) as of version 0.2.19.
+
+# Examples
+## Example Usage with  `llama.cpp`
+
+To compute a single embedding, build llama.cpp and run:
+```shell
+./embedding -ngl 99 -m [filepath-to-gguf].gguf -p 'search_query: What is TSNE?'
+```
+
+You can also submit a batch of texts to embed, as long as the total number of tokens does not exceed the context length. Only the first three embeddings are shown by the `embedding` example.
+
+`texts.txt`:
+```
+search_query: What is TSNE?
+search_query: Who is Laurens Van der Maaten?
+```
+
+Compute multiple embeddings:
+```shell
+./embedding -ngl 99 -m [filepath-to-gguf].gguf -f texts.txt
+```
+
+## Example Usage with LM Studio
+
+Download the 0.2.19 beta build from here: [Windows](https://releases.lmstudio.ai/windows/0.2.19/beta/LM-Studio-0.2.19-Setup-Preview-1.exe) [MacOS](https://releases.lmstudio.ai/mac/arm64/0.2.19/beta/LM-Studio-darwin-arm64-0.2.19-Preview-1.zip) [Linux](https://releases.lmstudio.ai/linux/0.2.19/beta/LM_Studio-0.2.19-Preview-1.AppImage)
+
+Once installed, open the app. The home should look like this:
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/6584f042b378d311dccea501/QGkYvH242S0c_clPqX9Ip.png)
+
+Search for either "ChristianAzinn" in the main search bar or go to the "Search" tab on the left menu and search the name there.
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/6584f042b378d311dccea501/11hLos1JNMyZ1q2K9ICss.png)
+
+Select your model from those that appear (this example uses `bge-small-en-v1.5-gguf`) and select which quantization you want to download. Since this model is pretty small, I recommend Q8_0, if not f16/32. Generally, the lower you go in the list (or the bigger the number gets), the larger the file and the better the performance.
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/6584f042b378d311dccea501/hu9DuVYahQ-QpII5P8mVD.png)
+
+You will see a green checkmark and the word "Downloaded" once the model has successfully downloaded, which can take some time depending on your network speeds.
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/6584f042b378d311dccea501/7fmXkLDmGTNVyG3oqB4--.png)
+
+Once this model is finished downloading, navigate to the "Local Server" tab on the left menu and open the loader for text embedding models. This loader does not appear before version 0.2.19, so ensure you downloaded the correct version.
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/6584f042b378d311dccea501/OrzvqQIhB9p-aMq2G6Lxd.png)
+
+Select the model you just downloaded from the dropdown that appears to load it. You may need to play with configurations in the right-side menu, such as GPU offload if it doesn't fit entirely into VRAM.
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/6584f042b378d311dccea501/TM4dO4DFP1xqZD1GWBqeI.png)
+
+All that's left to do is to hit the "Start Server" button:
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/6584f042b378d311dccea501/6TZvnX84rZKZ0TwVVLFnw.png)
+
+And if you see text like that shown below in the console, you're good to go! You can use this as a drop-in replacement for the OpenAI embeddings API in any application that requires it, or you can query the endpoint directly to test it out.
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/6584f042b378d311dccea501/kD47WaH-tzpr4qaAm-pMn.png)
+
+Example curl request to the API endpoint:
+```shell
+curl http://localhost:1234/v1/embeddings \
+  -H "Content-Type: application/json" \
+  -d '{
+    "input": "Your text string goes here",
+    "model": "model-identifier-here"
+  }'
+```
+
+For more information, see the LM Studio [text embedding documentation](https://lmstudio.ai/docs/text-embeddings).
+
+
+## Acknowledgements
+
+Thanks to the LM Studio team and everyone else working on open-source AI.
+
+This README is inspired by that of [nomic-ai-embed-text-v1.5-gguf](https://huggingface.co/nomic-ai/nomic-embed-text-v1.5-gguf), another excellent embedding model, and those of the legendary [TheBloke](https://huggingface.co/TheBloke).