---
tags:
- sentence-transformers
- sentence-similarity
- feature-extraction
- dense
- generated_from_trainer
- dataset_size:1259
- loss:CosineSimilarityLoss
base_model: AhmedZaky1/DIMI-embedding-matryoshka-arabic
widget:
- source_sentence: الخبز تاع الشوفان صحي بزاف ومفيد للقلب.
sentences:
- التعليم ماشي غير هدرة، هو رسالة وبناء اجيال.
- خصني دوش سخون يريحلي راسي.
- كي تاكل خبز شوفان مع العسل تحس بالطاقة.
- source_sentence: السيستام تاع لبلاد يسحق تغيير في العقلية.
sentences:
- لازم كل واحد يبدا بروحو باش لبلاد تتسقم.
- لازم نغير اللوك، غادي نحسن شعري.
- نتائج الباك تخرج من عند ONEC.
- source_sentence: القهوة تاعك مسوسة، زيدلها السكر.
sentences:
- ريحة الخبز في الدار تمد جو تاع هنا وبركة.
- السانوج يمد ذوق سبيسيال للخبز والمطلوع.
- ناقصة حلاوة القهوة هادي، سكرها شوية.
- source_sentence: راني حاب نشري لوتو جديدة تكون اقتصادية.
sentences:
- وشبيك تخزر، حاب تقول حاجة؟
- بركانا من التمسخير تاعك، نعرفك مليح.
- عيت من القديم، خصني طوموبيل ما تكلش المازوت.
- source_sentence: العطلة هي الوقت باش نريحو من لسانس.
sentences:
- لي غريف هما اللي ضيعو بزاف لي سوماستر.
- كي تخلص ليزيكزامان تحس روحك ولدت من جديد.
- كي تسافر في الكوشيت تجوز الوقت تقصر.
pipeline_tag: sentence-similarity
library_name: sentence-transformers
---
# SentenceTransformer based on AhmedZaky1/DIMI-embedding-matryoshka-arabic
This is a [sentence-transformers](https://www.SBERT.net) model finetuned from [AhmedZaky1/DIMI-embedding-matryoshka-arabic](https://huggingface.co/AhmedZaky1/DIMI-embedding-matryoshka-arabic). It maps sentences & paragraphs to a 768-dimensional dense vector space and can be used for semantic textual similarity, semantic search, paraphrase mining, text classification, clustering, and more.
## Model Details
### Model Description
- **Model Type:** Sentence Transformer
- **Base model:** [AhmedZaky1/DIMI-embedding-matryoshka-arabic](https://huggingface.co/AhmedZaky1/DIMI-embedding-matryoshka-arabic)
- **Maximum Sequence Length:** 75 tokens
- **Output Dimensionality:** 768 dimensions
- **Similarity Function:** Cosine Similarity
### Model Sources
- **Documentation:** [Sentence Transformers Documentation](https://sbert.net)
- **Repository:** [Sentence Transformers on GitHub](https://github.com/huggingface/sentence-transformers)
- **Hugging Face:** [Sentence Transformers on Hugging Face](https://huggingface.co/models?library=sentence-transformers)
### Full Model Architecture
```
SentenceTransformer(
(0): Transformer({'max_seq_length': 75, 'do_lower_case': False, 'architecture': 'BertModel'})
(1): Pooling({'word_embedding_dimension': 768, 'pooling_mode_cls_token': False, 'pooling_mode_mean_tokens': True, 'pooling_mode_max_tokens': False, 'pooling_mode_mean_sqrt_len_tokens': False, 'pooling_mode_weightedmean_tokens': False, 'pooling_mode_lasttoken': False, 'include_prompt': True})
)
```
## Usage
### Direct Usage (Sentence Transformers)
First install the Sentence Transformers library:
```bash
pip install -U sentence-transformers
```
Then you can load this model and run inference.
```python
from sentence_transformers import SentenceTransformer
# Download from the 🤗 Hub
model = SentenceTransformer("s1nju/darija-embedding-model")
# Run inference
sentences = [
'العطلة هي الوقت باش نريحو من لسانس.',
'كي تخلص ليزيكزامان تحس روحك ولدت من جديد.',
'لي غريف هما اللي ضيعو بزاف لي سوماستر.',
]
embeddings = model.encode(sentences)
print(embeddings.shape)
# [3, 768]
# Get the similarity scores for the embeddings
similarities = model.similarity(embeddings, embeddings)
print(similarities)
# tensor([[1.0000, 0.9451, 0.9580],
# [0.9451, 1.0000, 0.9401],
# [0.9580, 0.9401, 1.0000]])
```
## Training Details
### Training Dataset
#### Unnamed Dataset
* Size: 1,259 training samples
* Columns: sentence_0, sentence_1, and label
* Approximate statistics based on the first 1000 samples:
| | sentence_0 | sentence_1 | label |
|:--------|:----------------------------------------------------------------------------------|:----------------------------------------------------------------------------------|:----------------------------------------------------------------|
| type | string | string | float |
| details | - min: 7 tokens
- mean: 12.05 tokens
- max: 19 tokens
| - min: 7 tokens
- mean: 13.06 tokens
- max: 19 tokens
| - min: 0.0
- mean: 0.91
- max: 0.98
|
* Samples:
| sentence_0 | sentence_1 | label |
|:-------------------------------------------------|:-----------------------------------------------|:------------------|
| عنابة هي جوهرة الشرق وسيدي ابراهيم. | بونة الجميلة فيها بحر يطير العقل. | 0.93 |
| راني رايح للمارشي نجيب شوية قديان. | غادي نروح للحانوت نشري واش خصنا. | 0.94 |
| واش راك تقرا هاد ليامات؟ | كاش كتاب جديد راك تتبع فيه؟ | 0.91 |
* Loss: [CosineSimilarityLoss](https://sbert.net/docs/package_reference/sentence_transformer/losses.html#cosinesimilarityloss) with these parameters:
```json
{
"loss_fct": "torch.nn.modules.loss.MSELoss"
}
```
### Training Hyperparameters
#### Non-Default Hyperparameters
- `per_device_train_batch_size`: 16
- `per_device_eval_batch_size`: 16
- `num_train_epochs`: 1
- `multi_dataset_batch_sampler`: round_robin
#### All Hyperparameters
Click to expand
- `do_predict`: False
- `eval_strategy`: no
- `prediction_loss_only`: True
- `per_device_train_batch_size`: 16
- `per_device_eval_batch_size`: 16
- `gradient_accumulation_steps`: 1
- `eval_accumulation_steps`: None
- `torch_empty_cache_steps`: None
- `learning_rate`: 5e-05
- `weight_decay`: 0.0
- `adam_beta1`: 0.9
- `adam_beta2`: 0.999
- `adam_epsilon`: 1e-08
- `max_grad_norm`: 1
- `num_train_epochs`: 1
- `max_steps`: -1
- `lr_scheduler_type`: linear
- `lr_scheduler_kwargs`: None
- `warmup_ratio`: None
- `warmup_steps`: 0
- `log_level`: passive
- `log_level_replica`: warning
- `log_on_each_node`: True
- `logging_nan_inf_filter`: True
- `enable_jit_checkpoint`: False
- `save_on_each_node`: False
- `save_only_model`: False
- `restore_callback_states_from_checkpoint`: False
- `use_cpu`: False
- `seed`: 42
- `data_seed`: None
- `bf16`: False
- `fp16`: False
- `bf16_full_eval`: False
- `fp16_full_eval`: False
- `tf32`: None
- `local_rank`: -1
- `ddp_backend`: None
- `debug`: []
- `dataloader_drop_last`: False
- `dataloader_num_workers`: 0
- `dataloader_prefetch_factor`: None
- `disable_tqdm`: False
- `remove_unused_columns`: True
- `label_names`: None
- `load_best_model_at_end`: False
- `ignore_data_skip`: False
- `fsdp`: []
- `fsdp_config`: {'min_num_params': 0, 'xla': False, 'xla_fsdp_v2': False, 'xla_fsdp_grad_ckpt': False}
- `accelerator_config`: {'split_batches': False, 'dispatch_batches': None, 'even_batches': True, 'use_seedable_sampler': True, 'non_blocking': False, 'gradient_accumulation_kwargs': None}
- `parallelism_config`: None
- `deepspeed`: None
- `label_smoothing_factor`: 0.0
- `optim`: adamw_torch_fused
- `optim_args`: None
- `group_by_length`: False
- `length_column_name`: length
- `project`: huggingface
- `trackio_space_id`: trackio
- `ddp_find_unused_parameters`: None
- `ddp_bucket_cap_mb`: None
- `ddp_broadcast_buffers`: False
- `dataloader_pin_memory`: True
- `dataloader_persistent_workers`: False
- `skip_memory_metrics`: True
- `push_to_hub`: False
- `resume_from_checkpoint`: None
- `hub_model_id`: None
- `hub_strategy`: every_save
- `hub_private_repo`: None
- `hub_always_push`: False
- `hub_revision`: None
- `gradient_checkpointing`: False
- `gradient_checkpointing_kwargs`: None
- `include_for_metrics`: []
- `eval_do_concat_batches`: True
- `auto_find_batch_size`: False
- `full_determinism`: False
- `ddp_timeout`: 1800
- `torch_compile`: False
- `torch_compile_backend`: None
- `torch_compile_mode`: None
- `include_num_input_tokens_seen`: no
- `neftune_noise_alpha`: None
- `optim_target_modules`: None
- `batch_eval_metrics`: False
- `eval_on_start`: False
- `use_liger_kernel`: False
- `liger_kernel_config`: None
- `eval_use_gather_object`: False
- `average_tokens_across_devices`: True
- `use_cache`: False
- `prompts`: None
- `batch_sampler`: batch_sampler
- `multi_dataset_batch_sampler`: round_robin
- `router_mapping`: {}
- `learning_rate_mapping`: {}