Update README.md

README.md

@@ -1,3 +1,84 @@
 ---
 license: apache-2.0
+language:
+- en
+metrics:
+- f1
+pipeline_tag: token-classification
 ---
+
+# XLM-RoBERTa for English Metaphor Detection
+
+This model is a fine-tuned version of XLM-RoBERTa-large on VUAM dataset, for metaphor detection in English at token level. This model is presented in our paper [Leveraging a New Spanish Corpus for Multilingual and Cross-lingual Metaphor Detection](https://aclanthology.org/2022.conll-1.16/)
+
+
+### Model Sources
+
+<!-- Provide the basic links for the model. -->
+
+- **Repository:** (https://github.com/ixa-ehu/cometa)
+- **Paper:** [Leveraging a New Spanish Corpus for Multilingual and Cross-lingual Metaphor Detection](https://aclanthology.org/2022.conll-1.16/)
+
+
+### Training & Testing Data
+VUAM dataset (Steen et al. 2010).
+
+#### Training Hyperparameters
+
+- Batch size: 32
+- Weight Decay: 0.1
+- Learning Rate: 0.00003
+- Epochs: 4
+
+### Results
+
+- F1: 72.11
+- Precision: 73.95
+- Recall: 70.37 
+
+
+## Label Dictionary
+
+```
+{
+  "LABEL_0": "B-METAPHOR",
+  "LABEL_1": "I-METAPHOR",
+  "LABEL_2": "O"
+}
+```
+
+## Citation
+
+If you use this model, please cite our work:
+
+```
+
+@book{steen2010method,
+  title={A method for linguistic metaphor identification: From MIP to MIPVU},
+  author={Steen, Gerard and Dorst, Lettie and Herrmann, J. and Kaal, Anna and Krennmayr, Tina and Pasma, Trijntje},
+  volume={14},
+  year={2010},
+  publisher={John Benjamins Publishing}
+}
+
+@inproceedings{sanchez-bayona-agerri-2022-leveraging,
+    title = "Leveraging a New {S}panish Corpus for Multilingual and Cross-lingual Metaphor Detection",
+    author = "Sanchez-Bayona, Elisa  and
+      Agerri, Rodrigo",
+    editor = "Fokkens, Antske  and
+      Srikumar, Vivek",
+    booktitle = "Proceedings of the 26th Conference on Computational Natural Language Learning (CoNLL)",
+    month = dec,
+    year = "2022",
+    address = "Abu Dhabi, United Arab Emirates (Hybrid)",
+    publisher = "Association for Computational Linguistics",
+    url = "https://aclanthology.org/2022.conll-1.16",
+    doi = "10.18653/v1/2022.conll-1.16",
+    pages = "228--240",
+    abstract = "The lack of wide coverage datasets annotated with everyday metaphorical expressions for languages other than English is striking. This means that most research on supervised metaphor detection has been published only for that language. In order to address this issue, this work presents the first corpus annotated with naturally occurring metaphors in Spanish large enough to develop systems to perform metaphor detection. The presented dataset, CoMeta, includes texts from various domains, namely, news, political discourse, Wikipedia and reviews. In order to label CoMeta, we apply the MIPVU method, the guidelines most commonly used to systematically annotate metaphor on real data. We use our newly created dataset to provide competitive baselines by fine-tuning several multilingual and monolingual state-of-the-art large language models. Furthermore, by leveraging the existing VUAM English data in addition to CoMeta, we present the, to the best of our knowledge, first cross-lingual experiments on supervised metaphor detection. Finally, we perform a detailed error analysis that explores the seemingly high transfer of everyday metaphor across these two languages and datasets.",
+}
+```
+
+## Dataset Card Contact
+
+{elisa.sanchez, rodrigo.agerri}@ehu.eus