updated

README.md

@@ -175,30 +175,35 @@ SentenceTransformer(
 
 First install the Sentence Transformers library:
 
-```bash
-pip install -U sentence-transformers
-```
+from sentence_transformers import SentenceTransformer, util
+
+# Load the fine-tuned model from the Hub
+model_id = "srinivasanAI/bge-small-my-qna-model" # Replace with your model ID
+model = SentenceTransformer(model_id)
+
+# The BGE model requires a specific instruction for retrieval queries
+instruction = "Represent this sentence for searching relevant passages: "
+
+# 1. Define your query and your potential answers (passages)
+query = instruction + "What is the powerhouse of the cell?"
 
-Then you can load this model and run inference.
-```python
-from sentence_transformers import SentenceTransformer
-
-# Download from the 🤗 Hub
-model = SentenceTransformer("srinivasanAI/bge-small-my-qna-model")
-# Run inference
-sentences = [
-    'Represent this sentence for searching relevant passages: what topic do all scientific questions have in common',
-    'List of topics characterized as pseudoscience Criticism of pseudoscience, generally by the scientific community or skeptical organizations, involves critiques of the logical, methodological, or rhetorical bases of the topic in question.[1] Though some of the listed topics continue to be investigated scientifically, others were only subject to scientific research in the past, and today are considered refuted but resurrected in a pseudoscientific fashion. Other ideas presented here are entirely non-scientific, but have in one way or another infringed on scientific domains or practices.',
-    'Jane Wyatt Wyatt portrayed Amanda Grayson, Spock\'s mother and Ambassador Sarek\'s (Mark Lenard) wife, in the 1967 episode "Journey to Babel" of the original NBC series, Star Trek, and the 1986 film Star Trek IV: The Voyage Home.[9] Wyatt was once quoted as saying her fan mail for these two appearances in this role exceeded that of Lost Horizon. In 1969, she made a guest appearance on Here Come the Brides, but did not have any scenes with Mark Lenard, who was starring on the show as sawmill owner Aaron Stemple.',
+passages = [
+    "Mitochondria are organelles that act like a digestive system and are often called the powerhouse of the cell.",
+    "The cell wall is a rigid layer that provides structural support to plant cells.",
+    "The sun is a star at the center of the Solar System."
 ]
-embeddings = model.encode(sentences)
-print(embeddings.shape)
-# [3, 384]
-
-# Get the similarity scores for the embeddings
-similarities = model.similarity(embeddings, embeddings)
-print(similarities.shape)
-# [3, 3]
+
+# 2. Encode the single query and the list of passages separately
+query_embedding = model.encode(query)
+passage_embeddings = model.encode(passages)
+
+# 3. Calculate the similarity between the single query and all passages
+similarities = util.cos_sim(query_embedding, passage_embeddings)
+
+# 4. Print the results
+print(f"Query: {query.replace(instruction, '')}\n")
+for i, passage in enumerate(passages):
+    print(f"Similarity: {similarities[0][i]:.4f} | Passage: {passage}")
 ```
 
 <!--