shahdAI commited on
Commit
d08abcb
·
verified ·
1 Parent(s): 07e47ce

Upload folder using huggingface_hub

Browse files
models/.gitkeep ADDED
File without changes
models/ksaa_v2/1_Pooling/config.json ADDED
@@ -0,0 +1,5 @@
 
 
 
 
 
 
1
+ {
2
+ "embedding_dimension": 768,
3
+ "pooling_mode": "mean",
4
+ "include_prompt": true
5
+ }
models/ksaa_v2/README.md ADDED
@@ -0,0 +1,383 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ tags:
3
+ - sentence-transformers
4
+ - sentence-similarity
5
+ - feature-extraction
6
+ - generated_from_trainer
7
+ - dataset_size:90678
8
+ - loss:MatryoshkaLoss
9
+ - loss:MultipleNegativesRankingLoss
10
+ base_model: Omartificial-Intelligence-Space/Arabic-Triplet-Matryoshka-V2
11
+ widget:
12
+ - source_sentence: 'ماهي الكلمه التي تعني: حزن الشخص وجرت دمعته.'
13
+ sentences:
14
+ - استذكاء
15
+ - مستعبر
16
+ - تشخيصه
17
+ - source_sentence: 'ماهي الكلمه التي تعني: المره من تناول طعام يسير؛ لتهدئه الجوع
18
+ مؤقتا.'
19
+ sentences:
20
+ - صاحن
21
+ - ادعج
22
+ - تسكيته
23
+ - source_sentence: 'ماهي الكلمه التي تعني: اعتياد التقشف وشظف العيش.'
24
+ sentences:
25
+ - اخشيشان
26
+ - هزيم
27
+ - استذهال
28
+ - source_sentence: 'ماهي الكلمه التي تعني: تعب مرهق منهك القوى.'
29
+ sentences:
30
+ - تلفان
31
+ - نقزه
32
+ - عامل
33
+ - source_sentence: 'ماهي الكلمه التي تعني: بال قديم، عديم القيمه.'
34
+ sentences:
35
+ - ادرن
36
+ - خثير
37
+ - هريء
38
+ pipeline_tag: sentence-similarity
39
+ library_name: sentence-transformers
40
+ ---
41
+
42
+ # SentenceTransformer based on Omartificial-Intelligence-Space/Arabic-Triplet-Matryoshka-V2
43
+
44
+ This is a [sentence-transformers](https://www.SBERT.net) model finetuned from [Omartificial-Intelligence-Space/Arabic-Triplet-Matryoshka-V2](https://huggingface.co/Omartificial-Intelligence-Space/Arabic-Triplet-Matryoshka-V2). It maps sentences & paragraphs to a 768-dimensional dense vector space and can be used for retrieval.
45
+
46
+ ## Model Details
47
+
48
+ ### Model Description
49
+ - **Model Type:** Sentence Transformer
50
+ - **Base model:** [Omartificial-Intelligence-Space/Arabic-Triplet-Matryoshka-V2](https://huggingface.co/Omartificial-Intelligence-Space/Arabic-Triplet-Matryoshka-V2) <!-- at revision 408d483803e83aaea0aceec550deac66e5f8dc11 -->
51
+ - **Maximum Sequence Length:** 512 tokens
52
+ - **Output Dimensionality:** 768 dimensions
53
+ - **Similarity Function:** Cosine Similarity
54
+ - **Supported Modality:** Text
55
+ <!-- - **Training Dataset:** Unknown -->
56
+ <!-- - **Language:** Unknown -->
57
+ <!-- - **License:** Unknown -->
58
+
59
+ ### Model Sources
60
+
61
+ - **Documentation:** [Sentence Transformers Documentation](https://sbert.net)
62
+ - **Repository:** [Sentence Transformers on GitHub](https://github.com/huggingface/sentence-transformers)
63
+ - **Hugging Face:** [Sentence Transformers on Hugging Face](https://huggingface.co/models?library=sentence-transformers)
64
+
65
+ ### Full Model Architecture
66
+
67
+ ```
68
+ SentenceTransformer(
69
+ (0): Transformer({'transformer_task': 'feature-extraction', 'modality_config': {'text': {'method': 'forward', 'method_output_name': 'last_hidden_state'}}, 'module_output_name': 'token_embeddings', 'architecture': 'BertModel'})
70
+ (1): Pooling({'embedding_dimension': 768, 'pooling_mode': 'mean', 'include_prompt': True})
71
+ )
72
+ ```
73
+
74
+ ## Usage
75
+
76
+ ### Direct Usage (Sentence Transformers)
77
+
78
+ First install the Sentence Transformers library:
79
+
80
+ ```bash
81
+ pip install -U sentence-transformers
82
+ ```
83
+ Then you can load this model and run inference.
84
+ ```python
85
+ from sentence_transformers import SentenceTransformer
86
+
87
+ # Download from the 🤗 Hub
88
+ model = SentenceTransformer("sentence_transformers_model_id")
89
+ # Run inference
90
+ sentences = [
91
+ 'ماهي الكلمه التي تعني: بال قديم، عديم القيمه.',
92
+ 'هريء',
93
+ 'ادرن',
94
+ ]
95
+ embeddings = model.encode(sentences)
96
+ print(embeddings.shape)
97
+ # [3, 768]
98
+
99
+ # Get the similarity scores for the embeddings
100
+ similarities = model.similarity(embeddings, embeddings)
101
+ print(similarities)
102
+ # tensor([[1.0000, 0.4617, 0.1454],
103
+ # [0.4617, 1.0000, 0.0522],
104
+ # [0.1454, 0.0522, 1.0000]])
105
+ ```
106
+ <!--
107
+ ### Direct Usage (Transformers)
108
+
109
+ <details><summary>Click to see the direct usage in Transformers</summary>
110
+
111
+ </details>
112
+ -->
113
+
114
+ <!--
115
+ ### Downstream Usage (Sentence Transformers)
116
+
117
+ You can finetune this model on your own dataset.
118
+
119
+ <details><summary>Click to expand</summary>
120
+
121
+ </details>
122
+ -->
123
+
124
+ <!--
125
+ ### Out-of-Scope Use
126
+
127
+ *List how the model may foreseeably be misused and address what users ought not to do with the model.*
128
+ -->
129
+
130
+ <!--
131
+ ## Bias, Risks and Limitations
132
+
133
+ *What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
134
+ -->
135
+
136
+ <!--
137
+ ### Recommendations
138
+
139
+ *What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
140
+ -->
141
+
142
+ ## Training Details
143
+
144
+ ### Training Dataset
145
+
146
+ #### Unnamed Dataset
147
+
148
+ * Size: 90,678 training samples
149
+ * Columns: <code>anchor</code> and <code>positive</code>
150
+ * Approximate statistics based on the first 100 samples:
151
+ | | anchor | positive |
152
+ |:---------|:-----------------------------------------------------------------------------------|:--------------------------------------------------------------------------------|
153
+ | type | string | string |
154
+ | modality | text | text |
155
+ | details | <ul><li>min: 10 tokens</li><li>mean: 14.58 tokens</li><li>max: 27 tokens</li></ul> | <ul><li>min: 3 tokens</li><li>mean: 3.75 tokens</li><li>max: 5 tokens</li></ul> |
156
+ * Samples:
157
+ | anchor | positive |
158
+ |:-----------------------------------------------------------------------------------------------------|:---------------------|
159
+ | <code>ماهي الكلمه التي تعني: وفقا للشيء.</code> | <code>تبعا لـ</code> |
160
+ | <code>ماهي الكلمه التي تعني: مركب لنقل الناس او البضائع في البحر او النهر او الفضاء الخارجي .</code> | <code>سفين</code> |
161
+ | <code>ماهي الكلمه التي تعني: المهزوم.</code> | <code>هزيم</code> |
162
+ * Loss: [<code>MatryoshkaLoss</code>](https://sbert.net/docs/package_reference/sentence_transformer/losses.html#matryoshkaloss) with these parameters:
163
+ ```json
164
+ {
165
+ "loss": "MultipleNegativesRankingLoss",
166
+ "matryoshka_dims": [
167
+ 768
168
+ ],
169
+ "matryoshka_weights": [
170
+ 1
171
+ ],
172
+ "n_dims_per_step": -1
173
+ }
174
+ ```
175
+
176
+ ### Training Hyperparameters
177
+ #### Non-Default Hyperparameters
178
+
179
+ - `per_device_train_batch_size`: 128
180
+ - `num_train_epochs`: 5
181
+ - `warmup_steps`: 0.1
182
+ - `gradient_accumulation_steps`: 2
183
+ - `bf16`: True
184
+ - `batch_sampler`: no_duplicates
185
+
186
+ #### All Hyperparameters
187
+ <details><summary>Click to expand</summary>
188
+
189
+ - `per_device_train_batch_size`: 128
190
+ - `num_train_epochs`: 5
191
+ - `max_steps`: -1
192
+ - `learning_rate`: 5e-05
193
+ - `lr_scheduler_type`: linear
194
+ - `lr_scheduler_kwargs`: None
195
+ - `warmup_steps`: 0.1
196
+ - `optim`: adamw_torch_fused
197
+ - `optim_args`: None
198
+ - `weight_decay`: 0.0
199
+ - `adam_beta1`: 0.9
200
+ - `adam_beta2`: 0.999
201
+ - `adam_epsilon`: 1e-08
202
+ - `optim_target_modules`: None
203
+ - `gradient_accumulation_steps`: 2
204
+ - `average_tokens_across_devices`: True
205
+ - `max_grad_norm`: 1.0
206
+ - `label_smoothing_factor`: 0.0
207
+ - `bf16`: True
208
+ - `fp16`: False
209
+ - `bf16_full_eval`: False
210
+ - `fp16_full_eval`: False
211
+ - `tf32`: None
212
+ - `gradient_checkpointing`: False
213
+ - `gradient_checkpointing_kwargs`: None
214
+ - `torch_compile`: False
215
+ - `torch_compile_backend`: None
216
+ - `torch_compile_mode`: None
217
+ - `use_liger_kernel`: False
218
+ - `liger_kernel_config`: None
219
+ - `use_cache`: False
220
+ - `neftune_noise_alpha`: None
221
+ - `torch_empty_cache_steps`: None
222
+ - `auto_find_batch_size`: False
223
+ - `log_on_each_node`: True
224
+ - `logging_nan_inf_filter`: True
225
+ - `include_num_input_tokens_seen`: no
226
+ - `log_level`: passive
227
+ - `log_level_replica`: warning
228
+ - `disable_tqdm`: False
229
+ - `project`: huggingface
230
+ - `trackio_space_id`: None
231
+ - `trackio_bucket_id`: None
232
+ - `trackio_static_space_id`: None
233
+ - `per_device_eval_batch_size`: 8
234
+ - `prediction_loss_only`: True
235
+ - `eval_on_start`: False
236
+ - `eval_do_concat_batches`: True
237
+ - `eval_use_gather_object`: False
238
+ - `eval_accumulation_steps`: None
239
+ - `include_for_metrics`: []
240
+ - `batch_eval_metrics`: False
241
+ - `save_only_model`: False
242
+ - `save_on_each_node`: False
243
+ - `enable_jit_checkpoint`: False
244
+ - `push_to_hub`: False
245
+ - `hub_private_repo`: None
246
+ - `hub_model_id`: None
247
+ - `hub_strategy`: every_save
248
+ - `hub_always_push`: False
249
+ - `hub_revision`: None
250
+ - `load_best_model_at_end`: False
251
+ - `ignore_data_skip`: False
252
+ - `restore_callback_states_from_checkpoint`: False
253
+ - `full_determinism`: False
254
+ - `seed`: 42
255
+ - `data_seed`: None
256
+ - `use_cpu`: False
257
+ - `accelerator_config`: {'split_batches': False, 'dispatch_batches': None, 'even_batches': True, 'use_seedable_sampler': True, 'non_blocking': False, 'gradient_accumulation_kwargs': None}
258
+ - `parallelism_config`: None
259
+ - `dataloader_drop_last`: False
260
+ - `dataloader_num_workers`: 0
261
+ - `dataloader_pin_memory`: True
262
+ - `dataloader_persistent_workers`: False
263
+ - `dataloader_prefetch_factor`: None
264
+ - `remove_unused_columns`: True
265
+ - `label_names`: None
266
+ - `train_sampling_strategy`: random
267
+ - `length_column_name`: length
268
+ - `ddp_find_unused_parameters`: None
269
+ - `ddp_bucket_cap_mb`: None
270
+ - `ddp_broadcast_buffers`: False
271
+ - `ddp_static_graph`: None
272
+ - `ddp_backend`: None
273
+ - `ddp_timeout`: 1800
274
+ - `fsdp`: []
275
+ - `fsdp_config`: {'min_num_params': 0, 'xla': False, 'xla_fsdp_v2': False, 'xla_fsdp_grad_ckpt': False}
276
+ - `deepspeed`: None
277
+ - `debug`: []
278
+ - `skip_memory_metrics`: True
279
+ - `do_predict`: False
280
+ - `resume_from_checkpoint`: None
281
+ - `warmup_ratio`: None
282
+ - `local_rank`: -1
283
+ - `prompts`: None
284
+ - `batch_sampler`: no_duplicates
285
+ - `multi_dataset_batch_sampler`: proportional
286
+ - `router_mapping`: {}
287
+ - `learning_rate_mapping`: {}
288
+
289
+ </details>
290
+
291
+ ### Training Logs
292
+ | Epoch | Step | Training Loss |
293
+ |:------:|:----:|:-------------:|
294
+ | 0.2821 | 100 | 1.8383 |
295
+ | 0.5642 | 200 | 1.3010 |
296
+ | 0.8463 | 300 | 1.1525 |
297
+ | 1.1269 | 400 | 0.9740 |
298
+ | 1.4090 | 500 | 0.8594 |
299
+ | 1.6911 | 600 | 0.8258 |
300
+ | 1.9732 | 700 | 0.8039 |
301
+ | 2.2539 | 800 | 0.6164 |
302
+ | 2.5360 | 900 | 0.6076 |
303
+ | 2.8181 | 1000 | 0.6035 |
304
+ | 3.0987 | 1100 | 0.5412 |
305
+ | 3.3808 | 1200 | 0.4620 |
306
+ | 3.6629 | 1300 | 0.4595 |
307
+ | 3.9450 | 1400 | 0.4667 |
308
+ | 4.2257 | 1500 | 0.4030 |
309
+ | 4.5078 | 1600 | 0.3940 |
310
+ | 4.7898 | 1700 | 0.3759 |
311
+
312
+
313
+ ### Training Time
314
+ - **Training**: 10.7 minutes
315
+
316
+ ### Framework Versions
317
+ - Python: 3.12.13
318
+ - Sentence Transformers: 5.5.1
319
+ - Transformers: 5.9.0
320
+ - PyTorch: 2.11.0+cu128
321
+ - Accelerate: 1.13.0
322
+ - Datasets: 4.0.0
323
+ - Tokenizers: 0.22.2
324
+
325
+ ## Citation
326
+
327
+ ### BibTeX
328
+
329
+ #### Sentence Transformers
330
+ ```bibtex
331
+ @inproceedings{reimers-2019-sentence-bert,
332
+ title = "Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks",
333
+ author = "Reimers, Nils and Gurevych, Iryna",
334
+ booktitle = "Proceedings of the 2019 Conference on Empirical Methods in Natural Language Processing",
335
+ month = "11",
336
+ year = "2019",
337
+ publisher = "Association for Computational Linguistics",
338
+ url = "https://arxiv.org/abs/1908.10084",
339
+ }
340
+ ```
341
+
342
+ #### MatryoshkaLoss
343
+ ```bibtex
344
+ @misc{kusupati2024matryoshka,
345
+ title={Matryoshka Representation Learning},
346
+ author={Aditya Kusupati and Gantavya Bhatt and Aniket Rege and Matthew Wallingford and Aditya Sinha and Vivek Ramanujan and William Howard-Snyder and Kaifeng Chen and Sham Kakade and Prateek Jain and Ali Farhadi},
347
+ year={2024},
348
+ eprint={2205.13147},
349
+ archivePrefix={arXiv},
350
+ primaryClass={cs.LG}
351
+ }
352
+ ```
353
+
354
+ #### MultipleNegativesRankingLoss
355
+ ```bibtex
356
+ @misc{oord2019representationlearningcontrastivepredictive,
357
+ title={Representation Learning with Contrastive Predictive Coding},
358
+ author={Aaron van den Oord and Yazhe Li and Oriol Vinyals},
359
+ year={2019},
360
+ eprint={1807.03748},
361
+ archivePrefix={arXiv},
362
+ primaryClass={cs.LG},
363
+ url={https://arxiv.org/abs/1807.03748},
364
+ }
365
+ ```
366
+
367
+ <!--
368
+ ## Glossary
369
+
370
+ *Clearly define terms in order to be accessible across audiences.*
371
+ -->
372
+
373
+ <!--
374
+ ## Model Card Authors
375
+
376
+ *Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
377
+ -->
378
+
379
+ <!--
380
+ ## Model Card Contact
381
+
382
+ *Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
383
+ -->
models/ksaa_v2/config.json ADDED
@@ -0,0 +1,29 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "add_cross_attention": false,
3
+ "architectures": [
4
+ "BertModel"
5
+ ],
6
+ "attention_probs_dropout_prob": 0.1,
7
+ "bos_token_id": null,
8
+ "classifier_dropout": null,
9
+ "dtype": "float32",
10
+ "eos_token_id": null,
11
+ "hidden_act": "gelu",
12
+ "hidden_dropout_prob": 0.1,
13
+ "hidden_size": 768,
14
+ "initializer_range": 0.02,
15
+ "intermediate_size": 3072,
16
+ "is_decoder": false,
17
+ "layer_norm_eps": 1e-12,
18
+ "max_position_embeddings": 512,
19
+ "model_type": "bert",
20
+ "num_attention_heads": 12,
21
+ "num_hidden_layers": 12,
22
+ "pad_token_id": 0,
23
+ "position_embedding_type": "absolute",
24
+ "tie_word_embeddings": true,
25
+ "transformers_version": "5.9.0",
26
+ "type_vocab_size": 2,
27
+ "use_cache": false,
28
+ "vocab_size": 64000
29
+ }
models/ksaa_v2/config_sentence_transformers.json ADDED
@@ -0,0 +1,14 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "__version__": {
3
+ "pytorch": "2.11.0+cu128",
4
+ "sentence_transformers": "5.5.1",
5
+ "transformers": "5.9.0"
6
+ },
7
+ "default_prompt_name": null,
8
+ "model_type": "SentenceTransformer",
9
+ "prompts": {
10
+ "document": "",
11
+ "query": ""
12
+ },
13
+ "similarity_fn_name": "cosine"
14
+ }
models/ksaa_v2/model.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:219d1b29729df31db806248acfae8c078aedd6020c9a57992313e032f040280a
3
+ size 540795752
models/ksaa_v2/modules.json ADDED
@@ -0,0 +1,14 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ [
2
+ {
3
+ "idx": 0,
4
+ "name": "0",
5
+ "path": "",
6
+ "type": "sentence_transformers.base.modules.transformer.Transformer"
7
+ },
8
+ {
9
+ "idx": 1,
10
+ "name": "1",
11
+ "path": "1_Pooling",
12
+ "type": "sentence_transformers.sentence_transformer.modules.pooling.Pooling"
13
+ }
14
+ ]
models/ksaa_v2/sentence_bert_config.json ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "transformer_task": "feature-extraction",
3
+ "modality_config": {
4
+ "text": {
5
+ "method": "forward",
6
+ "method_output_name": "last_hidden_state"
7
+ }
8
+ },
9
+ "module_output_name": "token_embeddings"
10
+ }
models/ksaa_v2/tokenizer.json ADDED
The diff for this file is too large to render. See raw diff
 
models/ksaa_v2/tokenizer_config.json ADDED
@@ -0,0 +1,30 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "backend": "tokenizers",
3
+ "clean_up_tokenization_spaces": true,
4
+ "cls_token": "[CLS]",
5
+ "do_basic_tokenize": true,
6
+ "do_lower_case": false,
7
+ "is_local": false,
8
+ "local_files_only": false,
9
+ "mask_token": "[MASK]",
10
+ "max_len": 512,
11
+ "max_length": 512,
12
+ "model_max_length": 512,
13
+ "never_split": [
14
+ "[بريد]",
15
+ "[مستخدم]",
16
+ "[رابط]"
17
+ ],
18
+ "pad_to_multiple_of": null,
19
+ "pad_token": "[PAD]",
20
+ "pad_token_type_id": 0,
21
+ "padding_side": "right",
22
+ "sep_token": "[SEP]",
23
+ "stride": 0,
24
+ "strip_accents": null,
25
+ "tokenize_chinese_chars": true,
26
+ "tokenizer_class": "BertTokenizer",
27
+ "truncation_side": "right",
28
+ "truncation_strategy": "longest_first",
29
+ "unk_token": "[UNK]"
30
+ }