Riscrivi automaticamente i simboli API TF 1.x e compat.v1

Visualizza su TensorFlow.org Esegui in Google Colab Visualizza l'origine su GitHub Scarica quaderno

TensorFlow 2.x include molte modifiche alle API di TF 1.x e tf.compat.v1 , come il riordino degli argomenti, la ridenominazione dei simboli e la modifica dei valori predefiniti per i parametri. L'esecuzione manuale di tutte queste modifiche sarebbe noiosa e soggetta a errori. Per semplificare le modifiche e rendere la transizione a TF 2.x il più semplice possibile, il team di TensorFlow ha creato l'utilità tf_upgrade_v2 per facilitare la transizione del codice legacy alla nuova API.

L'uso tipico è questo:

tf_upgrade_v2 \
  --intree my_project/ \
  --outtree my_project_v2/ \
  --reportfile report.txt

Accelera il processo di aggiornamento convertendo gli script Python TensorFlow 1.x esistenti in TensorFlow 2.x.

Lo script di conversione automatizza molte trasformazioni API meccaniche, sebbene molte API non possano essere migrate automaticamente. Inoltre, non è in grado di rendere completamente compatibile il tuo codice con i comportamenti e le API di TF2. Quindi, è solo una parte del tuo viaggio di migrazione.

Moduli di compatibilità

Alcuni simboli API non possono essere aggiornati semplicemente utilizzando una sostituzione di stringa. Quelli che non possono essere aggiornati automaticamente verranno mappati alle loro posizioni nel modulo compat.v1 . Questo modulo sostituisce i simboli TF 1.x come tf.foo con il riferimento equivalente tf.compat.v1.foo . Se stai già utilizzando le API compat.v1 importando TF tramite import tensorflow.compat.v1 as tf , lo script tf_upgrade_v2 tenterà di convertire questi utilizzi in API non compatibili, ove possibile. Nota che mentre alcune API compat.v1 sono compatibili con i comportamenti TF2.x, molte non lo sono. Pertanto, ti consigliamo di correggere manualmente le sostituzioni e di migrarle a nuove API nello spazio dei nomi tf.* anziché nello spazio dei nomi tf.compat.v1 il più rapidamente possibile.

A causa delle deprecazioni del modulo TensorFlow 2.x (ad esempio, tf.flags e tf.contrib ), non è possibile aggirare alcune modifiche passando a compat.v1 . L'aggiornamento di questo codice potrebbe richiedere l'uso di una libreria aggiuntiva (ad esempio absl.flags ) o il passaggio a un pacchetto in tensorflow/addons .

Il resto di questa guida mostra come utilizzare lo script di riscrittura dei simboli. Sebbene lo script sia facile da usare, si consiglia vivamente di utilizzare lo script come parte del processo seguente:

  1. Unit test : assicurati che il codice che stai aggiornando abbia una suite di unit test con una copertura ragionevole. Questo è il codice Python, quindi il linguaggio non ti proteggerà da molte classi di errori. Assicurati inoltre che qualsiasi dipendenza che hai sia già stata aggiornata per essere compatibile con TensorFlow 2.x.

  2. Installa TensorFlow 1.15 : aggiorna il tuo TensorFlow all'ultima versione di TensorFlow 1.x, almeno 1.15. Ciò include l'API TensorFlow 2.0 finale in tf.compat.v2 .

  3. Test con 1.15 : assicurati che i tuoi unit test superino a questo punto. Li eseguirai ripetutamente durante l'aggiornamento, quindi iniziare dal verde è importante.

  4. Esegui lo script di aggiornamento : esegui tf_upgrade_v2 sull'intero albero dei sorgenti, test inclusi. Questo aggiornerà il tuo codice a un formato in cui utilizza solo i simboli disponibili in TensorFlow 2.0. Si accederà ai simboli obsoleti con tf.compat.v1 . Questi alla fine richiederanno un'attenzione manuale, ma non immediatamente.

  5. Esegui i test convertiti con TensorFlow 1.15 : il tuo codice dovrebbe comunque funzionare correttamente in TensorFlow 1.15. Esegui di nuovo i tuoi unit test. Qualsiasi errore nei tuoi test qui significa che c'è un bug nello script di aggiornamento. Per favore fateci sapere .

  6. Controllare il rapporto di aggiornamento per avvisi ed errori : lo script scrive un file di rapporto che spiega tutte le conversioni che dovresti ricontrollare o qualsiasi azione manuale che devi intraprendere. Ad esempio: qualsiasi istanza rimanente di contrib richiederà un'azione manuale per la rimozione. Si prega di consultare la RFC per ulteriori istruzioni .

  7. Installa TensorFlow 2.x : a questo punto dovrebbe essere sicuro passare ai binari di TensorFlow 2.x, anche se stai utilizzando comportamenti legacy

  8. Test con v1.disable_v2_behavior : rieseguire i test con v1.disable_v2_behavior() nella funzione principale dei test dovrebbe dare gli stessi risultati dell'esecuzione in 1.15.

  9. Abilita comportamento V2 : ora che i tuoi test funzionano utilizzando i binari TF2, ora puoi iniziare a migrare il tuo codice per evitare tf.estimator se utilizzando solo comportamenti TF2 supportati (senza disabilitazione del comportamento TF2). Consulta le Guide alla migrazione per i dettagli.

