README.md

---
base_model: akhooli/sbert_ar_nli_500k_norm
library_name: setfit
metrics:
- accuracy
pipeline_tag: text-classification
tags:
- setfit
- sentence-transformers
- text-classification
- generated_from_setfit_trainer
widget:
- text: 'هل كان من الممكن أن أكون مهووسًا أكثر عندما سمعت أن أبولو 13 سيتم إصداره
    بتنسيق آيماكس؟ '
- text: 'يبدو أنه تم إعادة تجميعه من أرضية غرفة التقطيع لأي صابون نهاري. '
- text: 'تخريبي، تأملي، سريري وشاعري، مدرس البيانو هو عمل جريء من العبقرية. '
- text: 'يثبت نولان أنه يستطيع أن يتعارض مع أفضلهم ويدير فيلم تشويق تقليدي أكثر بينما
    يتخلى عن القليل من صرامته الفكرية أو رباطة جأشه الإبداعية. '
- text: 'فيلم بائس يختزل الحرب العالمية الثانية إلى سعي رجل واحد للعثور على شعلة قديمة. '
inference: true
model-index:
- name: SetFit with akhooli/sbert_ar_nli_500k_norm
  results:
  - task:
      type: text-classification
      name: Text Classification
    dataset:
      name: Unknown
      type: unknown
      split: test
    metrics:
    - type: accuracy
      value: 0.56
      name: Accuracy
---

# SetFit with akhooli/sbert_ar_nli_500k_norm

