Update README.md

README.md

@@ -17,48 +17,6 @@ tags:
 - sentence-transformers
 - sentence-similarity
 - feature-extraction
-widget:
-- source_sentence: ثلاثة كلاب، واحد منهم لديه كرة زرقاء.
-  sentences:
-  - هناك ثلاثة حيوانات.
-  - كل ثلاثة كلاب لديهم ألعاب حمراء
-  - أنثى تلعب كرة القدم
-- source_sentence: نسبة الكوليسترول في غمد الميالين
-  sentences:
-  - العديد من الخلايا الدبقية التي تصطف على طول محور عصبي مطلوبة لتكوين الميالين بالكامل
-    وعزل خلية عصبية طويلة. يتكون المايلين من حوالي 30٪ بروتين و 27٪ كوليسترول و 43٪
-    فوسفوليبيد ، ويعتمد إنتاج المايلين بشكل كامل على تخليق الكوليسترول في الخلايا
-    الدبقية. مادة دهنية تحيط بأجزاء طويلة من الألياف العصبية. الميالين يعزل الخلايا
-    العصبية ويعزز مرور الإشارات الكهربائية في جميع أنحاء دائرة جهازك العصبي.
-  - جزء من لفافة عنق الرحم يحيط بالشريان السباتي والوريد الوداجي الداخلي والعصب المبهم
-    أو العصب الودي المبهم. الوتر الرسغي. أغماد لأوتار العضلات التي تتحرك فوق الرسغ.
-    غمد مغزلي. غمد عظم الفخذ. الاستثمار الخارجي للعصب البصري. غمد الفخذ. الغمد اللفافي
-    لأوعية الفخذ. غمد هنلي. endoneurium ، وخاصة الاستمرارية الدقيقة حول الفروع الطرفية
-    للألياف العصبية. غمد رقائقي. العجان.
-  - تتضمن البيانات، عند الاقتضاء، مقاييس الأداء.
-- source_sentence: قد تتأثر تقديرات مخاطر وفيات الأوزون على المدى القصير أيضًا بالمسألة
-    الإحصائية التي اكتشفها معهد الآثار الصحية (Greenbaum, 2002a).
-  sentences:
-  - لم يجد معهد الآثار الصحية أي مشاكل في تقييم مخاطر وفيات الأوزون على المدى القصير
-  - قد ينتج عن الصداع النصفي والصداع العنقودي ألمًا شديدًا من جانب واحد ، ولكن على
-    عكس ألم العصب الثلاثي التوائم ، لا تحدث هذه الحالات عن طريق الحركة أو ملامسة الوجه
-    ولا تستجيب على الفور لكاربامازيبين. انظر الجدول 1 أدناه.
-  - اكتشف معهد الآثار الصحية مشكلة إحصائية مع تقييم مخاطر وفيات الأوزون قصيرة الأجل.
-- source_sentence: الآثار الجانبية فينيليفرين
-  sentences:
-  - يسبب آثارا جانبية عند بعض المرضى. التأثير الجانبي الأكثر شيوعًا هو السعال المستمر.
-    في حين أن معظم الآثار الجانبية لليزينوبريل غير ضارة ، يجب أن تكون على دراية بالآثار
-    الجانبية الخطيرة ، والتي يمكن أن تشير إلى رد فعل تحسسي ، إذا كنت تعاني من أي آثار
-    جانبية ، يجب عليك التحدث إلى طبيبك. ترتبط أحيانًا بانخفاض ضغط الدم (انخفاض ضغط
-    الدم) ، خاصة في بداية العلاج.
-  - تشمل بعض الآثار الجانبية المحتملة لفينيليفرين الدوخة والأرق والصداع. في معظم الحالات
-    ، تميل الآثار الجانبية إلى أن تكون طفيفة ويسهل علاجها بشكل عام.
-  - الرجل يلعب كرة السلة
-- source_sentence: سوق للمنتجات داخل مبنى كبير ذو جدران بيضاء.
-  sentences:
-  - راكب الدراجة مغطى بالطين
-  - سوق المنتجات داخل مبنى صغير أسود الجدران.
-  - السوق يبيع الخضروات.
 model-index:
 - name: SentenceTransformer based on FacebookAI/xlm-roberta-large
   results:
@@ -99,12 +57,17 @@ model-index:
     - type: spearman_max
       value: 0.8288613978074281
       name: Spearman Max
+license: apache-2.0
+language:
+- ar
 ---
 
 # SentenceTransformer based on FacebookAI/xlm-roberta-large
 
 This is an **Arabic only** [sentence-transformers](https://www.SBERT.net) model finetuned from [FacebookAI/xlm-roberta-large](https://huggingface.co/FacebookAI/xlm-roberta-large). It maps sentences & paragraphs to a 1024-dimensional dense vector space and can be used for semantic textual similarity, semantic search, paraphrase mining, text classification, clustering, and more.
 
+The model is trained using the MatryoshkaLoss for embeddings of size 1024, 786, 512, 128, and 64 for storage optimization (See [Evaluation](#Evaluation)). 
+
 ## Model Details
 
 ### Model Description
@@ -147,7 +110,8 @@ Then you can load this model and run inference.
 from sentence_transformers import SentenceTransformer
 
 # Download from the 🤗 Hub
-model = SentenceTransformer("sentence_transformers_model_id")
+matryoshka_dim = 786
+model = SentenceTransformer("omarelshehy/Arabic-STS-Matryoshka", truncate_dim=matryoshka_dim)
 # Run inference
 sentences = [
     'سوق للمنتجات داخل مبنى كبير ذو جدران بيضاء.',
@@ -209,6 +173,10 @@ You can finetune this model on your own dataset.
 | pearson_max         | 0.8256     |
 | spearman_max        | 0.8289     |
 
+#### Embedding Size and Performance 
+
+This plot shows the slight degradation of performance qith smaller embedding sizes (worth investigating for your case since the benefits are huge compared to the slight loss in performance)
+
 
 ## Citation