Utilizzando lo script di riscrittura dei simboli tf_upgrade_v2

Impostare

Prima di iniziare, assicurarsi che TensorFlow 2.x sia installato.

import tensorflow as tf

print(tf.__version__)
2.6.0

Clona il repository git tensorflow/models in modo da avere del codice su cui testare:

git clone --branch r1.13.0 --depth 1 https://github.com/tensorflow/models
Cloning into 'models'...
remote: Enumerating objects: 2927, done.[K
remote: Counting objects: 100% (2927/2927), done.[K
remote: Compressing objects: 100% (2428/2428), done.[K
remote: Total 2927 (delta 504), reused 2113 (delta 424), pack-reused 0[K
Receiving objects: 100% (2927/2927), 369.04 MiB | 27.58 MiB/s, done.
Resolving deltas: 100% (504/504), done.
Checking out files: 100% (2768/2768), done.

Leggi l'aiuto

Lo script deve essere installato con TensorFlow. Ecco l'aiuto integrato:

tf_upgrade_v2 -h
usage: tf_upgrade_v2 [-h] [--infile INPUT_FILE] [--outfile OUTPUT_FILE]
                     [--intree INPUT_TREE] [--outtree OUTPUT_TREE]
                     [--copyotherfiles COPY_OTHER_FILES] [--inplace]
                     [--no_import_rename] [--no_upgrade_compat_v1_import]
                     [--reportfile REPORT_FILENAME] [--mode {DEFAULT,SAFETY}]
                     [--print_all]

Convert a TensorFlow Python file from 1.x to 2.0

Simple usage:
  tf_upgrade_v2.py --infile foo.py --outfile bar.py
  tf_upgrade_v2.py --infile foo.ipynb --outfile bar.ipynb
  tf_upgrade_v2.py --intree ~/code/old --outtree ~/code/new

optional arguments:
  -h, --help            show this help message and exit
  --infile INPUT_FILE   If converting a single file, the name of the file to
                        convert
  --outfile OUTPUT_FILE
                        If converting a single file, the output filename.
  --intree INPUT_TREE   If converting a whole tree of files, the directory to
                        read from (relative or absolute).
  --outtree OUTPUT_TREE
                        If converting a whole tree of files, the output
                        directory (relative or absolute).
  --copyotherfiles COPY_OTHER_FILES
                        If converting a whole tree of files, whether to copy
                        the other files.
  --inplace             If converting a set of files, whether to allow the
                        conversion to be performed on the input files.
  --no_import_rename    Not to rename import to compat.v2 explicitly.
  --no_upgrade_compat_v1_import
                        If specified, don't upgrade explicit imports of
                        `tensorflow.compat.v1 as tf` to the v2 APIs.
                        Otherwise, explicit imports of the form
                        `tensorflow.compat.v1 as tf` will be upgraded.
  --reportfile REPORT_FILENAME
                        The name of the file where the report log is
                        stored.(default: report.txt)
  --mode {DEFAULT,SAFETY}
                        Upgrade script mode. Supported modes: DEFAULT: Perform
                        only straightforward conversions to upgrade to 2.0. In
                        more difficult cases, switch to use compat.v1. SAFETY:
                        Keep 1.* code intact and import compat.v1 module.
  --print_all           Print full log to stdout instead of just printing
                        errors

Esempio di codice TF1

Ecco un semplice script TensorFlow 1.0:

head -n 65 models/samples/cookbook/regression/custom_regression.py | tail -n 10
# Calculate loss using mean squared error
  average_loss = tf.losses.mean_squared_error(labels, predictions)

  # Pre-made estimators use the total_loss instead of the average,
  # so report total_loss for compatibility.
  batch_size = tf.shape(labels)[0]
  total_loss = tf.to_float(batch_size) * average_loss

  if mode == tf.estimator.ModeKeys.TRAIN:
    optimizer = params.get("optimizer", tf.train.AdamOptimizer)

Con TensorFlow 2.x installato non funziona:

(cd models/samples/cookbook/regression && python custom_regression.py)
Traceback (most recent call last):
  File "custom_regression.py", line 162, in <module>
    tf.logging.set_verbosity(tf.logging.INFO)
AttributeError: module 'tensorflow' has no attribute 'logging'

File singolo

Lo script può essere eseguito su un singolo file Python:

!tf_upgrade_v2 \
  --infile models/samples/cookbook/regression/custom_regression.py \
  --outfile /tmp/custom_regression_v2.py
INFO line 38:8: Renamed 'tf.feature_column.input_layer' to 'tf.compat.v1.feature_column.input_layer'
INFO line 43:10: Renamed 'tf.layers.dense' to 'tf.compat.v1.layers.dense'
INFO line 46:17: Renamed 'tf.layers.dense' to 'tf.compat.v1.layers.dense'
INFO line 57:17: tf.losses.mean_squared_error requires manual check. tf.losses have been replaced with object oriented versions in TF 2.0 and after. The loss function calls have been converted to compat.v1 for backward compatibility. Please update these calls to the TF 2.0 versions.
INFO line 57:17: Renamed 'tf.losses.mean_squared_error' to 'tf.compat.v1.losses.mean_squared_error'
INFO line 61:15: Added keywords to args of function 'tf.shape'
INFO line 62:15: Changed tf.to_float call to tf.cast(..., dtype=tf.float32).
INFO line 65:40: Renamed 'tf.train.AdamOptimizer' to 'tf.compat.v1.train.AdamOptimizer'
INFO line 68:39: Renamed 'tf.train.get_global_step' to 'tf.compat.v1.train.get_global_step'
INFO line 83:9: tf.metrics.root_mean_squared_error requires manual check. tf.metrics have been replaced with object oriented versions in TF 2.0 and after. The metric function calls have been converted to compat.v1 for backward compatibility. Please update these calls to the TF 2.0 versions.
INFO line 83:9: Renamed 'tf.metrics.root_mean_squared_error' to 'tf.compat.v1.metrics.root_mean_squared_error'
INFO line 142:23: Renamed 'tf.train.AdamOptimizer' to 'tf.compat.v1.train.AdamOptimizer'
INFO line 162:2: Renamed 'tf.logging.set_verbosity' to 'tf.compat.v1.logging.set_verbosity'
INFO line 162:27: Renamed 'tf.logging.INFO' to 'tf.compat.v1.logging.INFO'
INFO line 163:2: Renamed 'tf.app.run' to 'tf.compat.v1.app.run'
TensorFlow 2.0 Upgrade Script
-----------------------------
Converted 1 files
Detected 0 issues that require attention
--------------------------------------------------------------------------------


Make sure to read the detailed log 'report.txt'

Lo script stamperà errori se non riesce a trovare una correzione per il codice.

Albero di directory

I progetti tipici, incluso questo semplice esempio, utilizzeranno molto più di un file. In genere si desidera aggiornare un intero pacchetto, quindi lo script può anche essere eseguito su un albero di directory:

# update the .py files and copy all the other files to the outtree
!tf_upgrade_v2 \
    --intree models/samples/cookbook/regression/ \
    --outtree regression_v2/ \
    --reportfile tree_report.txt
INFO line 82:10: tf.estimator.LinearRegressor: Default value of loss_reduction has been changed to SUM_OVER_BATCH_SIZE; inserting old default value tf.keras.losses.Reduction.SUM.

INFO line 105:2: Renamed 'tf.logging.set_verbosity' to 'tf.compat.v1.logging.set_verbosity'
INFO line 105:27: Renamed 'tf.logging.INFO' to 'tf.compat.v1.logging.INFO'
INFO line 106:2: Renamed 'tf.app.run' to 'tf.compat.v1.app.run'
INFO line 38:8: Renamed 'tf.feature_column.input_layer' to 'tf.compat.v1.feature_column.input_layer'
INFO line 43:10: Renamed 'tf.layers.dense' to 'tf.compat.v1.layers.dense'
INFO line 46:17: Renamed 'tf.layers.dense' to 'tf.compat.v1.layers.dense'
INFO line 57:17: tf.losses.mean_squared_error requires manual check. tf.losses have been replaced with object oriented versions in TF 2.0 and after. The loss function calls have been converted to compat.v1 for backward compatibility. Please update these calls to the TF 2.0 versions.
INFO line 57:17: Renamed 'tf.losses.mean_squared_error' to 'tf.compat.v1.losses.mean_squared_error'
INFO line 61:15: Added keywords to args of function 'tf.shape'
INFO line 62:15: Changed tf.to_float call to tf.cast(..., dtype=tf.float32).
INFO line 65:40: Renamed 'tf.train.AdamOptimizer' to 'tf.compat.v1.train.AdamOptimizer'
INFO line 68:39: Renamed 'tf.train.get_global_step' to 'tf.compat.v1.train.get_global_step'
INFO line 83:9: tf.metrics.root_mean_squared_error requires manual check. tf.metrics have been replaced with object oriented versions in TF 2.0 and after. The metric function calls have been converted to compat.v1 for backward compatibility. Please update these calls to the TF 2.0 versions.
INFO line 83:9: Renamed 'tf.metrics.root_mean_squared_error' to 'tf.compat.v1.metrics.root_mean_squared_error'
INFO line 142:23: Renamed 'tf.train.AdamOptimizer' to 'tf.compat.v1.train.AdamOptimizer'
INFO line 162:2: Renamed 'tf.logging.set_verbosity' to 'tf.compat.v1.logging.set_verbosity'
INFO line 162:27: Renamed 'tf.logging.INFO' to 'tf.compat.v1.logging.INFO'
INFO line 163:2: Renamed 'tf.app.run' to 'tf.compat.v1.app.run'
INFO line 58:10: tf.estimator.LinearRegressor: Default value of loss_reduction has been changed to SUM_OVER_BATCH_SIZE; inserting old default value tf.keras.losses.Reduction.SUM.

INFO line 101:2: Renamed 'tf.logging.set_verbosity' to 'tf.compat.v1.logging.set_verbosity'
INFO line 101:27: Renamed 'tf.logging.INFO' to 'tf.compat.v1.logging.INFO'
INFO line 102:2: Renamed 'tf.app.run' to 'tf.compat.v1.app.run'
INFO line 72:10: tf.estimator.DNNRegressor: Default value of loss_reduction has been changed to SUM_OVER_BATCH_SIZE; inserting old default value tf.keras.losses.Reduction.SUM.

INFO line 96:2: Renamed 'tf.logging.set_verbosity' to 'tf.compat.v1.logging.set_verbosity'
INFO line 96:27: Renamed 'tf.logging.INFO' to 'tf.compat.v1.logging.INFO'
INFO line 97:2: Renamed 'tf.app.run' to 'tf.compat.v1.app.run'
WARNING line 125:15: Changing dataset.make_one_shot_iterator() to tf.compat.v1.data.make_one_shot_iterator(dataset). Please check this transformation.

INFO line 40:7: Renamed 'tf.test.mock' to 'tf.compat.v1.test.mock'
TensorFlow 2.0 Upgrade Script
-----------------------------
Converted 7 files
Detected 1 issues that require attention
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
File: models/samples/cookbook/regression/automobile_data.py
--------------------------------------------------------------------------------
models/samples/cookbook/regression/automobile_data.py:125:15: WARNING: Changing dataset.make_one_shot_iterator() to tf.compat.v1.data.make_one_shot_iterator(dataset). Please check this transformation.



Make sure to read the detailed log 'tree_report.txt'

Nota l'unico avviso sulla funzione dataset.make_one_shot_iterator .

Ora lo script funziona con TensorFlow 2.x:

Si noti che poiché il modulo tf.compat.v1 è incluso in TF 1.15, lo script convertito verrà eseguito anche in TensorFlow 1.15.

(cd regression_v2 && python custom_regression.py 2>&1) | tail
I0922 22:16:42.778216 140254758430528 estimator.py:2074] Saving dict for global step 1000: global_step = 1000, loss = 651.5428, rmse = 3.684265
INFO:tensorflow:Saving 'checkpoint_path' summary for global step 1000: /tmp/tmpk2_4r192/model.ckpt-1000
I0922 22:16:42.817190 140254758430528 estimator.py:2135] Saving 'checkpoint_path' summary for global step 1000: /tmp/tmpk2_4r192/model.ckpt-1000
Tensor("IteratorGetNext:25", shape=(None,), dtype=float64, device=/device:CPU:0)
Tensor("Squeeze:0", shape=(None,), dtype=float32)

********************************************************************************

RMS error for the test set: $3684

Rapporto dettagliato

Lo script riporta anche un elenco di modifiche dettagliate. In questo esempio ha trovato una trasformazione forse non sicura e ha incluso un avviso nella parte superiore del file:

head -n 20 tree_report.txt
TensorFlow 2.0 Upgrade Script
-----------------------------
Converted 7 files
Detected 1 issues that require attention
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
File: models/samples/cookbook/regression/automobile_data.py
--------------------------------------------------------------------------------
models/samples/cookbook/regression/automobile_data.py:125:15: WARNING: Changing dataset.make_one_shot_iterator() to tf.compat.v1.data.make_one_shot_iterator(dataset). Please check this transformation.

================================================================================
Detailed log follows:

================================================================================
================================================================================
Input tree: 'models/samples/cookbook/regression/'
================================================================================
--------------------------------------------------------------------------------
Processing file 'models/samples/cookbook/regression/__init__.py'
 outputting to 'regression_v2/__init__.py'

Nota di nuovo l'unico avviso sulla Dataset.make_one_shot_iterator function .

In altri casi l'output spiegherà il motivo di modifiche non banali:

%%writefile dropout.py
import tensorflow as tf

d = tf.nn.dropout(tf.range(10), 0.2)
z = tf.zeros_like(d, optimize=False)
Writing dropout.py
!tf_upgrade_v2 \
  --infile dropout.py \
  --outfile dropout_v2.py \
  --reportfile dropout_report.txt > /dev/null
cat dropout_report.txt
TensorFlow 2.0 Upgrade Script
-----------------------------
Converted 1 files
Detected 0 issues that require attention
--------------------------------------------------------------------------------
================================================================================
Detailed log follows:

================================================================================
--------------------------------------------------------------------------------
Processing file 'dropout.py'
 outputting to 'dropout_v2.py'
--------------------------------------------------------------------------------

3:4: INFO: Changing keep_prob arg of tf.nn.dropout to rate, and recomputing value.

4:4: INFO: Renaming tf.zeros_like to tf.compat.v1.zeros_like because argument optimize is present. tf.zeros_like no longer takes an optimize argument, and behaves as if optimize=True. This call site specifies something other than optimize=True, so it was converted to compat.v1.
--------------------------------------------------------------------------------

Ecco il contenuto del file modificato, nota come lo script aggiunge i nomi degli argomenti per gestire gli argomenti spostati e rinominati:

cat dropout_v2.py
import tensorflow as tf

d = tf.nn.dropout(tf.range(10), rate=1 - (0.2))
z = tf.compat.v1.zeros_like(d, optimize=False)

Un progetto più grande potrebbe contenere alcuni errori. Ad esempio, converti il ​​modello deeplab:

!tf_upgrade_v2 \
    --intree models/research/deeplab \
    --outtree deeplab_v2 \
    --reportfile deeplab_report.txt > /dev/null

Ha prodotto i file di output:

ls deeplab_v2
README.md   datasets        input_preprocess.py        train.py
__init__.py deeplab_demo.ipynb  local_test.sh          utils
common.py   eval.py         local_test_mobilenetv2.sh  vis.py
common_test.py  export_model.py     model.py
core        g3doc           model_test.py

Ma c'erano degli errori. Il rapporto ti aiuterà a individuare ciò che devi correggere prima che venga eseguito. Ecco i primi tre errori:

cat deeplab_report.txt | grep -i models/research/deeplab | grep -i error | head -n 3
models/research/deeplab/eval.py:28:7: ERROR: Using member tf.contrib.slim in deprecated module tf.contrib. tf.contrib.slim cannot be converted automatically. tf.contrib will not be distributed with TensorFlow 2.0, please consider an alternative in non-contrib TensorFlow, a community-maintained repository such as tensorflow/addons, or fork the required code.
models/research/deeplab/eval.py:146:8: ERROR: Using member tf.contrib.metrics.aggregate_metric_map in deprecated module tf.contrib. tf.contrib.metrics.aggregate_metric_map cannot be converted automatically. tf.contrib will not be distributed with TensorFlow 2.0, please consider an alternative in non-contrib TensorFlow, a community-maintained repository such as tensorflow/addons, or fork the required code.
models/research/deeplab/export_model.py:25:7: ERROR: Using member tf.contrib.slim in deprecated module tf.contrib. tf.contrib.slim cannot be converted automatically. tf.contrib will not be distributed with TensorFlow 2.0, please consider an alternative in non-contrib TensorFlow, a community-maintained repository such as tensorflow/addons, or fork the required code.

Modalità "Sicurezza".

Lo script di conversione ha anche una modalità di SAFETY meno invasiva che modifica semplicemente le importazioni per utilizzare il modulo tensorflow.compat.v1 :

cat dropout.py
import tensorflow as tf

d = tf.nn.dropout(tf.range(10), 0.2)
z = tf.zeros_like(d, optimize=False)
tf_upgrade_v2 --mode SAFETY --infile dropout.py --outfile dropout_v2_safe.py > /dev/null
cat dropout_v2_safe.py
import tensorflow.compat.v1 as tf

d = tf.nn.dropout(tf.range(10), 0.2)
z = tf.zeros_like(d, optimize=False)

Come puoi vedere, questo non aggiorna il tuo codice, ma consente al codice TensorFlow 1 di essere eseguito su binari TensorFlow 2. Nota che questo non significa che il tuo codice stia eseguendo comportamenti TF 2.x supportati!

Avvertenze

  • Non aggiornare manualmente parti del codice prima di eseguire questo script. In particolare, le funzioni che hanno avuto argomenti riordinati come tf.argmax o tf.batch_to_space sì che lo script aggiunga in modo errato argomenti di parole chiave che mappano in modo errato il codice esistente.

  • Lo script presuppone che tensorflow venga importato utilizzando import tensorflow as tf o import tensorflow.compat.v1 as tf .

  • Questo script non riordina gli argomenti. Invece, lo script aggiunge argomenti di parole chiave alle funzioni che hanno i loro argomenti riordinati.

  • Dai un'occhiata a tf2up.ml per uno strumento conveniente per aggiornare i notebook Jupyter e i file Python in un repository GitHub.

Per segnalare bug degli script di aggiornamento o effettuare richieste di funzionalità, segnala un problema su GitHub .