tf.Variable

См. руководство по переменным.

tf.Variable(
    initial_value=None,
    trainable=None,
    validate_shape=True,
    caching_device=None,
    name=None,
    variable_def=None,
    dtype=None,
    import_scope=None,
    constraint=None,
    synchronization=tf.VariableSynchronization.AUTO,
    aggregation=tf.compat.v1.VariableAggregation.NONE,
    shape=None,
    experimental_enable_variable_lifting=True
)

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

Используется в руководстве	Используется в учебниках
Миграция контрольных точек модели Введение в градиенты и автоматическое дифференцирование Введение в переменные Расширенное автоматическое дифференцирование Улучшение производительности с tf.function	Масштабируемое сжатие модели Пользовательский цикл обучения с Keras и MultiWorkerMirroredStrategy Нейронный стиль трансфер Обучение сжатию данных Зоопарк обучаемых распределений

Переменная сохраняет общие, постоянные данные, изменяемые программой.

Конструктор Variable() требует начального значения для переменной, которое может быть Tensor любого типа и формы. Это начальное значение определяет тип и форму переменной. После создания тип и форма переменной фиксируются. Значение можно изменить, используя один из методов присваивания.

v = tf.Variable(1.)
v.assign(2.)
<tf.Variable ... shape=() dtype=float32, numpy=2.0>
v.assign_add(0.5)
<tf.Variable ... shape=() dtype=float32, numpy=2.5>

Аргумент shape в конструкторе Variable позволяет создать переменную с менее определенной формой, чем ее initial_value:

v = tf.Variable(1., shape=tf.TensorShape(None))
v.assign([[1.]])
<tf.Variable ... shape=<unknown> dtype=float32, numpy=array([[1.]], ...)>

Как и любая Tensor, переменные, созданные с помощью Variable(), могут использоваться в качестве входных данных для операций. Кроме того, все перегруженные операторы для класса Tensor переносятся на переменные.

w = tf.Variable([[1.], [2.]])
x = tf.constant([[3., 4.]])
tf.matmul(w, x)
<tf.Tensor:... shape=(2, 2), ... numpy=
  array([[3., 4.],
         [6., 8.]], dtype=float32)>
tf.sigmoid(w + x)
<tf.Tensor:... shape=(2, 2), ...>

При построении модели машинного обучения часто удобно различать переменные, содержащие обучаемые параметры модели, и другие переменные, такие как переменная step, используемая для подсчёта шагов обучения. Чтобы упростить это, конструктор переменной поддерживает параметр trainable=<bool>. tf.GradientTape по умолчанию отслеживает обучаемые переменные:

with tf.GradientTape(persistent=True) as tape:
  trainable = tf.Variable(1.)
  non_trainable = tf.Variable(2., trainable=False)
  x1 = trainable * 2.
  x2 = non_trainable * 3.
tape.gradient(x1, trainable)
<tf.Tensor:... shape=(), dtype=float32, numpy=2.0>
assert tape.gradient(x2, non_trainable) is None  # Unwatched

Переменные автоматически отслеживаются при назначении атрибутам типов, унаследованных от tf.Module.

m = tf.Module()
m.v = tf.Variable([1.])
m.trainable_variables
(<tf.Variable ... shape=(1,) ... numpy=array([1.], dtype=float32)>,)

Это отслеживание затем позволяет сохранять значения переменных в контрольных точках обучения или в SavedModels, которые включают сериализованные графики TensorFlow.

Переменные часто захватываются и обрабатываются tf.function. Это работает так же, как и у не-декорированной функции:

v = tf.Variable(0.)
read_and_decrement = tf.function(lambda: v.assign_sub(0.1))
read_and_decrement()
<tf.Tensor: shape=(), dtype=float32, numpy=-0.1>
read_and_decrement()
<tf.Tensor: shape=(), dtype=float32, numpy=-0.2>

Переменные, созданные внутри tf.function, должны принадлежать за пределами функции и создаваться только один раз:

class M(tf.Module):
  @tf.function
  def __call__(self, x):
    if not hasattr(self, "v"):  # Or set self.v to None in __init__
      self.v = tf.Variable(x)
    return self.v * x
