Update README.md

README.md

@@ -19,7 +19,7 @@ pipeline_tag: sentence-similarity
 <!-- This model card has been generated automatically according to the information the Trainer had access to. You
 should probably proofread and complete it, then remove this comment. -->
 
-# t5-de-ss
+# e5-base-german-sentence-embeddings
 
 This model is a fine-tuned version of [intfloat/e5-base](https://huggingface.co/intfloat/e5-base) on german subset of the stsb_multi_mt dataset.
 It achieves the following results on the evaluation set:
@@ -31,6 +31,35 @@ Test:
 - Loss: 1.2162
 - Pearson: 0.7252
 
+## Usage
+
+```python
+#install sentence-transformers
+!pip install -U sentence-transformers
+
+from sentence_transformers import SentenceTransformer
+
+# Download from the 🤗 Hub
+model = SentenceTransformer("kaixkhazaki/e5-base-german-sentence-similarity")
+
+sentences = [
+    'Ein älterer Herr genießt die Natur auf einer Parkbank.',
+    'Ein alter Mann vertieft sich in eine Zeitung im Stadtpark.',
+    'Ein Teenager hört Musik auf einer Bank.'
+]
+embeddings = model.encode(sentences)
+
+# Get the similarity scores for the embeddings
+similarities = model.similarity(embeddings, embeddings)
+
+>>
+tensor([[1.0000, 0.9044, 0.7919],
+        [0.9044, 1.0000, 0.7757],
+        [0.7919, 0.7757, 1.0000]])
+
+
+```
+
 ## Model description
 
 More information needed