Update README.md

README.md

@@ -4,4 +4,37 @@ widget:
 - text: "次の出来事の後に起こりうることは何ですか: Xが食パンにジャムを塗る"
 ---
 
-# nlp-waseda/comet-t5-base-japanese
+# COMET-T5 ja
+
+Finetuned T5 on [ATOMIC ja](https://github.com/nlp-waseda/comet-atomic-ja) using a text-to-text language modeling objective.
+It was introduced in this paper.
+
+### How to use
+
+You can use this model directly with a pipeline for text2text generation.
+Since the generation relies on some randomness, we set a seed for reproducibility:
+
+```python
+>>> from transformers import pipeline, set_seed
+>>> generator = pipeline('text2text-generation', model='nlp-waseda/comet-t5-base-japanese')
+>>> set_seed(42)
+>>> generator("次の出来事の後に起こりうることは何ですか: Xが大学で勉強する", max_length=30, num_return_sequences=5, do_sample=True)
+
+[{'generated_text': 'Xが成績順で合格する'},
+ {'generated_text': 'Xが学位を取得する'},
+ {'generated_text': 'Xが勉強を始める'},
+ {'generated_text': 'Xが大学に合格する'},
+ {'generated_text': 'Xが試験官から褒められる'}]
+```
+
+### BibTeX entry and citation info
+
+```bibtex
+@InProceedings{ide_nlp2023_event,
+    author =    "井手竜也 and 村田栄樹 and 堀尾海斗 and 河原大輔 and 山崎天 and 李聖哲 and 新里顕大 and 佐藤敏紀",
+    title =     "人間と言語モデルに対するプロンプトを用いたゼロからのイベント常識知識グラフ構築",
+    booktitle = "言語処理学会第29回年次大会",
+    year =      "2023",
+    url =       ""
+}
+```