Update README.md

README.md

@@ -2621,7 +2621,7 @@ This is our base sentence embedding model. It was trained using [AnglE](https://
 
 ## Quickstart
 
-Here, we provide several ways to produce sentence embeddings. Please note that you have to provide the prompt `Represent this sentence for searching relevant passages:` for query if you want to use it for retrieval. Besides that you don't need any prompt.
+Here, we provide several ways to produce sentence embeddings. Please note that you have to provide the prompt `Represent this sentence for searching relevant passages:` for query if you want to use it for retrieval. Besides that you don't need any prompt. Our model also supports Matryoshka Representation Learning and (binary) quantization when used via API or Sentence Transformers. 
 
 ### sentence-transformers
 
@@ -2632,6 +2632,7 @@ python -m pip install -U sentence-transformers
 ```python
 from sentence_transformers import SentenceTransformer
 from sentence_transformers.util import cos_sim
+from sentence_transformers.util import quantize_embeddings
 
 # 1. load model
 model = SentenceTransformer("mixedbread-ai/mxbai-embed-large-v1")
@@ -2652,6 +2653,16 @@ embeddings = model.encode(docs)
 
 similarities = cos_sim(embeddings[0], embeddings[1:])
 print('similarities:', similarities)
+
+# 2a. Encode with selection of MRL dimensions
+mrl_embeddings = model.encode(docs, normalize_embeddings=True)[..., :512]
+
+mrl_similarities = cos_sim(mrl_embeddings[0], mrl_embeddings[1:])
+print('mrl_similarities:', mrl_similarities)
+
+# 3. Apply binary quantization
+binary_embeddings = quantize_embeddings(embeddings, precision="binary")
+binary_mrl_embeddings = quantize_embeddings(mrl_embeddings, precision="binary")
 ```
 ### Transformers
 
@@ -2669,7 +2680,7 @@ def transform_query(query: str) -> str:
  """
  return f'Represent this sentence for searching relevant passages: {query}'
 
-# The model works really well with cls pooling (default) but also with mean poolin.
+# The model works really well with cls pooling (default) but also with mean pooling.
 def pooling(outputs: torch.Tensor, inputs: Dict, strategy: str = 'cls') -> np.ndarray:
  if strategy == 'cls':
  outputs = outputs[:, 0]
@@ -2744,7 +2755,6 @@ You can use the model via our API as follows:
 
 ```python
 from mixedbread_ai.client import MixedbreadAI
-from sklearn.metrics.pairwise import cosine_similarity
 import os
 
 mxbai = MixedbreadAI(api_key="{MIXEDBREAD_API_KEY}")
@@ -2756,16 +2766,21 @@ english_sentences = [
 
 res = mxbai.embeddings(
  input=english_sentences,
- model="mixedbread-ai/mxbai-embed-large-v1"
+ model="mixedbread-ai/mxbai-embed-large-v1",
+ normalized=True,
+ encoding_format=['ubinary','float'],
+ dimensions=512
 )
-embeddings = [entry.embedding for entry in res.data]
 
-similarities = cosine_similarity([embeddings[0]], [embeddings[1]])
-print(similarities)
+print(res.dimensions, res.data[0].embedding.ubinary, res.data[0].embedding.float_)
 ```
 
 The API comes with native INT8 and binary quantization support! Check out the [docs](https://mixedbread.ai/docs) for more information.
 
+### Why binary MRL?
+
+The combination of binary quantization and Matryoshka Representation Learning allows you to reduce the memory usage of your embeddings significantly. This leads to much lower costs when using a vector database. You can read more about the technology and its advantages in our [blog post](https://www.mixedbread.ai/blog/binary-mrl).
+
 ## Evaluation
 As of March 2024, our model archives SOTA performance for Bert-large sized models on the [MTEB](https://huggingface.co/spaces/mteb/leaderboard). It ourperforms commercial models like OpenAIs text-embedding-3-large and matches the performance of model 20x it's size like the [echo-mistral-7b](https://huggingface.co/jspringer/echo-mistral-7b-instruct-lasttoken). Our model was trained with no overlap of the MTEB data, which indicates that our model generalizes well across several domains, tasks and text length. We know there are some limitations with this model, which will be fixed in v2.