Upload README.md

README.md

@@ -103,15 +103,22 @@ for i, query in enumerate(queries):
     print(f"Query: {query}")
     for j, doc in enumerate(documents):
         print(f" Similarity: {scores[i, j]:.4f} | Document {j}: {doc[:80]}...")
+```
+
+<details>
+
+<summary>See example output</summary>
 
-# Query: What is machine learning?
-#  Similarity: 0.6857 | Document 0: Machine learning is a subset of ...
-#  Similarity: 0.4598 | Document 1: Neural networks are trained ...
-# 
-# Query: How does neural network training work?
-#  Similarity: 0.4238 | Document 0: Machine learning is a subset of ...
-#  Similarity: 0.5723 | Document 1: Neural networks are trained ...
 ```
+Query: What is machine learning?
+ Similarity: 0.6857 | Document 0: Machine learning is a subset of ...
+ Similarity: 0.4598 | Document 1: Neural networks are trained ...
+
+Query: How does neural network training work?
+ Similarity: 0.4238 | Document 0: Machine learning is a subset of ...
+ Similarity: 0.5723 | Document 1: Neural networks are trained ...
+```
+</details>
 
 ## Transformers.js
 
@@ -216,13 +223,20 @@ similarities = model.similarity(query_embeds, doc_embeds)
 print('After MRL:')
 print(f"* Embeddings dimension: {query_embeds.shape[1]}")
 print(f"* Similarities: \n\t{similarities}")
+```
 
-# After MRL:
-# * Embeddings dimension: 256
-# * Similarities:
-#   tensor([[0.7136, 0.4989],
-#           [0.4567, 0.6022]])
+<details>
+
+<summary>See example output</summary>
+
+```
+After MRL:
+* Embeddings dimension: 256
+* Similarities:
+  tensor([[0.7136, 0.4989],
+          [0.4567, 0.6022]])
 ```
+</details>
 
 ## Vector Quantization
 Vector quantization, for example to `int8` or `binary`, can be performed as follows:
@@ -257,6 +271,19 @@ print(f"* Similarities: \n{similarities}")
 #   [ 72961  98333]]
 ```
 
+<details>
+
+<summary>See example output</summary>
+
+```
+After quantization:
+* Embeddings type: int8
+* Similarities:
+   [[118022  79111]
+    [ 72961  98333]]
+```
+</details>
+
 # Evaluation
 
 Please [see here](https://huggingface.co/MongoDB/mdbr-leaf-ir/blob/main/evaluate_models.ipynb).