Update README.md

README.md

@@ -1,11 +1,19 @@
 ---
 library_name: transformers
-tags: []
+tags:
+- headline-generation
+- tags-generation
+- multilingual
+license: cc-by-sa-4.0
+datasets:
+- faisaltareque/XL-HeadTags
+pipeline_tag: text2text-generation
 ---
 
 # Model Card for Model ID
 
 <!-- Provide a quick summary of what the model is/does. -->
+This is a Text-to-Text model for generating headlines and tags from news articles.
 
 
 
@@ -14,58 +22,59 @@ tags: []
 ### Model Description
 
 <!-- Provide a longer summary of what this model is. -->
+This model is a Text-to-Text model for generating headlines and tags from news articles. This is a mT5 model finetuned on the **XL-HeadTags** multilingual dataset [(read more)](https://aclanthology.org/2024.findings-acl.771/). 
 
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-
-- **Developed by:** [More Information Needed]
+<!-- - **Developed by:** [More Information Needed]
 - **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
+- **Shared by [optional]:** [More Information Needed] -->
+
+<!-- - **Language(s) (NLP):** [More Information Needed]
+- **License:** [More Information Needed] -->
+- **Model type:** T5
+- **Finetuned from model :** [mT5](https://huggingface.co/google/mt5-base)
 
 ### Model Sources [optional]
 
 <!-- Provide the basic links for the model. -->
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+- **Repository:** [XL-HeadTags](https://github.com/faisaltareque/XL-HeadTags)
+- **Paper:** [XL-HeadTags](https://aclanthology.org/2024.findings-acl.771/)
+<!-- - **Demo [optional]:** [More Information Needed] -->
 
-## Uses
+<!-- ## Uses -->
 
 <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
 
-### Direct Use
 
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+<!-- ### Direct Use -->
 
+<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+<!-- 
 [More Information Needed]
 
-### Downstream Use [optional]
+### Downstream Use [optional] -->
 
 <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
 
-[More Information Needed]
+<!-- [More Information Needed]
 
-### Out-of-Scope Use
+### Out-of-Scope Use -->
 
 <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
 
-[More Information Needed]
+<!-- [More Information Needed]
 
-## Bias, Risks, and Limitations
+## Bias, Risks, and Limitations -->
 
 <!-- This section is meant to convey both technical and sociotechnical limitations. -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-### Recommendations
+<!-- ### Recommendations -->
 
 <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
 
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
+<!-- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
 
 ## How to Get Started with the Model
 
@@ -75,74 +84,74 @@ Use the code below to get started with the model.
 
 ## Training Details
 
-### Training Data
+### Training Data -->
 
 <!-- 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. -->
 
-[More Information Needed]
+<!-- [More Information Needed]
 
-### Training Procedure
+### Training Procedure -->
 
 <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
 
-#### Preprocessing [optional]
+<!-- #### Preprocessing [optional]
 
-[More Information Needed]
+[More Information Needed] -->
 
 
-#### Training Hyperparameters
+<!-- #### Training Hyperparameters
 
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
+- **Training regime:** [More Information Needed] fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
 
-#### Speeds, Sizes, Times [optional]
+<!-- #### Speeds, Sizes, Times [optional] -->
 
 <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
 
-[More Information Needed]
+<!-- [More Information Needed]
 
-## Evaluation
+## Evaluation -->
 
 <!-- This section describes the evaluation protocols and provides the results. -->
 
-### Testing Data, Factors & Metrics
+<!-- ### Testing Data, Factors & Metrics
 
-#### Testing Data
+#### Testing Data -->
 
 <!-- This should link to a Dataset Card if possible. -->
 
-[More Information Needed]
+<!-- [More Information Needed]
 
-#### Factors
+#### Factors -->
 
 <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
 
-[More Information Needed]
+<!-- [More Information Needed]
 
-#### Metrics
+#### Metrics -->
 
 <!-- These are the evaluation metrics being used, ideally with a description of why. -->
 
-[More Information Needed]
+<!-- [More Information Needed]
 
-### Results
+### Results -->
 
-[More Information Needed]
+<!-- [More Information Needed]
 
-#### Summary
+#### Summary -->
 
 
 
-## Model Examination [optional]
+<!-- ## Model Examination [optional] -->
 
 <!-- Relevant interpretability work for the model goes here -->
 
-[More Information Needed]
+<!-- [More Information Needed]
 
-## Environmental Impact
+## Environmental Impact -->
 
 <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
 
-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).
+<!-- 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).
 
 - **Hardware Type:** [More Information Needed]
 - **Hours used:** [More Information Needed]
@@ -166,34 +175,38 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 #### Software
 
-[More Information Needed]
+[More Information Needed] -->
 
 ## Citation [optional]
 
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-
-**BibTeX:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
+```
+@inproceedings{shohan-etal-2024-xl,
+    title = "{XL}-{H}ead{T}ags: Leveraging Multimodal Retrieval Augmentation for the Multilingual Generation of News Headlines and Tags",
+    author = "Shohan, Faisal  and
+      Nayeem, Mir Tafseer  and
+      Islam, Samsul  and
+      Akash, Abu Ubaida  and
+      Joty, Shafiq",
+    editor = "Ku, Lun-Wei  and
+      Martins, Andre  and
+      Srikumar, Vivek",
+    booktitle = "Findings of the Association for Computational Linguistics ACL 2024",
+    month = aug,
+    year = "2024",
+    address = "Bangkok, Thailand and virtual meeting",
+    publisher = "Association for Computational Linguistics",
+    url = "https://aclanthology.org/2024.findings-acl.771",
+    pages = "12991--13024"
+}
+```
 
 ## Model Card Authors [optional]
 
-[More Information Needed]
+- Faisal Tareque Shohan (faisaltareque@hotmail.com)
+- Mir Tafseer Nayeem (mnayeem@ualberta.ca)
+- Samsul Islam (samsulratul98@gmail.com)
+- Abu Ubaida Akash (abu.ubaida.akash@usherbrooke.ca)
+- Shafiq Joty (sjoty@salesforce.com)
 
 ## Model Card Contact
-
-[More Information Needed]
+[Faisal Tareque Shohan](mailto:faisaltareque@hotmail.com)