nielsr HF Staff commited on
Commit
e8b1ad6
·
verified ·
1 Parent(s): 1543039

Improve model card: add pipeline_tag, library_name, license, and paper details

Browse files

This PR significantly improves the model card for the model presented in [Robust Adaptation of Large Multimodal Models for Retrieval Augmented Hateful Meme Detection](https://huggingface.co/papers/2502.13061).

Key changes include:
- **Updated `library_name` to `transformers`**: This ensures the "How to use" widget properly displays a `transformers` code snippet, as the model is compatible with `transformers` for loading and inference of its PEFT adapters.
- **Added `pipeline_tag: image-text-to-text`**: This makes the model discoverable under the appropriate task category on the Hugging Face Hub, reflecting its multimodal input and text output capabilities.
- **Added `license: cc-by-4.0`**: Provides clear licensing information.
- **Added `language: en` and relevant `tags`**: Enhances model discoverability.
- **Populated model card content**: The model card now includes the paper title, Hugging Face paper link, the abstract as a detailed model description, and filled-out sections for model details, uses, biases, training, and evaluation, providing comprehensive information about the model.
- **Added BibTeX citations**: The provided BibTeX entries for the associated papers are now correctly placed in the "Citation" section.

Please review and merge this PR if everything looks good.

Files changed (1) hide show
  1. README.md +42 -149
README.md CHANGED
@@ -1,207 +1,97 @@
1
  ---
2
  base_model: QWen/QWen2-VL-7B-Instruct
3
- library_name: peft
 
 
 
 
 
 
4
  ---
5
 
6
- # Model Card for Model ID
7
-
8
- <!-- Provide a quick summary of what the model is/does. -->
9
-
10
 
 
11
 
12
  ## Model Details
13
 
14
  ### Model Description
15
 
16
- <!-- Provide a longer summary of what this model is. -->
17
-
18
-
19
-
20
- - **Developed by:** [More Information Needed]
21
- - **Funded by [optional]:** [More Information Needed]
22
- - **Shared by [optional]:** [More Information Needed]
23
- - **Model type:** [More Information Needed]
24
- - **Language(s) (NLP):** [More Information Needed]
25
- - **License:** [More Information Needed]
26
- - **Finetuned from model [optional]:** [More Information Needed]
27
 
28
- ### Model Sources [optional]
 
 
 
 
29
 
30
- <!-- Provide the basic links for the model. -->
31
 
32
- - **Repository:** [More Information Needed]
33
- - **Paper [optional]:** [More Information Needed]
34
- - **Demo [optional]:** [More Information Needed]
35
 
36
  ## Uses
37
 
38
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
39
-
40
  ### Direct Use
41
 
42
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
43
-
44
- [More Information Needed]
45
-
46
- ### Downstream Use [optional]
47
-
48
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
49
-
50
- [More Information Needed]
51
 
52
  ### Out-of-Scope Use
53
 
54
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
55
-
56
- [More Information Needed]
57
 
58
  ## Bias, Risks, and Limitations
59
 
60
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
-
62
- [More Information Needed]
63
 
64
  ### Recommendations
65
 
66
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
67
-
68
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
69
 
70
  ## How to Get Started with the Model
71
 
72
- Use the code below to get started with the model.
73
-
74
- [More Information Needed]
75
 
76
  ## Training Details
77
 
78
  ### Training Data
79
 
80
- <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
81
-
82
- [More Information Needed]
83
 
84
  ### Training Procedure
85
 
86
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
87
-
88
- #### Preprocessing [optional]
89
-
90
- [More Information Needed]
91
-
92
 
93
  #### Training Hyperparameters
94
-
95
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
96
-
97
- #### Speeds, Sizes, Times [optional]
98
-
99
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
100
-
101
- [More Information Needed]
102
 
103
  ## Evaluation
104
 
105
- <!-- This section describes the evaluation protocols and provides the results. -->
106
-
107
  ### Testing Data, Factors & Metrics
108
 
109
  #### Testing Data
110
 
111
- <!-- This should link to a Dataset Card if possible. -->
112
-
113
- [More Information Needed]
114
-
115
- #### Factors
116
-
117
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
118
-
119
- [More Information Needed]
120
 
121
  #### Metrics
122
 
123
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
124
-
125
- [More Information Needed]
 
 
 
126
 
127
  ### Results
128
 
129
- [More Information Needed]
130
-
131
- #### Summary
132
-
133
-
134
-
135
- ## Model Examination [optional]
136
-
137
- <!-- Relevant interpretability work for the model goes here -->
138
 
139
- [More Information Needed]
140
 
141
- ## Environmental Impact
142
 
143
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
144
-
145
- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
146
-
147
- - **Hardware Type:** [More Information Needed]
148
- - **Hours used:** [More Information Needed]
149
- - **Cloud Provider:** [More Information Needed]
150
- - **Compute Region:** [More Information Needed]
151
- - **Carbon Emitted:** [More Information Needed]
152
-
153
- ## Technical Specifications [optional]
154
-
155
- ### Model Architecture and Objective
156
-
157
- [More Information Needed]
158
-
159
- ### Compute Infrastructure
160
-
161
- [More Information Needed]
162
-
163
- #### Hardware
164
-
165
- [More Information Needed]
166
-
167
- #### Software
168
-
169
- [More Information Needed]
170
-
171
- ## Citation [optional]
172
-
173
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
174
-
175
- **BibTeX:**
176
-
177
- [More Information Needed]
178
-
179
- **APA:**
180
-
181
- [More Information Needed]
182
-
183
- ## Glossary [optional]
184
-
185
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
186
-
187
- [More Information Needed]
188
-
189
- ## More Information [optional]
190
-
191
- [More Information Needed]
192
-
193
- ## Model Card Authors [optional]
194
-
195
- [More Information Needed]
196
-
197
- ## Model Card Contact
198
-
199
- [More Information Needed]
200
- ### Framework versions
201
-
202
- - PEFT 0.12.0
203
-
204
- ```
205
  @inproceedings{RGCL2024Mei,
206
  title = "Improving Hateful Meme Detection through Retrieval-Guided Contrastive Learning",
207
  author = "Mei, Jingbiao and
@@ -231,4 +121,7 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
231
  author={Mei, Jingbiao and Chen, Jinghong and Yang, Guangyu and Lin, Weizhe and Byrne, Bill},
232
  year={2025},
233
  month=may }
234
- ```
 
 
 
 
1
  ---
2
  base_model: QWen/QWen2-VL-7B-Instruct
3
+ library_name: transformers
4
+ license: cc-by-4.0
5
+ pipeline_tag: image-text-to-text
6
+ language: en
7
+ tags:
8
+ - multimodal
9
+ - hateful-speech-detection
10
  ---
11
 
12
+ # Robust Adaptation of Large Multimodal Models for Retrieval Augmented Hateful Meme Detection
 
 
 
13
 
14
+ This repository contains a PEFT fine-tuned Large Multimodal Model (LMM) for hateful meme detection, as presented in the paper [Robust Adaptation of Large Multimodal Models for Retrieval Augmented Hateful Meme Detection](https://huggingface.co/papers/2502.13061).
15
 
16
  ## Model Details
17
 
18
  ### Model Description
19
 
20
+ Hateful memes have become a significant concern on the Internet, necessitating robust automated detection systems. While Large Multimodal Models (LMMs) have shown promise in hateful meme detection, they face notable challenges like sub-optimal performance and limited out-of-domain generalization capabilities. Recent studies further reveal the limitations of both supervised fine-tuning (SFT) and in-context learning when applied to LMMs in this setting. To address these issues, this work proposes a robust adaptation framework for hateful meme detection that enhances in-domain accuracy and cross-domain generalization while preserving the general vision-language capabilities of LMMs. Analysis reveals that this approach achieves improved robustness under adversarial attacks compared to SFT models. Experiments on six meme classification datasets show that this approach achieves state-of-the-art performance, outperforming larger agentic systems. Moreover, the method generates higher-quality rationales for explaining hateful content compared to standard SFT, enhancing model interpretability.
 
 
 
 
 
 
 
 
 
 
21
 
22
+ - **Developed by:** Jingbiao Mei, Jinghong Chen, Guangyu Yang, Weizhe Lin, Bill Byrne
23
+ - **Model type:** Large Multimodal Model (LMM), fine-tuned using PEFT (LoRA) for hateful meme detection.
24
+ - **Language(s) (NLP):** English
25
+ - **License:** cc-by-4.0
26
+ - **Finetuned from model:** QWen/QWen2-VL-7B-Instruct
27
 
28
+ ### Model Sources
29
 
30
+ - **Paper:** [https://huggingface.co/papers/2502.13061](https://huggingface.co/papers/2502.13061)
 
 
31
 
32
  ## Uses
33
 
 
 
34
  ### Direct Use
35
 
36
+ This model is intended for the robust detection of hateful memes. It can be used to classify multimodal content (image and text) for hate speech, offering improved accuracy and cross-domain generalization. It also provides rationales for its classifications, aiding interpretability.
 
 
 
 
 
 
 
 
37
 
38
  ### Out-of-Scope Use
39
 
40
+ This model should not be used for generating hateful content, propagating misinformation, or any other malicious purposes. It is a detection tool and its application should align with ethical AI principles for combating harmful online content.
 
 
41
 
42
  ## Bias, Risks, and Limitations
43
 
44
+ All AI models, especially those dealing with sensitive content like hate speech, may exhibit biases from their training data or limitations in understanding complex nuances, sarcasm, or evolving slang. This could lead to misclassifications or biased explanations.
 
 
45
 
46
  ### Recommendations
47
 
48
+ Users (both direct and downstream) should be made aware of the risks, biases, and limitations of the model. Continuous monitoring, human oversight in critical applications, and further evaluation on diverse and evolving datasets are recommended.
 
 
49
 
50
  ## How to Get Started with the Model
51
 
52
+ This model is a PEFT (Parameter-Efficient Fine-Tuning) adapter built on top of `QWen/QWen2-VL-7B-Instruct`. To use it, you typically load the base model and its tokenizer using the Hugging Face Transformers library, and then load this model as a PEFT adapter.
 
 
53
 
54
  ## Training Details
55
 
56
  ### Training Data
57
 
58
+ The model was trained and evaluated on six meme classification datasets, as mentioned in the paper.
 
 
59
 
60
  ### Training Procedure
61
 
62
+ The paper proposes a robust adaptation framework that enhances in-domain accuracy and cross-domain generalization while preserving the general vision-language capabilities of LMMs. The training involved fine-tuning using PEFT (LoRA).
 
 
 
 
 
63
 
64
  #### Training Hyperparameters
65
+ - **Training regime:** Based on the base model, Qwen2-VL-7B-Instruct often uses mixed precision (e.g., bfloat16).
66
+ - **Epochs:** 3
67
+ - **Train Batch Size:** 16
 
 
 
 
 
68
 
69
  ## Evaluation
70
 
 
 
71
  ### Testing Data, Factors & Metrics
72
 
73
  #### Testing Data
74
 
75
+ The model was evaluated on six meme classification datasets.
 
 
 
 
 
 
 
 
76
 
77
  #### Metrics
78
 
79
+ The evaluation metrics recorded during training include:
80
+ - `accuracy`
81
+ - `auroc` (Area Under the Receiver Operating Characteristic curve)
82
+ - `f1` (F1 Score)
83
+ - `precision`
84
+ - `recall`
85
 
86
  ### Results
87
 
88
+ The proposed approach achieved state-of-the-art performance across six meme classification datasets, outperforming larger agentic systems. It also demonstrated improved robustness under adversarial attacks and generated higher-quality rationales compared to standard SFT models.
 
 
 
 
 
 
 
 
89
 
90
+ ## Citation
91
 
92
+ If you find this work helpful, please consider citing the following papers:
93
 
94
+ ```bibtex
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
95
  @inproceedings{RGCL2024Mei,
96
  title = "Improving Hateful Meme Detection through Retrieval-Guided Contrastive Learning",
97
  author = "Mei, Jingbiao and
 
121
  author={Mei, Jingbiao and Chen, Jinghong and Yang, Guangyu and Lin, Weizhe and Byrne, Bill},
122
  year={2025},
123
  month=may }
124
+ ```
125
+ ### Framework versions
126
+
127
+ - PEFT 0.12.0