tf.compat.v1.make_template

Оборачивает произвольную функцию так, чтобы она совместно использовала переменные.

tf.compat.v1.make_template(
    name_,
    func_,
    create_scope_now_=False,
    unique_name_=None,
    custom_getter_=None,
    **kwargs
)

tf.compat.v1.make_template — устаревший API, совместимый только с включённым eager execution и tf.function, если объединить его с tf.compat.v1.keras.utils.track_tf1_style_variables. Подробнее см. раздел руководства по переносу сопоставления моделей, посвящённый make_template:

https://www.tensorflow.org/guide/migrate/model_mapping#using_tfcompatv1make_template_in_the_decorated_method

Даже если вы используете устаревшие API для повторного использования переменных на основе variable_scope, рекомендуем напрямую использовать tf.compat.v1.keras.utils.track_tf1_style_variables, а не tf.compat.v1.make_template, поскольку он проще и предсказуемее взаимодействует с eager execution, чем make_template.

В подходе API TF2 переменные отслеживаются с помощью tf.Modules, слоёв и моделей Keras, а не с опорой на make_template.

Описание

Используется в блокнотах

Эта функция оборачивает func_ в шаблон и частично вычисляет его. Шаблоны — это функции, которые создают переменные при первом вызове и повторно используют их при последующих вызовах. Чтобы func_ был совместим с Template, он должен удовлетворять следующим условиям:

• Функция должна создавать все обучаемые переменные и любые переменные, которые нужно повторно использовать, вызывая tf.compat.v1.get_variable. Если обучаемая переменная создаётся с помощью tf.Variable, будет вызвана ошибка ValueError. Переменные, предназначенные для локального использования, можно создавать, указав tf.Variable(..., trainable=false).
• Функция может использовать области видимости переменных и другие шаблоны для внутреннего создания и повторного использования переменных, но не должна использовать tf.compat.v1.global_variables для захвата переменных, определённых вне области видимости функции.
• Внутренние области видимости и имена переменных не должны зависеть от аргументов, не переданных в make_template. Как правило, при ошибке будет вызвана ошибка ValueError с сообщением о попытке повторно использовать несуществующую переменную.

В следующем примере и z, и w будут масштабированы с помощью одного и того же y. Важно отметить: если бы мы не присвоили scalar_name и использовали разные имена для z и w, была бы вызвана ошибка ValueError, поскольку переменную нельзя было бы повторно использовать.

def my_op(x, scalar_name):
  var1 = tf.compat.v1.get_variable(scalar_name,
                         shape=[],
                         initializer=tf.compat.v1.constant_initializer(1))
  return x * var1

scale_by_y = tf.compat.v1.make_template('scale_by_y', my_op, scalar_name='y')

z = scale_by_y(input1)
w = scale_by_y(input2)

В качестве меры предосторожности возвращённая функция после первого вызова вызовет ошибку ValueError, если обучаемые переменные создаются вызовом tf.Variable.

Если все эти условия выполнены, шаблон обеспечивает соблюдение двух свойств:

1. При многократном вызове одного и того же шаблона все нелокальные переменные будут совместно использоваться.
2. Два разных шаблона гарантированно будут уникальными, если только вы не войдёте повторно в ту же область видимости переменных, что и при первоначальном определении шаблона, и не определите его заново. Пример такого исключения:

def my_op(x, scalar_name):
  var1 = tf.compat.v1.get_variable(scalar_name,
                         shape=[],
                         initializer=tf.compat.v1.constant_initializer(1))
  return x * var1

with tf.compat.v1.variable_scope('scope') as vs:
  scale_by_y = tf.compat.v1.make_template('scale_by_y', my_op,
  scalar_name='y')
  z = scale_by_y(input1)
  w = scale_by_y(input2)

# Creates a template that reuses the variables above.
with tf.compat.v1.variable_scope(vs, reuse=True):
  scale_by_y2 = tf.compat.v1.make_template('scale_by_y', my_op,
  scalar_name='y')
  z2 = scale_by_y2(input1)
  w2 = scale_by_y2(input2)

В зависимости от значения create_scope_now_ полная область видимости переменных может быть захвачена либо при первом вызове, либо при создании. Если для этого параметра задано значение True, у всех тензоров, созданных повторными вызовами шаблона, в конце имени будет добавлено _N+1, поскольку при первом входе в область видимости в конструкторе Template тензоры не создаются.

Примечание: name_, func_ и create_scope_now_ заканчиваются символом подчёркивания, чтобы снизить вероятность конфликтов с kwargs.