m = M()
m(2.)
<tf.Tensor: shape=(), dtype=float32, numpy=4.0>
m(3.)
<tf.Tensor: shape=(), dtype=float32, numpy=6.0>
m.v
<tf.Variable ... shape=() dtype=float32, numpy=2.0>

См. документацию по tf.function для получения подробностей.

END_OF_DOCUMENT_MARKER

Args
`initial_value`	A `Tensor`, or Python object convertible to a `Tensor`, which is the initial value for the Variable. The initial value must have a shape specified unless `validate_shape` is set to False. Can also be a callable with no argument that returns the initial value when called. In that case, `dtype` must be specified. (Note that initializer functions from init_ops.py must first be bound to a shape before being used here.)
`trainable`	If `True`, GradientTapes automatically watch uses of this variable. Defaults to `True`, unless `synchronization` is set to `ON_READ`, in which case it defaults to `False`.
`validate_shape`	If `False`, allows the variable to be initialized with a value of unknown shape. If `True`, the default, the shape of `initial_value` must be known.
`caching_device`	Note: This argument is only valid when using a v1-style `Session`. Optional device string describing where the Variable should be cached for reading. Defaults to the Variable's device. If not `None`, caches on another device. Typical use is to cache on the device where the Ops using the Variable reside, to deduplicate copying through `Switch` and other conditional statements.
`name`	Optional name for the variable. Defaults to `'Variable'` and gets uniquified automatically.
`variable_def`	`VariableDef` protocol buffer. If not `None`, recreates the Variable object with its contents, referencing the variable's nodes in the graph, which must already exist. The graph is not changed. `variable_def` and the other arguments are mutually exclusive.
`dtype`	If set, initial_value will be converted to the given type. If `None`, either the datatype will be kept (if `initial_value` is a Tensor), or `convert_to_tensor` will decide.
`import_scope`	Optional имя области именования. Name scope to add to the `Variable.` Only used when initializing from protocol buffer.
`constraint`	An optional projection function to be applied to the variable after being updated by an `Optimizer` (e.g. used to implement norm constraints or value constraints for layer weights). The function must take as input the unprojected Tensor representing the value of the variable and return the Tensor for the projected value (which must have the same shape). Constraints are not safe to use when doing asynchronous distributed training.
`synchronization`	Indicates when a distributed variable will be aggregated. Accepted values are constants defined in the class `tf.VariableSynchronization`. By default the synchronization is set to `AUTO` and the current `DistributionStrategy` chooses when to synchronize.
`aggregation`	Indicates how a distributed variable will be aggregated. Accepted values are constants defined in the class `tf.VariableAggregation`.
`shape`	(optional) The shape of this variable. If None, the shape of `initial_value` will be used. When setting this argument to `tf.TensorShape(None)` (representing an unspecified shape), the variable can be assigned with values of different shapes.
`experimental_enable_variable_lifting`	Whether to lift the variable out if it's in a `tf.function`. Default is `True`. When this argument is `True`, variable creation will follow the behavior and restrictions described here. If this argument is `False`, that description doesn't apply, and you can freely create and use the variable in the `tf.function`, as if it's a "mutable `tf.Tensor`". You can't return the variable though.

Raises
`ValueError`	If both `variable_def` and initial_value are specified.
`ValueError`	If the initial value is not specified, or does not have a shape and `validate_shape` is `True`.

Attributes
`aggregation`
`constraint`	Returns the constraint function associated with this variable.
`device`	The device of this variable.
`dtype`	The `DType` of this variable.
`graph`	The `Graph` of this variable.
`initial_value`	Returns the Tensor used as the initial value for the variable. Note that this is different from `initialized_value()` which runs the op that initializes the variable before returning its value. This method returns the tensor that is used by the op that initializes the variable.
`initializer`	The initializer operation for this variable.
`name`	The name of this variable.
`op`	The `Operation` of this variable.
`shape`	The `TensorShape` of this variable.
`synchronization`
`trainable`

Child Classes

class SaveSliceInfo

Methods

`assign`

