Add SetFit model

.gitattributes

@@ -33,3 +33,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.zip filter=lfs diff=lfs merge=lfs -text
 *.zst filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text
+tokenizer.json filter=lfs diff=lfs merge=lfs -text

1_Pooling/config.json

@@ -0,0 +1,10 @@
+{
+  "word_embedding_dimension": 768,
+  "pooling_mode_cls_token": true,
+  "pooling_mode_mean_tokens": false,
+  "pooling_mode_max_tokens": false,
+  "pooling_mode_mean_sqrt_len_tokens": false,
+  "pooling_mode_weightedmean_tokens": false,
+  "pooling_mode_lasttoken": false,
+  "include_prompt": true
+}

2_Dense/config.json

@@ -0,0 +1 @@
+{"in_features": 768, "out_features": 768, "bias": true, "activation_function": "torch.nn.modules.activation.Tanh"}

2_Dense/pytorch_model.bin

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4b4be681fccad796fda2017043f21a0ed4b080c3c8ce41330bf57db76c028d53
+size 2364028

README.md

@@ -1,3 +1,241 @@
 ---
-license: apache-2.0
+library_name: setfit
+tags:
+- setfit
+- sentence-transformers
+- text-classification
+- generated_from_setfit_trainer
+metrics:
+- accuracy
+widget:
+- text: حصل لاعبو المنتخب السوري لكرة القدم على مكافأة سريعة، بعد تحقيقهم الفوز على
+    نظيرهم السعودي 2/1 في المباراة التي أقيمت، أول من أمس، على استاد الريان ضمن مباريات
+    المجموعة الثانية لبطولة أمم آسيا بكرة القدم، المقامة حالياً في الدوحة وتستمر حتى
+    27 يناير الجاري.
+- text: هدد الامين العام لحزب الله حسن نصرالله الثلاثاء بضرب البنى التحتية في اسرائيل
+    وبتدمير ابنية في تل ابيب في حال هاجمت الدولة العبرية لبنان، ملمحا الى اقتناء حزب
+    الله القدرات العسكرية التي تخوله القيام بذلك.
+- text: برّأت لجنة تحقيق إسرائيلية على نطاق واسع أمس الجيش الإسرائيلي في تحقيق بشأن
+    حصار غزة والعدوان على اسطول الحرية، فيما كشف تقرير إخباري إسرائيلي أن وزير الخارجية
+    أفيغدور ليبرمان، رسم خريطة لدولة فلسطينية بحدود مؤقتة، سارع الفلسطينيون برفضها.
+- text: دعا الرئيس المنتخب لساحل العاج الحسن وتارا، أمس، الى استخدام القوة لحمل منافسه
+    لوران غباغبو على التنحي.
+- text: تتجه الأنظار، اليوم، إلى القمة الكلاسيكية الخاصة بين منتخبي اليابان وكوريا
+    الجنوبية، على ملعب نادي الغرافة في نصف نهائي كأس آسيا الخامسة عشرة لكرة القدم
+    في الدوحة.
+pipeline_tag: text-classification
+inference: true
+base_model: sentence-transformers/LaBSE
+model-index:
+- name: SetFit with sentence-transformers/LaBSE
+  results:
+  - task:
+      type: text-classification
+      name: Text Classification
+    dataset:
+      name: Unknown
+      type: unknown
+      split: test
+    metrics:
+    - type: accuracy
+      value: 0.9083333333333333
+      name: Accuracy
 ---
