Improve model card: Add model description, code link, and paper link

#1
by nielsr HF staff - opened
Files changed (1) hide show
  1. README.md +23 -141
README.md CHANGED
@@ -33,172 +33,72 @@ model-index:
33
  name: Accuracy
34
  ---
35
 
36
- # Model Card for Model ID
37
-
38
- <!-- Provide a quick summary of what the model is/does. -->
39
-
40
 
 
41
 
42
  ## Model Details
43
 
44
  ### Model Description
45
 
46
- <!-- Provide a longer summary of what this model is. -->
47
-
48
-
49
 
50
- - **Developed by:** [More Information Needed]
51
- - **Funded by [optional]:** [More Information Needed]
52
- - **Shared by [optional]:** [More Information Needed]
53
- - **Model type:** [More Information Needed]
54
- - **Language(s) (NLP):** [More Information Needed]
55
- - **License:** [More Information Needed]
56
- - **Finetuned from model [optional]:** [More Information Needed]
57
 
58
- ### Model Sources [optional]
59
 
60
- <!-- Provide the basic links for the model. -->
 
61
 
62
- - **Repository:** [More Information Needed]
63
- - **Paper [optional]:** [More Information Needed]
64
- - **Demo [optional]:** [More Information Needed]
65
 
66
  ## Uses
67
 
68
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
69
-
70
  ### Direct Use
71
 
72
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
73
-
74
- [More Information Needed]
75
 
76
  ### Downstream Use [optional]
77
 
78
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
79
-
80
- [More Information Needed]
81
 
82
  ### Out-of-Scope Use
83
 
84
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
85
-
86
- [More Information Needed]
87
 
88
  ## Bias, Risks, and Limitations
89
 
90
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
91
-
92
- [More Information Needed]
93
 
94
  ### Recommendations
95
 
96
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
97
-
98
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
99
 
100
  ## How to Get Started with the Model
101
 
102
- Use the code below to get started with the model.
103
 
104
- [More Information Needed]
105
 
106
  ## Training Details
107
 
108
  ### Training Data
109
 
110
- <!-- 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. -->
111
-
112
- [More Information Needed]
113
 
114
  ### Training Procedure
115
 
116
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
117
-
118
- #### Preprocessing [optional]
119
-
120
- [More Information Needed]
121
-
122
-
123
- #### Training Hyperparameters
124
-
125
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
126
-
127
- #### Speeds, Sizes, Times [optional]
128
-
129
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
130
-
131
- [More Information Needed]
132
 
133
  ## Evaluation
134
 
135
- <!-- This section describes the evaluation protocols and provides the results. -->
136
-
137
- ### Testing Data, Factors & Metrics
138
-
139
- #### Testing Data
140
-
141
- <!-- This should link to a Dataset Card if possible. -->
142
-
143
- [More Information Needed]
144
-
145
- #### Factors
146
-
147
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
148
-
149
- [More Information Needed]
150
-
151
- #### Metrics
152
-
153
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
154
-
155
- [More Information Needed]
156
 
157
- ### Results
158
 
159
- [More Information Needed]
160
-
161
- #### Summary
162
-
163
-
164
-
165
- ## Model Examination [optional]
166
-
167
- <!-- Relevant interpretability work for the model goes here -->
168
-
169
- [More Information Needed]
170
-
171
- ## Environmental Impact
172
-
173
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
174
-
175
- - **Hardware Type:** [More Information Needed]
176
- - **Hours used:** [More Information Needed]
177
- - **Cloud Provider:** [More Information Needed]
178
- - **Compute Region:** [More Information Needed]
179
- - **Carbon Emitted:** [More Information Needed]
180
-
181
- ## Technical Specifications [optional]
182
-
183
- ### Model Architecture and Objective
184
-
185
- [More Information Needed]
186
-
187
- ### Compute Infrastructure
188
-
189
- [More Information Needed]
190
-
191
- #### Hardware
192
-
193
- [More Information Needed]
194
-
195
- #### Software
196
-
197
- [More Information Needed]
198
-
199
- ## Citation [optional]
200
-
201
- ```
202
  @misc{yuxuan2025detectingoffensivememessocial,
203
  title={Detecting Offensive Memes with Social Biases in Singapore Context Using Multimodal Large Language Models},
204
  author={Cao Yuxuan and Wu Jiayang and Alistair Cheong Liang Chuen and Bryan Shan Guanrong and Theodore Lee Chong Jen and Sherman Chann Zhi Shen},
@@ -208,22 +108,4 @@ Use the code below to get started with the model.
208
  primaryClass={cs.CV},
209
  url={https://arxiv.org/abs/2502.18101},
210
  }
211
- ```
212
-
213
- ## Glossary [optional]
214
-
215
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
216
-
217
- [More Information Needed]
218
-
219
- ## More Information [optional]
220
-
221
- [More Information Needed]
222
-
223
- ## Model Card Authors [optional]
224
-
225
- [More Information Needed]
226
-
227
- ## Model Card Contact
228
-
229
- [More Information Needed]
 