View source

assign(
    value, use_locking=False, name=None, read_value=True
)

Присваивает новое значение переменной.

Это по существу сокращение для assign(self, value).

Args
`value`	A `Tensor`. Новое значение для этой переменной.
`use_locking`	If `True`, use locking during the assignment.
`name`	The name of the operation to be created
`read_value`	if True, will return something which evaluates to the new value of the variable; if False will return the assign op.

Returns
Обновлённая переменная. Если `read_value` ложно, вместо этого возвращает None в режиме Eager и операцию присваивания в режиме графа.

`assign_add`

View source

assign_add(
    delta, use_locking=False, name=None, read_value=True
)

Добавляет значение к этой переменной.

Это по существу сокращение для assign_add(self, delta).

Args
`delta`	A `Tensor`. Значение, которое нужно добавить к этой переменной.
`use_locking`	If `True`, use locking during the operation.
`name`	The name of the operation to be created
`read_value`	if True, will return something which evaluates to the new value of the variable; if False will return the assign op.

Returns
Обновлённая переменная. Если `read_value` ложно, вместо этого возвращает None в режиме Eager и операцию присваивания в режиме графа.

`assign_sub`

View source

assign_sub(
    delta, use_locking=False, name=None, read_value=True
)

Вычитает значение из этой переменной.

Это по существу сокращение для assign_sub(self, delta).

Args
`delta`	A `Tensor`. Значение, которое нужно вычесть из этой переменной.
`use_locking`	If `True`, use locking during the operation.
`name`	The name of the operation to be created
`read_value`	if True, will return something which evaluates to the new value of the variable; if False will return the assign op.

Returns
Обновлённая переменная. Если `read_value` ложно, вместо этого возвращает None в режиме Eager и операцию присваивания в режиме графа.

`batch_scatter_update`

View source

batch_scatter_update(
    sparse_delta, use_locking=False, name=None
)

Присваивает tf.IndexedSlices этой переменной поблочно.

Аналогично batch_gather. Предполагается, что у этой переменной и SparseDelta IndexedSlices есть ряд ведущих измерений, которые одинаковы для всех из них, а обновления выполняются на последнем измерении индексов. Другими словами, размеры должны быть следующими:

num_prefix_dims = sparse_delta.indices.ndims - 1 batch_dim = num_prefix_dims + 1 sparse_delta.updates.shape = sparse_delta.indices.shape + var.shape[ batch_dim:]

где

sparse_delta.updates.shape[:num_prefix_dims] == sparse_delta.indices.shape[:num_prefix_dims] == var.shape[:num_prefix_dims]

И выполняемая операция может быть выражена как:

var[i_1, ..., i_n, sparse_delta.indices[i_1, ..., i_n, j]] = sparse_delta.updates[ i_1, ..., i_n, j]

Когда sparse_delta.indices — это тензор размерности 1, эта операция эквивалентна scatter_update.

Чтобы избежать этой операции, можно перебрать первые ndims переменной и использовать scatter_update на подтензорах, полученных путём среза первой размерности. Это допустимый вариант для ndims = 1, но менее эффективный, чем данная реализация.

Аргументы
`sparse_delta`	`tf.IndexedSlices` для назначения этой переменной.
`use_locking`	Если `True`, использовать блокировку во время выполнения операции.
`name`	Имя операции.

Возвращаемое значение
Обновлённая переменная.

Исключения
`TypeError`	Если `sparse_delta` не является `IndexedSlices`.

Аргументы
`indices`	Переменная. Должна быть одного из следующих типов: `int32`, `int64`. Индексный тензор.
`name`	Имя операции (необязательно).

Аргументы
`value`	Новое значение переменной.
`session`	Сессия, используемая для оценки этой переменной. Если нет, используется сессия по умолчанию.

Args
`sparse_delta`	`tf.IndexedSlices` для добавления к этой переменной.
`use_locking`	Если `True`, использовать блокировку во время операции.
`name`	имя операции.

Args
`sparse_delta`	`tf.IndexedSlices` для деления этой переменной.
`use_locking`	Если `True`, использовать блокировку во время операции.
`name`	имя операции.

