Dzień Społeczności ML jest 9 listopada! Dołącz do nas na aktualizacje z TensorFlow Jax i więcej Dowiedz się więcej

Automatycznie przepisuj symbole API TF 1.x i compat.v1

Zobacz na TensorFlow.org Uruchom w Google Colab Wyświetl źródło na GitHub Pobierz notatnik

TensorFlow 2.x zawiera wiele zmian API z TF 1.x oraz tf.compat.v1 API, takie jak zmiana kolejności argumentów, zmiana nazwy symboli, a zmiany wartości domyślnych parametrów. Ręczne wykonywanie wszystkich tych modyfikacji byłoby żmudne i podatne na błędy. Aby usprawnić zmiany oraz dokonać przejścia do TF 2.x jako bezszwowe jak to możliwe, zespół TensorFlow stworzył tf_upgrade_v2 narzędzie, aby pomóc przejściowym starszych kod do nowego API.

Typowe użycie jest takie:

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

Przyspieszy proces aktualizacji poprzez konwersję istniejących skryptów TensorFlow 1.x Python do TensorFlow 2.x.

Skrypt konwersji automatyzuje wiele przekształceń mechanicznych interfejsów API, chociaż wielu interfejsów API nie można automatycznie migrować. Nie jest również w stanie w pełni zapewnić zgodność kodu z zachowaniami i interfejsami API TF2. Jest to więc tylko część Twojej podróży migracyjnej.

Moduły kompatybilności

Niektórych symboli API nie można uaktualnić po prostu za pomocą zamiany ciągu. Te, które nie mogą być automatycznie przeniesieni zostaną odwzorowane na swoich miejscach w compat.v1 modułu. Moduł ten zastępuje symboli TF 1.x jak tf.foo z równoważną tf.compat.v1.foo odniesienia. Jeśli już używasz compat.v1 API importując TF poprzez import tensorflow.compat.v1 as tf The tf_upgrade_v2 skrypt próbować w miarę możliwości, aby przekształcić te zwyczaje z non-COMPAT API. Należy zauważyć, że podczas gdy niektóre compat.v1 API są zgodne z zachowaniami TF2.x, wielu nie. Tak, zalecamy ręcznie korektę zamienniki i ich migracji do nowych API w tf.* Nazw zamiast tf.compat.v1 nazw, tak szybko jak to możliwe.

Ze względu TensorFlow modułu 2.x deprecations (np tf.flags i tf.contrib ), niektóre zmiany mogą nie być obejść przez włączenie do compat.v1 . Rozbudowa kod może wymagać użycia dodatkowych biblioteki (np absl.flags ) lub przełączanie pakietu, tensorflow / dodatków .

Pozostała część tego przewodnika pokazuje, jak używać skryptu przepisywania symboli. Chociaż skrypt jest łatwy w użyciu, zdecydowanie zaleca się jego użycie w ramach następującego procesu:

  1. Urządzenie pomiarowe: Upewnij się, że kod jesteś modernizacja ma testową pakietu urządzenia z rozsądną pokrycia. To jest kod Pythona, więc język nie ochroni Cię przed wieloma klasami błędów. Upewnij się również, że wszelkie zależności, które posiadasz, zostały już zaktualizowane, aby były zgodne z TensorFlow 2.x.

  2. Zainstalować TensorFlow 1.15: Zmień swoją TensorFlow do najnowszej wersji TensorFlow 1.x, co najmniej 1,15. Obejmuje to ostateczny TensorFlow 2.0 API w tf.compat.v2 .

  3. Test Z 1.15: Zapewnienie Twoje testy jednostkowe przechodzą w tym momencie. Będziesz je uruchamiał wielokrotnie podczas aktualizacji, więc ważne jest rozpoczęcie od zielonego.

  4. Uruchomić skrypt aktualizacyjny: Run tf_upgrade_v2 na całym drzewie źródłowym, testy włączone. To zaktualizuje Twój kod do formatu, w którym używa tylko symboli dostępnych w TensorFlow 2.0. Będą dostępne wycofane symboli z tf.compat.v1 . W końcu będą wymagały ręcznej uwagi, ale nie natychmiast.

  5. Uruchom przekonwertowane testy z TensorFlow 1.15: Kod powinien nadal działać dobrze w TensorFlow 1,15. Ponownie uruchom testy jednostkowe. Każdy błąd w twoich testach oznacza, że ​​jest błąd w skrypcie aktualizacji. Proszę dać nam znać .

  6. Sprawdź raport uaktualnienia dla ostrzeżeń i błędów: Skrypt zapisuje plik raportu, który wyjaśnia żadnych konwersji należy dokładnie sprawdzić, czy jakiegokolwiek ręcznego działania trzeba podjąć. Na przykład: usunięcie wszystkich pozostałych wystąpień contrib będzie wymagało ręcznego działania. Należy skonsultować się z RFC dla większej liczby instrukcji .

  7. Zainstalować TensorFlow 2.x: W tym momencie powinno być bezpieczne, aby przełączyć się TensorFlow 2.x pliki binarne, nawet jeśli działa z dotychczasowych zachowań

  8. Test z v1.disable_v2_behavior : Ponowne wyświetlanie testy z v1.disable_v2_behavior() w funkcji głównej badań powinny dać takie same wyniki jak działa pod 1.15.

  9. Włącz V2 Zachowanie: Teraz, że testy pracować przy użyciu plików binarnych TF2, można teraz rozpocząć migrację kodu do unikania tf.estimator s i tylko przy użyciu obsługiwanych TF2 zachowań (bez zachowania TF2 wyłączenie). Zobacz migracji prowadnice dla szczegółów.

