Create README.md

README.md

@@ -0,0 +1,58 @@
+---
+tags:
+- e5
+- int8
+---
+
+# multilingual-e5-small-int8-dynamic
+
+This is [intfloat/multilingual-e5-small](https://huggingface.co/intfloat/multilingual-e5-small) INT8 model quantized with [huggingface/optimum-intel](https://github.com/huggingface/optimum-intel) through the usage of [Intel® Neural Compressor](https://github.com/intel/neural-compressor). 
+
+### Usage
+
+Below is an example to encode queries and passages from the MS-MARCO passage ranking dataset.
+
+```python
+import torch.nn.functional as F
+from torch import Tensor
+from transformers import AutoTokenizer
+from optimum.intel.neural_compressor import INCModel
+
+def average_pool(
+  last_hidden_states: Tensor,
+  attention_mask: Tensor
+) -> Tensor:
+    last_hidden = last_hidden_states.masked_fill(~attention_mask[..., None].bool(), 0.0)
+    return last_hidden.sum(dim=1) / attention_mask.sum(dim=1)[..., None]
+
+input_texts = [
+  'query: how much protein should a female eat',
+  'query: summit define',
+  "passage: As a general guideline, the CDC's average requirement of protein for women ages 19 to 70 is 46 grams per day. But, as you can see from this chart, you'll need to increase that if you're expecting or training for a marathon. Check out the chart below to see how much protein you should be eating each day.",
+  "passage: Definition of summit for English Language Learners. : 1  the highest point of a mountain : the top of a mountain. : 2  the highest level. : 3  a meeting or series of meetings between the leaders of two or more governments."
+]
+
+model_name = "efederici/multilingual-e5-small-int8-dynamic"
+
+tokenizer = AutoTokenizer.from_pretrained(model_name)
+model = INCModel.from_pretrained(model_name)
+
+batch_dict = tokenizer(input_texts, max_length=512, padding=True, truncation=True, return_tensors='pt')
+outputs = model(**batch_dict)
+embeddings = average_pool(outputs.last_hidden_state, batch_dict['attention_mask'])
+
+# (Optionally) normalize embeddings
+embeddings = F.normalize(embeddings, p=2, dim=1)
+scores = (embeddings[:2] @ embeddings[2:].T) * 100
+
+print(scores.tolist())
+```
+
+```
+@article{wang2022text,
+  title={Text Embeddings by Weakly-Supervised Contrastive Pre-training},
+  author={Wang, Liang and Yang, Nan and Huang, Xiaolong and Jiao, Binxing and Yang, Linjun and Jiang, Daxin and Majumder, Rangan and Wei, Furu},
+  journal={arXiv preprint arXiv:2212.03533},
+  year={2022}
+}
+```