mirror of
https://github.com/huggingface/transformers.git
synced 2025-07-31 02:02:21 +06:00
TF: purge TFTrainer (#28483)
This commit is contained in:
Joao Gante
GitHub
parent
afc45b13ca
commit
4fb3d3a0f6
@ -2049,7 +2049,6 @@ In this case you usually need to raise the value of `initial_scale_power`. Setti
|
||||
|
||||
### Notes
|
||||
|
||||
- DeepSpeed works with the PyTorch [`Trainer`] but not TF [`TFTrainer`].
|
||||
- While DeepSpeed has a pip installable PyPI package, it is highly recommended that it gets installed from [source](https://github.com/microsoft/deepspeed#installation) to best match your hardware and also if you need to enable
|
||||
certain features, like 1-bit Adam, which aren't available in the pypi distribution.
|
||||
- You don't have to use the [`Trainer`] to use DeepSpeed with 🤗 Transformers - you can use any model
|
||||
|
||||
@ -1,320 +1,313 @@
|
||||
<!---
|
||||
Copyright 2020 The HuggingFace Team. Tutti i diritti riservati.
|
||||
<!---
|
||||
Copyright 2020 The HuggingFace Team. Tutti i diritti riservati.
|
||||
|
||||
Concesso in licenza in base alla Licenza Apache, Versione 2.0 (la "Licenza");
|
||||
non è possibile utilizzare questo file se non in conformità con la Licenza.
|
||||
È possibile ottenere una copia della Licenza all'indirizzo
|
||||
Concesso in licenza in base alla Licenza Apache, Versione 2.0 (la "Licenza");
|
||||
non è possibile utilizzare questo file se non in conformità con la Licenza.
|
||||
È possibile ottenere una copia della Licenza all'indirizzo
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
A meno che non sia richiesto dalla legge applicabile o concordato per iscritto, il software
|
||||
distribuito con la Licenza è distribuito su BASE "COSÌ COM'È",
|
||||
SENZA GARANZIE O CONDIZIONI DI ALCUN TIPO, espresse o implicite.
|
||||
Per la lingua specifica vedi la Licenza che regola le autorizzazioni e
|
||||
le limitazioni ai sensi della STESSA.
|
||||
A meno che non sia richiesto dalla legge applicabile o concordato per iscritto, il software
|
||||
distribuito con la Licenza è distribuito su BASE "COSÌ COM'È",
|
||||
SENZA GARANZIE O CONDIZIONI DI ALCUN TIPO, espresse o implicite.
|
||||
Per la lingua specifica vedi la Licenza che regola le autorizzazioni e
|
||||
le limitazioni ai sensi della STESSA.
|
||||
|
||||
⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
|
||||
rendered properly in your Markdown viewer.
|
||||
|
||||
-->
|
||||
-->
|
||||
|
||||
# Migrazione da pacchetti precedenti
|
||||
# Migrazione da pacchetti precedenti
|
||||
|
||||
## Migrazione da transformers `v3.x` a `v4.x`
|
||||
## Migrazione da transformers `v3.x` a `v4.x`
|
||||
|
||||
Un paio di modifiche sono state introdotte nel passaggio dalla versione 3 alla versione 4. Di seguito è riportato un riepilogo delle
|
||||
modifiche previste:
|
||||
Un paio di modifiche sono state introdotte nel passaggio dalla versione 3 alla versione 4. Di seguito è riportato un riepilogo delle
|
||||
modifiche previste:
|
||||
|
||||
#### 1. AutoTokenizer e pipeline ora utilizzano tokenizer veloci (rust) per impostazione predefinita.
|
||||
#### 1. AutoTokenizer e pipeline ora utilizzano tokenizer veloci (rust) per impostazione predefinita.
|
||||
|
||||
I tokenizer python e rust hanno all'incirca le stesse API, ma i tokenizer rust hanno un set di funzionalità più completo.
|
||||
I tokenizer python e rust hanno all'incirca le stesse API, ma i tokenizer rust hanno un set di funzionalità più completo.
|
||||
|
||||
Ciò introduce due modifiche sostanziali:
|
||||
- La gestione dei token in overflow tra i tokenizer Python e Rust è diversa.
|
||||
- I tokenizers di rust non accettano numeri interi nei metodi di codifica.
|
||||
Ciò introduce due modifiche sostanziali:
|
||||
- La gestione dei token in overflow tra i tokenizer Python e Rust è diversa.
|
||||
- I tokenizers di rust non accettano numeri interi nei metodi di codifica.
|
||||
|
||||
##### Come ottenere lo stesso comportamento di v3.x in v4.x
|
||||
##### Come ottenere lo stesso comportamento di v3.x in v4.x
|
||||
|
||||
- Le pipeline ora contengono funzionalità aggiuntive pronte all'uso. Vedi la [pipeline di classificazione dei token con il flag `grouped_entities`](main_classes/pipelines#transformers.TokenClassificationPipeline).
|
||||
- Gli auto-tokenizer ora restituiscono tokenizer rust. Per ottenere invece i tokenizer python, l'utente deve usare il flag `use_fast` impostandolo `False`:
|
||||
- Le pipeline ora contengono funzionalità aggiuntive pronte all'uso. Vedi la [pipeline di classificazione dei token con il flag `grouped_entities`](main_classes/pipelines#transformers.TokenClassificationPipeline).
|
||||
- Gli auto-tokenizer ora restituiscono tokenizer rust. Per ottenere invece i tokenizer python, l'utente deve usare il flag `use_fast` impostandolo `False`:
|
||||
|
||||
Nella versione `v3.x`:
|
||||
```py
|
||||
from transformers import AutoTokenizer
|
||||
Nella versione `v3.x`:
|
||||
```py
|
||||
from transformers import AutoTokenizer
|
||||
|
||||
tokenizer = AutoTokenizer.from_pretrained("bert-base-cased")
|
||||
```
|
||||
per ottenere lo stesso nella versione `v4.x`:
|
||||
```py
|
||||
from transformers import AutoTokenizer
|
||||
tokenizer = AutoTokenizer.from_pretrained("bert-base-cased")
|
||||
```
|
||||
per ottenere lo stesso nella versione `v4.x`:
|
||||
```py
|
||||
from transformers import AutoTokenizer
|
||||
|
||||
tokenizer = AutoTokenizer.from_pretrained("bert-base-cased", use_fast=False)
|
||||
```
|
||||
tokenizer = AutoTokenizer.from_pretrained("bert-base-cased", use_fast=False)
|
||||
```
|
||||
|
||||
#### 2. SentencePiece è stato rimosso dalle dipendenze richieste
|
||||
#### 2. SentencePiece è stato rimosso dalle dipendenze richieste
|
||||
|
||||
Il requisito sulla dipendenza SentencePiece è stato rimosso da `setup.py`. È stato fatto per avere un canale su anaconda cloud senza basarsi su `conda-forge`. Ciò significa che i tokenizer che dipendono dalla libreria SentencePiece non saranno disponibili con un'installazione standard di `transformers`.
|
||||
Il requisito sulla dipendenza SentencePiece è stato rimosso da `setup.py`. È stato fatto per avere un canale su anaconda cloud senza basarsi su `conda-forge`. Ciò significa che i tokenizer che dipendono dalla libreria SentencePiece non saranno disponibili con un'installazione standard di `transformers`.
|
||||
|
||||
Ciò include le versioni **lente** di:
|
||||
- `XLNetTokenizer`
|
||||
- `AlbertTokenizer`
|
||||
- `CamembertTokenizer`
|
||||
- `MBartTokenizer`
|
||||
- `PegasusTokenizer`
|
||||
- `T5Tokenizer`
|
||||
- `ReformerTokenizer`
|
||||
- `XLMRobertaTokenizer`
|
||||
Ciò include le versioni **lente** di:
|
||||
- `XLNetTokenizer`
|
||||
- `AlbertTokenizer`
|
||||
- `CamembertTokenizer`
|
||||
- `MBartTokenizer`
|
||||
- `PegasusTokenizer`
|
||||
- `T5Tokenizer`
|
||||
- `ReformerTokenizer`
|
||||
- `XLMRobertaTokenizer`
|
||||
|
||||
##### Come ottenere lo stesso comportamento della v3.x nella v4.x
|
||||
##### Come ottenere lo stesso comportamento della v3.x nella v4.x
|
||||
|
||||
Per ottenere lo stesso comportamento della versione `v3.x`, devi installare anche `sentencepiece`:
|
||||
Per ottenere lo stesso comportamento della versione `v3.x`, devi installare anche `sentencepiece`:
|
||||
|
||||
Nella versione `v3.x`:
|
||||
```bash
|
||||
pip install transformers
|
||||
```
|
||||
per ottenere lo stesso nella versione `v4.x`:
|
||||
```bash
|
||||
pip install transformers[sentencepiece]
|
||||
```
|
||||
o
|
||||
```bash
|
||||
pip install transformers stentencepiece
|
||||
```
|
||||
#### 3. L'architettura delle repo è stato aggiornata in modo che ogni modello abbia la propria cartella
|
||||
Nella versione `v3.x`:
|
||||
```bash
|
||||
pip install transformers
|
||||
```
|
||||
per ottenere lo stesso nella versione `v4.x`:
|
||||
```bash
|
||||
pip install transformers[sentencepiece]
|
||||
```
|
||||
o
|
||||
```bash
|
||||
pip install transformers stentencepiece
|
||||
```
|
||||
#### 3. L'architettura delle repo è stato aggiornata in modo che ogni modello abbia la propria cartella
|
||||
|
||||
Con l’aggiunta di nuovi modelli, il numero di file nella cartella `src/transformers` continua a crescere e diventa più difficile navigare e capire. Abbiamo fatto la scelta di inserire ogni modello e i file che lo accompagnano nelle proprie sottocartelle.
|
||||
Con l’aggiunta di nuovi modelli, il numero di file nella cartella `src/transformers` continua a crescere e diventa più difficile navigare e capire. Abbiamo fatto la scelta di inserire ogni modello e i file che lo accompagnano nelle proprie sottocartelle.
|
||||
|
||||
Si tratta di una modifica sostanziale in quanto l'importazione di layer intermedi utilizzando direttamente il modulo di un modello deve essere eseguita tramite un percorso diverso.
|
||||
Si tratta di una modifica sostanziale in quanto l'importazione di layer intermedi utilizzando direttamente il modulo di un modello deve essere eseguita tramite un percorso diverso.
|
||||
|
||||
##### Come ottenere lo stesso comportamento della v3.x nella v4.x
|
||||
##### Come ottenere lo stesso comportamento della v3.x nella v4.x
|
||||
|
||||
Per ottenere lo stesso comportamento della versione `v3.x`, devi aggiornare il percorso utilizzato per accedere ai layer.
|
||||
Per ottenere lo stesso comportamento della versione `v3.x`, devi aggiornare il percorso utilizzato per accedere ai layer.
|
||||
|
||||
Nella versione `v3.x`:
|
||||
```bash
|
||||
from transformers.modeling_bert import BertLayer
|
||||
```
|
||||
per ottenere lo stesso nella versione `v4.x`:
|
||||
```bash
|
||||
from transformers.models.bert.modeling_bert import BertLayer
|
||||
```
|
||||
Nella versione `v3.x`:
|
||||
```bash
|
||||
from transformers.modeling_bert import BertLayer
|
||||
```
|
||||
per ottenere lo stesso nella versione `v4.x`:
|
||||
```bash
|
||||
from transformers.models.bert.modeling_bert import BertLayer
|
||||
```
|
||||
|
||||
#### 4. Impostare l'argomento `return_dict` su `True` per impostazione predefinita
|
||||
#### 4. Impostare l'argomento `return_dict` su `True` per impostazione predefinita
|
||||
|
||||
L'[argomento `return_dict`](main_classes/output) abilita la restituzione di oggetti python dict-like contenenti gli output del modello, invece delle tuple standard. Questo oggetto è self-documented poiché le chiavi possono essere utilizzate per recuperare valori, comportandosi anche come una tupla e gli utenti possono recuperare oggetti per indexing o slicing.
|
||||
L'[argomento `return_dict`](main_classes/output) abilita la restituzione di oggetti python dict-like contenenti gli output del modello, invece delle tuple standard. Questo oggetto è self-documented poiché le chiavi possono essere utilizzate per recuperare valori, comportandosi anche come una tupla e gli utenti possono recuperare oggetti per indexing o slicing.
|
||||
|
||||
Questa è una modifica sostanziale poiché la tupla non può essere decompressa: `value0, value1 = outputs` non funzionerà.
|
||||
Questa è una modifica sostanziale poiché la tupla non può essere decompressa: `value0, value1 = outputs` non funzionerà.
|
||||
|
||||
##### Come ottenere lo stesso comportamento della v3.x nella v4.x
|
||||
##### Come ottenere lo stesso comportamento della v3.x nella v4.x
|
||||
|
||||
Per ottenere lo stesso comportamento della versione `v3.x`, specifica l'argomento `return_dict` come `False`, sia nella configurazione del modello che nel passaggio successivo.
|
||||
Per ottenere lo stesso comportamento della versione `v3.x`, specifica l'argomento `return_dict` come `False`, sia nella configurazione del modello che nel passaggio successivo.
|
||||
|
||||
Nella versione `v3.x`:
|
||||
```bash
|
||||
model = BertModel.from_pretrained("bert-base-cased")
|
||||
outputs = model(**inputs)
|
||||
```
|
||||
per ottenere lo stesso nella versione `v4.x`:
|
||||
```bash
|
||||
model = BertModel.from_pretrained("bert-base-cased")
|
||||
outputs = model(**inputs, return_dict=False)
|
||||
```
|
||||
o
|
||||
```bash
|
||||
model = BertModel.from_pretrained("bert-base-cased", return_dict=False)
|
||||
outputs = model(**inputs)
|
||||
```
|
||||
Nella versione `v3.x`:
|
||||
```bash
|
||||
model = BertModel.from_pretrained("bert-base-cased")
|
||||
outputs = model(**inputs)
|
||||
```
|
||||
per ottenere lo stesso nella versione `v4.x`:
|
||||
```bash
|
||||
model = BertModel.from_pretrained("bert-base-cased")
|
||||
outputs = model(**inputs, return_dict=False)
|
||||
```
|
||||
o
|
||||
```bash
|
||||
model = BertModel.from_pretrained("bert-base-cased", return_dict=False)
|
||||
outputs = model(**inputs)
|
||||
```
|
||||
|
||||
#### 5. Rimozione di alcuni attributi deprecati
|
||||
#### 5. Rimozione di alcuni attributi deprecati
|
||||
|
||||
Gli attributi sono stati rimossi se deprecati da almeno un mese. L'elenco completo degli attributi obsoleti è disponibile in [#8604](https://github.com/huggingface/transformers/pull/8604).
|
||||
Gli attributi sono stati rimossi se deprecati da almeno un mese. L'elenco completo degli attributi obsoleti è disponibile in [#8604](https://github.com/huggingface/transformers/pull/8604).
|
||||
|
||||
Ecco un elenco di questi attributi/metodi/argomenti e quali dovrebbero essere le loro sostituzioni:
|
||||
Ecco un elenco di questi attributi/metodi/argomenti e quali dovrebbero essere le loro sostituzioni:
|
||||
|
||||
In diversi modelli, le etichette diventano coerenti con gli altri modelli:
|
||||
- `masked_lm_labels` diventa `labels` in `AlbertForMaskedLM` e `AlbertForPreTraining`.
|
||||
- `masked_lm_labels` diventa `labels` in `BertForMaskedLM` e `BertForPreTraining`.
|
||||
- `masked_lm_labels` diventa `labels` in `DistilBertForMaskedLM`.
|
||||
- `masked_lm_labels` diventa `labels` in `ElectraForMaskedLM`.
|
||||
- `masked_lm_labels` diventa `labels` in `LongformerForMaskedLM`.
|
||||
- `masked_lm_labels` diventa `labels` in `MobileBertForMaskedLM`.
|
||||
- `masked_lm_labels` diventa `labels` in `RobertaForMaskedLM`.
|
||||
- `lm_labels` diventa `labels` in `BartForConditionalGeneration`.
|
||||
- `lm_labels` diventa `labels` in `GPT2DoubleHeadsModel`.
|
||||
- `lm_labels` diventa `labels` in `OpenAIGPTDoubleHeadsModel`.
|
||||
- `lm_labels` diventa `labels` in `T5ForConditionalGeneration`.
|
||||
In diversi modelli, le etichette diventano coerenti con gli altri modelli:
|
||||
- `masked_lm_labels` diventa `labels` in `AlbertForMaskedLM` e `AlbertForPreTraining`.
|
||||
- `masked_lm_labels` diventa `labels` in `BertForMaskedLM` e `BertForPreTraining`.
|
||||
- `masked_lm_labels` diventa `labels` in `DistilBertForMaskedLM`.
|
||||
- `masked_lm_labels` diventa `labels` in `ElectraForMaskedLM`.
|
||||
- `masked_lm_labels` diventa `labels` in `LongformerForMaskedLM`.
|
||||
- `masked_lm_labels` diventa `labels` in `MobileBertForMaskedLM`.
|
||||
- `masked_lm_labels` diventa `labels` in `RobertaForMaskedLM`.
|
||||
- `lm_labels` diventa `labels` in `BartForConditionalGeneration`.
|
||||
- `lm_labels` diventa `labels` in `GPT2DoubleHeadsModel`.
|
||||
- `lm_labels` diventa `labels` in `OpenAIGPTDoubleHeadsModel`.
|
||||
- `lm_labels` diventa `labels` in `T5ForConditionalGeneration`.
|
||||
|
||||
In diversi modelli, il meccanismo di memorizzazione nella cache diventa coerente con gli altri:
|
||||
- `decoder_cached_states` diventa `past_key_values` in tutti i modelli BART-like, FSMT e T5.
|
||||
- `decoder_past_key_values` diventa `past_key_values` in tutti i modelli BART-like, FSMT e T5.
|
||||
- `past` diventa `past_key_values` in tutti i modelli CTRL.
|
||||
- `past` diventa `past_key_values` in tutti i modelli GPT-2.
|
||||
In diversi modelli, il meccanismo di memorizzazione nella cache diventa coerente con gli altri:
|
||||
- `decoder_cached_states` diventa `past_key_values` in tutti i modelli BART-like, FSMT e T5.
|
||||
- `decoder_past_key_values` diventa `past_key_values` in tutti i modelli BART-like, FSMT e T5.
|
||||
- `past` diventa `past_key_values` in tutti i modelli CTRL.
|
||||
- `past` diventa `past_key_values` in tutti i modelli GPT-2.
|
||||
|
||||
Per quanto riguarda le classi tokenizer:
|
||||
- L'attributo tokenizer `max_len` diventa `model_max_length`.
|
||||
- L'attributo tokenizer `return_lengths` diventa `return_length`.
|
||||
- L'argomento di codifica del tokenizer `is_pretokenized` diventa `is_split_into_words`.
|
||||
Per quanto riguarda le classi tokenizer:
|
||||
- L'attributo tokenizer `max_len` diventa `model_max_length`.
|
||||
- L'attributo tokenizer `return_lengths` diventa `return_length`.
|
||||
- L'argomento di codifica del tokenizer `is_pretokenized` diventa `is_split_into_words`.
|
||||
|
||||
Per quanto riguarda la classe `Trainer`:
|
||||
- L'argomento `tb_writer` di `Trainer` è stato rimosso in favore della funzione richiamabile `TensorBoardCallback(tb_writer=...)`.
|
||||
- L'argomento `prediction_loss_only` di `Trainer` è stato rimosso in favore dell'argomento di classe `args.prediction_loss_only`.
|
||||
- L'attributo `data_collator` di `Trainer` sarà richiamabile.
|
||||
- Il metodo `_log` di `Trainer` è deprecato a favore di `log`.
|
||||
- Il metodo `_training_step` di `Trainer` è deprecato a favore di `training_step`.
|
||||
- Il metodo `_prediction_loop` di `Trainer` è deprecato a favore di `prediction_loop`.
|
||||
- Il metodo `is_local_master` di `Trainer` è deprecato a favore di `is_local_process_zero`.
|
||||
- Il metodo `is_world_master` di `Trainer` è deprecato a favore di `is_world_process_zero`.
|
||||
Per quanto riguarda la classe `Trainer`:
|
||||
- L'argomento `tb_writer` di `Trainer` è stato rimosso in favore della funzione richiamabile `TensorBoardCallback(tb_writer=...)`.
|
||||
- L'argomento `prediction_loss_only` di `Trainer` è stato rimosso in favore dell'argomento di classe `args.prediction_loss_only`.
|
||||
- L'attributo `data_collator` di `Trainer` sarà richiamabile.
|
||||
- Il metodo `_log` di `Trainer` è deprecato a favore di `log`.
|
||||
- Il metodo `_training_step` di `Trainer` è deprecato a favore di `training_step`.
|
||||
- Il metodo `_prediction_loop` di `Trainer` è deprecato a favore di `prediction_loop`.
|
||||
- Il metodo `is_local_master` di `Trainer` è deprecato a favore di `is_local_process_zero`.
|
||||
- Il metodo `is_world_master` di `Trainer` è deprecato a favore di `is_world_process_zero`.
|
||||
|
||||
Per quanto riguarda la classe `TFTrainer`:
|
||||
- L'argomento `prediction_loss_only` di `TFTrainer` è stato rimosso a favore dell'argomento di classe `args.prediction_loss_only`.
|
||||
- Il metodo `_log` di `Trainer` è deprecato a favore di `log`.
|
||||
- Il metodo `_prediction_loop` di `TFTrainer` è deprecato a favore di `prediction_loop`.
|
||||
- Il metodo `_setup_wandb` di `TFTrainer` è deprecato a favore di `setup_wandb`.
|
||||
- Il metodo `_run_model` di `TFTrainer` è deprecato a favore di `run_model`.
|
||||
Per quanto riguarda la classe `TrainingArguments`:
|
||||
- L'argomento `evaluate_during_training` di `TrainingArguments` è deprecato a favore di `evaluation_strategy`.
|
||||
|
||||
Per quanto riguarda la classe `TrainingArguments`:
|
||||
- L'argomento `evaluate_during_training` di `TrainingArguments` è deprecato a favore di `evaluation_strategy`.
|
||||
Per quanto riguarda il modello Transfo-XL:
|
||||
- L'attributo di configurazione `tie_weight` di Transfo-XL diventa `tie_words_embeddings`.
|
||||
- Il metodo di modellazione `reset_length` di Transfo-XL diventa `reset_memory_length`.
|
||||
|
||||
Per quanto riguarda il modello Transfo-XL:
|
||||
- L'attributo di configurazione `tie_weight` di Transfo-XL diventa `tie_words_embeddings`.
|
||||
- Il metodo di modellazione `reset_length` di Transfo-XL diventa `reset_memory_length`.
|
||||
|
||||
Per quanto riguarda le pipeline:
|
||||
- L'argomento `topk` di `FillMaskPipeline` diventa `top_k`.
|
||||
Per quanto riguarda le pipeline:
|
||||
- L'argomento `topk` di `FillMaskPipeline` diventa `top_k`.
|
||||
|
||||
|
||||
|
||||
## Passaggio da pytorch-transformers a 🤗 Transformers
|
||||
## Passaggio da pytorch-transformers a 🤗 Transformers
|
||||
|
||||
Ecco un breve riepilogo di ciò a cui prestare attenzione durante il passaggio da `pytorch-transformers` a 🤗 Transformers.
|
||||
Ecco un breve riepilogo di ciò a cui prestare attenzione durante il passaggio da `pytorch-transformers` a 🤗 Transformers.
|
||||
|
||||
### L’ordine posizionale di alcune parole chiave di input dei modelli (`attention_mask`, `token_type_ids`...) è cambiato
|
||||
### L’ordine posizionale di alcune parole chiave di input dei modelli (`attention_mask`, `token_type_ids`...) è cambiato
|
||||
|
||||
Per usare Torchscript (vedi #1010, #1204 e #1195) l'ordine specifico delle **parole chiave di input** di alcuni modelli (`attention_mask`, `token_type_ids`...) è stato modificato.
|
||||
Per usare Torchscript (vedi #1010, #1204 e #1195) l'ordine specifico delle **parole chiave di input** di alcuni modelli (`attention_mask`, `token_type_ids`...) è stato modificato.
|
||||
|
||||
Se inizializzavi i modelli usando parole chiave per gli argomenti, ad esempio `model(inputs_ids, attention_mask=attention_mask, token_type_ids=token_type_ids)`, questo non dovrebbe causare alcun cambiamento.
|
||||
Se inizializzavi i modelli usando parole chiave per gli argomenti, ad esempio `model(inputs_ids, attention_mask=attention_mask, token_type_ids=token_type_ids)`, questo non dovrebbe causare alcun cambiamento.
|
||||
|
||||
Se inizializzavi i modelli con input posizionali per gli argomenti, ad esempio `model(inputs_ids, attention_mask, token_type_ids)`, potrebbe essere necessario ricontrollare l'ordine esatto degli argomenti di input.
|
||||
Se inizializzavi i modelli con input posizionali per gli argomenti, ad esempio `model(inputs_ids, attention_mask, token_type_ids)`, potrebbe essere necessario ricontrollare l'ordine esatto degli argomenti di input.
|
||||
|
||||
## Migrazione da pytorch-pretrained-bert
|
||||
## Migrazione da pytorch-pretrained-bert
|
||||
|
||||
Ecco un breve riepilogo di ciò a cui prestare attenzione durante la migrazione da `pytorch-pretrained-bert` a 🤗 Transformers
|
||||
Ecco un breve riepilogo di ciò a cui prestare attenzione durante la migrazione da `pytorch-pretrained-bert` a 🤗 Transformers
|
||||
|
||||
### I modelli restituiscono sempre `tuple`
|
||||
### I modelli restituiscono sempre `tuple`
|
||||
|
||||
La principale modifica di rilievo durante la migrazione da `pytorch-pretrained-bert` a 🤗 Transformers è che il metodo dei modelli di previsione dà sempre una `tupla` con vari elementi a seconda del modello e dei parametri di configurazione.
|
||||
La principale modifica di rilievo durante la migrazione da `pytorch-pretrained-bert` a 🤗 Transformers è che il metodo dei modelli di previsione dà sempre una `tupla` con vari elementi a seconda del modello e dei parametri di configurazione.
|
||||
|
||||
Il contenuto esatto delle tuple per ciascun modello è mostrato in dettaglio nelle docstring dei modelli e nella [documentazione](https://huggingface.co/transformers/).
|
||||
Il contenuto esatto delle tuple per ciascun modello è mostrato in dettaglio nelle docstring dei modelli e nella [documentazione](https://huggingface.co/transformers/).
|
||||
|
||||
In quasi tutti i casi, andrà bene prendendo il primo elemento dell'output come quello che avresti precedentemente utilizzato in `pytorch-pretrained-bert`.
|
||||
In quasi tutti i casi, andrà bene prendendo il primo elemento dell'output come quello che avresti precedentemente utilizzato in `pytorch-pretrained-bert`.
|
||||
|
||||
Ecco un esempio di conversione da `pytorch-pretrained-bert`
|
||||
a 🤗 Transformers per un modello di classificazione `BertForSequenceClassification`:
|
||||
a 🤗 Transformers per un modello di classificazione `BertForSequenceClassification`:
|
||||
|
||||
```python
|
||||
# Carichiamo il nostro modello
|
||||
model = BertForSequenceClassification.from_pretrained("bert-base-uncased")
|
||||
```python
|
||||
# Carichiamo il nostro modello
|
||||
model = BertForSequenceClassification.from_pretrained("bert-base-uncased")
|
||||
|
||||
# Se usavi questa riga in pytorch-pretrained-bert :
|
||||
loss = model(input_ids, labels=labels)
|
||||
# Se usavi questa riga in pytorch-pretrained-bert :
|
||||
loss = model(input_ids, labels=labels)
|
||||
|
||||
# Ora usa questa riga in 🤗 Transformers per estrarre la perdita dalla tupla di output:
|
||||
outputs = model(input_ids, labels=labels)
|
||||
loss = outputs[0]
|
||||
# Ora usa questa riga in 🤗 Transformers per estrarre la perdita dalla tupla di output:
|
||||
outputs = model(input_ids, labels=labels)
|
||||
loss = outputs[0]
|
||||
|
||||
# In 🤗 Transformers puoi anche avere accesso ai logit:
|
||||
loss, logits = outputs[:2]
|
||||
# In 🤗 Transformers puoi anche avere accesso ai logit:
|
||||
loss, logits = outputs[:2]
|
||||
|
||||
# Ed anche agli attention weight se configuri il modello per restituirli (e anche altri output, vedi le docstring e la documentazione)
|
||||
model = BertForSequenceClassification.from_pretrained(" bert-base-uncased", output_attentions=True)
|
||||
outputs = model(input_ids, labels=labels)
|
||||
loss, logits, attentions = outputs
|
||||
```
|
||||
# Ed anche agli attention weight se configuri il modello per restituirli (e anche altri output, vedi le docstring e la documentazione)
|
||||
model = BertForSequenceClassification.from_pretrained(" bert-base-uncased", output_attentions=True)
|
||||
outputs = model(input_ids, labels=labels)
|
||||
loss, logits, attentions = outputs
|
||||
```
|
||||
|
||||
### Serializzazione
|
||||
### Serializzazione
|
||||
|
||||
Modifica sostanziale nel metodo `from_pretrained()`:
|
||||
Modifica sostanziale nel metodo `from_pretrained()`:
|
||||
|
||||
1. I modelli sono ora impostati in modalità di valutazione in maniera predefinita quando usi il metodo `from_pretrained()`. Per addestrarli non dimenticare di riportarli in modalità di addestramento (`model.train()`) per attivare i moduli di dropout.
|
||||
1. I modelli sono ora impostati in modalità di valutazione in maniera predefinita quando usi il metodo `from_pretrained()`. Per addestrarli non dimenticare di riportarli in modalità di addestramento (`model.train()`) per attivare i moduli di dropout.
|
||||
|
||||
2. Gli argomenti aggiuntivi `*inputs` e `**kwargs` forniti al metodo `from_pretrained()` venivano passati direttamente al metodo `__init__()` della classe sottostante del modello. Ora sono usati per aggiornare prima l'attributo di configurazione del modello, che può non funzionare con le classi del modello derivate costruite basandosi sui precedenti esempi di `BertForSequenceClassification`. Più precisamente, gli argomenti posizionali `*inputs` forniti a `from_pretrained()` vengono inoltrati direttamente al metodo `__init__()` del modello mentre gli argomenti keyword `**kwargs` (i) che corrispondono agli attributi della classe di configurazione, vengono utilizzati per aggiornare tali attributi (ii) che non corrispondono ad alcun attributo della classe di configurazione, vengono inoltrati al metodo `__init__()`.
|
||||
2. Gli argomenti aggiuntivi `*inputs` e `**kwargs` forniti al metodo `from_pretrained()` venivano passati direttamente al metodo `__init__()` della classe sottostante del modello. Ora sono usati per aggiornare prima l'attributo di configurazione del modello, che può non funzionare con le classi del modello derivate costruite basandosi sui precedenti esempi di `BertForSequenceClassification`. Più precisamente, gli argomenti posizionali `*inputs` forniti a `from_pretrained()` vengono inoltrati direttamente al metodo `__init__()` del modello mentre gli argomenti keyword `**kwargs` (i) che corrispondono agli attributi della classe di configurazione, vengono utilizzati per aggiornare tali attributi (ii) che non corrispondono ad alcun attributo della classe di configurazione, vengono inoltrati al metodo `__init__()`.
|
||||
|
||||
Inoltre, sebbene non si tratti di una modifica sostanziale, i metodi di serializzazione sono stati standardizzati e probabilmente dovresti passare al nuovo metodo `save_pretrained(save_directory)` se prima usavi qualsiasi altro metodo di serializzazione.
|
||||
Inoltre, sebbene non si tratti di una modifica sostanziale, i metodi di serializzazione sono stati standardizzati e probabilmente dovresti passare al nuovo metodo `save_pretrained(save_directory)` se prima usavi qualsiasi altro metodo di serializzazione.
|
||||
|
||||
Ecco un esempio:
|
||||
Ecco un esempio:
|
||||
|
||||
```python
|
||||
### Carichiamo un modello e un tokenizer
|
||||
model = BertForSequenceClassification.from_pretrained("bert-base-uncased")
|
||||
tokenizer = BertTokenizer.from_pretrained("bert-base-uncased")
|
||||
```python
|
||||
### Carichiamo un modello e un tokenizer
|
||||
model = BertForSequenceClassification.from_pretrained("bert-base-uncased")
|
||||
tokenizer = BertTokenizer.from_pretrained("bert-base-uncased")
|
||||
|
||||
### Facciamo fare alcune cose al nostro modello e tokenizer
|
||||
# Es: aggiungiamo nuovi token al vocabolario e agli embending del nostro modello
|
||||
tokenizer.add_tokens(["[SPECIAL_TOKEN_1]", "[SPECIAL_TOKEN_2]"])
|
||||
model.resize_token_embeddings(len(tokenizer))
|
||||
### Facciamo fare alcune cose al nostro modello e tokenizer
|
||||
# Es: aggiungiamo nuovi token al vocabolario e agli embending del nostro modello
|
||||
tokenizer.add_tokens(["[SPECIAL_TOKEN_1]", "[SPECIAL_TOKEN_2]"])
|
||||
model.resize_token_embeddings(len(tokenizer))
|
||||
# Alleniamo il nostro modello
|
||||
train(model)
|
||||
train(model)
|
||||
|
||||
### Ora salviamo il nostro modello e il tokenizer in una cartella
|
||||
model.save_pretrained("./my_saved_model_directory/")
|
||||
tokenizer.save_pretrained("./my_saved_model_directory/")
|
||||
### Ora salviamo il nostro modello e il tokenizer in una cartella
|
||||
model.save_pretrained("./my_saved_model_directory/")
|
||||
tokenizer.save_pretrained("./my_saved_model_directory/")
|
||||
|
||||
### Ricarichiamo il modello e il tokenizer
|
||||
model = BertForSequenceClassification.from_pretrained("./my_saved_model_directory/")
|
||||
tokenizer = BertTokenizer.from_pretrained("./my_saved_model_directory/")
|
||||
```
|
||||
### Ricarichiamo il modello e il tokenizer
|
||||
model = BertForSequenceClassification.from_pretrained("./my_saved_model_directory/")
|
||||
tokenizer = BertTokenizer.from_pretrained("./my_saved_model_directory/")
|
||||
```
|
||||
|
||||
### Ottimizzatori: BertAdam e OpenAIAdam ora sono AdamW, lo scheduling è quello standard PyTorch
|
||||
### Ottimizzatori: BertAdam e OpenAIAdam ora sono AdamW, lo scheduling è quello standard PyTorch
|
||||
|
||||
I due ottimizzatori precedenti inclusi, `BertAdam` e `OpenAIAdam`, sono stati sostituiti da un singolo `AdamW` che presenta alcune differenze:
|
||||
I due ottimizzatori precedenti inclusi, `BertAdam` e `OpenAIAdam`, sono stati sostituiti da un singolo `AdamW` che presenta alcune differenze:
|
||||
|
||||
- implementa solo la correzione del weights decay,
|
||||
- lo scheduling ora è esterno (vedi sotto),
|
||||
- anche il gradient clipping ora è esterno (vedi sotto).
|
||||
- implementa solo la correzione del weights decay,
|
||||
- lo scheduling ora è esterno (vedi sotto),
|
||||
- anche il gradient clipping ora è esterno (vedi sotto).
|
||||
|
||||
Il nuovo ottimizzatore `AdamW` corrisponde alle API di `Adam` di PyTorch e ti consente di utilizzare metodi PyTorch o apex per lo scheduling e il clipping.
|
||||
|
||||
Lo scheduling è ora standard [PyTorch learning rate schedulers](https://pytorch.org/docs/stable/optim.html#how-to-adjust-learning-rate) e non fanno più parte dell'ottimizzatore.
|
||||
Lo scheduling è ora standard [PyTorch learning rate schedulers](https://pytorch.org/docs/stable/optim.html#how-to-adjust-learning-rate) e non fanno più parte dell'ottimizzatore.
|
||||
|
||||
Ecco un esempio di linear warmup e decay con `BertAdam` e con `AdamW`:
|
||||
Ecco un esempio di linear warmup e decay con `BertAdam` e con `AdamW`:
|
||||
|
||||
```python
|
||||
# Parametri:
|
||||
lr = 1e-3
|
||||
max_grad_norm = 1.0
|
||||
num_training_steps = 1000
|
||||
num_warmup_steps = 100
|
||||
warmup_proportion = float( num_warmup_steps) / float(num_training_steps) # 0.1
|
||||
```python
|
||||
# Parametri:
|
||||
lr = 1e-3
|
||||
max_grad_norm = 1.0
|
||||
num_training_steps = 1000
|
||||
num_warmup_steps = 100
|
||||
warmup_proportion = float( num_warmup_steps) / float(num_training_steps) # 0.1
|
||||
|
||||
### In precedenza l'ottimizzatore BertAdam veniva istanziato in questo modo:
|
||||
optimizer = BertAdam(
|
||||
model.parameters(),
|
||||
lr=lr,
|
||||
schedule="warmup_linear",
|
||||
warmup=warmup_proportion,
|
||||
num_training_steps=num_training_steps,
|
||||
)
|
||||
### e usato in questo modo:
|
||||
for batch in train_data:
|
||||
loss = model(batch)
|
||||
loss.backward()
|
||||
optimizer.step()
|
||||
### In precedenza l'ottimizzatore BertAdam veniva istanziato in questo modo:
|
||||
optimizer = BertAdam(
|
||||
model.parameters(),
|
||||
lr=lr,
|
||||
schedule="warmup_linear",
|
||||
warmup=warmup_proportion,
|
||||
num_training_steps=num_training_steps,
|
||||
)
|
||||
### e usato in questo modo:
|
||||
for batch in train_data:
|
||||
loss = model(batch)
|
||||
loss.backward()
|
||||
optimizer.step()
|
||||
|
||||
### In 🤗 Transformers, ottimizzatore e schedule sono divisi e usati in questo modo:
|
||||
optimizer = AdamW(
|
||||
model.parameters(), lr=lr, correct_bias=False
|
||||
) # Per riprodurre il comportamento specifico di BertAdam impostare correct_bias=False
|
||||
scheduler = get_linear_schedule_with_warmup(
|
||||
optimizer, num_warmup_steps=num_warmup_steps, num_training_steps=num_training_steps
|
||||
) # PyTorch scheduler
|
||||
### e va usato così:
|
||||
for batch in train_data:
|
||||
loss = model(batch)
|
||||
loss.backward()
|
||||
torch.nn.utils.clip_grad_norm_(
|
||||
model.parameters(), max_grad_norm
|
||||
) # Gradient clipping non è più in AdamW (quindi puoi usare amp senza problemi)
|
||||
optimizer.step()
|
||||
### In 🤗 Transformers, ottimizzatore e schedule sono divisi e usati in questo modo:
|
||||
optimizer = AdamW(
|
||||
model.parameters(), lr=lr, correct_bias=False
|
||||
) # Per riprodurre il comportamento specifico di BertAdam impostare correct_bias=False
|
||||
scheduler = get_linear_schedule_with_warmup(
|
||||
optimizer, num_warmup_steps=num_warmup_steps, num_training_steps=num_training_steps
|
||||
) # PyTorch scheduler
|
||||
### e va usato così:
|
||||
for batch in train_data:
|
||||
loss = model(batch)
|
||||
loss.backward()
|
||||
torch.nn.utils.clip_grad_norm_(
|
||||
model.parameters(), max_grad_norm
|
||||
) # Gradient clipping non è più in AdamW (quindi puoi usare amp senza problemi)
|
||||
optimizer.step()
|
||||
scheduler.step()
|
||||
```
|
||||
|
||||
@ -1910,7 +1910,7 @@ SW: Model with 2783M total params, 65M largest layer params.
|
||||
|
||||
3. 次の出力:
|
||||
|
||||
```bash
|
||||
```bash
|
||||
python -c 'import torch; print(f"torch: {torch.__version__}")'
|
||||
python -c 'import transformers; print(f"transformers: {transformers.__version__}")'
|
||||
python -c 'import deepspeed; print(f"deepspeed: {deepspeed.__version__}")'
|
||||
@ -1994,7 +1994,6 @@ SW: Model with 2783M total params, 65M largest layer params.
|
||||
|
||||
### Notes
|
||||
|
||||
- DeepSpeed は PyTorch [`Trainer`] では動作しますが、TF [`TFTrainer`] では動作しません。
|
||||
- DeepSpeed には pip でインストール可能な PyPI パッケージがありますが、ハードウェアに最も適合するように、また有効にする必要がある場合は、[ソース](https://github.com/microsoft/deepspeed#installation) からインストールすることを強くお勧めします。
|
||||
1 ビット Adam などの特定の機能は、pypi ディストリビューションでは利用できません。
|
||||
- 🤗 Transformers で DeepSpeed を使用するために [`Trainer`] を使用する必要はありません - 任意のモデルを使用できます
|
||||
|
||||
@ -249,7 +249,7 @@ recommend ZeRO-3 config as starting one. -->
|
||||
注意：
|
||||
|
||||
- 如果您需要在特定的 GPU 上运行，而不是 GPU 0，则无法使用 `CUDA_VISIBLE_DEVICES` 来限制可用 GPU 的可见范围。相反，您必须使用以下语法：
|
||||
|
||||
|
||||
```bash
|
||||
deepspeed --include localhost:1 examples/pytorch/translation/run_translation.py ...
|
||||
```
|
||||
@ -1845,7 +1845,6 @@ SW: Model with 2783M total params, 65M largest layer params.
|
||||
|
||||
### 注意事项
|
||||
|
||||
- DeepSpeed 与 PyTorch [`Trainer`] 一起工作，但不与 TF [`TFTrainer`] 一起工作。
|
||||
- 尽管 DeepSpeed 有一个可安装的 PyPI 包，但强烈建议从源代码安装它，以最好地匹配您的硬件，如果您需要启用某些功能，如 1-bit Adam，这些功能在 pypi 发行版中不可用。
|
||||
- 您不必使用🤗 Transformers的 [`Trainer`] 来使用 DeepSpeed - 您可以使用任何模型与自己的训练器，您还需要根据 [DeepSpeed 集成说明](https://www.deepspeed.ai/getting-started/#writing-deepspeed-models) 调整后者。
|
||||
|
||||
|
||||
@ -1,313 +0,0 @@
|
||||
#!/usr/bin/env python
|
||||
# coding=utf-8
|
||||
# Copyright 2020 The HuggingFace Team. All rights reserved.
|
||||
#
|
||||
# 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 sequence classification."""
|
||||
|
||||
|
||||
import logging
|
||||
import os
|
||||
from dataclasses import dataclass, field
|
||||
from typing import Dict, Optional
|
||||
|
||||
import datasets
|
||||
import numpy as np
|
||||
import tensorflow as tf
|
||||
|
||||
from transformers import (
|
||||
AutoConfig,
|
||||
AutoTokenizer,
|
||||
EvalPrediction,
|
||||
HfArgumentParser,
|
||||
PreTrainedTokenizer,
|
||||
TFAutoModelForSequenceClassification,
|
||||
TFTrainer,
|
||||
TFTrainingArguments,
|
||||
)
|
||||
from transformers.utils import logging as hf_logging
|
||||
|
||||
|
||||
hf_logging.set_verbosity_info()
|
||||
hf_logging.enable_default_handler()
|
||||
hf_logging.enable_explicit_format()
|
||||
|
||||
|
||||
def get_tfds(
|
||||
train_file: str,
|
||||
eval_file: str,
|
||||
test_file: str,
|
||||
tokenizer: PreTrainedTokenizer,
|
||||
label_column_id: int,
|
||||
max_seq_length: Optional[int] = None,
|
||||
):
|
||||
files = {}
|
||||
|
||||
if train_file is not None:
|
||||
files[datasets.Split.TRAIN] = [train_file]
|
||||
if eval_file is not None:
|
||||
files[datasets.Split.VALIDATION] = [eval_file]
|
||||
if test_file is not None:
|
||||
files[datasets.Split.TEST] = [test_file]
|
||||
|
||||
ds = datasets.load_dataset("csv", data_files=files)
|
||||
features_name = list(ds[list(files.keys())[0]].features.keys())
|
||||
label_name = features_name.pop(label_column_id)
|
||||
label_list = list(set(ds[list(files.keys())[0]][label_name]))
|
||||
label2id = {label: i for i, label in enumerate(label_list)}
|
||||
input_names = tokenizer.model_input_names
|
||||
transformed_ds = {}
|
||||
|
||||
if len(features_name) == 1:
|
||||
for k in files.keys():
|
||||
transformed_ds[k] = ds[k].map(
|
||||
lambda example: tokenizer.batch_encode_plus(
|
||||
example[features_name[0]], truncation=True, max_length=max_seq_length, padding="max_length"
|
||||
),
|
||||
batched=True,
|
||||
)
|
||||
elif len(features_name) == 2:
|
||||
for k in files.keys():
|
||||
transformed_ds[k] = ds[k].map(
|
||||
lambda example: tokenizer.batch_encode_plus(
|
||||
(example[features_name[0]], example[features_name[1]]),
|
||||
truncation=True,
|
||||
max_length=max_seq_length,
|
||||
padding="max_length",
|
||||
),
|
||||
batched=True,
|
||||
)
|
||||
|
||||
def gen_train():
|
||||
for ex in transformed_ds[datasets.Split.TRAIN]:
|
||||
d = {k: v for k, v in ex.items() if k in input_names}
|
||||
label = label2id[ex[label_name]]
|
||||
yield (d, label)
|
||||
|
||||
def gen_val():
|
||||
for ex in transformed_ds[datasets.Split.VALIDATION]:
|
||||
d = {k: v for k, v in ex.items() if k in input_names}
|
||||
label = label2id[ex[label_name]]
|
||||
yield (d, label)
|
||||
|
||||
def gen_test():
|
||||
for ex in transformed_ds[datasets.Split.TEST]:
|
||||
d = {k: v for k, v in ex.items() if k in input_names}
|
||||
label = label2id[ex[label_name]]
|
||||
yield (d, label)
|
||||
|
||||
train_ds = (
|
||||
tf.data.Dataset.from_generator(
|
||||
gen_train,
|
||||
({k: tf.int32 for k in input_names}, tf.int64),
|
||||
({k: tf.TensorShape([None]) for k in input_names}, tf.TensorShape([])),
|
||||
)
|
||||
if datasets.Split.TRAIN in transformed_ds
|
||||
else None
|
||||
)
|
||||
|
||||
if train_ds is not None:
|
||||
train_ds = train_ds.apply(tf.data.experimental.assert_cardinality(len(ds[datasets.Split.TRAIN])))
|
||||
|
||||
val_ds = (
|
||||
tf.data.Dataset.from_generator(
|
||||
gen_val,
|
||||
({k: tf.int32 for k in input_names}, tf.int64),
|
||||
({k: tf.TensorShape([None]) for k in input_names}, tf.TensorShape([])),
|
||||
)
|
||||
if datasets.Split.VALIDATION in transformed_ds
|
||||
else None
|
||||
)
|
||||
|
||||
if val_ds is not None:
|
||||
val_ds = val_ds.apply(tf.data.experimental.assert_cardinality(len(ds[datasets.Split.VALIDATION])))
|
||||
|
||||
test_ds = (
|
||||
tf.data.Dataset.from_generator(
|
||||
gen_test,
|
||||
({k: tf.int32 for k in input_names}, tf.int64),
|
||||
({k: tf.TensorShape([None]) for k in input_names}, tf.TensorShape([])),
|
||||
)
|
||||
if datasets.Split.TEST in transformed_ds
|
||||
else None
|
||||
)
|
||||
|
||||
if test_ds is not None:
|
||||
test_ds = test_ds.apply(tf.data.experimental.assert_cardinality(len(ds[datasets.Split.TEST])))
|
||||
|
||||
return train_ds, val_ds, test_ds, label2id
|
||||
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
@dataclass
|
||||
class DataTrainingArguments:
|
||||
"""
|
||||
Arguments pertaining to what data we are going to input our model for training and eval.
|
||||
|
||||
Using `HfArgumentParser` we can turn this class
|
||||
into argparse arguments to be able to specify them on
|
||||
the command line.
|
||||
"""
|
||||
|
||||
label_column_id: int = field(metadata={"help": "Which column contains the label"})
|
||||
train_file: str = field(default=None, metadata={"help": "The path of the training file"})
|
||||
dev_file: Optional[str] = field(default=None, metadata={"help": "The path of the development file"})
|
||||
test_file: Optional[str] = field(default=None, metadata={"help": "The path of the test file"})
|
||||
max_seq_length: int = field(
|
||||
default=128,
|
||||
metadata={
|
||||
"help": (
|
||||
"The maximum total input sequence length after tokenization. Sequences longer "
|
||||
"than this will be truncated, sequences shorter will be padded."
|
||||
)
|
||||
},
|
||||
)
|
||||
overwrite_cache: bool = field(
|
||||
default=False, metadata={"help": "Overwrite the cached training and evaluation sets"}
|
||||
)
|
||||
|
||||
|
||||
@dataclass
|
||||
class ModelArguments:
|
||||
"""
|
||||
Arguments pertaining to which model/config/tokenizer we are going to fine-tune from.
|
||||
"""
|
||||
|
||||
model_name_or_path: 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"}
|
||||
)
|
||||
use_fast: bool = field(default=False, metadata={"help": "Set this flag to use fast tokenization."})
|
||||
# If you want to tweak more attributes on your tokenizer, you should do it in a distinct script,
|
||||
# or just modify its tokenizer_config.json.
|
||||
cache_dir: Optional[str] = field(
|
||||
default=None,
|
||||
metadata={"help": "Where do you want to store the pretrained models downloaded from huggingface.co"},
|
||||
)
|
||||
|
||||
|
||||
def main():
|
||||
# See all possible arguments in src/transformers/training_args.py
|
||||
# or by passing the --help flag to this script.
|
||||
# We now keep distinct sets of args, for a cleaner separation of concerns.
|
||||
parser = HfArgumentParser((ModelArguments, DataTrainingArguments, TFTrainingArguments))
|
||||
model_args, data_args, training_args = parser.parse_args_into_dataclasses()
|
||||
|
||||
if (
|
||||
os.path.exists(training_args.output_dir)
|
||||
and os.listdir(training_args.output_dir)
|
||||
and training_args.do_train
|
||||
and not training_args.overwrite_output_dir
|
||||
):
|
||||
raise ValueError(
|
||||
f"Output directory ({training_args.output_dir}) already exists and is not empty. Use"
|
||||
" --overwrite_output_dir to overcome."
|
||||
)
|
||||
|
||||
# Setup logging
|
||||
logging.basicConfig(
|
||||
format="%(asctime)s - %(levelname)s - %(name)s - %(message)s",
|
||||
datefmt="%m/%d/%Y %H:%M:%S",
|
||||
level=logging.INFO,
|
||||
)
|
||||
logger.info(
|
||||
f"n_replicas: {training_args.n_replicas}, distributed training: {bool(training_args.n_replicas > 1)}, "
|
||||
f"16-bits training: {training_args.fp16}"
|
||||
)
|
||||
logger.info(f"Training/evaluation parameters {training_args}")
|
||||
|
||||
# Load pretrained model and tokenizer
|
||||
#
|
||||
# Distributed training:
|
||||
# The .from_pretrained methods guarantee that only one local process can concurrently
|
||||
# download model & vocab.
|
||||
|
||||
tokenizer = AutoTokenizer.from_pretrained(
|
||||
model_args.tokenizer_name if model_args.tokenizer_name else model_args.model_name_or_path,
|
||||
cache_dir=model_args.cache_dir,
|
||||
)
|
||||
|
||||
train_dataset, eval_dataset, test_ds, label2id = get_tfds(
|
||||
train_file=data_args.train_file,
|
||||
eval_file=data_args.dev_file,
|
||||
test_file=data_args.test_file,
|
||||
tokenizer=tokenizer,
|
||||
label_column_id=data_args.label_column_id,
|
||||
max_seq_length=data_args.max_seq_length,
|
||||
)
|
||||
|
||||
config = AutoConfig.from_pretrained(
|
||||
model_args.config_name if model_args.config_name else model_args.model_name_or_path,
|
||||
num_labels=len(label2id),
|
||||
label2id=label2id,
|
||||
id2label={id: label for label, id in label2id.items()},
|
||||
finetuning_task="text-classification",
|
||||
cache_dir=model_args.cache_dir,
|
||||
)
|
||||
|
||||
with training_args.strategy.scope():
|
||||
model = TFAutoModelForSequenceClassification.from_pretrained(
|
||||
model_args.model_name_or_path,
|
||||
from_pt=bool(".bin" in model_args.model_name_or_path),
|
||||
config=config,
|
||||
cache_dir=model_args.cache_dir,
|
||||
)
|
||||
|
||||
def compute_metrics(p: EvalPrediction) -> Dict:
|
||||
preds = np.argmax(p.predictions, axis=1)
|
||||
|
||||
return {"acc": (preds == p.label_ids).mean()}
|
||||
|
||||
# Initialize our Trainer
|
||||
trainer = TFTrainer(
|
||||
model=model,
|
||||
args=training_args,
|
||||
train_dataset=train_dataset,
|
||||
eval_dataset=eval_dataset,
|
||||
compute_metrics=compute_metrics,
|
||||
)
|
||||
|
||||
# Training
|
||||
if training_args.do_train:
|
||||
trainer.train()
|
||||
trainer.save_model()
|
||||
tokenizer.save_pretrained(training_args.output_dir)
|
||||
|
||||
# Evaluation
|
||||
results = {}
|
||||
if training_args.do_eval:
|
||||
logger.info("*** Evaluate ***")
|
||||
result = trainer.evaluate()
|
||||
output_eval_file = os.path.join(training_args.output_dir, "eval_results.txt")
|
||||
|
||||
with open(output_eval_file, "w") as writer:
|
||||
logger.info("***** Eval results *****")
|
||||
|
||||
for key, value in result.items():
|
||||
logger.info(f" {key} = {value}")
|
||||
writer.write(f"{key} = {value}\n")
|
||||
|
||||
results.update(result)
|
||||
|
||||
return results
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@ -1,310 +0,0 @@
|
||||
#!/usr/bin/env python
|
||||
# coding=utf-8
|
||||
# Copyright 2018 The HuggingFace Inc. team.
|
||||
#
|
||||
# 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 named entity recognition."""
|
||||
|
||||
|
||||
import logging
|
||||
import os
|
||||
from dataclasses import dataclass, field
|
||||
from importlib import import_module
|
||||
from typing import Dict, List, Optional, Tuple
|
||||
|
||||
import numpy as np
|
||||
from seqeval.metrics import classification_report, f1_score, precision_score, recall_score
|
||||
from utils_ner import Split, TFTokenClassificationDataset, TokenClassificationTask
|
||||
|
||||
from transformers import (
|
||||
AutoConfig,
|
||||
AutoTokenizer,
|
||||
EvalPrediction,
|
||||
HfArgumentParser,
|
||||
TFAutoModelForTokenClassification,
|
||||
TFTrainer,
|
||||
TFTrainingArguments,
|
||||
)
|
||||
from transformers.utils import logging as hf_logging
|
||||
|
||||
|
||||
hf_logging.set_verbosity_info()
|
||||
hf_logging.enable_default_handler()
|
||||
hf_logging.enable_explicit_format()
|
||||
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
@dataclass
|
||||
class ModelArguments:
|
||||
"""
|
||||
Arguments pertaining to which model/config/tokenizer we are going to fine-tune from.
|
||||
"""
|
||||
|
||||
model_name_or_path: 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"}
|
||||
)
|
||||
task_type: Optional[str] = field(
|
||||
default="NER", metadata={"help": "Task type to fine tune in training (e.g. NER, POS, etc)"}
|
||||
)
|
||||
tokenizer_name: Optional[str] = field(
|
||||
default=None, metadata={"help": "Pretrained tokenizer name or path if not the same as model_name"}
|
||||
)
|
||||
use_fast: bool = field(default=False, metadata={"help": "Set this flag to use fast tokenization."})
|
||||
# If you want to tweak more attributes on your tokenizer, you should do it in a distinct script,
|
||||
# or just modify its tokenizer_config.json.
|
||||
cache_dir: Optional[str] = field(
|
||||
default=None,
|
||||
metadata={"help": "Where do you want to store the pretrained models downloaded from huggingface.co"},
|
||||
)
|
||||
|
||||
|
||||
@dataclass
|
||||
class DataTrainingArguments:
|
||||
"""
|
||||
Arguments pertaining to what data we are going to input our model for training and eval.
|
||||
"""
|
||||
|
||||
data_dir: str = field(
|
||||
metadata={"help": "The input data dir. Should contain the .txt files for a CoNLL-2003-formatted task."}
|
||||
)
|
||||
labels: Optional[str] = field(
|
||||
metadata={"help": "Path to a file containing all labels. If not specified, CoNLL-2003 labels are used."}
|
||||
)
|
||||
max_seq_length: int = field(
|
||||
default=128,
|
||||
metadata={
|
||||
"help": (
|
||||
"The maximum total input sequence length after tokenization. Sequences longer "
|
||||
"than this will be truncated, sequences shorter will be padded."
|
||||
)
|
||||
},
|
||||
)
|
||||
overwrite_cache: bool = field(
|
||||
default=False, metadata={"help": "Overwrite the cached training and evaluation sets"}
|
||||
)
|
||||
|
||||
|
||||
def main():
|
||||
# See all possible arguments in src/transformers/training_args.py
|
||||
# or by passing the --help flag to this script.
|
||||
# We now keep distinct sets of args, for a cleaner separation of concerns.
|
||||
parser = HfArgumentParser((ModelArguments, DataTrainingArguments, TFTrainingArguments))
|
||||
model_args, data_args, training_args = parser.parse_args_into_dataclasses()
|
||||
|
||||
if (
|
||||
os.path.exists(training_args.output_dir)
|
||||
and os.listdir(training_args.output_dir)
|
||||
and training_args.do_train
|
||||
and not training_args.overwrite_output_dir
|
||||
):
|
||||
raise ValueError(
|
||||
f"Output directory ({training_args.output_dir}) already exists and is not empty. Use"
|
||||
" --overwrite_output_dir to overcome."
|
||||
)
|
||||
|
||||
module = import_module("tasks")
|
||||
|
||||
try:
|
||||
token_classification_task_clazz = getattr(module, model_args.task_type)
|
||||
token_classification_task: TokenClassificationTask = token_classification_task_clazz()
|
||||
except AttributeError:
|
||||
raise ValueError(
|
||||
f"Task {model_args.task_type} needs to be defined as a TokenClassificationTask subclass in {module}. "
|
||||
f"Available tasks classes are: {TokenClassificationTask.__subclasses__()}"
|
||||
)
|
||||
|
||||
# Setup logging
|
||||
logging.basicConfig(
|
||||
format="%(asctime)s - %(levelname)s - %(name)s - %(message)s",
|
||||
datefmt="%m/%d/%Y %H:%M:%S",
|
||||
level=logging.INFO,
|
||||
)
|
||||
logger.info(
|
||||
"n_replicas: %s, distributed training: %s, 16-bits training: %s",
|
||||
training_args.n_replicas,
|
||||
bool(training_args.n_replicas > 1),
|
||||
training_args.fp16,
|
||||
)
|
||||
logger.info("Training/evaluation parameters %s", training_args)
|
||||
|
||||
# Prepare Token Classification task
|
||||
labels = token_classification_task.get_labels(data_args.labels)
|
||||
label_map: Dict[int, str] = dict(enumerate(labels))
|
||||
num_labels = len(labels)
|
||||
|
||||
# Load pretrained model and tokenizer
|
||||
#
|
||||
# Distributed training:
|
||||
# The .from_pretrained methods guarantee that only one local process can concurrently
|
||||
# download model & vocab.
|
||||
|
||||
config = AutoConfig.from_pretrained(
|
||||
model_args.config_name if model_args.config_name else model_args.model_name_or_path,
|
||||
num_labels=num_labels,
|
||||
id2label=label_map,
|
||||
label2id={label: i for i, label in enumerate(labels)},
|
||||
cache_dir=model_args.cache_dir,
|
||||
)
|
||||
tokenizer = AutoTokenizer.from_pretrained(
|
||||
model_args.tokenizer_name if model_args.tokenizer_name else model_args.model_name_or_path,
|
||||
cache_dir=model_args.cache_dir,
|
||||
use_fast=model_args.use_fast,
|
||||
)
|
||||
|
||||
with training_args.strategy.scope():
|
||||
model = TFAutoModelForTokenClassification.from_pretrained(
|
||||
model_args.model_name_or_path,
|
||||
from_pt=bool(".bin" in model_args.model_name_or_path),
|
||||
config=config,
|
||||
cache_dir=model_args.cache_dir,
|
||||
)
|
||||
|
||||
# Get datasets
|
||||
train_dataset = (
|
||||
TFTokenClassificationDataset(
|
||||
token_classification_task=token_classification_task,
|
||||
data_dir=data_args.data_dir,
|
||||
tokenizer=tokenizer,
|
||||
labels=labels,
|
||||
model_type=config.model_type,
|
||||
max_seq_length=data_args.max_seq_length,
|
||||
overwrite_cache=data_args.overwrite_cache,
|
||||
mode=Split.train,
|
||||
)
|
||||
if training_args.do_train
|
||||
else None
|
||||
)
|
||||
eval_dataset = (
|
||||
TFTokenClassificationDataset(
|
||||
token_classification_task=token_classification_task,
|
||||
data_dir=data_args.data_dir,
|
||||
tokenizer=tokenizer,
|
||||
labels=labels,
|
||||
model_type=config.model_type,
|
||||
max_seq_length=data_args.max_seq_length,
|
||||
overwrite_cache=data_args.overwrite_cache,
|
||||
mode=Split.dev,
|
||||
)
|
||||
if training_args.do_eval
|
||||
else None
|
||||
)
|
||||
|
||||
def align_predictions(predictions: np.ndarray, label_ids: np.ndarray) -> Tuple[List[int], List[int]]:
|
||||
preds = np.argmax(predictions, axis=2)
|
||||
batch_size, seq_len = preds.shape
|
||||
out_label_list = [[] for _ in range(batch_size)]
|
||||
preds_list = [[] for _ in range(batch_size)]
|
||||
|
||||
for i in range(batch_size):
|
||||
for j in range(seq_len):
|
||||
if label_ids[i, j] != -100:
|
||||
out_label_list[i].append(label_map[label_ids[i][j]])
|
||||
preds_list[i].append(label_map[preds[i][j]])
|
||||
|
||||
return preds_list, out_label_list
|
||||
|
||||
def compute_metrics(p: EvalPrediction) -> Dict:
|
||||
preds_list, out_label_list = align_predictions(p.predictions, p.label_ids)
|
||||
|
||||
return {
|
||||
"precision": precision_score(out_label_list, preds_list),
|
||||
"recall": recall_score(out_label_list, preds_list),
|
||||
"f1": f1_score(out_label_list, preds_list),
|
||||
}
|
||||
|
||||
# Initialize our Trainer
|
||||
trainer = TFTrainer(
|
||||
model=model,
|
||||
args=training_args,
|
||||
train_dataset=train_dataset.get_dataset() if train_dataset else None,
|
||||
eval_dataset=eval_dataset.get_dataset() if eval_dataset else None,
|
||||
compute_metrics=compute_metrics,
|
||||
)
|
||||
|
||||
# Training
|
||||
if training_args.do_train:
|
||||
trainer.train()
|
||||
trainer.save_model()
|
||||
tokenizer.save_pretrained(training_args.output_dir)
|
||||
|
||||
# Evaluation
|
||||
results = {}
|
||||
if training_args.do_eval:
|
||||
logger.info("*** Evaluate ***")
|
||||
|
||||
result = trainer.evaluate()
|
||||
output_eval_file = os.path.join(training_args.output_dir, "eval_results.txt")
|
||||
|
||||
with open(output_eval_file, "w") as writer:
|
||||
logger.info("***** Eval results *****")
|
||||
|
||||
for key, value in result.items():
|
||||
logger.info(" %s = %s", key, value)
|
||||
writer.write("%s = %s\n" % (key, value))
|
||||
|
||||
results.update(result)
|
||||
|
||||
# Predict
|
||||
if training_args.do_predict:
|
||||
test_dataset = TFTokenClassificationDataset(
|
||||
token_classification_task=token_classification_task,
|
||||
data_dir=data_args.data_dir,
|
||||
tokenizer=tokenizer,
|
||||
labels=labels,
|
||||
model_type=config.model_type,
|
||||
max_seq_length=data_args.max_seq_length,
|
||||
overwrite_cache=data_args.overwrite_cache,
|
||||
mode=Split.test,
|
||||
)
|
||||
|
||||
predictions, label_ids, metrics = trainer.predict(test_dataset.get_dataset())
|
||||
preds_list, labels_list = align_predictions(predictions, label_ids)
|
||||
report = classification_report(labels_list, preds_list)
|
||||
|
||||
logger.info("\n%s", report)
|
||||
|
||||
output_test_results_file = os.path.join(training_args.output_dir, "test_results.txt")
|
||||
|
||||
with open(output_test_results_file, "w") as writer:
|
||||
writer.write("%s\n" % report)
|
||||
|
||||
# Save predictions
|
||||
output_test_predictions_file = os.path.join(training_args.output_dir, "test_predictions.txt")
|
||||
|
||||
with open(output_test_predictions_file, "w") as writer:
|
||||
with open(os.path.join(data_args.data_dir, "test.txt"), "r") as f:
|
||||
example_id = 0
|
||||
|
||||
for line in f:
|
||||
if line.startswith("-DOCSTART-") or line == "" or line == "\n":
|
||||
writer.write(line)
|
||||
|
||||
if not preds_list[example_id]:
|
||||
example_id += 1
|
||||
elif preds_list[example_id]:
|
||||
output_line = line.split()[0] + " " + preds_list[example_id].pop(0) + "\n"
|
||||
|
||||
writer.write(output_line)
|
||||
else:
|
||||
logger.warning("Maximum sequence length exceeded: No prediction for '%s'.", line.split()[0])
|
||||
|
||||
return results
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@ -226,7 +226,7 @@ wandb.login()
|
||||
|
||||
To enable logging to W&B, include `"wandb"` in the `report_to` of your `TrainingArguments` or script. Or just pass along `--report_to_all` if you have `wandb` installed.
|
||||
|
||||
Whenever you use `Trainer` or `TFTrainer` classes, your losses, evaluation metrics, model topology and gradients (for `Trainer` only) will automatically be logged.
|
||||
Whenever you use the `Trainer` class, your losses, evaluation metrics, model topology and gradients will automatically be logged.
|
||||
|
||||
Advanced configuration is possible by setting environment variables:
|
||||
|
||||
@ -282,7 +282,7 @@ To enable Neptune logging, in your `TrainingArguments`, set the `report_to` argu
|
||||
|
||||
```python
|
||||
training_args = TrainingArguments(
|
||||
"quick-training-distilbert-mrpc",
|
||||
"quick-training-distilbert-mrpc",
|
||||
evaluation_strategy="steps",
|
||||
eval_steps=20,
|
||||
report_to="neptune",
|
||||
|
||||
@ -15,7 +15,7 @@ limitations under the License.
|
||||
|
||||
# Examples
|
||||
|
||||
This folder contains actively maintained examples of the use of 🤗 Transformers organized into different ML tasks. All examples in this folder are **TensorFlow** examples and are written using native Keras rather than classes like `TFTrainer`, which we now consider deprecated. If you've previously only used 🤗 Transformers via `TFTrainer`, we highly recommend taking a look at the new style - we think it's a big improvement!
|
||||
This folder contains actively maintained examples of the use of 🤗 Transformers organized into different ML tasks. All examples in this folder are **TensorFlow** examples and are written using native Keras. If you've previously only used 🤗 Transformers via `TFTrainer`, we highly recommend taking a look at the new style - we think it's a big improvement!
|
||||
|
||||
In addition, all scripts here now support the [🤗 Datasets](https://github.com/huggingface/datasets) library - you can grab entire datasets just by changing one command-line argument!
|
||||
|
||||
@ -32,13 +32,13 @@ Here is the list of all our examples:
|
||||
| Task | Example datasets |
|
||||
|---|---|
|
||||
| [**`language-modeling`**](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/language-modeling) | WikiText-2
|
||||
| [**`multiple-choice`**](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/multiple-choice) | SWAG
|
||||
| [**`multiple-choice`**](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/multiple-choice) | SWAG
|
||||
| [**`question-answering`**](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/question-answering) | SQuAD
|
||||
| [**`summarization`**](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/summarization) | XSum
|
||||
| [**`summarization`**](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/summarization) | XSum
|
||||
| [**`text-classification`**](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/text-classification) | GLUE
|
||||
| [**`token-classification`**](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/token-classification) | CoNLL NER
|
||||
| [**`translation`**](https://github.com/huggingface/transformers/tree/main/examples/tensorflow/translation) | WMT
|
||||
|
||||
## Coming soon
|
||||
|
||||
- **Colab notebooks** to easily run through these scripts!
|
||||
- **Colab notebooks** to easily run through these scripts!
|
||||
|
||||
@ -4401,7 +4401,6 @@ else:
|
||||
"create_optimizer",
|
||||
]
|
||||
_import_structure["tf_utils"] = []
|
||||
_import_structure["trainer_tf"] = ["TFTrainer"]
|
||||
|
||||
|
||||
try:
|
||||
@ -8560,9 +8559,6 @@ if TYPE_CHECKING:
|
||||
create_optimizer,
|
||||
)
|
||||
|
||||
# Trainer
|
||||
from .trainer_tf import TFTrainer
|
||||
|
||||
try:
|
||||
if not (
|
||||
is_librosa_available()
|
||||
|
||||
@ -1,801 +0,0 @@
|
||||
# Copyright 2020 The HuggingFace Team. All rights reserved.
|
||||
#
|
||||
# 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.
|
||||
"""Tensorflow trainer class."""
|
||||
|
||||
import datetime
|
||||
import math
|
||||
import os
|
||||
import warnings
|
||||
from typing import Callable, Dict, Optional, Tuple
|
||||
|
||||
from .utils import ENV_VARS_TRUE_VALUES
|
||||
|
||||
|
||||
# Integrations must be imported before ML frameworks:
|
||||
# isort: off
|
||||
from .integrations import (
|
||||
is_comet_available,
|
||||
is_wandb_available,
|
||||
)
|
||||
|
||||
# isort: on
|
||||
|
||||
import numpy as np
|
||||
import tensorflow as tf
|
||||
from tensorflow.python.distribute.values import PerReplica
|
||||
|
||||
from .modeling_tf_utils import TFPreTrainedModel
|
||||
from .optimization_tf import GradientAccumulator, create_optimizer
|
||||
from .trainer_utils import (
|
||||
PREFIX_CHECKPOINT_DIR,
|
||||
EvalPrediction,
|
||||
IntervalStrategy,
|
||||
PredictionOutput,
|
||||
enable_full_determinism,
|
||||
set_seed,
|
||||
)
|
||||
from .training_args_tf import TFTrainingArguments
|
||||
from .utils import logging
|
||||
|
||||
|
||||
if is_wandb_available():
|
||||
import wandb
|
||||
|
||||
if is_comet_available():
|
||||
import comet_ml
|
||||
|
||||
logger = logging.get_logger(__name__)
|
||||
|
||||
|
||||
class TFTrainer:
|
||||
"""
|
||||
TFTrainer is a simple but feature-complete training and eval loop for TensorFlow, optimized for 🤗 Transformers.
|
||||
|
||||
Args:
|
||||
model ([`TFPreTrainedModel`]):
|
||||
The model to train, evaluate or use for predictions.
|
||||
args ([`TFTrainingArguments`]):
|
||||
The arguments to tweak training.
|
||||
train_dataset ([`~tf.data.Dataset`], *optional*):
|
||||
The dataset to use for training. The dataset should yield tuples of `(features, labels)` where `features`
|
||||
is a dict of input features and `labels` is the labels. If `labels` is a tensor, the loss is calculated by
|
||||
the model by calling `model(features, labels=labels)`. If `labels` is a dict, such as when using a
|
||||
QuestionAnswering head model with multiple targets, the loss is instead calculated by calling
|
||||
`model(features, **labels)`.
|
||||
eval_dataset ([`~tf.data.Dataset`], *optional*):
|
||||
The dataset to use for evaluation. The dataset should yield tuples of `(features, labels)` where `features`
|
||||
is a dict of input features and `labels` is the labels. If `labels` is a tensor, the loss is calculated by
|
||||
the model by calling `model(features, labels=labels)`. If `labels` is a dict, such as when using a
|
||||
QuestionAnswering head model with multiple targets, the loss is instead calculated by calling
|
||||
`model(features, **labels)`.
|
||||
compute_metrics (`Callable[[EvalPrediction], Dict]`, *optional*):
|
||||
The function that will be used to compute metrics at evaluation. Must take a [`EvalPrediction`] and return
|
||||
a dictionary string to metric values.
|
||||
tb_writer (`tf.summary.SummaryWriter`, *optional*):
|
||||
Object to write to TensorBoard.
|
||||
optimizers (`Tuple[tf.keras.optimizers.Optimizer, tf.keras.optimizers.schedules.LearningRateSchedule]`, *optional*):
|
||||
A tuple containing the optimizer and the scheduler to use. The optimizer default to an instance of
|
||||
[`tf.keras.optimizers.Adam`] if `args.weight_decay_rate` is 0 else an instance of [`AdamWeightDecay`]. The
|
||||
scheduler will default to an instance of [`tf.keras.optimizers.schedules.PolynomialDecay`] if
|
||||
`args.num_warmup_steps` is 0 else an instance of [`WarmUp`].
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
model: TFPreTrainedModel,
|
||||
args: TFTrainingArguments,
|
||||
train_dataset: Optional[tf.data.Dataset] = None,
|
||||
eval_dataset: Optional[tf.data.Dataset] = None,
|
||||
compute_metrics: Optional[Callable[[EvalPrediction], Dict]] = None,
|
||||
tb_writer: Optional[tf.summary.SummaryWriter] = None,
|
||||
optimizers: Tuple[tf.keras.optimizers.Optimizer, tf.keras.optimizers.schedules.LearningRateSchedule] = (
|
||||
None,
|
||||
None,
|
||||
),
|
||||
):
|
||||
self.model = model
|
||||
self.args = args
|
||||
self.train_dataset = train_dataset
|
||||
self.eval_dataset = eval_dataset
|
||||
self.compute_metrics = compute_metrics
|
||||
self.optimizer, self.lr_scheduler = optimizers
|
||||
self.gradient_accumulator = GradientAccumulator()
|
||||
self.global_step = 0
|
||||
self.epoch_logging = 0
|
||||
self.eval_loss = tf.keras.metrics.Sum()
|
||||
|
||||
warnings.warn(
|
||||
"The class `TFTrainer` is deprecated and will be removed in version 5 of Transformers. "
|
||||
"We recommend using native Keras instead, by calling methods like `fit()` and `predict()` "
|
||||
"directly on the model object. Detailed examples of the Keras style can be found in our "
|
||||
"examples at https://github.com/huggingface/transformers/tree/main/examples/tensorflow",
|
||||
FutureWarning,
|
||||
)
|
||||
|
||||
if tb_writer is not None:
|
||||
self.tb_writer = tb_writer
|
||||
else:
|
||||
self.tb_writer = tf.summary.create_file_writer(self.args.logging_dir)
|
||||
|
||||
if is_wandb_available():
|
||||
self.setup_wandb()
|
||||
elif os.getenv("WANDB_DISABLED", "").upper() not in ENV_VARS_TRUE_VALUES:
|
||||
logger.info(
|
||||
"You are instantiating a Trainer but W&B is not installed. To use wandb logging, "
|
||||
"run `pip install wandb && wandb login` see https://docs.wandb.com/huggingface."
|
||||
)
|
||||
|
||||
if is_comet_available():
|
||||
self.setup_comet()
|
||||
elif os.environ.get("COMET_MODE") != "DISABLED":
|
||||
logger.info(
|
||||
"To use comet_ml logging, run `pip/conda install comet_ml` "
|
||||
"see https://www.comet.ml/docs/python-sdk/huggingface/"
|
||||
)
|
||||
|
||||
enable_full_determinism(self.args.seed) if self.args.full_determinism else set_seed(self.args.seed)
|
||||
|
||||
def get_train_tfdataset(self) -> tf.data.Dataset:
|
||||
"""
|
||||
Returns the training [`~tf.data.Dataset`].
|
||||
|
||||
Subclass and override this method if you want to inject some custom behavior.
|
||||
"""
|
||||
if self.train_dataset is None:
|
||||
raise ValueError("Trainer: training requires a train_dataset.")
|
||||
|
||||
self.total_train_batch_size = self.args.train_batch_size * self.args.gradient_accumulation_steps
|
||||
self.num_train_examples = self.train_dataset.cardinality().numpy()
|
||||
|
||||
if self.num_train_examples < 0:
|
||||
raise ValueError("The training dataset must have an asserted cardinality")
|
||||
|
||||
ds = (
|
||||
self.train_dataset.repeat()
|
||||
.shuffle(self.num_train_examples, seed=self.args.seed)
|
||||
.batch(self.total_train_batch_size, drop_remainder=self.args.dataloader_drop_last)
|
||||
.prefetch(tf.data.experimental.AUTOTUNE)
|
||||
)
|
||||
|
||||
return self.args.strategy.experimental_distribute_dataset(ds)
|
||||
|
||||
def get_eval_tfdataset(self, eval_dataset: Optional[tf.data.Dataset] = None) -> tf.data.Dataset:
|
||||
"""
|
||||
Returns the evaluation [`~tf.data.Dataset`].
|
||||
|
||||
Args:
|
||||
eval_dataset ([`~tf.data.Dataset`], *optional*):
|
||||
If provided, will override *self.eval_dataset*. The dataset should yield tuples of `(features, labels)`
|
||||
where `features` is a dict of input features and `labels` is the labels. If `labels` is a tensor, the
|
||||
loss is calculated by the model by calling `model(features, labels=labels)`. If `labels` is a dict,
|
||||
such as when using a QuestionAnswering head model with multiple targets, the loss is instead calculated
|
||||
by calling `model(features, **labels)`.
|
||||
|
||||
Subclass and override this method if you want to inject some custom behavior.
|
||||
"""
|
||||
if eval_dataset is None and self.eval_dataset is None:
|
||||
raise ValueError("Trainer: evaluation requires an eval_dataset.")
|
||||
|
||||
eval_dataset = eval_dataset if eval_dataset is not None else self.eval_dataset
|
||||
num_examples = eval_dataset.cardinality().numpy()
|
||||
|
||||
if num_examples < 0:
|
||||
raise ValueError("The training dataset must have an asserted cardinality")
|
||||
|
||||
approx = math.floor if self.args.dataloader_drop_last else math.ceil
|
||||
steps = approx(num_examples / self.args.eval_batch_size)
|
||||
ds = (
|
||||
eval_dataset.repeat()
|
||||
.batch(self.args.eval_batch_size, drop_remainder=self.args.dataloader_drop_last)
|
||||
.prefetch(tf.data.experimental.AUTOTUNE)
|
||||
)
|
||||
|
||||
return self.args.strategy.experimental_distribute_dataset(ds), steps, num_examples
|
||||
|
||||
def get_test_tfdataset(self, test_dataset: tf.data.Dataset) -> tf.data.Dataset:
|
||||
"""
|
||||
Returns a test [`~tf.data.Dataset`].
|
||||
|
||||
Args:
|
||||
test_dataset ([`~tf.data.Dataset`]):
|
||||
The dataset to use. The dataset should yield tuples of `(features, labels)` where `features` is a dict
|
||||
of input features and `labels` is the labels. If `labels` is a tensor, the loss is calculated by the
|
||||
model by calling `model(features, labels=labels)`. If `labels` is a dict, such as when using a
|
||||
QuestionAnswering head model with multiple targets, the loss is instead calculated by calling
|
||||
`model(features, **labels)`.
|
||||
|
||||
Subclass and override this method if you want to inject some custom behavior.
|
||||
"""
|
||||
|
||||
num_examples = test_dataset.cardinality().numpy()
|
||||
|
||||
if num_examples < 0:
|
||||
raise ValueError("The training dataset must have an asserted cardinality")
|
||||
|
||||
steps = math.ceil(num_examples / self.args.eval_batch_size)
|
||||
ds = test_dataset.batch(self.args.eval_batch_size).prefetch(tf.data.experimental.AUTOTUNE)
|
||||
|
||||
return self.args.strategy.experimental_distribute_dataset(ds), steps, num_examples
|
||||
|
||||
def create_optimizer_and_scheduler(self, num_training_steps: int):
|
||||
"""
|
||||
Setup the optimizer and the learning rate scheduler.
|
||||
|
||||
We provide a reasonable default that works well. If you want to use something else, you can pass a tuple in the
|
||||
TFTrainer's init through `optimizers`, or subclass and override this method.
|
||||
"""
|
||||
if not self.optimizer and not self.lr_scheduler:
|
||||
warmup_steps = (
|
||||
self.args.warmup_steps
|
||||
if self.args.warmup_steps > 0
|
||||
else math.ceil(num_training_steps * self.args.warmup_ratio)
|
||||
)
|
||||
|
||||
self.optimizer, self.lr_scheduler = create_optimizer(
|
||||
self.args.learning_rate,
|
||||
num_training_steps,
|
||||
warmup_steps,
|
||||
adam_beta1=self.args.adam_beta1,
|
||||
adam_beta2=self.args.adam_beta2,
|
||||
adam_epsilon=self.args.adam_epsilon,
|
||||
weight_decay_rate=self.args.weight_decay,
|
||||
power=self.args.poly_power,
|
||||
)
|
||||
|
||||
def setup_wandb(self):
|
||||
"""
|
||||
Setup the optional Weights & Biases (`wandb`) integration.
|
||||
|
||||
One can subclass and override this method to customize the setup if needed. Find more information `here
|
||||
<https://docs.wandb.com/huggingface>`__. You can also override the following environment variables:
|
||||
|
||||
Environment:
|
||||
WANDB_PROJECT:
|
||||
(Optional): str - "huggingface" by default, set this to a custom string to store results in a different
|
||||
project.
|
||||
WANDB_DISABLED:
|
||||
(Optional): boolean - defaults to false, set to "true" to disable wandb entirely.
|
||||
"""
|
||||
|
||||
logger.info('Automatic Weights & Biases logging enabled, to disable set os.environ["WANDB_DISABLED"] = "true"')
|
||||
combined_dict = {**self.model.config.to_dict(), **self.args.to_sanitized_dict()}
|
||||
wandb.init(project=os.getenv("WANDB_PROJECT", "huggingface"), config=combined_dict, name=self.args.run_name)
|
||||
|
||||
def setup_comet(self):
|
||||
"""
|
||||
Setup the optional Comet.ml integration.
|
||||
|
||||
Environment:
|
||||
COMET_MODE:
|
||||
(Optional): str - "OFFLINE", "ONLINE", or "DISABLED"
|
||||
COMET_PROJECT_NAME:
|
||||
(Optional): str - Comet.ml project name for experiments
|
||||
COMET_OFFLINE_DIRECTORY:
|
||||
(Optional): str - folder to use for saving offline experiments when `COMET_MODE` is "OFFLINE"
|
||||
|
||||
For a number of configurable items in the environment, see `here
|
||||
<https://www.comet.ml/docs/python-sdk/advanced/#comet-configuration-variables>`__
|
||||
"""
|
||||
comet_mode = os.getenv("COMET_MODE", "ONLINE").upper()
|
||||
args = {"project_name": os.getenv("COMET_PROJECT_NAME", "huggingface")}
|
||||
experiment = None
|
||||
if comet_mode == "ONLINE":
|
||||
experiment = comet_ml.Experiment(**args)
|
||||
logger.info("Automatic Comet.ml online logging enabled")
|
||||
elif comet_mode == "OFFLINE":
|
||||
args["offline_directory"] = os.getenv("COMET_OFFLINE_DIRECTORY", "./")
|
||||
experiment = comet_ml.OfflineExperiment(**args)
|
||||
logger.info("Automatic Comet.ml offline logging enabled; use `comet upload` when finished")
|
||||
if experiment is not None:
|
||||
experiment._set_model_graph(self.model, framework="transformers")
|
||||
experiment._log_parameters(self.args, prefix="args/", framework="transformers")
|
||||
experiment._log_parameters(self.model.config, prefix="config/", framework="transformers")
|
||||
|
||||
def prediction_loop(
|
||||
self,
|
||||
dataset: tf.data.Dataset,
|
||||
steps: int,
|
||||
num_examples: int,
|
||||
description: str,
|
||||
prediction_loss_only: Optional[bool] = None,
|
||||
) -> PredictionOutput:
|
||||
"""
|
||||
Prediction/evaluation loop, shared by [`~TFTrainer.evaluate`] and [`~TFTrainer.predict`].
|
||||
|
||||
Works both with or without labels.
|
||||
"""
|
||||
|
||||
prediction_loss_only = (
|
||||
prediction_loss_only if prediction_loss_only is not None else self.args.prediction_loss_only
|
||||
)
|
||||
|
||||
logger.info(f"***** Running {description} *****")
|
||||
logger.info(f" Num examples in dataset = {num_examples}")
|
||||
if description == "Evaluation":
|
||||
logger.info(f" Num examples in used in evaluation = {self.args.eval_batch_size * steps}")
|
||||
logger.info(f" Batch size = {self.args.eval_batch_size}")
|
||||
|
||||
label_ids: np.ndarray = None
|
||||
preds: np.ndarray = None
|
||||
self.eval_loss.reset_states()
|
||||
|
||||
# Reset the past mems state at the beginning of the evaluation if necessary.
|
||||
if self.args.past_index >= 0:
|
||||
self._past = None
|
||||
|
||||
for step, batch in enumerate(dataset):
|
||||
logits = self.distributed_prediction_steps(batch)
|
||||
_, labels = batch
|
||||
|
||||
if not prediction_loss_only:
|
||||
if isinstance(logits, tuple):
|
||||
logits = logits[0]
|
||||
|
||||
if isinstance(labels, tuple):
|
||||
labels = labels[0]
|
||||
|
||||
if self.args.n_replicas > 1:
|
||||
for val in logits.values:
|
||||
if preds is None:
|
||||
preds = val.numpy()
|
||||
else:
|
||||
preds = np.append(preds, val.numpy(), axis=0)
|
||||
|
||||
for val in labels.values:
|
||||
if label_ids is None:
|
||||
label_ids = val.numpy()
|
||||
else:
|
||||
label_ids = np.append(label_ids, val.numpy(), axis=0)
|
||||
else:
|
||||
if preds is None:
|
||||
preds = logits.numpy()
|
||||
else:
|
||||
preds = np.append(preds, logits.numpy(), axis=0)
|
||||
|
||||
if label_ids is None:
|
||||
label_ids = labels.numpy()
|
||||
else:
|
||||
label_ids = np.append(label_ids, labels.numpy(), axis=0)
|
||||
|
||||
if step == steps - 1:
|
||||
break
|
||||
|
||||
if self.compute_metrics is not None and preds is not None and label_ids is not None:
|
||||
metrics = self.compute_metrics(EvalPrediction(predictions=preds, label_ids=label_ids))
|
||||
else:
|
||||
metrics = {}
|
||||
|
||||
metrics["eval_loss"] = self.eval_loss.result().numpy() / steps
|
||||
|
||||
for key in list(metrics.keys()):
|
||||
if not key.startswith("eval_"):
|
||||
metrics[f"eval_{key}"] = metrics.pop(key)
|
||||
|
||||
if self.args.past_index and hasattr(self, "_past"):
|
||||
# Clean the state at the end of training
|
||||
delattr(self, "_past")
|
||||
|
||||
return PredictionOutput(predictions=preds, label_ids=label_ids, metrics=metrics)
|
||||
|
||||
def log(self, logs: Dict[str, float]) -> None:
|
||||
"""
|
||||
Log `logs` on the various objects watching training.
|
||||
|
||||
Subclass and override this method to inject custom behavior.
|
||||
|
||||
Args:
|
||||
logs (`Dict[str, float]`):
|
||||
The values to log.
|
||||
"""
|
||||
logs["epoch"] = self.epoch_logging
|
||||
|
||||
if self.tb_writer:
|
||||
with self.tb_writer.as_default():
|
||||
for k, v in logs.items():
|
||||
tf.summary.scalar(k, v, step=self.global_step)
|
||||
self.tb_writer.flush()
|
||||
|
||||
if is_wandb_available():
|
||||
wandb.log(logs, step=self.global_step)
|
||||
|
||||
if is_comet_available():
|
||||
experiment = comet_ml.config.get_global_experiment()
|
||||
if experiment is not None:
|
||||
experiment._log_metrics(
|
||||
logs, step=self.global_step, epoch=self.epoch_logging, framework="transformers"
|
||||
)
|
||||
|
||||
output = {**logs, **{"step": self.global_step}}
|
||||
|
||||
logger.info(output)
|
||||
|
||||
def evaluate(self, eval_dataset: Optional[tf.data.Dataset] = None) -> Dict[str, float]:
|
||||
"""
|
||||
Run evaluation and returns metrics.
|
||||
|
||||
The calling script will be responsible for providing a method to compute metrics, as they are task-dependent
|
||||
(pass it to the init `compute_metrics` argument).
|
||||
|
||||
Args:
|
||||
eval_dataset ([`~tf.data.Dataset`], *optional*):
|
||||
Pass a dataset if you wish to override `self.eval_dataset`. The dataset should yield tuples of
|
||||
`(features, labels)` where `features` is a dict of input features and `labels` is the labels. If
|
||||
`labels` is a tensor, the loss is calculated by the model by calling `model(features, labels=labels)`.
|
||||
If `labels` is a dict, such as when using a QuestionAnswering head model with multiple targets, the
|
||||
loss is instead calculated by calling `model(features, **labels)`.
|
||||
|
||||
Returns:
|
||||
A dictionary containing the evaluation loss and the potential metrics computed from the predictions.
|
||||
"""
|
||||
eval_ds, steps, num_examples = self.get_eval_tfdataset(eval_dataset)
|
||||
|
||||
output = self.prediction_loop(eval_ds, steps, num_examples, description="Evaluation")
|
||||
logs = {**output.metrics}
|
||||
logs["epoch"] = self.epoch_logging
|
||||
|
||||
self.log(logs)
|
||||
|
||||
return output.metrics
|
||||
|
||||
def prediction_step(
|
||||
self, features: tf.Tensor, labels: tf.Tensor, nb_instances_in_global_batch: tf.Tensor
|
||||
) -> tf.Tensor:
|
||||
"""
|
||||
Compute the prediction on features and update the loss with labels.
|
||||
|
||||
Subclass and override to inject some custom behavior.
|
||||
"""
|
||||
per_example_loss, logits = self.run_model(features, labels, False)
|
||||
scaled_loss = per_example_loss / tf.cast(nb_instances_in_global_batch, dtype=per_example_loss.dtype)
|
||||
|
||||
self.eval_loss.update_state(scaled_loss)
|
||||
|
||||
return logits
|
||||
|
||||
@tf.function
|
||||
def distributed_prediction_steps(self, batch):
|
||||
nb_instances_in_batch = self._compute_nb_instances(batch)
|
||||
inputs = self._get_step_inputs(batch, nb_instances_in_batch)
|
||||
|
||||
logits = self.args.strategy.run(self.prediction_step, inputs)
|
||||
|
||||
return logits
|
||||
|
||||
def train(self) -> None:
|
||||
"""
|
||||
Train method to train the model.
|
||||
"""
|
||||
train_ds = self.get_train_tfdataset()
|
||||
|
||||
if self.args.debug:
|
||||
tf.summary.trace_on(graph=True, profiler=True)
|
||||
|
||||
self.gradient_accumulator.reset()
|
||||
|
||||
num_update_steps_per_epoch = self.num_train_examples / self.total_train_batch_size
|
||||
|
||||
# In fact, ``self.args.dataloader_drop_last`` has no effect in `trainer_tf.py`, because
|
||||
# the dataset is repeated before being batched.
|
||||
# It has the effect only when TPU is used which requires explicit tensor shape in order to make
|
||||
# the gradient accumulation implementation work.
|
||||
approx = math.floor if self.args.dataloader_drop_last else math.ceil
|
||||
num_update_steps_per_epoch = approx(num_update_steps_per_epoch)
|
||||
|
||||
# At least one update for each epoch.
|
||||
num_update_steps_per_epoch = max(num_update_steps_per_epoch, 1)
|
||||
self.steps_per_epoch = num_update_steps_per_epoch
|
||||
|
||||
if self.args.max_steps > 0:
|
||||
t_total = self.args.max_steps
|
||||
epochs = (self.args.max_steps // self.steps_per_epoch) + int(
|
||||
self.args.max_steps % self.steps_per_epoch > 0
|
||||
)
|
||||
else:
|
||||
t_total = self.steps_per_epoch * self.args.num_train_epochs
|
||||
epochs = self.args.num_train_epochs
|
||||
|
||||
# Since ``self.args.num_train_epochs`` can be `float`, we make ``epochs`` be a `float` always.
|
||||
epochs = float(epochs)
|
||||
|
||||
with self.args.strategy.scope():
|
||||
self.create_optimizer_and_scheduler(num_training_steps=t_total)
|
||||
folder = os.path.join(self.args.output_dir, PREFIX_CHECKPOINT_DIR)
|
||||
ckpt = tf.train.Checkpoint(optimizer=self.optimizer, model=self.model)
|
||||
self.model.ckpt_manager = tf.train.CheckpointManager(ckpt, folder, max_to_keep=self.args.save_total_limit)
|
||||
|
||||
iterations = self.optimizer.iterations
|
||||
epochs_trained = 0
|
||||
steps_trained_in_current_epoch = 0
|
||||
if self.model.ckpt_manager.latest_checkpoint:
|
||||
logger.info(
|
||||
f"Checkpoint file {self.model.ckpt_manager.latest_checkpoint} found and restoring from checkpoint"
|
||||
)
|
||||
ckpt.restore(self.model.ckpt_manager.latest_checkpoint).expect_partial()
|
||||
|
||||
self.global_step = iterations.numpy()
|
||||
|
||||
epochs_trained = self.global_step // self.steps_per_epoch
|
||||
steps_trained_in_current_epoch = self.global_step % self.steps_per_epoch
|
||||
|
||||
logger.info(" Continuing training from checkpoint, will skip to saved global_step")
|
||||
logger.info(f" Continuing training from epoch {epochs_trained}")
|
||||
logger.info(f" Continuing training from global step {self.global_step}")
|
||||
logger.info(f" Will skip the first {steps_trained_in_current_epoch} steps in the first epoch")
|
||||
|
||||
tf.summary.experimental.set_step(self.global_step)
|
||||
|
||||
with self.tb_writer.as_default():
|
||||
tf.summary.text("args", self.args.to_json_string())
|
||||
|
||||
self.tb_writer.flush()
|
||||
|
||||
logger.info("***** Running training *****")
|
||||
logger.info(f" Num examples = {self.num_train_examples}")
|
||||
# TODO: We might want to print a more precise ``epochs`` if self.args.max_steps > 0 ?
|
||||
logger.info(f" Num Epochs = {epochs}")
|
||||
logger.info(f" Instantaneous batch size per device = {self.args.per_device_train_batch_size}")
|
||||
logger.info(
|
||||
f" Total train batch size (w. parallel, distributed & accumulation) = {self.total_train_batch_size}"
|
||||
)
|
||||
logger.info(f" Gradient Accumulation steps = {self.args.gradient_accumulation_steps}")
|
||||
logger.info(f" Steps per epoch = {self.steps_per_epoch}")
|
||||
logger.info(f" Total optimization steps = {t_total}")
|
||||
|
||||
self.train_loss = tf.keras.metrics.Sum()
|
||||
start_time = datetime.datetime.now()
|
||||
|
||||
for epoch_iter in range(epochs_trained, int(epochs)):
|
||||
# Reset the past mems state at the beginning of each epoch if necessary.
|
||||
if self.args.past_index >= 0:
|
||||
self._past = None
|
||||
|
||||
for step, batch in enumerate(train_ds):
|
||||
# Skip past any already trained steps if resuming training
|
||||
if steps_trained_in_current_epoch > 0:
|
||||
steps_trained_in_current_epoch -= 1
|
||||
continue
|
||||
|
||||
self.distributed_training_steps(batch)
|
||||
|
||||
self.global_step = iterations.numpy()
|
||||
self.epoch_logging = epoch_iter + (step + 1) / self.steps_per_epoch
|
||||
|
||||
training_loss = self.train_loss.result() / (step + 1)
|
||||
|
||||
if self.args.debug:
|
||||
logs = {}
|
||||
logs["loss"] = training_loss.numpy()
|
||||
logs["epoch"] = self.epoch_logging
|
||||
|
||||
self.log(logs)
|
||||
|
||||
if self.global_step == 1 and self.args.debug:
|
||||
with self.tb_writer.as_default():
|
||||
tf.summary.trace_export(
|
||||
name="training", step=self.global_step, profiler_outdir=self.args.logging_dir
|
||||
)
|
||||
|
||||
if (
|
||||
self.args.eval_steps > 0
|
||||
and self.args.evaluation_strategy == IntervalStrategy.STEPS
|
||||
and self.global_step % self.args.eval_steps == 0
|
||||
):
|
||||
self.evaluate()
|
||||
|
||||
if (self.args.logging_steps > 0 and self.global_step % self.args.logging_steps == 0) or (
|
||||
self.global_step == 1 and self.args.logging_first_step
|
||||
):
|
||||
logs = {}
|
||||
logs["loss"] = training_loss.numpy()
|
||||
logs["learning_rate"] = self.lr_scheduler(self.global_step).numpy()
|
||||
logs["epoch"] = self.epoch_logging
|
||||
|
||||
self.log(logs)
|
||||
|
||||
if self.args.save_steps > 0 and self.global_step % self.args.save_steps == 0:
|
||||
ckpt_save_path = self.model.ckpt_manager.save()
|
||||
|
||||
logger.info(f"Saving checkpoint for step {self.global_step} at {ckpt_save_path}")
|
||||
|
||||
if self.args.max_steps > 0 and self.global_step >= t_total:
|
||||
break
|
||||
|
||||
if self.global_step % self.steps_per_epoch == 0:
|
||||
break
|
||||
|
||||
self.train_loss.reset_states()
|
||||
|
||||
if self.args.max_steps > 0 and self.global_step >= self.args.max_steps:
|
||||
break
|
||||
|
||||
end_time = datetime.datetime.now()
|
||||
|
||||
logger.info(f"Training took: {str(end_time - start_time)}")
|
||||
|
||||
if self.args.past_index and hasattr(self, "_past"):
|
||||
# Clean the state at the end of training
|
||||
delattr(self, "_past")
|
||||
|
||||
def training_step(self, features, labels, nb_instances_in_global_batch):
|
||||
"""
|
||||
Perform a training step on features and labels.
|
||||
|
||||
Subclass and override to inject some custom behavior.
|
||||
"""
|
||||
per_example_loss, _ = self.run_model(features, labels, True)
|
||||
scaled_loss = per_example_loss / tf.cast(nb_instances_in_global_batch, dtype=per_example_loss.dtype)
|
||||
gradients = tf.gradients(scaled_loss, self.model.trainable_variables)
|
||||
gradients = [
|
||||
g if g is not None else tf.zeros_like(v) for g, v in zip(gradients, self.model.trainable_variables)
|
||||
]
|
||||
|
||||
if self.args.gradient_accumulation_steps > 1:
|
||||
self.gradient_accumulator(gradients)
|
||||
|
||||
self.train_loss.update_state(scaled_loss)
|
||||
|
||||
if self.args.gradient_accumulation_steps == 1:
|
||||
return gradients
|
||||
|
||||
def apply_gradients(self, features, labels, nb_instances_in_global_batch):
|
||||
if self.args.gradient_accumulation_steps == 1:
|
||||
gradients = self.training_step(features, labels, nb_instances_in_global_batch)
|
||||
|
||||
self.optimizer.apply_gradients(list(zip(gradients, self.model.trainable_variables)))
|
||||
else:
|
||||
for _ in tf.range(self.args.gradient_accumulation_steps):
|
||||
reduced_features = {
|
||||
k: ft[: self.args.train_batch_size // self.args.n_replicas] for k, ft in features.items()
|
||||
}
|
||||
|
||||
if tf.is_tensor(labels):
|
||||
reduced_labels = labels[: self.args.train_batch_size // self.args.n_replicas]
|
||||
elif isinstance(labels, dict):
|
||||
reduced_labels = {
|
||||
k: lbl[: self.args.train_batch_size // self.args.n_replicas] for k, lbl in labels.items()
|
||||
}
|
||||
else:
|
||||
raise ValueError("The labels must be either a tf.Tensor or a dict.")
|
||||
|
||||
self.training_step(reduced_features, reduced_labels, nb_instances_in_global_batch)
|
||||
|
||||
features = {
|
||||
k: tf.concat(
|
||||
[ft[self.args.train_batch_size // self.args.n_replicas :], reduced_features[k]],
|
||||
axis=0,
|
||||
)
|
||||
for k, ft in features.items()
|
||||
}
|
||||
|
||||
if tf.is_tensor(labels):
|
||||
labels = tf.concat(
|
||||
[labels[self.args.train_batch_size // self.args.n_replicas :], reduced_labels], axis=0
|
||||
)
|
||||
elif isinstance(labels, dict):
|
||||
labels = {
|
||||
k: tf.concat(
|
||||
[lbl[self.args.train_batch_size // self.args.n_replicas :], reduced_labels[k]],
|
||||
axis=0,
|
||||
)
|
||||
for k, lbl in labels.items()
|
||||
}
|
||||
else:
|
||||
raise ValueError("The labels must be either a tf.Tensor or a dict.")
|
||||
|
||||
gradients = self.gradient_accumulator.gradients
|
||||
gradients = [
|
||||
(tf.clip_by_value(grad, -self.args.max_grad_norm, self.args.max_grad_norm)) for grad in gradients
|
||||
]
|
||||
|
||||
self.optimizer.apply_gradients(list(zip(gradients, self.model.trainable_variables)))
|
||||
self.gradient_accumulator.reset()
|
||||
|
||||
@tf.function
|
||||
def distributed_training_steps(self, batch):
|
||||
with self.args.strategy.scope():
|
||||
nb_instances_in_batch = self._compute_nb_instances(batch)
|
||||
inputs = self._get_step_inputs(batch, nb_instances_in_batch)
|
||||
|
||||
self.args.strategy.run(self.apply_gradients, inputs)
|
||||
|
||||
@staticmethod
|
||||
def _compute_nb_instances(batch):
|
||||
labels = batch[-1]
|
||||
if isinstance(labels, PerReplica):
|
||||
labels = tf.concat(labels.values, axis=0)
|
||||
|
||||
nb_instances = tf.reduce_sum(tf.cast(labels != -100, dtype=tf.int32))
|
||||
|
||||
return nb_instances
|
||||
|
||||
@staticmethod
|
||||
def _get_step_inputs(batch, nb_instances):
|
||||
features, labels = batch
|
||||
|
||||
if isinstance(labels, PerReplica):
|
||||
# need to make a `PerReplica` objects for ``nb_instances``
|
||||
nb_instances = PerReplica([nb_instances] * len(labels.values))
|
||||
|
||||
step_inputs = (features, labels, nb_instances)
|
||||
|
||||
return step_inputs
|
||||
|
||||
def run_model(self, features, labels, training):
|
||||
"""
|
||||
Computes the loss of the given features and labels pair.
|
||||
|
||||
Subclass and override this method if you want to inject some custom behavior.
|
||||
|
||||
Args:
|
||||
features (`tf.Tensor`): A batch of input features.
|
||||
labels (`tf.Tensor`): A batch of labels.
|
||||
training (`bool`): Whether or not to run the model in training mode.
|
||||
|
||||
Returns:
|
||||
A tuple of two `tf.Tensor`: The loss and logits.
|
||||
"""
|
||||
|
||||
if self.args.past_index >= 0 and getattr(self, "_past", None) is not None:
|
||||
features["mems"] = self._past
|
||||
|
||||
if isinstance(labels, (dict)):
|
||||
outputs = self.model(features, training=training, **labels)[:2]
|
||||
else:
|
||||
outputs = self.model(features, labels=labels, training=training)[:2]
|
||||
|
||||
loss, logits = outputs[:2]
|
||||
|
||||
if self.args.past_index >= 0:
|
||||
self._past = outputs[self.args.past_index]
|
||||
|
||||
return loss, logits
|
||||
|
||||
def predict(self, test_dataset: tf.data.Dataset) -> PredictionOutput:
|
||||
"""
|
||||
Run prediction and returns predictions and potential metrics.
|
||||
|
||||
Depending on the dataset and your use case, your test dataset may contain labels. In that case, this method
|
||||
will also return metrics, like in `evaluate()`.
|
||||
|
||||
Args:
|
||||
test_dataset ([`~tf.data.Dataset`]):
|
||||
Dataset to run the predictions on. The dataset should yield tuples of `(features, labels)` where
|
||||
`features` is a dict of input features and `labels` is the labels. If `labels` is a tensor, the loss is
|
||||
calculated by the model by calling `model(features, labels=labels)`. If `labels` is a dict, such as
|
||||
when using a QuestionAnswering head model with multiple targets, the loss is instead calculated by
|
||||
calling `model(features, **labels)`
|
||||
|
||||
Returns: *NamedTuple* A namedtuple with the following keys:
|
||||
|
||||
- predictions (`np.ndarray`): The predictions on `test_dataset`.
|
||||
- label_ids (`np.ndarray`, *optional*): The labels (if the dataset contained some).
|
||||
- metrics (`Dict[str, float]`, *optional*): The potential dictionary of metrics (if the dataset contained
|
||||
labels).
|
||||
"""
|
||||
test_ds, steps, num_examples = self.get_test_tfdataset(test_dataset)
|
||||
|
||||
return self.prediction_loop(test_ds, steps, num_examples, description="Prediction")
|
||||
|
||||
def save_model(self, output_dir: Optional[str] = None):
|
||||
"""
|
||||
Will save the model, so you can reload it using `from_pretrained()`.
|
||||
"""
|
||||
output_dir = output_dir if output_dir is not None else self.args.output_dir
|
||||
|
||||
logger.info(f"Saving model in {output_dir}")
|
||||
|
||||
if not isinstance(self.model, TFPreTrainedModel):
|
||||
raise ValueError("Trainer.model appears to not be a PreTrainedModel")
|
||||
|
||||
self.model.save_pretrained(output_dir)
|
||||
@ -13,7 +13,7 @@
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
"""
|
||||
Utilities for the Trainer and TFTrainer class. Should be independent from PyTorch and TensorFlow.
|
||||
PyTorch-independent utilities for the Trainer class.
|
||||
"""
|
||||
|
||||
import copy
|
||||
|
||||
@ -379,8 +379,6 @@ class TrainingArguments:
|
||||
set to warn or lower (default), `False` otherwise.
|
||||
remove_unused_columns (`bool`, *optional*, defaults to `True`):
|
||||
Whether or not to automatically remove the columns unused by the model forward method.
|
||||
|
||||
(Note that this behavior is not implemented for [`TFTrainer`] yet.)
|
||||
label_names (`List[str]`, *optional*):
|
||||
The list of keys in your dictionary of inputs that correspond to the labels.
|
||||
|
||||
|
||||
@ -2993,10 +2993,3 @@ class WarmUp(metaclass=DummyObject):
|
||||
|
||||
def create_optimizer(*args, **kwargs):
|
||||
requires_backends(create_optimizer, ["tf"])
|
||||
|
||||
|
||||
class TFTrainer(metaclass=DummyObject):
|
||||
_backends = ["tf"]
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
requires_backends(self, ["tf"])
|
||||
|
||||
@ -944,7 +944,6 @@ DEPRECATED_OBJECTS = [
|
||||
"xnli_output_modes",
|
||||
"xnli_processors",
|
||||
"xnli_tasks_num_labels",
|
||||
"TFTrainer",
|
||||
"TFTrainingArguments",
|
||||
]
|
||||
|
||||
|
||||
@ -965,7 +965,6 @@ src/transformers/trainer.py
|
||||
src/transformers/trainer_callback.py
|
||||
src/transformers/trainer_pt_utils.py
|
||||
src/transformers/trainer_seq2seq.py
|
||||
src/transformers/trainer_tf.py
|
||||
src/transformers/trainer_utils.py
|
||||
src/transformers/training_args.py
|
||||
src/transformers/training_args_seq2seq.py
|
||||
|
||||
Loading…
Reference in New Issue
Block a user