Update README.md

README.md

@@ -3,6 +3,10 @@ license: mit
 tags:
 - question-answering
 - generated_from_trainer
+- bert
+- jaquad
+language: 
+- ja
 inference:
   parameters:
     align_to_words: false
@@ -23,9 +27,30 @@ should probably proofread and complete it, then remove this comment. -->
 
 # roberta_qa_japanese
 
-This model is a fine-tuned version of [rinna/japanese-roberta-base](https://huggingface.co/rinna/japanese-roberta-base) on the None dataset.
-It achieves the following results on the evaluation set:
-- Loss: 0.0516
+(Japanese caption : 日本語の (抽出型) 質問応答のモデル)
+
+This model is a fine-tuned question-answering model of [rinna/japanese-roberta-base](https://huggingface.co/rinna/japanese-roberta-base) on [JaQuAD](https://huggingface.co/datasets/SkelterLabsInc/JaQuAD) dataset.
+
+## Intended uses
+
+When running with a dedicated pipeline :
+
+```python
+from transformers import AutoModelForTokenClassification
+from transformers import pipeline
+
+model_name = "tsmatz/roberta_qa_japanese"
+qa_pipeline = pipeline(
+    "question-answering",
+    model=model_name,
+    tokenizer=model_name)
+result = qa_pipeline(
+    question = "決勝トーナメントで日本に勝ったのはどこでしたか。",
+    context = "日本は予選リーグで強豪のドイツとスペインに勝って決勝トーナメントに進んだが、クロアチアと対戦して敗れた。",
+    align_to_words = False,
+)
+print(result)
+```
 
 ## Model description