+
+# SetFit with sentence-transformers/LaBSE
+
+This is a [SetFit](https://github.com/huggingface/setfit) model that can be used for Text Classification. This SetFit model uses [sentence-transformers/LaBSE](https://huggingface.co/sentence-transformers/LaBSE) 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:** [sentence-transformers/LaBSE](https://huggingface.co/sentence-transformers/LaBSE)
+- **Classification head:** a [LogisticRegression](https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.LogisticRegression.html) instance
+- **Maximum Sequence Length:** 256 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                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
+|:---------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| life     | <ul><li>'عارضات يرتدين ابتكارات مختلفة لعدد من المصممين خلال أسبوع ساو باولو للموضة في البرازيل.'</li><li>'رفض قاض أميركي أمس، دعوى التشهير التي أقامها ديفيد بيكهام مطالبا بتعويض قدره 25 مليون دولار ضد مجلة تتناول أخبار المشاهير نشرت مقالا يقول أن نجم كرة القدم الإنجليزي المتزوج مارس الجنس مع'</li><li>'تعرض صالة «هالسيون غاليري» في لندن اعتباراً من السبت، لوحات للموسيقي الاميركي بوب ديلان في تكملة لمجموعته الفنية «درون بلانك سيريز» التي سبق عرضها في ألمانيا في 2007 وبريطانيا في 2008.'</li></ul>                                                                                                                                                                                                                                                                                                                                                                                    |
+| politics | <ul><li>'لقي شخص واحد على الأقل مصرعه، واعتبر ثلاثة آخرون في عداد المفقودين، بعد انفجار طائرة ركاب روسية، بعد قليل من هبوطها اضطرارياً في مطار مدينة "سورغوت" بمنطقة سيبيريا، وعلى متنها نحو 130 راكباً، وفق ما أكدت مصادر رسمية امس.'</li><li>'اعلنت الشرطة الباكستانية ان خمسة اشخاص على الاقل قتلوا في تفجير قنبلة خبئت في دراجة نارية في منطقة تقع شمال غرب باكستان تشهد باستمرار اعمال عنف بين السنة والشيعة.'</li><li>'وحده الأحمق يسعى إلى التنبؤ بمسار الانتفاضتين التونسية والمصرية، لكن الغبي فقط ينكر ان ثمة شيئاً دراماتيكياً وعميقاً يجري على نطاق واسع في العالمين العربي والإسلامي، وهو أكثر من مجرد ظاهرة سياسية.'</li></ul>                                                                                                                                                                                                                                                           |
+| sports   | <ul><li>'زار سمو الشيخ عبدالله بن زايد ال نهيان وزير الخارجية بعثة المنتخب الوطني الاول لكرة القدم المتواجدة في العاصمة القطرية الدوحة للمشاركة في كاس اسيا 2011.'</li><li>'أعلنت أكاديمية لوريوس العالمية أسماء الفائزين بجوائزها السنوية الثانية عشرة لعام ،2011 في احتفال ضخم أقيم مساء أمس بفندق قصر الإمارات، بالعاصمة أبوظبي، بحضور نخبة كبيرة من نجوم ومشاهير العالم في الرياضة والفن.'</li><li>'حقق فريق الشارقة فوزا هاما ومستحقا على النصر بنتيجة 4/ 1، في المباراة التي جمعتهما مساء امس على ستاد ال مكتوم بدبي ضمن الجولة 15 من دوري اتصالات.'</li></ul>                                                                                                                                                                                                                                                                                                                                   |
+| business | <ul><li>'بلغ مجمل عدد الشركات التي تستثمر في قطاع الخدمات الأمنية في مختلف أنحاء الدولة 404 شركات، توظف لديها نحو 30 ألف موظف، بحسب ورقة عمل استعرضها مدير إدارة شركات الأمن الخاصة في وزارة الداخلية، العقيد أحمد الحنطوبي، خلال ملتقى «الأمن وحماية الاستثمارات»، الذي عقد في غرفة تجارة وصناعة الشارقة، أمس.'</li><li>'أعلنت شركة «طيران الإمارات» توسيع شبكة خطوطها في شمال أوروبا، من خلال إضافة مزيد من الرحلات المنتظمة إلى خدماتها القائمة إلى كل من النمسا وألمانيا في مارس وسبتمبر المقبلين، إضافة إلى الخدمات الجديدة التي أعلنتها أخيراً إلى كل من سويسرا والدنمارك.'</li><li>'وقّعت شركة أبوظبي للخدمات العامة «مساندة»، أمس، اتفاقية شراكة استراتيجية من الفئة الذهبية مع شركة «أوراكل» العالمية المتخصصة في البرامج التقنية، ما سيدعم إدارة خدمات تكنولوجيا المعلومات في «مساندة» في تنفيذ المشروعات المنوطة إليها، بما فيها برنامج تخطيط موارد المشروعات الحكومية المشتركة.'</li></ul> |
+
+## Evaluation
+
+### Metrics
+| Label   | Accuracy |
+|:--------|:---------|
+| **all** | 0.9083   |
+
+## 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("Ezzaldin-97/LaBSE-based-Arabic-News-Classifier")
+# 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   | 11  | 32.9082 | 60  |
+
+| Label    | Training Sample Count |
+|:---------|:----------------------|
+| business | 54                    |
+| life     | 98                    |
+| politics | 91                    |
+| sports   | 73                    |
+
+### Training Hyperparameters
+- batch_size: (16, 16)
+- num_epochs: (2, 2)
+- max_steps: -1
+- sampling_strategy: oversampling
+- num_iterations: 20
+- body_learning_rate: (2e-05, 2e-05)
+- head_learning_rate: 2e-05
+- loss: CosineSimilarityLoss
+- distance_metric: cosine_distance
+- margin: 0.25
+- end_to_end: False
+- use_amp: False
+- warmup_proportion: 0.1
+- seed: 42
+- eval_max_steps: -1
+- load_best_model_at_end: False
+
+### Training Results
+| Epoch  | Step | Training Loss | Validation Loss |
+|:------:|:----:|:-------------:|:---------------:|
+| 0.0013 | 1    | 0.2934        | -               |
+| 0.0633 | 50   | 0.2025        | -               |
+| 0.1266 | 100  | 0.104         | -               |
+| 0.1899 | 150  | 0.0906        | -               |
+| 0.2532 | 200  | 0.0012        | -               |
+| 0.3165 | 250  | 0.001         | -               |
+| 0.3797 | 300  | 0.0008        | -               |
+| 0.4430 | 350  | 0.0007        | -               |
+| 0.5063 | 400  | 0.0005        | -               |
+| 0.5696 | 450  | 0.0006        | -               |
+| 0.6329 | 500  | 0.0003        | -               |
+| 0.6962 | 550  | 0.0003        | -               |
+| 0.7595 | 600  | 0.0004        | -               |
+| 0.8228 | 650  | 0.0004        | -               |
+| 0.8861 | 700  | 0.0003        | -               |
+| 0.9494 | 750  | 0.0003        | -               |
+| 1.0127 | 800  | 0.0003        | -               |
+| 1.0759 | 850  | 0.0002        | -               |
+| 1.1392 | 900  | 0.0002        | -               |
+| 1.2025 | 950  | 0.0003        | -               |
+| 1.2658 | 1000 | 0.0003        | -               |
+| 1.3291 | 1050 | 0.0002        | -               |
+| 1.3924 | 1100 | 0.0002        | -               |
+| 1.4557 | 1150 | 0.0004        | -               |
+| 1.5190 | 1200 | 0.0002        | -               |
+| 1.5823 | 1250 | 0.0003        | -               |
+| 1.6456 | 1300 | 0.0002        | -               |
+| 1.7089 | 1350 | 0.0002        | -               |
+| 1.7722 | 1400 | 0.0003        | -               |
+| 1.8354 | 1450 | 0.0002        | -               |
+| 1.8987 | 1500 | 0.0002        | -               |
+| 1.9620 | 1550 | 0.0003        | -               |
+
+### Framework Versions
+- Python: 3.10.12
+- SetFit: 1.0.3
+- Sentence Transformers: 2.6.1
+- Transformers: 4.38.2
+- PyTorch: 2.2.1+cu121
+- Datasets: 2.18.0
+- Tokenizers: 0.15.2
+
+## 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.*
+-->

config.json

@@ -0,0 +1,32 @@
+{
+  "_name_or_path": "sentence-transformers/LaBSE",
+  "architectures": [
+    "BertModel"
+  ],
+  "attention_probs_dropout_prob": 0.1,
+  "classifier_dropout": null,
+  "directionality": "bidi",
+  "gradient_checkpointing": false,
+  "hidden_act": "gelu",
+  "hidden_dropout_prob": 0.1,
+  "hidden_size": 768,
+  "initializer_range": 0.02,
+  "intermediate_size": 3072,
+  "layer_norm_eps": 1e-12,
+  "max_position_embeddings": 512,
+  "model_type": "bert",
+  "num_attention_heads": 12,
+  "num_hidden_layers": 12,
+  "pad_token_id": 0,
+  "pooler_fc_size": 768,
+  "pooler_num_attention_heads": 12,
+  "pooler_num_fc_layers": 3,
+  "pooler_size_per_head": 128,
+  "pooler_type": "first_token_transform",
+  "position_embedding_type": "absolute",
+  "torch_dtype": "float32",
+  "transformers_version": "4.38.2",
+  "type_vocab_size": 2,
+  "use_cache": true,
+  "vocab_size": 501153
+}

config_sentence_transformers.json

@@ -0,0 +1,9 @@
+{
+  "__version__": {
+    "sentence_transformers": "2.0.0",
+    "transformers": "4.7.0",
+    "pytorch": "1.9.0+cu102"
+  },
+  "prompts": {},
+  "default_prompt_name": null
+}

config_setfit.json

@@ -0,0 +1,9 @@
+{
+  "normalize_embeddings": false,
+  "labels": [
+    "business",
+    "life",
+    "politics",
+    "sports"
+  ]
+}

model.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:6f262b5e5c2b6fedf00566169de1f2891637c4bc67f26c44d23caf3d18810afd
+size 1883730160

model_head.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a442fa6cc8a7f856ed464efa025b5d563663758cb91e9f9950fa3d27b093eda7
+size 25559

modules.json

@@ -0,0 +1,26 @@
+[
+  {
+    "idx": 0,
+    "name": "0",
+    "path": "",
+    "type": "sentence_transformers.models.Transformer"
+  },
+  {
+    "idx": 1,
+    "name": "1",
+    "path": "1_Pooling",
+    "type": "sentence_transformers.models.Pooling"
+  },
+  {
+    "idx": 2,
+    "name": "2",
+    "path": "2_Dense",
+    "type": "sentence_transformers.models.Dense"
+  },
+  {
+    "idx": 3,
+    "name": "3",
+    "path": "3_Normalize",
+    "type": "sentence_transformers.models.Normalize"
+  }
+]

sentence_bert_config.json

@@ -0,0 +1,4 @@
+{
+  "max_seq_length": 256,
+  "do_lower_case": false
+}

special_tokens_map.json

@@ -0,0 +1,37 @@
+{
+  "cls_token": {
+    "content": "[CLS]",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "mask_token": {
+    "content": "[MASK]",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "pad_token": {
+    "content": "[PAD]",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "sep_token": {
+    "content": "[SEP]",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  },
+  "unk_token": {
+    "content": "[UNK]",
+    "lstrip": false,
+    "normalized": false,
+    "rstrip": false,
+    "single_word": false
+  }
+}

tokenizer.json

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:92262b29204f8fdc169a63f9005a0e311a16262cef4d96ecfe2a7ed638662ed3
+size 13632172

tokenizer_config.json

@@ -0,0 +1,58 @@
+{
+  "added_tokens_decoder": {
+    "0": {
+      "content": "[PAD]",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "100": {
+      "content": "[UNK]",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "101": {
+      "content": "[CLS]",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "102": {
+      "content": "[SEP]",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    },
+    "103": {
+      "content": "[MASK]",
+      "lstrip": false,
+      "normalized": false,
+      "rstrip": false,
+      "single_word": false,
+      "special": true
+    }
+  },
+  "clean_up_tokenization_spaces": true,
+  "cls_token": "[CLS]",
+  "do_basic_tokenize": true,
+  "do_lower_case": false,
+  "full_tokenizer_file": null,
+  "mask_token": "[MASK]",
+  "model_max_length": 512,
+  "never_split": null,
+  "pad_token": "[PAD]",
+  "sep_token": "[SEP]",
+  "strip_accents": null,
+  "tokenize_chinese_chars": true,
+  "tokenizer_class": "BertTokenizer",
+  "unk_token": "[UNK]"
+}