Update README.md

README.md

@@ -1,3 +1,62 @@
----
-license: cc-by-sa-4.0
----
+---
+base_model: google/mt5-xxl
+license: apache-2.0
+language:
+- it
+---
+
+# modafact-ita
+
+`modafact-ita` is a sequence-to-sequence fine-tuned model for joint **event Factuality and Modality** detection in **Italian**.
+The model was fine-tuned on [ModaFact](https://huggingface.co/datasets/dhfbk/modafact-ita), a dataset manually annotated with Factuality and Modality values.
+
+
+## Model Details
+
+### Model Description
+
+- **Developed by:** DH Group @ FBK
+- **Model type:** Sequence-to-sequence
+- **Language(s) (NLP):** Italian
+- **License:** apache-2.0
+- **Finetuned from model:** [google/mt5-xxl](https://huggingface.co/google/mt5-xxl)
+
+### Model Sources
+
+<!-- Provide the basic links for the model. -->
+
+- **Paper:** TBP
+- **Inference script:** [https://github.com/dhfbk/ModaFact](https://github.com/dhfbk/ModaFact)
+
+## Uses
+
+The model can be used to detect event Factuality and Modality values.
+The model takes in input one sentence at a time, for example:
+
+```Per chiarire la questione la Santa Sede autorizzò il prelievo di campioni del legno che vennero datati attraverso l'utilizzo del metodo del carbonio-14.```
+
+and outputs a sequence of span=labels, in this format:
+
+```chiarire=POSSIBLE-POS-FUTURE-FINAL | autorizzò=CERTAIN-POS-PRESENT/PAST | prelievo=UNDERSPECIFIED-POS-FUTURE-CONCESSIVE | datati=CERTAIN-POS-PRESENT/PAST | utilizzo=CERTAIN-POS-PRESENT/PAST```
+
+
+## Training Details
+
+### Training Data
+
+[https://huggingface.co/datasets/dhfbk/modafact-ita](https://huggingface.co/datasets/dhfbk/modafact-ita)
+
+#### Training Hyperparameters
+
+- **Hyperparameters:** 
+
+
+## Evaluation
+
+
+## Citation
+
+
+**BibTeX:**
+
+TBP