Reescrever automaticamente os símbolos da API TF 1.x e compat.v1

Ver no TensorFlow.org Executar no Google Colab Ver fonte no GitHub Baixar caderno

TensorFlow 2.x inclui muitas mudanças na API de TF 1.x e os tf.compat.v1 APIs, como a reordenação argumentos, renomear símbolos e alterar valores padrão para parâmetros. Realizar manualmente todas essas modificações seria tedioso e sujeito a erros. Para agilizar as mudanças, e para tornar a sua transição para TF 2.x tão simples quanto possível, a equipe TensorFlow criou o tf_upgrade_v2 utilitário para código legado ajuda transição para a nova API.

O uso típico é assim:

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

Isso vai acelerar seu processo de atualização, convertendo scripts Python do TensorFlow 1.x existentes para TensorFlow 2.x.

O script de conversão automatiza muitas transformações de API mecânicas, embora muitas APIs não possam ser migradas automaticamente. Também não é capaz de tornar seu código totalmente compatível com os comportamentos e APIs do TF2. Portanto, é apenas uma parte de sua jornada de migração.

Módulos de compatibilidade

Certos símbolos API não podem ser atualizados simplesmente usando uma substituição de string. Aqueles que não podem ser atualizados automaticamente será mapeado para suas localizações no compat.v1 módulo. Este módulo substitui símbolos TF 1.x como tf.foo com o equivalente tf.compat.v1.foo referência. Se você já estiver usando compat.v1 APIs importando TF via import tensorflow.compat.v1 as tf , o tf_upgrade_v2 roteiro tentará converter esses usos para as APIs não-compat sempre que possível. Note-se que enquanto algumas compat.v1 APIs são compatíveis com os comportamentos TF2.x, não são muitos. Assim, recomendamos que você manualmente substituições revisar e migrá-los para novas APIs no tf.* Namespace em vez de tf.compat.v1 namespace o mais rápido possível.

Devido a TensorFlow deprecations módulo 2.x (por exemplo, tf.flags e tf.contrib ), algumas modificações podem não ser contornado pela comutação para compat.v1 . Actualizar este código pode exigir o uso de uma biblioteca adicional (por exemplo, absl.flags ) ou comutação de um pacote em tensorflow / complementos .

O restante deste guia demonstra como usar o script de regravação de símbolo. Embora o script seja fácil de usar, é altamente recomendável que você use o script como parte do seguinte processo:

  1. Unidade de Teste: Verifique se o código que você está atualizando tem um conjunto de testes de unidade com uma cobertura razoável. Este é o código Python, então a linguagem não o protegerá de muitas classes de erros. Certifique-se também de que qualquer dependência que você já tenha feito upgrade para ser compatível com o TensorFlow 2.x.

  2. Instale TensorFlow 1,15: Melhore a sua TensorFlow para a última versão TensorFlow 1.x, pelo menos, 1,14. Isto inclui a API final de 2,0 TensorFlow em tf.compat.v2 .

  3. Teste Com 1.15: Certifique-se os testes de unidade passar neste momento. Você os executará repetidamente durante a atualização, portanto, começar do verde é importante.

  4. Execute o script de atualização: Run tf_upgrade_v2 em sua árvore de origem inteira, os testes incluídos. Isso atualizará seu código para um formato em que ele usa apenas os símbolos disponíveis no TensorFlow 2.0. Símbolos preteridos será acessado com tf.compat.v1 . Eventualmente, isso exigirá atenção manual, mas não imediatamente.

  5. Execute os testes convertidos com TensorFlow 1.15: O seu código ainda deve correr bem em TensorFlow 1,15. Execute seus testes de unidade novamente. Qualquer erro em seus testes aqui significa que há um bug no script de atualização. Por favor, deixe-nos saber .

  6. Verifique o relatório de atualização para avisos e erros: O script escreve um arquivo de relatório que explica todas as conversões que você deve verificar, ou qualquer ação manual que você precisa tomar. Por exemplo: Quaisquer instâncias restantes de contrib exigirão ação manual para remover. Por favor, consulte o RFC para obter mais instruções .

  7. Instale TensorFlow 2.x: Neste ponto, deve ser seguro para mudar para TensorFlow 2.x binários, mesmo se você estiver executando com comportamentos legados

  8. Teste com v1.disable_v2_behavior : Re-executar os testes com um v1.disable_v2_behavior() na função principal dos testes deve dar os mesmos resultados como sendo executado em 1,15.

  9. Ativar V2 Comportamento: Agora que os testes de trabalhar usando os binários TF2, agora você pode começar a migrar seu código para evitar tf.estimator s e usando apenas suportados TF2 comportamentos (com nenhum comportamento TF2 incapacitante). Consulte o Guia de migração para mais detalhes.

