Leo97 commited on
Commit
aad44c5
·
1 Parent(s): 13fbcf7

update model card README.md

Browse files
Files changed (1) hide show
  1. README.md +16 -71
README.md CHANGED
@@ -9,16 +9,6 @@ metrics:
9
  model-index:
10
  - name: KoELECTRA-small-v3-modu-ner
11
  results: []
12
- language:
13
- - ko
14
- pipeline_tag: token-classification
15
- widget:
16
- - text: "서울역으로 안내해줘."
17
- example_title: "Example 1"
18
- - text: "에어컨 온도 3도 올려줘."
19
- example_title: "Example 2"
20
- - text: "아이유 노래 검색해줘."
21
- example_title: "Example 3"
22
  ---
23
 
24
  <!-- This model card has been generated automatically according to the information the Trainer had access to. You
@@ -26,63 +16,25 @@ should probably proofread and complete it, then remove this comment. -->
26
 
27
  # KoELECTRA-small-v3-modu-ner
28
 
29
- 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.
30
  It achieves the following results on the evaluation set:
31
- - Loss: 0.1350
32
- - Precision: 0.8068
33
- - Recall: 0.8308
34
- - F1: 0.8186
35
- - Accuracy: 0.9598
36
 
37
  ## Model description
38
 
39
- 태깅 시스템 : BIO 시스템
40
- - B-(begin) : 개체명이 시작할 때
41
- - I-(inside) : 토큰이 개체명 중간에 있을 때
42
- - O(outside) : 토큰이 개체명이 아닐 경우
43
-
44
- 한국정보통신기술협회(TTA) 대분류 기준을 따르는 15 가지의 태그셋
45
-
46
- | 분류 | 표기 | 정의 |
47
- |:------------:|:---:|:-----------|
48
- | ARTIFACTS | AF | 사람에 의해 창조된 인공물로 문화재, 건물, 악기, 도로, 무기, 운송수단, 작품명, 공산품명이 모두 이에 해당 |
49
- | ANIMAL | AM | 사람을 제외한 짐승 |
50
- | CIVILIZATION | CV | 문명/문화 |
51
- | DATE | DT | 기간 및 계절, 시기/시대 |
52
- | EVENT | EV | 특정 사건/사고/행사 명칭 |
53
- | STUDY_FIELD | FD | 학문 분야, 학파 및 유파 |
54
- | LOCATION | LC | 지역/장소와 지형/지리 명칭 등을 모두 포함 |
55
- | MATERIAL | MT | 원소 및 금속, 암석/보석, 화학물질 |
56
- | ORGANIZATION | OG | 기관 및 단체 명칭 |
57
- | PERSON | PS | 인명 및 인물의 별칭 (유사 인물 명칭 포함) |
58
- | PLANT | PT | 꽃/나무, 육지식물, 해초류, 버섯류, 이끼류 |
59
- | QUANTITY | QT | 수량/분량, 순서/순차, 수사로 이루어진 표현 |
60
- | TIME | TI | 시계상으로 나타나는 시/시각, 시간 범위 |
61
- | TERM | TM | 타 개체명에서 정의된 세부 개체명 이외의 개체명 |
62
- | THEORY | TR | 특정 이론, 법칙 원리 등 |
63
 
64
  ## Intended uses & limitations
65
 
66
- ### How to use
67
- You can use this model with Transformers *pipeline* for NER.
68
- ```python
69
- from transformers import AutoTokenizer, AutoModelForTokenClassification
70
- from transformers import pipeline
71
-
72
- tokenizer = AutoTokenizer.from_pretrained("Leo97/KoELECTRA-small-v3-modu-ner")
73
- model = AutoModelForTokenClassification.from_pretrained("Leo97/KoELECTRA-small-v3-modu-ner")
74
- ner = pipeline("ner", model=model, tokenizer=tokenizer)
75
-
76
- example = "서울역으로 안내해줘."
77
- ner_results = ner(example)
78
- print(ner_results)
79
- ```
80
 
81
  ## Training and evaluation data
82
 
83
- 개체명 인식(NER) 모델 학습 데이터 셋
84
- - 문화체육관광부 > 국립국어원 > 모두의 말뭉치 > 개체명 분석 말뭉치 2021
85
- - https://corpus.korean.go.kr/request/reausetMain.do
86
 
87
  ## Training procedure
88
 