Używanie symbolu przepisywanie tf_upgrade_v2 skrypt

Ustawiać

Przed rozpoczęciem upewnij się, że TensorFlow 2.x jest zainstalowany.

import tensorflow as tf

print(tf.__version__)
2.6.0

Sklonować tensorflow / Modele git repozytorium, więc trzeba trochę kodu do testu na:

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.

Przeczytaj pomoc

Skrypt powinien być zainstalowany z TensorFlow. Oto wbudowana pomoc:

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

Przykładowy kod TF1

Oto prosty skrypt 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)

Po zainstalowaniu TensorFlow 2.x nie działa:

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

Pojedynczy plik

Skrypt można uruchomić na pojedynczym pliku Pythona:

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

Skrypt wypisze błędy, jeśli nie znajdzie poprawki dla kodu.

Drzewo katalogów

Typowe projekty, w tym ten prosty przykład, będą wykorzystywać znacznie więcej niż jeden plik. Zazwyczaj chcesz zaktualizować cały pakiet, więc skrypt można również uruchomić w drzewie katalogów:

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

Należy zwrócić uwagę na jedno ostrzeżenie o dataset.make_one_shot_iterator funkcji.

Teraz skrypt działa z TensorFlow 2.x:

Należy zauważyć, że ponieważ tf.compat.v1 moduł jest w TF 1,15 przeliczoną skrypt również uruchomić w 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

Szczegółowy raport

Skrypt zgłasza również listę szczegółowych zmian. W tym przykładzie znalazł jedną potencjalnie niebezpieczną transformację i umieścił ostrzeżenie na górze pliku:

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'

Uwaga ponownie jedno ostrzeżenie o Dataset.make_one_shot_iterator function .

W innych przypadkach dane wyjściowe wyjaśnią uzasadnienie nietrywialnych zmian:

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

Oto zmodyfikowana zawartość pliku, zauważ, jak skrypt dodaje nazwy argumentów, aby poradzić sobie z przeniesionymi i zmienionymi argumentami:

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)

Większy projekt może zawierać kilka błędów. Na przykład przekonwertuj model deeplab:

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

Wyprodukował pliki wyjściowe:

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

Ale były błędy. Raport pomoże Ci określić, co musisz naprawić, zanim to się uruchomi. Oto pierwsze trzy błędy:

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.

Tryb „Bezpieczeństwo”

Skrypt konwersji ma również mniej inwazyjne SAFETY tryb, który po prostu zmienia importu do korzystania z tensorflow.compat.v1 moduł:

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)

Jak widać, nie aktualizuje to kodu, ale umożliwia działanie kodu TensorFlow 1 na plikach binarnych TensorFlow 2. Zauważ, że nie oznacza to, że Twój kod działa z wspieranymi zachowaniami TF 2.x!

Zastrzeżenia

  • Nie aktualizuj części kodu ręcznie przed uruchomieniem tego skryptu. W szczególności funkcje, które miały ponownie uporządkowane argumenty jak tf.argmax lub tf.batch_to_space przyczyną skryptu niepoprawnie dodać argumenty kluczowe, które MISMaP istniejącego kodu.

  • Scenariusz zakłada, że tensorflow jest importowany pomocą import tensorflow as tf lub import tensorflow.compat.v1 as tf .

  • Ten skrypt nie zmienia kolejności argumentów. Zamiast tego skrypt dodaje argumenty słów kluczowych do funkcji, które mają zmienioną kolejność argumentów.

  • Sprawdź tf2up.ml dla wygodnego narzędzia do aktualizacji notebooki Jupyter i plików Python w repozytorium GitHub.

Aby zgłosić błędy aktualizacji skryptu lub funkcja żądania wykonania, należy zgłosić problem na GitHub .