Aprenda o que há de mais recente em aprendizado de máquina, IA generativa e muito mais no WiML Symposium 2023 Registre-se

Esta página foi traduzida pela API Cloud Translation.

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

Veja no TensorFlow.org

Executar no Google Colab

Ver fonte no GitHub

Baixar caderno

O TensorFlow 2.x inclui muitas alterações de API do TF 1.xe das APIs tf.compat.v1 , como reordenar argumentos, renomear símbolos e alterar valores padrão para parâmetros. Executar manualmente todas essas modificações seria tedioso e propenso a erros. Para simplificar as alterações e tornar sua transição para o TF 2.x o mais simples possível, a equipe do TensorFlow criou o utilitário tf_upgrade_v2 para ajudar na transição do código legado para a nova API.

O uso típico é assim:

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

Ele acelerará o processo de atualização convertendo os scripts Python existentes do TensorFlow 1.x para o TensorFlow 2.x.

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

Módulos de compatibilidade

Certos símbolos da API não podem ser atualizados simplesmente usando uma substituição de string. Aqueles que não podem ser atualizados automaticamente serão mapeados para seus locais no módulo compat.v1 . Este módulo substitui símbolos TF 1.x como tf.foo pela referência tf.compat.v1.foo equivalente. Se você já estiver usando APIs compat.v1 importando TF via import tensorflow.compat.v1 as tf , o script tf_upgrade_v2 tentará converter esses usos para APIs não compatíveis sempre que possível. Observe que, embora algumas APIs compat.v1 sejam compatíveis com comportamentos TF2.x, muitas não são. Portanto, recomendamos que você revise manualmente as substituições e as migre para novas APIs no namespace tf.* em vez do namespace tf.compat.v1 o mais rápido possível.

Devido à descontinuação do módulo TensorFlow 2.x (por exemplo, tf.flags e tf.contrib ), algumas alterações não podem ser contornadas alternando para compat.v1 . A atualização deste código pode exigir o uso de uma biblioteca adicional (por exemplo, absl.flags ) ou a mudança para um pacote em tensorflow/addons .

Processo de atualização recomendado

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

Teste de unidade : Certifique-se de que o código que você está atualizando tenha um conjunto de testes de unidade com cobertura razoável. Este é o código Python, portanto, a linguagem não o protegerá de muitas classes de erros. Certifique-se também de que qualquer dependência já tenha sido atualizada para ser compatível com o TensorFlow 2.x.
Instale o TensorFlow 1.15 : atualize seu TensorFlow para a versão mais recente do TensorFlow 1.x, pelo menos 1.15. Isso inclui a API final do TensorFlow 2.0 em tf.compat.v2 .
Test With 1.15 : Certifique-se de que seus testes de unidade passem neste ponto. Você os executará repetidamente à medida que atualizar, portanto, começar do verde é importante.
Execute o script de atualização : Execute tf_upgrade_v2 em toda a sua árvore de origem, incluindo testes. Isso atualizará seu código para um formato em que ele usa apenas símbolos disponíveis no TensorFlow 2.0. Símbolos obsoletos serão acessados com tf.compat.v1 . Estes eventualmente exigirão atenção manual, mas não imediatamente.
Execute os testes convertidos com o TensorFlow 1.15 : seu código ainda deve funcionar bem no 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 .
Verifique se há avisos e erros no relatório de atualização : o script grava um arquivo de relatório que explica todas as conversões que você deve verificar novamente ou qualquer ação manual que você precisa realizar. Por exemplo: Quaisquer instâncias restantes de contrib exigirão ação manual para remover. Consulte o RFC para obter mais instruções .
Instale o TensorFlow 2.x : neste ponto, deve ser seguro alternar para os binários do TensorFlow 2.x, mesmo se você estiver executando com comportamentos legados
Teste com v1.disable_v2_behavior : Reexecutar seus testes com um v1.disable_v2_behavior() na função principal dos testes deve fornecer os mesmos resultados que executar em 1.15.
Habilitar o comportamento V2 : Agora que seus testes funcionam usando os binários do TF2, agora você pode começar a migrar seu código para evitar tf.estimator se usando apenas comportamentos TF2 suportados (sem desabilitar o comportamento do TF2). Consulte os guias de migração para obter detalhes.

Usando o script `tf_upgrade_v2` de reescrita de símbolos

Configurar

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

import tensorflow as tf

print(tf.__version__)

2.6.0

Clone o repositório git tensorflow/models para que você tenha algum código para testar:

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.

Leia a ajuda

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

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 executa:

(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 encontrar uma correção para o código.

Árvore de diretórios

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

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

Observe um aviso sobre a função dataset.make_one_shot_iterator .

Agora o script funciona com o TensorFlow 2.x:

Observe que, como o módulo tf.compat.v1 está incluído no TF 1.15, o script convertido também será executado no 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

Relatório detalhado

O script também relata uma lista de alterações 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 único aviso sobre a Dataset.make_one_shot_iterator function .

Em outros casos, a saída explicará o raciocínio para alterações 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 argumentos 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 que isso seja 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/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.

Modo "Segurança"

O script de conversão também possui um modo SAFETY menos invasivo que simplesmente altera as importações para usar o módulo 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)

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

Ressalvas

Não atualize partes do seu código manualmente antes de executar este script. Em particular, funções que tiveram argumentos reordenados como tf.argmax ou tf.batch_to_space fazem com que o script adicione incorretamente argumentos de palavras-chave que mapeiam incorretamente 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 palavras-chave a funções que têm seus argumentos reordenados.
Confira tf2up.ml para uma ferramenta conveniente para atualizar notebooks Jupyter e arquivos Python em um repositório GitHub.

Para relatar bugs de script de atualização ou fazer solicitações de recursos, registre um problema no GitHub .