Update README.md

README.md

@@ -17,24 +17,23 @@ should probably proofread and complete it, then remove this comment. -->
 
 # xlm-roberta-ner-ja
 
-This model is a fine-tuned version of [xlm-roberta-base](https://huggingface.co/xlm-roberta-base) on the None dataset.
-It achieves the following results on the evaluation set:
-- Loss: 0.0173
-- F1: 0.9864
+(Japanese caption : 日本語の固有表現抽出のモデル)
 
-## Model description
-
-More information needed
+This model is a fine-tuned NER (named entity recognition) token classification model of [xlm-roberta-base](https://huggingface.co/xlm-roberta-base) (pre-trained cross-lingual ```RobertaModel```) on Wikipedia Japanese NER dataset by Stockmark Inc.<br>
+See [here](https://github.com/stockmarkteam/ner-wikipedia-dataset) for the license of this dataset.
 
 ## Intended uses & limitations
 
-More information needed
-
-## Training and evaluation data
+```python
+from transformers import AutoModelForTokenClassification
+from transformers import pipeline
 
-More information needed
+model_name = "tsmatz/xlm-roberta-ner-ja"
+model = AutoModelForTokenClassification.from_pretrained(model_name)
 
-## Training procedure
+classifier = pipeline("token-classification", model=model_name)
+classifier("鈴木は4月の陽気の良い日に、鈴をつけて熊本県の阿蘇山に登った")
+```
 
 ### Training hyperparameters