Args
`sparse_delta`	`tf.IndexedSlices` для использования в операции max с этой переменной.
`use_locking`	Если `True`, использовать блокировку во время операции.
`name`	имя операции.

Args
`sparse_delta`	`tf.IndexedSlices` для умножения на эту переменную.
`use_locking`	Если `True`, использовать блокировку во время операции.
`name`	имя операции.

Args
`indices`	Индексы для использования в операции.
`updates`	Значения для использования в операции.
`name`	Имя операции.

Аргументы
`indices`	Индексы, которые будут использоваться в операции.
`updates`	Значения, которые будут использоваться в операции.
`name`	имя операции.

Аргументы
`sparse_delta`	`tf.IndexedSlices`, которые нужно вычесть из этой переменной.
`True`	Если значение истинно, использовать блокировку во время операции.
`name`	имя операции.

Аргументы
`sparse_delta`	`tf.IndexedSlices`, которые нужно присвоить этой переменной.
`True`	Если значение истинно, использовать блокировку во время операции.
`name`	имя операции.

Аргументы
`indices`	Индекс `Tensor`. Должен быть одного из следующих типов: `int32`, `int64`. Должен быть в пределах `[0, params.shape[axis])`.
`name`	Имя операции (необязательно).

Аргументы
`x`	Переменная `Tensor`. Должен быть одного из следующих типов: `float32`, `float64`, `int32`, `uint8`, `int16`, `int8`, `int64`, `bfloat16`, `uint16`, `half`, `uint32`, `uint64`.
`y`	Переменная `Tensor`. Должен иметь тот же тип, что и `x`.
`name`	Имя операции (необязательно).

Аргументы
`var`	Объект `ops.Variable`.
`slice_spec`	Аргументы для `Tensor.getitem`.

Исключения
`ValueError`	Если размер среза отрицательный.
`TypeError`	TypeError: Если индексы среза не являются целыми числами, слайсами, эллипсами, tf.newaxis или тензорами типа int32/int64.

Аргументы
`x`	Объект `Tensor`. Должен быть одного из следующих типов: `float32`, `float64`, `int32`, `uint8`, `int16`, `int8`, `int64`, `bfloat16`, `uint16`, `half`, `uint32`, `uint64`.
`y`	Объект `Tensor`. Должен иметь тот же тип, что и `x`.
`name`	Имя операции (необязательно).

tf.Variable

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

Child Classes

Methods

assign

assign_add

assign_sub

batch_scatter_update

scatter_div

scatter_max

scatter_min

scatter_mul

scatter_nd_add

scatter_nd_sub

scatter_nd_update

scatter_sub

scatter_update

set_shape

sparse_read

to_proto

value

__abs__

__add__

__and__

__div__

__eq__

__floordiv__

__ge__

Пример:

__getitem__

__gt__

Пример:

__invert__

__iter__

__le__

Пример:

__lt__

Пример:

__matmul__

__mod__

__mul__

__ne__

__neg__

__or__

__pow__

__radd__

__rand__

__rdiv__

__rfloordiv__

__rmatmul__

__rmod__

__rmul__

__ror__

__rpow__

__rsub__

__rtruediv__

__rxor__

__sub__

__truediv__

__xor__

`assign`

`assign_add`

`assign_sub`

`batch_scatter_update`

`scatter_div`

`scatter_max`

`scatter_min`

`scatter_mul`

`scatter_nd_add`

`scatter_nd_sub`

`scatter_nd_update`

`scatter_sub`

`scatter_update`

`set_shape`

`sparse_read`

`to_proto`

`value`

`abs`

`add`

`and`

`div`

`eq`

`floordiv`

`ge`

`getitem`

`gt`

`invert`

`iter`

`le`

`lt`

`matmul`

`mod`

`mul`

`ne`

`neg`

`or`

`pow`

`radd`

`rand`

`rdiv`

`rfloordiv`

`rmatmul`

`rmod`

`rmul`

`ror`

`rpow`

`rsub`

`rtruediv`

`rxor`

`sub`

`truediv`

`xor`