Utilizando a reescrever símbolo tf_upgrade_v2 roteiro

Configurar

Antes de começar, verifique se o TensorFlow 2.x está instalado.

import tensorflow as tf

print(tf.__version__)
2.6.0

Clonar os tensorflow / modelos repositório git então você tem algum código para teste em:

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 | 29.44 MiB/s, done.
Resolving deltas: 100% (504/504), done.
Checking out files: 100% (2768/2768), done.

Leia a ajuda

O script deve ser instalado com TensorFlow. Aqui está a ajuda integrada:

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

Exemplo de código TF1

Aqui está um script simples do 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)

Com o TensorFlow 2.x instalado, ele não funciona:

(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'

Único arquivo

O script pode ser executado em um único arquivo 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'

O script imprimirá erros se não conseguir encontrar uma correção para o código.

Árvore de diretório

Projetos típicos, incluindo este exemplo simples, usarão muito mais de um arquivo. Normalmente deseja atualizar um pacote inteiro, então o script também pode ser executado em uma árvore de diretório:

# 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 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'
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 40:7: Renamed 'tf.test.mock' to 'tf.compat.v1.test.mock'
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 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'
WARNING line 125:15: Changing dataset.make_one_shot_iterator() to tf.compat.v1.data.make_one_shot_iterator(dataset). Please check this transformation.

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'

Note-se a um aviso sobre a dataset.make_one_shot_iterator função.

Agora o script funciona com o TensorFlow 2.x:

Note-se que porque o tf.compat.v1 módulo está incluído no TF 1,14, o script convertido também será executado em TensorFlow 1,14.

(cd regression_v2 && python custom_regression.py 2>&1) | tail
I0814 01:22:06.576656 140709717727040 estimator.py:2074] Saving dict for global step 1000: global_step = 1000, loss = 413.53702, rmse = 2.9351923
INFO:tensorflow:Saving 'checkpoint_path' summary for global step 1000: /tmp/tmpq8bvkmo0/model.ckpt-1000
I0814 01:22:06.613278 140709717727040 estimator.py:2135] Saving 'checkpoint_path' summary for global step 1000: /tmp/tmpq8bvkmo0/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: $2935

Relatório detalhado

O script também relata uma lista de mudanças detalhadas. Neste exemplo, ele encontrou uma transformação possivelmente insegura e incluiu um aviso na parte superior do arquivo:

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'

Observe novamente o aviso sobre a Dataset.make_one_shot_iterator function .

Em outros casos, a saída explicará o motivo para mudanças não triviais:

%%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.
--------------------------------------------------------------------------------

Aqui está o conteúdo do arquivo modificado, observe como o script adiciona nomes de argumento para lidar com argumentos movidos e renomeados:

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)

Um projeto maior pode conter alguns erros. Por exemplo, converta o modelo deeplab:

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

Ele produziu os arquivos de saída:

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

Mas houve erros. O relatório o ajudará a identificar o que você precisa corrigir antes de ser executado. Aqui estão os três primeiros erros:

cat deeplab_report.txt | grep -i models/research/deeplab | grep -i error | head -n 3
models/research/deeplab/vis.py:31: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/model.py:60: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: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.

Modo "Segurança"

O script de conversão também tem um menos invasiva SAFETY modo que simplesmente muda as importações de usar o tensorflow.compat.v1 módulo:

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)

Como você pode ver, isso não atualiza seu código, mas permite que o código do TensorFlow 1 seja executado nos binários do TensorFlow 2. Observe que isso não significa que seu código está executando os comportamentos TF 2.x suportados!

Ressalvas

  • Não atualize partes do seu código manualmente antes de executar este script. Em particular, as funções que tiveram argumentos reordenadas como tf.argmax ou tf.batch_to_space causa o script para adicionar incorretamente argumentos-chave que mismap seu código existente.

  • O script assume que tensorflow é importado usando import tensorflow as tf , ou import tensorflow.compat.v1 as tf .

  • Este script não reordena argumentos. Em vez disso, o script adiciona argumentos de palavra-chave a funções que têm seus argumentos reordenados.

  • Confira tf2up.ml para uma ferramenta conveniente para atualizar cadernos Jupyter e arquivos Python em um repositório GitHub.

Para reportar bugs de script de atualização ou pedidos de funcionalidades Faça, por favor arquive um problema no GitHub .