Create README.md

README.md

@@ -0,0 +1,27 @@
+---
+license: mit
+language:
+- en
+metrics:
+- f1
+- accuracy
+base_model:
+- google-t5/t5-base
+library_name: transformers
+---
+
+
+The official trained models for "Computational Analysis of Communicative Acts for Understanding Crisis News Comment Discourses". The model is based on T5-base, and we used the [Compacter](https://arxiv.org/abs/2106.04647) model and fine-tuned it on our crisis narratives dataset.  
+
+To use the model, you need the original code of our paper from the following link:  
+[Access the Code](https://github.com/Aalto-CRAI-CIS/Acts-in-crisis-narratives/tree/main/few_shot_learning/AdapterModel)
+
+Follow the guidelines, and in the execution script (`adapter.sh`), make the following changes to load this fine-tuned model:
+
+1. Add your test task method to `seq2seq/data/task.py`, similar to other task methods.
+
+2. Modify `adapter_inference.sh` with your test task information and run it.
+
+
+
+