Update README.md

README.md

@@ -36,7 +36,7 @@ It achieves the following results on the evaluation set:
 
 아래 항목에 대한 개체명 인식을 제공합니다.
 
-- 사람이름 [PS]
+- 사람이름 [PS] - 낮은 인식률
 - 주소 (구 주소 및 도로명 주소) [AD]
 - 카드번호 [CN]
 - 계좌번호 [BN]
@@ -76,4 +76,29 @@ The following hyperparameters were used during training:
 - Transformers 4.40.2
 - Pytorch 2.3.0+cu118
 - Datasets 2.19.1
-- Tokenizers 0.19.1
+- Tokenizers 0.19.1
+
+### Use
+```python
+from transformers import AutoTokenizer, AutoModelForTokenClassification
+from transformers import pipeline
+
+tokenizer = AutoTokenizer.from_pretrained("vitus9988/klue_roberta_small_ner_identified")
+model = AutoModelForTokenClassification.from_pretrained("vitus9988/klue_roberta_small_ner_identified")
+
+nlp = pipeline("ner", model=model, tokenizer=tokenizer, aggregation_strategy="simple")
+example = """
+저는 서울특별시 강남대로 56길 100호에 삽니다. 전화번호는 010-1234-5678이고 주민등록번호는 123456-1234567입니다. 메일주소는 [email protected]입니다.
+"""
+
+ner_results = nlp(example)
+for i in ner_results:
+    print(i)
+
+#{'entity_group': 'AD', 'score': 0.79996574, 'word': '서울특별시 강남대로 56길 100호', 'start': 4, 'end': 23}
+#{'entity_group': 'PH', 'score': 0.948794, 'word': '010 - 1234 - 5678', 'start': 36, 'end': 49}
+#{'entity_group': 'RN', 'score': 0.90686846, 'word': '123456 - 1234567', 'start': 60, 'end': 74}
+#{'entity_group': 'EM', 'score': 0.935588, 'word': 'hugging @ face. com', 'start': 85, 'end': 101}
+
+```
+