Python tf.compat.v1.make_template用法及代碼示例

給定一個任意函數，將其包裝，以便進行變量共享。

用法

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

遷移到 TF2

警告：這個 API 是為 TensorFlow v1 設計的。繼續閱讀有關如何從該 API 遷移到本機 TensorFlow v2 等效項的詳細信息。見TensorFlow v1 到 TensorFlow v2 遷移指南有關如何遷移其餘代碼的說明。

tf.compat.v1.make_template 是一個遺留 API，僅與啟用的渴望執行和 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 ，因為它以比 make_template 更簡單和更可預測的方式與即刻執行互操作。

TF2 API 方法將使用 tf.Module 或 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)

作為 safe-guard，如果通過調用 tf.Variable 創建可訓練變量，則返回的函數將在第一次調用後引發 ValueError。

如果所有這些都是真的，那麽模板會強製執行 2 個屬性：

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，因為第一次在模板構造函數中輸入範圍時，不會創建張量。

注意：name_ , func_ 和 create_scope_now_ 有一個尾隨下劃線，以減少與 kwargs 衝突的可能性。