Improve model card: Add pipeline tag, update license and tags, expand content and usage (#1)

- Improve model card: Add pipeline tag, update license and tags, expand content and usage (c892ba17f06184748b6fe02ab2a4d7184d142bae)
- Update README.md (68c27ef44c549caa3109f25269b0a6548b453406)


Co-authored-by: Niels Rogge <[email protected]>

README.md

@@ -1,25 +1,31 @@
 ---
-library_name: transformers
-license: mit
 base_model: microsoft/mdeberta-v3-base
-tags:
-- generated_from_trainer
+language:
+- bg
+library_name: transformers
+license: cc-by-4.0
 metrics:
 - accuracy
 - f1
+tags:
+- generated_from_trainer
+- deberta
+- multilingual
+- subjectivity-detection
+pipeline_tag: text-classification
 model-index:
 - name: mdeberta-v3-base-subjectivity-bulgarian
   results: []
-language:
-- bg
+datasets:
+- MatteoFasulo/clef2025_checkthat_task1_subjectivity
 ---
 
-<!-- This model card has been generated automatically according to the information the Trainer had access to. You
-should probably proofread and complete it, then remove this comment. -->
-
 # mdeberta-v3-base-subjectivity-bulgarian
 
-This model is a fine-tuned version of [microsoft/mdeberta-v3-base](https://huggingface.co/microsoft/mdeberta-v3-base) on the [CheckThat! Lab Task 1 Subjectivity Detection at CLEF 2025](arxiv.org/abs/2507.11764).
+This model is a fine-tuned version of [microsoft/mdeberta-v3-base](https://huggingface.co/microsoft/mdeberta-v3-base) for **Subjectivity Detection in News Articles**. It was presented by AI Wizards in the paper [AI Wizards at CheckThat! 2025: Enhancing Transformer-Based Embeddings with Sentiment for Subjectivity Detection in News Articles](https://arxiv.org/abs/2507.11764) as part of the [CLEF 2025 CheckThat! Lab Task 1](https://huggingface.co/papers/2507.11764).
+
+The official code and materials for this project can be found on the [GitHub repository](https://github.com/MatteoFasulo/clef2025-checkthat).
+
 It achieves the following results on the evaluation set:
 - Loss: 0.5111
 - Macro F1: 0.7869
@@ -32,15 +38,27 @@ It achieves the following results on the evaluation set:
 
 ## Model description
 
-More information needed
+This model identifies whether a sentence is **subjective** (e.g., opinion-laden) or **objective**. This task is a key component in combating misinformation, improving fact-checking pipelines, and supporting journalists. This specific checkpoint is fine-tuned for the Bulgarian language.
+
+The primary strategy behind this model involves enhancing transformer-based classifiers (specifically mDeBERTaV3-base) by integrating sentiment scores, derived from an auxiliary model, with sentence representations. This aims to improve upon standard fine-tuning, particularly boosting subjective F1 score. To address class imbalance prevalent across languages, decision threshold calibration optimized on the development set was employed. The research achieved high rankings in the CLEF 2025 CheckThat! Lab Task 1, notably ranking 1st for Greek (zero-shot, Macro F1 = 0.51) and securing 1st–4th place in most monolingual settings.
 
 ## Intended uses & limitations
 
-More information needed
+**Intended Uses:**
+This model is intended for research and practical applications focused on subjectivity detection in news articles, particularly for distinguishing subjective (opinion-laden) from objective content. It can be particularly useful in:
+*   Combating misinformation by identifying opinionated content.
+*   Improving fact-checking pipelines.
+*   Supporting journalists in content analysis and understanding bias.
+
+**Limitations:**
+*   While the overarching research explored multilingual and zero-shot settings, this specific model checkpoint is fine-tuned for Bulgarian. Its performance might vary when applied to other languages or domains not represented in the training data without further fine-tuning.
+*   The paper notes that an initial submission quirk led to skewed class distribution and under-calibrated thresholds; the reported results reflect the corrected evaluation. Users should be aware of potential nuances when applying the model to data with significantly different class distributions.
 
 ## Training and evaluation data
 
-More information needed
+This model was trained and evaluated as part of the CLEF 2025 CheckThat! Lab Task 1: Subjectivity Detection in News Articles. Training and development datasets were provided for Arabic, German, English, Italian, and Bulgarian. The final evaluation included additional unseen languages such as Greek, Romanian, Polish, and Ukrainian to assess generalization capabilities.
+
+To address class imbalance, a common issue across these languages, a decision threshold calibration optimized on the development set was employed. More details on the datasets and experimental setup can be found in the [paper](https://arxiv.org/abs/2507.11764) and the [GitHub repository](https://github.com/MatteoFasulo/clef2025-checkthat).
 
 ## Training procedure
 
@@ -66,10 +84,49 @@ The following hyperparameters were used during training:
 | No log        | 5.0   | 230  | 0.5065          | 0.7728   | 0.7835  | 0.7696  | 0.7315  | 0.7966 | 0.6763 | 0.7803   |
 | No log        | 6.0   | 276  | 0.5111          | 0.7869   | 0.7949  | 0.7839  | 0.7510  | 0.8033 | 0.7050 | 0.7930   |
 
-
 ### Framework versions
 
 - Transformers 4.50.0
 - Pytorch 2.5.1+cu121
 - Datasets 3.3.1
-- Tokenizers 0.21.0
+- Tokenizers 0.21.0
+
+## How to use
+
+You can use this model directly with the Hugging Face `transformers` library for text classification:
+
+```python
+from transformers import pipeline
+
+# Load the text classification pipeline
+classifier = pipeline(
+    "text-classification",
+    model="MatteoFasulo/mdeberta-v3-base-subjectivity-bulgarian",
+    tokenizer="microsoft/mdeberta-v3-base",
+)
+
+# Example usage:
+result1 = classifier("По принцип никой не иска войни, но за нещастие те се случват.")
+print(f"Classification: {result1}")
+# Expected output: [{'label': 'SUBJ', 'score': ...}]
+
+result2 = classifier("В един момент започнал сам да търси изход за своето спасение и здраве")
+print(f"Classification: {result2}")
+# Expected output: [{'label': 'OBJ', 'score': ...}]
+```
+
+## Citation
+
+If you find our work helpful or inspiring, please feel free to cite it:
+
+```bibtex
+@misc{fasulo2025aiwizardscheckthat2025,
+      title={AI Wizards at CheckThat! 2025: Enhancing Transformer-Based Embeddings with Sentiment for Subjectivity Detection in News Articles}, 
+      author={Matteo Fasulo and Luca Babboni and Luca Tedeschini},
+      year={2025},
+      eprint={2507.11764},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL},
+      url={https://arxiv.org/abs/2507.11764}, 
+}
+```