Update README.md

README.md

@@ -9,11 +9,18 @@ metrics:
 model-index:
 - name: KoELECTRA-small-v3-modu-ner
   results: []
+language:
+- ko
+pipeline_tag: token-classification
+widget:
+- text: "서울역으로 안내해줘."
+  example_title: "Example 1"
+- text: "에어컨 온도 3도 올려줘."
+  example_title: "Example 2"
+- text: "아이유 노래 검색해줘."
+  example_title: "Example 3"
 ---
 
-<!-- This model card has been generated automatically according to the information the Trainer had access to. You
-should probably proofread and complete it, then remove this comment. -->
-
 # KoELECTRA-small-v3-modu-ner
 
 This model is a fine-tuned version of [monologg/koelectra-small-v3-discriminator](https://huggingface.co/monologg/koelectra-small-v3-discriminator) on an unknown dataset.
@@ -26,15 +33,53 @@ It achieves the following results on the evaluation set:
 
 ## Model description
 
-More information needed
+태깅 시스템 : BIO 시스템
+- B-(begin) : 개체명이 시작할 때
+- I-(inside) : 토큰이 개체명 중간에 있을 때
+- O(outside) : 토큰이 개체명이 아닐 경우
+
+한국정보통신기술협회(TTA) 대분류 기준을 따르는 15 가지의 태그셋
+
+| 분류          | 표기 | 정의        |
+|:------------:|:---:|:-----------|
+| ARTIFACTS    | AF  | 사람에 의해 창조된 인공물로 문화재, 건물, 악기, 도로, 무기, 운송수단, 작품명, 공산품명이 모두 이에 해당 |
+| ANIMAL       | AM  | 사람을 제외한 짐승 |
+| CIVILIZATION | CV  | 문명/문화 |
+| DATE         | DT  | 기간 및 계절, 시기/시대 |
+| EVENT        | EV  | 특정 사건/사고/행사 명칭 |
+| STUDY_FIELD  | FD  | 학문 분야, 학파 및 유파 |
+| LOCATION     | LC  | 지역/장소와 지형/지리 명칭 등을 모두 포함 |
+| MATERIAL     | MT  | 원소 및 금속, 암석/보석, 화학물질 |
+| ORGANIZATION | OG  | 기관 및 단체 명칭 |
+| PERSON       | PS  | 인명 및 인물의 별칭 (유사 인물 명칭 포함) |
+| PLANT        | PT  | 꽃/나무, 육지식물, 해초류, 버섯류, 이끼류 |
+| QUANTITY     | QT  | 수량/분량, 순서/순차, 수사로 이루어진 표현 |
+| TIME         | TI  | 시계상으로 나타나는 시/시각, 시간 범위 |
+| TERM         | TM  | 타 개체명에서 정의된 세부 개체명 이외의 개체명 |
+| THEORY       | TR  | 특정 이론, 법칙 원리 등 |
 
 ## Intended uses & limitations
 
-More information needed
+### How to use
+You can use this model with Transformers *pipeline* for NER.
+```python
+from transformers import AutoTokenizer, AutoModelForTokenClassification
+from transformers import pipeline
+
+tokenizer = AutoTokenizer.from_pretrained("Leo97/KoELECTRA-small-v3-modu-ner")
+model = AutoModelForTokenClassification.from_pretrained("Leo97/KoELECTRA-small-v3-modu-ner")
+ner = pipeline("ner", model=model, tokenizer=tokenizer)
+
+example = "서울역으로 안내해줘."
+ner_results = ner(example)
+print(ner_results)
+```
 
 ## Training and evaluation data
 
-More information needed
+개체명 인식(NER) 모델 학습 데이터 셋
+- 문화체육관광부 > 국립국어원 > 모두의 말뭉치 > 개체명 분석 말뭉치 2021
+- https://corpus.korean.go.kr/request/reausetMain.do
 
 ## Training procedure