33
  name: Accuracy
34
  ---
35
 
36
+ # Model Card for Qwen2-VL 7B RSLORA Offensive Meme Singapore
 
 
 
37
 
38
+ This model is a fine-tuned version of Qwen2-VL-7B-Instruct for offensive meme classification in the Singapore context. It was trained on the [multimodal_meme_classification_singapore](https://huggingface.co/datasets/aliencaocao/multimodal_meme_classification_singapore) dataset.
39
 
40
  ## Model Details
41
 
42
  ### Model Description
43
 
44
+ This model classifies memes as offensive or not, taking into account Singaporean social context. It leverages the visual and textual understanding capabilities of Qwen2-VL-7B-Instruct.
 
 
45
 
46
+ - **Developed by:** Cao Yuxuan, Wu Jiayang, Alistair Cheong Liang Chuen, Bryan Shan Guanrong, Theodore Lee Chong Jen, and Sherman Chann Zhi Shen
47
+ - **Model type:** Vision-Language Model (VLM)
48
+ - **Language(s) (NLP):** en
49
+ - **License:** MIT
50
+ - **Finetuned from model:** Qwen/Qwen2-VL-7B-Instruct
 
 
51
 
52
+ ### Model Sources
53
 
54
+ - **Repository:** [https://github.com/aliencaocao/vlm-for-memes-aisg](https://github.com/aliencaocao/vlm-for-memes-aisg)
55
+ - **Paper:** [Detecting Offensive Memes with Social Biases in Singapore Context Using Multimodal Large Language Models](https://arxiv.org/abs/2502.18101)
56
 
 
 
 
57
 
58
  ## Uses
59
 
 
 
60
  ### Direct Use
61
 
62
+ This model can be used directly to classify memes. See the code example in the "How to Get Started" section.
 
 
63
 
64
  ### Downstream Use [optional]
65
 
66
+ This model can be further fine-tuned for other related tasks or incorporated into a larger content moderation system.
 
 
67
 
68
  ### Out-of-Scope Use
69
 
70
+ This model is specifically trained for the Singaporean context and may not generalize well to other cultures or languages. It should not be used to make definitive judgments about individuals or groups.
 
 
71
 
72
  ## Bias, Risks, and Limitations
73
 
74
+ Like any machine learning model, this model may exhibit biases present in the training data. It is important to be aware of these limitations and use the model responsibly. Further research is needed to assess and mitigate potential biases.
 
 
75
 
76
  ### Recommendations
77
 
78
+ Users should be aware of the potential for bias and limitations in the model's performance. It is recommended to use this model as a tool to assist human moderators rather than a replacement for human judgment.
 
 
79
 
80
  ## How to Get Started with the Model
81
 
82
+ See the model repository's README for usage examples: [https://github.com/aliencaocao/vlm-for-memes-aisg](https://github.com/aliencaocao/vlm-for-memes-aisg)
83
 
 
84
 
85
  ## Training Details
86
 
87
  ### Training Data
88
 
89
+ The model was trained on the [multimodal_meme_classification_singapore](https://huggingface.co/datasets/aliencaocao/multimodal_meme_classification_singapore) dataset. This dataset contains memes labeled as offensive or not within the Singaporean context.
 
 
90
 
91
  ### Training Procedure
92
 
93
+ More details about the training procedure can be found in the paper.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
94
 
95
  ## Evaluation
96
 
97
+ The model achieved an AUROC of 0.8192 and an accuracy of 0.8043 on a held-out test set. See the paper for more details on the evaluation methodology.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
98
 
99
+ ## Citation
100
 
101
+ ```bibtex
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
102
  @misc{yuxuan2025detectingoffensivememessocial,
103
  title={Detecting Offensive Memes with Social Biases in Singapore Context Using Multimodal Large Language Models},
104
  author={Cao Yuxuan and Wu Jiayang and Alistair Cheong Liang Chuen and Bryan Shan Guanrong and Theodore Lee Chong Jen and Sherman Chann Zhi Shen},
 
108
  primaryClass={cs.CV},
109
  url={https://arxiv.org/abs/2502.18101},
110
  }
111
+ ```