Improve model card: add pipeline tag, detailed metrics, description, and usage

README.md

@@ -1,25 +1,55 @@
 ---
-library_name: transformers
-license: mit
 base_model: microsoft/mdeberta-v3-base
-tags:
-- generated_from_trainer
+language:
+- en
+library_name: transformers
+license: cc-by-4.0
 metrics:
 - accuracy
 - f1
+pipeline_tag: text-classification
+tags:
+- subjectivity-detection
+- news-articles
 model-index:
 - name: mdeberta-v3-base-subjectivity-english
-  results: []
-language:
-- en
+  results:
+  - task:
+      name: Subjectivity Detection
+      type: text-classification
+    dataset:
+      name: CheckThat! Lab Task 1 Subjectivity Detection at CLEF 2025 - English
+      type: checkthat_clef_2025_task1
+    metrics:
+    - type: loss
+      value: 0.5845
+      name: Loss
+    - type: f1
+      value: 0.7921
+      name: Macro F1
+    - type: precision
+      value: 0.7952
+      name: Macro P
+    - type: recall
+      value: 0.7941
+      name: Macro R
+    - type: f1
+      value: 0.7885
+      name: Subj F1
+    - type: precision
+      value: 0.8364
+      name: Subj P
+    - type: recall
+      value: 0.7458
+      name: Subj R
+    - type: accuracy
+      value: 0.7922
+      name: Accuracy
 ---
 
-<!-- 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-english
 
-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) on the [CheckThat! Lab Task 1 Subjectivity Detection at CLEF 2025](https://arxiv.org/abs/2507.11764).
 It achieves the following results on the evaluation set:
 - Loss: 0.5845
 - Macro F1: 0.7921
@@ -32,15 +62,55 @@ It achieves the following results on the evaluation set:
 
 ## Model description
 
-More information needed
+This model is part of AI Wizards' participation in the CLEF 2025 CheckThat! Lab Task 1: Subjectivity Detection in News Articles. Its primary goal is to classify sentences as subjective (opinion-laden) or objective.
+
+The model is based on the [mDeBERTaV3-base](https://huggingface.co/microsoft/mdeberta-v3-base) architecture. Its core innovation lies in enhancing transformer-based classifiers by integrating sentiment scores, derived from an auxiliary model, with sentence representations. This approach aims to significantly improve upon standard fine-tuning for subjectivity detection, resulting in consistent performance gains, particularly in subjective F1 score. To further address class imbalance, prevalent across languages, decision threshold calibration optimized on the development set was employed.
 
 ## Intended uses & limitations
 
-More information needed
+**Intended uses**:
+*   Classifying sentences in news articles as subjective or objective.
+*   Supporting fact-checking pipelines by identifying opinionated content.
+*   Assisting journalists in distinguishing between facts and opinions.
+
+The model was evaluated across various settings, including monolingual (Arabic, German, English, Italian, and Bulgarian), multilingual, and zero-shot transfer (Greek, Polish, Romanian, and Ukrainian).
+
+**Limitations**:
+*   Performance may vary on domains significantly different from news articles, as the model was fine-tuned specifically on news data.
+*   While the sentiment augmentation significantly boosts performance, the overall effectiveness can depend on the quality and nature of the input text.
+*   As noted by the authors in their GitHub repository, due to a mistake in their submission process for the multilingual track, the official Macro F1 score was initially lower than its actual performance. The corrected score would have placed them 9th overall in the challenge.
+*   The model primarily processes text inputs and is not designed for other modalities.
 
 ## Training and evaluation data
 
-More information needed
+The model was trained and evaluated on datasets provided for the [CLEF 2025 CheckThat! Lab Task 1: Subjectivity Detection in News Articles](https://arxiv.org/abs/2507.11764).
+
+Training and development datasets were provided for multiple languages including Arabic, German, English, Italian, and Bulgarian. For the final evaluation, additional unseen languages such as Greek, Romanian, Polish, and Ukrainian were included to assess the model's generalization capabilities. The training process involved augmenting transformer embeddings with sentiment signals and applying decision threshold calibration to effectively address class imbalances observed across languages.
+
+## How to use
+
+You can use this model for text classification with the `transformers` library:
+
+```python
+from transformers import pipeline
+
+# Load the text classification pipeline
+classifier = pipeline("text-classification", model="MatteoFasulo/mdeberta-v3-base-subjectivity-english")
+
+# Example usage for an objective sentence
+text1 = "The company reported a 10% increase in profits in the last quarter."
+result1 = classifier(text1)
+print(f"Text: '{text1}'
+Classification: {result1}")
+# Expected output: [{'label': 'OBJ', 'score': 0.99...}]
+
+# Example usage for a subjective sentence
+text2 = "This product is absolutely amazing and everyone should try it!"
+result2 = classifier(text2)
+print(f"Text: '{text2}'
+Classification: {result2}")
+# Expected output: [{'label': 'SUBJ', 'score': 0.98...}]
+```
 
 ## Training procedure
 
@@ -72,4 +142,25 @@ The following hyperparameters were used during training:
 - Transformers 4.49.0
 - Pytorch 2.5.1+cu121
 - Datasets 3.3.1
-- Tokenizers 0.21.0
+- Tokenizers 0.21.0
+
+## Code
+
+The official code and materials for this submission are available on GitHub:
+[https://github.com/MatteoFasulo/clef2025-checkthat](https://github.com/MatteoFasulo/clef2025-checkthat)
+
+## 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}, 
+}
+```