LLMXperts commited on
Commit
b1e4355
·
verified ·
1 Parent(s): feb4435

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +0 -83
README.md CHANGED
@@ -19,11 +19,6 @@ tags:
19
  license: apache-2.0
20
  ---
21
 
22
- # Arabic Triplet Matryoshka V2 Model [ATM2]
23
-
24
-
25
- ![image/png](https://cdn-uploads.huggingface.co/production/uploads/628f7a71dd993507cfcbe587/FrLQzFUJ3grEUOdONWGME.png)
26
-
27
  ## Model Description
28
 
29
  Arabic-Triplet-Matryoshka-V2-Model is a state-of-the-art Arabic language embedding model based on the [sentence-transformers](https://www.SBERT.net) framework. It is fine-tuned from [aubmindlab/bert-base-arabertv02](https://huggingface.co/aubmindlab/bert-base-arabertv02) and specifically designed to capture the rich semantic nuances of Arabic text.
@@ -37,67 +32,6 @@ This model maps sentences and paragraphs to a 768-dimensional dense vector space
37
  - Information retrieval
38
  - Question answering
39
 
40
- ## Key Features
41
-
42
- - **State-of-the-Art Performance**: Achieved 0.85 on STS17 and 0.64 on STS22.v2 with an average score of 74.5, making it the leading Arabic embedding model currently available.
43
- - **MatryoshkaLoss Training**: Utilizes nested embedding learning techniques to create hierarchical embeddings at multiple resolutions.
44
- - **Optimization**: Trained for 3 epochs with a final training loss of 0.718.
45
- - **Full Arabic Language Support**: Designed specifically to handle the complexity and morphological richness of Arabic language.
46
-
47
- ## Training Details
48
-
49
- The model was trained using a combination of two loss functions:
50
- - **MatryoshkaLoss**: Enables the creation of nested embeddings at multiple resolutions, allowing for efficient and adaptable representations.
51
- - **MultipleNegativesRankingLoss**: Enhances the model's ability to discriminate between semantically similar and dissimilar text pairs.
52
-
53
- Training parameters:
54
- - **Base model**: aubmindlab/bert-base-arabertv02
55
- - **Dataset**: akhooli/arabic-triplets-1m-curated-sims-len (1M samples)
56
- - **Epochs**: 3
57
- - **Final Loss**: 0.718
58
- - **Embedding Dimension**: 768
59
-
60
- ## Performance
61
-
62
- The model demonstrates exceptional performance on standard Arabic semantic textual similarity benchmarks:
63
- - **STS17**: 0.85
64
- - **STS22.v2**: 0.64
65
- - **Average Performance**: 74.5
66
-
67
- This represents the current state-of-the-art for Arabic embedding models, outperforming previous approaches by a significant margin.
68
-
69
- ## Use Cases
70
-
71
- This model is particularly well-suited for:
72
- - **Information Retrieval**: Enhancing search capabilities for Arabic content.
73
- - **Document Similarity**: Identifying similar documents or text passages.
74
- - **Text Classification**: Powering classification systems for Arabic content.
75
- - **Question Answering**: Supporting Arabic QA systems with improved semantic understanding.
76
- - **Semantic Clustering**: Organizing Arabic text data based on meaning.
77
- - **Cross-lingual Applications**: When combined with other language models for multilingual applications.
78
-
79
- ## Usage Examples
80
-
81
- ```python
82
- from sentence_transformers import SentenceTransformer
83
-
84
- # Download from the 🤗 Hub
85
- model = SentenceTransformer("Omartificial-Intelligence-Space/Arabic-Triplet-Matryoshka-V2")
86
- # Run inference
87
- sentences = [
88
- 'SENTENCE 1',
89
- 'SENTENCE 2',
90
- 'SENTENCE 3',
91
- ]
92
- embeddings = model.encode(sentences)
93
- print(embeddings.shape)
94
- # [3, 768]
95
-
96
- # Get the similarity scores for the embeddings
97
- similarities = model.similarity(embeddings, embeddings)
98
- print(similarities.shape)
99
- # [3, 3]
100
- ```
101
 
102
  ## Limitations
103
 
@@ -110,20 +44,3 @@ Despite its strong performance, users should be aware of the following limitatio
110
 
111
  This model is intended for research and applications that benefit Arabic language processing. Users should be mindful of potential biases that may exist in the training data and the resulting embeddings. We encourage responsible use of this technology and welcome feedback on ways to improve fairness and representation.
112
 
113
- ## Citation
114
-
115
- If you use the Arabic Matryoshka Embeddings Model in your research or applications, please cite it as follows:
116
-
117
- ```bibtex
118
- @article{nacar2024enhancing,
119
- title={Enhancing Semantic Similarity Understanding in Arabic NLP with Nested Embedding Learning},
120
- author={Nacar, Omer and Koubaa, Anis},
121
- journal={arXiv preprint arXiv:2407.21139},
122
- year={2024}
123
- }
124
- ```
125
-
126
- ## Acknowledgements
127
-
128
- We would like to acknowledge [AraBERT](https://github.com/aub-mind/arabert) for the base model and [akhooli](https://huggingface.co/akhooli) for the valuable dataset that made this work possible.
129
-
 
19
  license: apache-2.0
20
  ---
21
 
 
 
 
 
 
22
  ## Model Description
23
 
24
  Arabic-Triplet-Matryoshka-V2-Model is a state-of-the-art Arabic language embedding model based on the [sentence-transformers](https://www.SBERT.net) framework. It is fine-tuned from [aubmindlab/bert-base-arabertv02](https://huggingface.co/aubmindlab/bert-base-arabertv02) and specifically designed to capture the rich semantic nuances of Arabic text.
 
32
  - Information retrieval
33
  - Question answering
34
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
35
 
36
  ## Limitations
37
 
 
44
 
45
  This model is intended for research and applications that benefit Arabic language processing. Users should be mindful of potential biases that may exist in the training data and the resulting embeddings. We encourage responsible use of this technology and welcome feedback on ways to improve fairness and representation.
46