Create README.md

README.md

@@ -0,0 +1,171 @@
+---
+base_model: avsolatorio/gist-large-embedding-v0
+inference: false
+language:
+- en
+license: mit
+model_creator: avsolatorio
+model_name: gist-large-embedding-v0
+model_type: bert
+quantized_by: ChristianAzinn
+library_name: sentence-transformers
+pipeline_tag: feature-extraction
+tags:
+  - feature-extraction
+  - mteb
+  - sentence-similarity
+  - sentence-transformers
+  - bert
+  - gguf
+---
+
+# gist-large-embedding-v0-gguf
+
+Model creator: [avsolatorio](https://huggingface.co/avsolatorio)
+
+Original model: [gist-large-embedding-v0](https://huggingface.co/avsolatorio/gist-large-embedding-v0)
+
+## Original Description
+
+The model is fine-tuned on top of the [BAAI/bge-large-en-v1.5](https://huggingface.co/BAAI/bge-large-en-v1.5) using the [MEDI dataset](https://github.com/xlang-ai/instructor-embedding.git) augmented with mined triplets from the [MTEB Classification](https://huggingface.co/mteb) training dataset (excluding data from the Amazon Polarity Classification task).
+
+The model does not require any instruction for generating embeddings. This means that queries for retrieval tasks can be directly encoded without crafting instructions.
+
+Technical paper: [GISTEmbed: Guided In-sample Selection of Training Negatives for Text Embedding Fine-tuning](https://arxiv.org/abs/2402.16829)
+
+
+# Data
+
+The dataset used is a compilation of the MEDI and MTEB Classification training datasets. Third-party datasets may be subject to additional terms and conditions under their associated licenses. A HuggingFace Dataset version of the compiled dataset, and the specific revision used to train the model, is available:
+
+- Dataset: [avsolatorio/medi-data-mteb_avs_triplets](https://huggingface.co/datasets/avsolatorio/medi-data-mteb_avs_triplets)
+- Revision: 238a0499b6e6b690cc64ea56fde8461daa8341bb
+
+The dataset contains a `task_type` key, which can be used to select only the mteb classification tasks (prefixed with `mteb_`).
+
+The **MEDI Dataset** is published in the following paper: [One Embedder, Any Task: Instruction-Finetuned Text Embeddings](https://arxiv.org/abs/2212.09741).
+
+The MTEB Benchmark results of the GIST embedding model, compared with the base model, suggest that the fine-tuning dataset has perturbed the model considerably, which resulted in significant improvements in certain tasks while adversely degrading performance in some.
+
+The retrieval performance for the TRECCOVID task is of note. The fine-tuning dataset does not contain significant knowledge about COVID-19, which could have caused the observed performance degradation. We found some evidence, detailed in the paper, that thematic coverage of the fine-tuning data can affect downstream performance.
+
+
+## Description
+
+This repo contains GGUF format files for the gist-large-embedding-v0 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.
+
+# Meta-information
+## Explanation of quantisation methods
+<details>
+  <summary>Click to see details</summary>
+The methods available are:
+* GGML_TYPE_Q2_K - "type-1" 2-bit quantization in super-blocks containing 16 blocks, each block having 16 weight. Block scales and mins are quantized with 4 bits. This ends up effectively using 2.5625 bits per weight (bpw)
+* GGML_TYPE_Q3_K - "type-0" 3-bit quantization in super-blocks containing 16 blocks, each block having 16 weights. Scales are quantized with 6 bits. This end up using 3.4375 bpw.
+* GGML_TYPE_Q4_K - "type-1" 4-bit quantization in super-blocks containing 8 blocks, each block having 32 weights. Scales and mins are quantized with 6 bits. This ends up using 4.5 bpw.
+* GGML_TYPE_Q5_K - "type-1" 5-bit quantization. Same super-block structure as GGML_TYPE_Q4_K resulting in 5.5 bpw
+* GGML_TYPE_Q6_K - "type-0" 6-bit quantization. Super-blocks with 16 blocks, each block having 16 weights. Scales are quantized with 8 bits. This ends up using 6.5625 bpw
+Refer to the Provided Files table below to see what files use which methods, and how.
+</details>
+
+## Provided Files
+| Name | Quant method | Bits | Size | Max RAM required | Use case |
+| ---- | ---- | ---- | ---- | ---- | ----- |
+| Name | Quant method | Bits | Size | Use case |
+| [gist-large-embedding-v0.Q2_K.gguf](https://huggingface.co/ChristianAzinn/gist-large-embedding-v0-gguf/blob/main/gist-large-embedding-v0.Q2_K.gguf) | Q2_K | 2 | 144 MB | smallest, significant quality loss - not recommended for most purposes |
+| [gist-large-embedding-v0.Q3_K_S.gguf](https://huggingface.co/ChristianAzinn/gist-large-embedding-v0-gguf/blob/main/gist-large-embedding-v0.Q3_K_S.gguf) | Q3_K_S | 3 | 160 MB | very small, high quality loss |
+| [gist-large-embedding-v0.Q3_K_M.gguf](https://huggingface.co/ChristianAzinn/gist-large-embedding-v0-gguf/blob/main/gist-large-embedding-v0.Q3_K_M.gguf) | Q3_K_M | 3 | 181 MB | very small, high quality loss |
+| [gist-large-embedding-v0.Q3_K_L.gguf](https://huggingface.co/ChristianAzinn/gist-large-embedding-v0-gguf/blob/main/gist-large-embedding-v0.Q3_K_L.gguf) | Q3_K_L | 3 | 198 MB | small, substantial quality loss |
+| [gist-large-embedding-v0.Q4_0.gguf](https://huggingface.co/ChristianAzinn/gist-large-embedding-v0-gguf/blob/main/gist-large-embedding-v0.Q4_0.gguf) | Q4_0 | 4 | 200 MB | legacy; small, very high quality loss - prefer using Q3_K_M |
+| [gist-large-embedding-v0.Q4_K_S.gguf](https://huggingface.co/ChristianAzinn/gist-large-embedding-v0-gguf/blob/main/gist-large-embedding-v0.Q4_K_S.gguf) | Q4_K_S | 4 | 203 MB | small, greater quality loss |
+| [gist-large-embedding-v0.Q4_K_M.gguf](https://huggingface.co/ChristianAzinn/gist-large-embedding-v0-gguf/blob/main/gist-large-embedding-v0.Q4_K_M.gguf) | Q4_K_M | 4 | 216 MB | medium, balanced quality - recommended |
+| [gist-large-embedding-v0.Q5_0.gguf](https://huggingface.co/ChristianAzinn/gist-large-embedding-v0-gguf/blob/main/gist-large-embedding-v0.Q5_0.gguf) | Q5_0 | 5 | 237 MB | legacy; medium, balanced quality - prefer using Q4_K_M |
+| [gist-large-embedding-v0.Q5_K_S.gguf](https://huggingface.co/ChristianAzinn/gist-large-embedding-v0-gguf/blob/main/gist-large-embedding-v0.Q5_K_S.gguf) | Q5_K_S | 5 | 237 MB | large, low quality loss - recommended |
+| [gist-large-embedding-v0.Q5_K_M.gguf](https://huggingface.co/ChristianAzinn/gist-large-embedding-v0-gguf/blob/main/gist-large-embedding-v0.Q5_K_M.gguf) | Q5_K_M | 5 | 246 MB | large, very low quality loss - recommended |
+| [gist-large-embedding-v0.Q6_K.gguf](https://huggingface.co/ChristianAzinn/gist-large-embedding-v0-gguf/blob/main/gist-large-embedding-v0.Q6_K.gguf) | Q6_K | 6 | 278 MB | very large, extremely low quality loss |
+| [gist-large-embedding-v0.Q8_0.gguf](https://huggingface.co/ChristianAzinn/gist-large-embedding-v0-gguf/blob/main/gist-large-embedding-v0.Q8_0.gguf) | Q8_0 | 8 | 358 MB | very large, extremely low quality loss - recommended |
+| [gist-large-embedding-v0.Q8_0.gguf](https://huggingface.co/ChristianAzinn/gist-large-embedding-v0-gguf/blob/main/gist-large-embedding-v0_fp16.gguf) | FP16 | 16 | 670 MB | enormous, pretty much the original model - not recommended |
+| [gist-large-embedding-v0.Q8_0.gguf](https://huggingface.co/ChristianAzinn/gist-large-embedding-v0-gguf/blob/main/gist-large-embedding-v0_fp32.gguf) | FP32 | 32 | 1.34 GB | enormous, pretty much the original model - not recommended |
+
+# 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 configuratios 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).