tf.compat.v1.get_variable
Получает существующую переменную с указанными параметрами или создаёт новую.
tf.compat.v1.get_variable(
name,
shape=None,
dtype=None,
initializer=None,
regularizer=None,
trainable=None,
collections=None,
caching_device=None,
partitioner=None,
validate_shape=True,
use_resource=None,
custom_getter=None,
constraint=None,
synchronization=tf.VariableSynchronization.AUTO,
aggregation=tf.compat.v1.VariableAggregation.NONE
)
Переход к TF2
Хотя это устаревший compat.v1 API, tf.compat.v1.get_variable в основном совместим с выполнением в режиме eager и tf.function, но только если вы используете его совместно с декоратором tf.compat.v1.keras.utils.track_tf1_style_variables. (Хотя он будет вести себя так, как будто reuse всегда установлен в AUTO_REUSE.)
См. руководство по миграции моделей https://www.tensorflow.org/guide/migrate/model_mapping для получения дополнительной информации.
Если вы не используете его совместно с tf.compat.v1.keras.utils.track_tf1_style_variables, get_variable будет создавать совершенно новую переменную каждый раз при вызове и никогда не будет повторно использовать переменные, независимо от имён переменных или аргументов reuse.
Эквивалент этого символа в TF2 — tf.Variable, но обратите внимание, что при использовании tf.Variable вы должны убедиться, что отслеживаете свои переменные (и аргументы регуляризации) либо вручную, либо с помощью механизмов tf.Module или tf.keras.layers.Layer.
Раздел руководства по миграции https://www.tensorflow.org/guide/migrate/model_mapping#incremental_migration_to_native_tf2 содержит более подробную информацию по поэтапной миграции этих использований к tf.Variable.
Примечание: Аргументpartitionerнесовместим с поведением TF2, даже при использованииtf.compat.v1.keras.utils.track_tf1_style_variables. Его можно заменить на использованиеParameterServerStrategyи его партиционеров. Подробнее см. руководство по миграции для многопроцессорной CPU/GPU-тренировки https://www.tensorflow.org/guide/migrate/multi_worker_cpu_gpu_training и руководства, на которые оно ссылается.
Описание
Эта функция добавляет префикс к имени с текущим областью переменных и выполняет проверки повторного использования. Подробное описание работы повторного использования см. в разделе «Как использовать области переменных» https://tensorflow.org/guide/variables. Вот базовый пример:
def foo():
with tf.variable_scope("foo", reuse=tf.AUTO_REUSE):
v = tf.get_variable("v", [1])
return v
v1 = foo() # Creates v.
v2 = foo() # Gets the same, existing v.
assert v1 == v2
Если инициализатор — None (по умолчанию), будет использоваться инициализатор по умолчанию, переданный в области переменных. Если и он None тоже, будет использоваться glorot_uniform_initializer. Инициализатор также может быть тензором, в этом случае переменная будет инициализирована этим значением и формой.
Аналогично, если регуляризатор — None (по умолчанию), будет использоваться регуляризатор по умолчанию, переданный в области переменных (если и он None тоже, то по умолчанию регуляризация не выполняется).
Если задан партиционер, возвращается PartitionedVariable. Обращение к этому объекту как к Tensor возвращает фрагменты, конкатенированные вдоль оси разбиения.
Доступны некоторые полезные партиционеры. См., например, variable_axis_size_partitioner и min_max_variable_partitioner.
| Аргументы | |
|---|---|
name | Имя новой или существующей переменной. |
shape | Форма новой или существующей переменной. |
dtype | Тип новой или существующей переменной (по умолчанию DT_FLOAT). |
initializer | Инициализатор для переменной, если она создаётся. Может быть объектом инициализатора или тензором. Если это тензор, его форма должна быть известна, если validate_shape — False. |
regularizer | Функция (тензор -> тензор или None); результат её применения к только что созданной переменной будет добавлен в коллекцию tf.GraphKeys.REGULARIZATION_LOSSES и может быть использован для регуляризации. |
trainable | Если True также добавить переменную в коллекцию графа GraphKeys.TRAINABLE_VARIABLES (см. tf.Variable). |
collections | Список ключей коллекций графа, в которые нужно добавить переменную. По умолчанию [GraphKeys.GLOBAL_VARIABLES] (см. tf.Variable). |
caching_device | Необязательная строка устройства или функция, описывающая, где переменная должна кэшироваться для чтения. По умолчанию — устройство переменной. Если не None, кэшируется на другом устройстве. Типичное использование — кэширование на устройстве, где находятся операции, использующие переменную, для избежания дублирования копирования через Switch и другие условные операторы. |
partitioner | Необязательная вызываемая функция, принимающая полностью определённую TensorShape и dtype создаваемой переменной и возвращающая список разбиений для каждой оси (в настоящее время может быть разделена только одна ось). |
validate_shape | Если False, позволяет инициализировать переменную значением неизвестной формы. Если True (по умолчанию), форма initial_value должна быть известна. Для использования этого параметра инициализатор должен быть тензором, а не объектом инициализатора. |
use_resource | Если False, создаёт обычную переменную. Если True, создаёт экспериментальную ResourceVariable вместо неё с чётко определённой семантикой. По умолчанию False (в дальнейшем будет изменено на True). Когда включено eager execution, этот аргумент всегда принудительно устанавливается в True. |
custom_getter | Вызываемая функция, принимающая в качестве первого аргумента истинный getter и позволяющая переопределять внутренний метод get_variable. Подпись custom_getter должна соответствовать подписи этого метода, но наиболее надёжная версия позволит изменения: def custom_getter(getter, *args, **kwargs). Также разрешен прямой доступ ко всем get_variable параметрам: def custom_getter(getter, name, *args, **kwargs). Простой пользовательский getter-идентификатор, который просто создаёт переменные с изменёнными именами: def custom_getter(getter, name, *args, **kwargs): return getter(name + '_suffix', *args, **kwargs) |
constraint | Необязательная функция проекции, которая применяется к переменной после её обновления операцией Optimizer (например, используется для реализации ограничений нормы или ограничений значения для весов слоёв). Функция должна принимать в качестве входного значения не спроецированный тензор, представляющий значение переменной, и возвращать тензор спроецированного значения (форма которого должна быть такой же). Ограничения не безопасны при использовании при асинхронной распределённой тренировке. |
synchronization | Указывает, когда распределённая переменная будет агрегироваться. Допустимые значения — константы, определённые в классе tf.VariableSynchronization. По умолчанию синхронизация установлена в AUTO, и текущий DistributionStrategy выбирает время синхронизации. |
aggregation | Указывает, как распределённая переменная будет агрегироваться. Допустимые значения — константы, определённые в классе tf.VariableAggregation. |
| Возвращает | |
|---|---|
Созданная или существующая Variable (или PartitionedVariable, если использовался партиционер). |
| Исключения | |
|---|---|
ValueError | при создании новой переменной и отсутствии объявленной формы, при нарушении повторного использования при создании переменной или при несовпадении типа initializer и dtype. Повторное использование задаётся внутри variable_scope |
© 2022 The TensorFlow Authors. All rights reserved.
Licensed under the Creative Commons Attribution License 4.0.
Code samples licensed under the Apache 2.0 License.
https://www.tensorflow.org/versions/r2.9/api_docs/python/tf/compat/v1/get_variable