This is a [SetFit](https://github.com/huggingface/setfit) model that can be used for Text Classification. This SetFit model uses [akhooli/sbert_ar_nli_500k_norm](https://huggingface.co/akhooli/sbert_ar_nli_500k_norm) as the Sentence Transformer embedding model. A [LogisticRegression](https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.LogisticRegression.html) instance is used for classification.

The model has been trained using an efficient few-shot learning technique that involves:

1. Fine-tuning a [Sentence Transformer](https://www.sbert.net) with contrastive learning.
2. Training a classification head with features from the fine-tuned Sentence Transformer.

## Model Details

### Model Description
- **Model Type:** SetFit
- **Sentence Transformer body:** [akhooli/sbert_ar_nli_500k_norm](https://huggingface.co/akhooli/sbert_ar_nli_500k_norm)
- **Classification head:** a [LogisticRegression](https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.LogisticRegression.html) instance
- **Maximum Sequence Length:** 512 tokens
- **Number of Classes:** 4 classes
<!-- - **Training Dataset:** [Unknown](https://huggingface.co/datasets/unknown) -->
<!-- - **Language:** Unknown -->
<!-- - **License:** Unknown -->

### Model Sources

- **Repository:** [SetFit on GitHub](https://github.com/huggingface/setfit)
- **Paper:** [Efficient Few-Shot Learning Without Prompts](https://arxiv.org/abs/2209.11055)
- **Blogpost:** [SetFit: Efficient Few-Shot Learning Without Prompts](https://huggingface.co/blog/setfit)

### Model Labels
| Label | Examples                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|:------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|  0    | <ul><li>'الحماقة الشاملة مثل هذه هي مسألة ذوق. '</li><li>'... أصبح أكثر واهية بالتأكيد مع العديد من القطع الثابتة ذات الحجم الكبير والبعيدة عن الشخصية والمسامية منطقيًا. '</li><li>'أعتقد أن الخطأ الأول هو تصوير شاتنر في دور أستاذ أسطوري وكونيس في دور طالب جامعي لامع - أين هو بولي شور في دور عالم الصواريخ؟ '</li></ul>                                                                                                                                                                                                            |
|       | <ul><li>"إن مور يشبه الثور التقدمي في متجر للخزف الصيني، وهو محرض يقتحم الأفكار ومجموعات المصالح الخاصة بينما يجمع علامته التجارية الخاصة من الليبرالية. '$$ 0"</li><li>"`` كوين -lrb- لكريستيان بيل هو -rrb- قرصان غرانج يرتدي ملابس جلدية مع تسريحة شعر مثل غاندالف في نفق الرياح ولهجة كوكني المذهلة ببساطة. '$$ 0"</li><li>'يحمل هذا الفيلم الرقيق على كتفيه الرشيقتين، ويخوض تشان في الكتابة الفاسدة والاتجاه والتوقيت بابتسامة تقول: "إذا بقيت إيجابيًا، فربما أستطيع أن أعرض واحدة من أعظم صوري، المعلم السكير". \'$$ 0'</li></ul> |
|  1    | <ul><li>'... إنه مفهوم مثل أي دليل دمى، وهو شيء يمكن حتى لغير التقنيين الاستمتاع به. '</li><li>'لن يرحب الجميع أو يقبلوا محاكمات هنري كيسنجر باعتبارها لوحة مخلصة، لكن قليلين هم من يستطيعون القول بأن المناقشة التي تنضم إليها هذه المحاكمة ضرورية وتأتي في الوقت المناسب. '</li><li>'على الرغم من أنه يقرع طبلًا مبتذلًا جدًا في بعض الأحيان، إلا أن الحوار الجديد لهذا الجمهور الممتع، والموسيقى النشطة، والشجاعة اللطيفة غالبًا ما تكون معدية. '</li></ul>                                                                            |
| 0     | <ul><li>'ليس بالضبط ركب النحل '</li><li>'أنا أكره هذا الفيلم '</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |

## Evaluation

### Metrics
| Label   | Accuracy |
|:--------|:---------|
| **all** | 0.56     |

## Uses

### Direct Use for Inference

First install the SetFit library:

```bash
pip install setfit
```

Then you can load this model and run inference.

```python
from setfit import SetFitModel

# Download from the 🤗 Hub
model = SetFitModel.from_pretrained("akhooli/setfit")
# Run inference
preds = model("يبدو أنه تم إعادة تجميعه من أرضية غرفة التقطيع لأي صابون نهاري. ")
```

<!--
### Downstream Use

*List how someone could finetune this model on their own dataset.*
-->

<!--
### Out-of-Scope Use

*List how the model may foreseeably be misused and address what users ought not to do with the model.*
-->

<!--
## Bias, Risks and Limitations

*What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
-->

<!--
### Recommendations

*What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
-->

## Training Details

### Training Set Metrics
| Training set | Min | Median  | Max |
|:-------------|:----|:--------|:----|
| Word count   | 5   | 16.5769 | 31  |

| Label  | Training Sample Count |
|:-------|:----------------------|
| سلبي   | 0                     |
| إيجابي | 0                     |

### Training Hyperparameters
- batch_size: (32, 32)
- num_epochs: (3, 3)
- max_steps: -1
- sampling_strategy: oversampling
- body_learning_rate: (2e-05, 1e-05)
- head_learning_rate: 0.01
- loss: CosineSimilarityLoss
- distance_metric: cosine_distance
- margin: 0.25
- end_to_end: False
- use_amp: False
- warmup_proportion: 0.1
- l2_weight: 0.01
- seed: 42
- eval_max_steps: -1
- load_best_model_at_end: True

### Training Results
| Epoch | Step | Training Loss | Validation Loss |
|:-----:|:----:|:-------------:|:---------------:|
| 0.125 | 1    | 0.278         | -               |
| 1.0   | 8    | -             | 0.2514          |
| 2.0   | 16   | -             | 0.2524          |
| 3.0   | 24   | -             | 0.2543          |

### Framework Versions
- Python: 3.10.14
- SetFit: 1.2.0.dev0
- Sentence Transformers: 3.1.1
- Transformers: 4.45.1
- PyTorch: 2.4.0
- Datasets: 3.0.1
- Tokenizers: 0.20.0

## Citation

### BibTeX
```bibtex
@article{https://doi.org/10.48550/arxiv.2209.11055,
    doi = {10.48550/ARXIV.2209.11055},
    url = {https://arxiv.org/abs/2209.11055},
    author = {Tunstall, Lewis and Reimers, Nils and Jo, Unso Eun Seo and Bates, Luke and Korat, Daniel and Wasserblat, Moshe and Pereg, Oren},
    keywords = {Computation and Language (cs.CL), FOS: Computer and information sciences, FOS: Computer and information sciences},
    title = {Efficient Few-Shot Learning Without Prompts},
    publisher = {arXiv},
    year = {2022},
    copyright = {Creative Commons Attribution 4.0 International}
}
```

<!--
## Glossary

*Clearly define terms in order to be accessible across audiences.*
-->

<!--
## Model Card Authors

*Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
-->

<!--
## Model Card Contact

*Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
-->