@@ -95,29 +47,22 @@ The following hyperparameters were used during training:
95
  - seed: 42
96
  - optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
97
  - lr_scheduler_type: linear
98
- - lr_scheduler_warmup_steps: 7575
99
- - num_epochs: 10
100
  - mixed_precision_training: Native AMP
101
 
102
  ### Training results
103
 
104
  | Training Loss | Epoch | Step | Validation Loss | Precision | Recall | F1 | Accuracy |
105
  |:-------------:|:-----:|:-----:|:---------------:|:---------:|:------:|:------:|:--------:|
106
- | No log | 1.0 | 3788 | 0.3021 | 0.6356 | 0.6380 | 0.6368 | 0.9223 |
107
- | No log | 2.0 | 7576 | 0.1905 | 0.7397 | 0.7441 | 0.7419 | 0.9431 |
108
- | No log | 3.0 | 11364 | 0.1612 | 0.7611 | 0.7897 | 0.7751 | 0.9505 |
109
- | No log | 4.0 | 15152 | 0.1494 | 0.7855 | 0.7998 | 0.7926 | 0.9544 |
110
- | No log | 5.0 | 18940 | 0.1427 | 0.7833 | 0.8194 | 0.8009 | 0.9559 |
111
- | No log | 6.0 | 22728 | 0.1398 | 0.7912 | 0.8223 | 0.8064 | 0.9572 |
112
- | No log | 7.0 | 26516 | 0.1361 | 0.8035 | 0.8240 | 0.8136 | 0.9587 |
113
- | No log | 8.0 | 30304 | 0.1360 | 0.8047 | 0.8280 | 0.8162 | 0.9592 |
114
- | No log | 9.0 | 34092 | 0.1346 | 0.8058 | 0.8299 | 0.8177 | 0.9596 |
115
- | 0.2256 | 10.0 | 37880 | 0.1350 | 0.8068 | 0.8308 | 0.8186 | 0.9598 |
116
 
117
 
118
  ### Framework versions
119
 
120
  - Transformers 4.27.4
121
- - Pytorch 1.13.1+cu116
122
  - Datasets 2.11.0
123
- - Tokenizers 0.13.2
 
9
  model-index:
10
  - name: KoELECTRA-small-v3-modu-ner
11
  results: []
 
 
 
 
 
 
 
 
 
 
12
  ---
13
 
14
  <!-- This model card has been generated automatically according to the information the Trainer had access to. You
 
16
 
17
  # KoELECTRA-small-v3-modu-ner
18
 
19
+ This model was trained from scratch on an unknown dataset.
20
  It achieves the following results on the evaluation set:
21
+ - Loss: 0.1370
22
+ - Precision: 0.8146
23
+ - Recall: 0.8349
24
+ - F1: 0.8246
25
+ - Accuracy: 0.9609
26
 
27
  ## Model description
28
 
29
+ More information needed
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
30
 
31
  ## Intended uses & limitations
32
 
33
+ More information needed
 
 
 
 
 
 
 
 
 
 
 
 
 
34
 
35
  ## Training and evaluation data
36
 
37
+ More information needed
 
 
38
 
39
  ## Training procedure
40
 
 
47
  - seed: 42
48
  - optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
49
  - lr_scheduler_type: linear
50
+ - lr_scheduler_warmup_steps: 2272
51
+ - num_epochs: 3
52
  - mixed_precision_training: Native AMP
53
 
54
  ### Training results
55
 
56
  | Training Loss | Epoch | Step | Validation Loss | Precision | Recall | F1 | Accuracy |
57
  |:-------------:|:-----:|:-----:|:---------------:|:---------:|:------:|:------:|:--------:|
58
+ | No log | 1.0 | 3788 | 0.1367 | 0.8089 | 0.8240 | 0.8164 | 0.9595 |
59
+ | No log | 2.0 | 7576 | 0.1345 | 0.8130 | 0.8331 | 0.8229 | 0.9604 |
60
+ | 0.0953 | 3.0 | 11364 | 0.1370 | 0.8146 | 0.8349 | 0.8246 | 0.9609 |
 
 
 
 
 
 
 
61
 
62
 
63
  ### Framework versions
64
 
65
  - Transformers 4.27.4
66
+ - Pytorch 2.0.0+cu118
67
  - Datasets 2.11.0
68
+ - Tokenizers 0.13.2