-
Notifications
You must be signed in to change notification settings - Fork 1
/
token-classification.py
395 lines (352 loc) · 15.7 KB
/
token-classification.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
#!/usr/bin/env python3
# coding=utf-8
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""
Fine-tuning the library models for token classification.
"""
# You can also adapt this script on your own token classification task and datasets. Pointers for this are left as
# comments.
import os
from dataclasses import dataclass, field
from typing import Optional
import numpy as np
import evaluate
from transformers import (
AutoConfig,
AutoModelForTokenClassification,
AutoTokenizer,
DataCollatorForTokenClassification,
HfArgumentParser,
PreTrainedTokenizerFast,
Trainer,
TrainingArguments,
)
from utils import setup
@dataclass
class ModelArguments:
"""
Arguments pertaining to which model/config/tokenizer we are going to fine-tune from.
"""
model_id: str = field(
metadata={"help": "Path to pretrained model or model identifier from huggingface.co/models"})
config_name: Optional[str] = field(
default=None, metadata={"help": "Pretrained config name or path if not the same as model_name"})
tokenizer_name: Optional[str] = field(
default=None, metadata={"help": "Pretrained tokenizer name or path if not the same as model_name"})
cache_dir: Optional[str] = field(
default=None,
metadata={"help": "Where do you want to store the pretrained models downloaded from huggingface.co"},
)
model_revision: str = field(
default="main",
metadata={"help": "The specific model version to use (can be a branch name, tag name or commit id)."},
)
use_auth_token: bool = field(
default=False,
metadata={
"help": ("Will use the token generated when running `huggingface-cli login` (necessary to use this script "
"with private models).")
},
)
hidden_dropout_prob: float = field(
default=0.1,
metadata={
"help": "The dropout probability for all fully connected layers in the embeddings, encoder, and pooler."
})
save_model: bool = field(
default=False,
metadata={
"help": ("Whether to save the model after training.")
},
)
@dataclass
class DataTrainingArguments:
"""
Arguments pertaining to what data we are going to input our model for training and eval.
"""
task_name: str = field(metadata={"help": "The name of the task (ner, pos...)."})
dataset_name: str = field(metadata={"help": "The name of the dataset to use (via the datasets library)."})
dataset_config_name: Optional[str] = field(
default=None, metadata={"help": "The configuration name of the dataset to use (via the datasets library)."})
text_column_name: Optional[str] = field(
default=None, metadata={"help": "The column name of text to input in the file (a csv or JSON file)."})
label_column_name: Optional[str] = field(
default=None, metadata={"help": "The column name of label to input in the file (a csv or JSON file)."})
overwrite_cache: bool = field(default=False, metadata={"help": "Overwrite the cached training and evaluation sets"})
preprocessing_num_workers: Optional[int] = field(
default=None,
metadata={"help": "The number of processes to use for the preprocessing."},
)
max_seq_length: int = field(
default=512,
metadata={
"help": ("The maximum total input sequence length after tokenization. If set, sequences longer "
"than this will be truncated, sequences shorter will be padded.")
},
)
pad_to_max_length: bool = field(
default=False,
metadata={
"help":
("Whether to pad all samples to model maximum sentence length. "
"If False, will pad the samples dynamically when batching to the maximum length in the batch. More "
"efficient on GPU but very bad for TPU.")
},
)
max_train_samples: int = field(
default=0,
metadata={
"help": ("For debugging purposes or quicker training, truncate the number of training examples to this "
"value if set.")
},
)
label_all_tokens: bool = field(
default=False,
metadata={
"help": ("Whether to put the label for one word on all tokens of generated by that word or just on the "
"one (in which case the other tokens will have a padding index).")
},
)
return_entity_level_metrics: bool = field(
default=False,
metadata={"help": "Whether to return all the entity levels during evaluation or just the overall ones."},
)
add_tokens: Optional[str] = field(default=None, metadata={"help": "Add special tokens to the vocabulary."})
def parse_columns(data_args, raw_datasets):
column_names = raw_datasets["train"].column_names
if data_args.text_column_name is not None:
text_column_name = data_args.text_column_name
elif "tokens" in column_names:
text_column_name = "tokens"
else:
text_column_name = column_names[0]
if data_args.label_column_name is not None:
label_column_name = data_args.label_column_name
elif "tags" in column_names:
label_column_name = "tags"
elif f"{data_args.task_name}_tags" in column_names:
label_column_name = f"{data_args.task_name}_tags"
else:
label_column_name = column_names[1]
label_list = raw_datasets["train"].features[label_column_name].feature.names
label2id = {l: i for i, l in enumerate(label_list)}
id2label = {i: l for i, l in enumerate(label_list)}
return text_column_name, label_column_name, label2id, id2label
def main():
parser = HfArgumentParser((ModelArguments, DataTrainingArguments, TrainingArguments))
model_args, data_args, training_args = parser.parse_args_into_dataclasses()
logger, last_checkpoint, raw_datasets = setup(model_args, data_args, training_args)
text_column_name, label_column_name, label2id, id2label = parse_columns(data_args, raw_datasets)
config = AutoConfig.from_pretrained(
model_args.config_name if model_args.config_name else model_args.model_id,
id2label=id2label,
label2id=label2id,
finetuning_task=data_args.task_name,
cache_dir=model_args.cache_dir,
revision=model_args.model_revision,
hidden_dropout_prob=model_args.hidden_dropout_prob,
output_hidden_states=False,
use_auth_token=True if model_args.use_auth_token else None,
)
tokenizer = AutoTokenizer.from_pretrained(model_args.tokenizer_name if model_args.tokenizer_name else model_args.model_id,
cache_dir=model_args.cache_dir,
use_fast=True,
revision=model_args.model_revision,
use_auth_token=True if model_args.use_auth_token else None,
**({
"add_prefix_space": True
} if config.model_type in {"bloom", "gpt2", "roberta", "deberta"} else {}))
model = AutoModelForTokenClassification.from_pretrained(
model_args.model_id,
from_tf=bool(".ckpt" in model_args.model_id),
config=config,
cache_dir=model_args.cache_dir,
revision=model_args.model_revision,
use_auth_token=True if model_args.use_auth_token else None,
)
assert isinstance(tokenizer, PreTrainedTokenizerFast), "This model does not have a Fast Tokenizer"
if data_args.add_tokens:
logger.info(f"Old vocabulary size: {len(tokenizer)}")
n = tokenizer.add_tokens(data_args.add_tokens.split())
model.resize_token_embeddings(len(tokenizer))
logger.info(str(data_args.add_tokens))
logger.info(f"Added {n} tokens. New vocabulary size: {len(tokenizer)}")
# Map that sends B-Xxx label to its I-Xxx counterpart
is_bio = False
b_to_i_label = []
for idx, label in id2label.items():
if label.startswith("B-") and label.replace("B-", "I-") in label2id:
b_to_i_label.append(label2id[label.replace("B-", "I-")])
is_bio = True
else:
b_to_i_label.append(idx)
padding = "max_length" if data_args.pad_to_max_length else False
# Tokenize all texts and align the labels with them.
def tokenize_and_align_labels(examples):
tokenized_inputs = tokenizer(
examples[text_column_name],
padding=padding,
truncation=True,
max_length=data_args.max_seq_length,
is_split_into_words=True,
)
labels = []
for i, label in enumerate(examples[label_column_name]):
word_ids = tokenized_inputs.word_ids(batch_index=i)
previous_word_idx = None
label_ids = []
for word_idx in word_ids:
# Special token
if word_idx is None:
label_ids.append(-100)
# First token of word
elif word_idx != previous_word_idx:
label_ids.append(label[word_idx])
# Suffix tokens
elif data_args.label_all_tokens:
label_ids.append(b_to_i_label[label[word_idx]])
else:
label_ids.append(-100)
previous_word_idx = word_idx
labels.append(label_ids)
tokenized_inputs["labels"] = labels
return tokenized_inputs
def prepare_dataset(split):
if split not in raw_datasets:
raise ValueError(f"requires a {split} dataset")
split_dataset = raw_datasets[split]
if split == "train" and data_args.max_train_samples > 0:
max_train_samples = min(len(split_dataset), data_args.max_train_samples)
split_dataset = split_dataset.select(range(max_train_samples))
with training_args.main_process_first(desc=f"{split} dataset map pre-processing"):
split_dataset = split_dataset.map(
tokenize_and_align_labels,
batched=True,
num_proc=data_args.preprocessing_num_workers,
load_from_cache_file=not data_args.overwrite_cache,
desc=f"Running tokenizer on {split} dataset",
)
return split_dataset
train_dataset = prepare_dataset("train") if training_args.do_train else None
eval_dataset = prepare_dataset("validation") if training_args.do_eval else None
predict_dataset = prepare_dataset("test") if training_args.do_predict else None
# Data collator
data_collator = DataCollatorForTokenClassification(tokenizer, pad_to_multiple_of=8 if training_args.fp16 else None)
# Metrics
if is_bio:
metric = evaluate.load("seqeval")
else:
metric = evaluate.load("accuracy")
def compute_metrics(p):
predictions, labels = p
predictions = np.argmax(predictions, axis=2)
# Remove ignored index (special tokens)
if is_bio:
true_predictions = [[id2label[p] for p in pred[label != -100]]
for pred, label in zip(predictions, labels)]
true_labels = [[id2label[l] for l in label[label != -100]] for label in labels]
else:
true_predictions = predictions[labels != -100]
true_labels = labels[labels != -100]
results = metric.compute(predictions=true_predictions, references=true_labels)
if data_args.return_entity_level_metrics:
# Unpack nested dictionaries
final_results = {}
for key, value in results.items(): # type: ignore
if isinstance(value, dict):
for n, v in value.items():
final_results[f"{key}_{n}"] = v
else:
final_results[key] = value
return final_results
elif is_bio:
return {
"precision": results["overall_precision"], # type: ignore
"recall": results["overall_recall"], # type: ignore
"f1": results["overall_f1"], # type: ignore
"accuracy": results["overall_accuracy"], # type: ignore
}
else:
return results
# Initialize our Trainer
trainer = Trainer(
model=model,
args=training_args,
train_dataset=train_dataset, # type: ignore
eval_dataset=eval_dataset, # type: ignore
tokenizer=tokenizer,
data_collator=data_collator,
compute_metrics=compute_metrics, # type: ignore
)
# Training
if training_args.do_train:
assert train_dataset is not None
checkpoint = None
if training_args.resume_from_checkpoint is not None:
checkpoint = training_args.resume_from_checkpoint
elif last_checkpoint is not None:
checkpoint = last_checkpoint
train_result = trainer.train(resume_from_checkpoint=checkpoint)
metrics = train_result.metrics
if model_args.save_model:
trainer.save_model()
max_train_samples = (
data_args.max_train_samples
if data_args.max_train_samples > 0 else len(train_dataset)
)
metrics["train_samples"] = min(max_train_samples, len(train_dataset))
trainer.log_metrics("train", metrics)
trainer.save_metrics("train", metrics)
trainer.save_state()
# Evaluation
if training_args.do_eval:
logger.info("*** Evaluate ***")
metrics = trainer.evaluate()
trainer.log_metrics("eval", metrics)
trainer.save_metrics("eval", metrics)
# Predict
if training_args.do_predict:
logger.info("*** Predict ***")
predictions, labels, metrics = trainer.predict(predict_dataset, metric_key_prefix="predict") # type: ignore
predictions = np.argmax(predictions, axis=2)
trainer.log_metrics("predict", metrics)
trainer.save_metrics("predict", metrics)
# Remove ignored index (special tokens)
true_predictions = [
[id2label[p] for (p, l) in zip(prediction, label) if l != -100]
for prediction, label in zip(predictions, labels) # type: ignore
]
# Save predictions
output_predictions_file = os.path.join(training_args.output_dir, "predictions.txt")
if trainer.is_world_process_zero():
with open(output_predictions_file, "w") as writer:
for prediction in true_predictions:
writer.write(" ".join(prediction) + "\n")
kwargs = {"finetuned_from": model_args.model_id, "tasks": "token-classification"}
if data_args.dataset_name is not None:
kwargs["dataset_tags"] = data_args.dataset_name
if data_args.dataset_config_name is not None:
kwargs["dataset_args"] = data_args.dataset_config_name
kwargs["dataset"] = f"{data_args.dataset_name} {data_args.dataset_config_name}"
else:
kwargs["dataset"] = data_args.dataset_name
if training_args.push_to_hub:
trainer.push_to_hub(**kwargs)
else:
trainer.create_model_card(**kwargs)
def _mp_fn(index):
# For xla_spawn (TPUs)
main()
if __name__ == "__main__":
main()