Update README.md

README.md

@@ -1,3 +1,48 @@
 ---
 license: apache-2.0
+language:
+- en
+tags:
+  - conversation
+  - dialogue
+  - commonsense
 ---
+
+# Model Card for ConvoSenseGenerator
+
+ConvoSenseGenerator is a generative model that produces commonsense inferences for dialogue contexts, covering 10 common social commonsense types such as emotional reactions, motivations, causes, subsequent events, and more! It is trained on the large-scale dataset, ConvoSense, that is collected synthetically using ChatGPT3.5. ConvoSenseGenerator produces inferences that humans judge to achieve high reasonability, high rates of novel information for the corresponding dialogue contexts, and high degree of detail, outperforming models trained on previous datasets that are human-written.
+
+## Model Description
+- **Repository:** [Code](https://github.com/emorynlp/convosense)
+- **Paper:** [ConvoSense: Overcoming Monotonous Commonsense Inferences for Conversational AI](https://github.com/emorynlp/ConvoSense/blob/main/paper.pdf)
+- **Point of Contact:** [Sarah E. Finch](mailto:sfillwo@emory.edu)
+
+## Model Training
+
+ConvoSenseGenerator is trained on our recent dataset: 🥤[ConvoSense](https://huggingface.co/datasets/allenai/soda).
+The backbone model of ConvoSenseGenerator is [T5-3b](https://huggingface.co/t5-3b).
+
+### How to use
+
+Below is a simple code snippet to get ConvoSenseGenerator running :)
+
+```python
+import torch
+from transformers import AutoTokenizer, AutoModelForSeq2SeqLM
+device = torch.device("cuda" if torch.cuda.is_available() else "cpu")
+tokenizer = AutoTokenizer.from_pretrained("sefinch/ConvoSenseGenerator")
+model = AutoModelForSeq2SeqLM.from_pretrained("sefinch/ConvoSenseGenerator").to(device)
+...
+```
+
+### Citation
+
+Please cite our work if you find the resources in this repository useful:
+```
+@article{convosense_finch:24,
+    author = {Finch, Sarah E. and Choi, Jinho D.},
+    title = "{ConvoSense: Overcoming Monotonous Commonsense Inferences for Conversational AI}",
+    journal = {Transactions of the Association for Computational Linguistics},
+    year = {2024}
+}
+```