tf.experimental.dtensor.DVariable

Замена tf.Variable, учитывающая размещение начального значения.

Наследует от: Variable

tf.experimental.dtensor.DVariable(
    initial_value, *args, dtype=None, **kwargs
)

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

Класс также обрабатывает операции сохранения и восстановления в DTensor. Обратите внимание: в данный момент DVariable может использовать обычный tf.Variable, если initial_value не является DTensor.

Дочерние классы

class SaveSliceInfo

Методы

assign

Посмотреть исходный код

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

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

assign_add

Посмотреть исходный код

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

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

assign_sub

Посмотреть исходный код

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

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

batch_scatter_update

Посмотреть исходный код

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

Пакетно присваивает этой переменной значения tf.IndexedSlices.

Аналогично batch_gather. Предполагается, что эта переменная и разреженный тензор sparse_delta 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 — это одномерный тензор, эта операция эквивалентна scatter_update.

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

count_up_to

Посмотреть исходный код

count_up_to(
    limit
)

Увеличивает значение этой переменной, пока оно не достигнет limit. (устарело)

При выполнении этой операции значение переменной увеличивается на 1. Если в результате увеличения значение переменной превысит limit, операция вызовет исключение OutOfRangeError.

Если ошибка не возникает, операция возвращает значение переменной до увеличения.

По сути, это краткая форма записи count_up_to(self, limit).

eval

Посмотреть исходный код

eval(
    session=None
)

Вычисляет и возвращает значение этой переменной.

experimental_ref

Посмотреть исходный код

experimental_ref()

УСТАРЕВШАЯ ФУНКЦИЯ

from_proto

Посмотреть исходный код

@staticmethod
from_proto(
    variable_def, import_scope=None
)

Возвращает объект Variable, созданный из variable_def.

gather_nd

Посмотреть исходный код

gather_nd(
    indices, name=None
)

Разреженно считывает значение этой переменной с помощью gather_nd.

get_shape

Посмотреть исходный код

get_shape() -> tf.TensorShape

Псевдоним Variable.shape.

initialized_value

Посмотреть исходный код

initialized_value()

Возвращает значение инициализированной переменной. (устарело)

Используйте этот метод вместо самой переменной, чтобы инициализировать другую переменную значением, зависящим от значения этой переменной.

# Initialize 'v' with a random tensor.
v = tf.Variable(tf.random.truncated_normal([10, 40]))
# Use `initialized_value` to guarantee that `v` has been
# initialized before its value is used to initialize `w`.
# The random values are picked only once.
w = tf.Variable(v.initialized_value() * 2.0)

is_initialized

Посмотреть исходный код

is_initialized(
    name=None
)

Проверяет, инициализирована ли переменная-ресурс.

Выводит скалярное булево значение, указывающее, инициализирован ли тензор.

load

Посмотреть исходный код

load(
    value, session=None
)

Загружает в эту переменную новое значение. (устарело)

Записывает новое значение в память переменной. Не добавляет операции в граф.

Для этого метода требуется сеанс, в котором запущен граф, содержащий эту переменную. Если сеанс не передан, используется сеанс по умолчанию. Дополнительные сведения о запуске графа и сеансах см. в разделе tf.compat.v1.Session.

v = tf.Variable([1, 2])
init = tf.compat.v1.global_variables_initializer()

with tf.compat.v1.Session() as sess:
    sess.run(init)
    # Usage passing the session explicitly.
    v.load([2, 3], sess)
    print(v.eval(sess)) # prints [2 3]
    # Usage with the default session.  The 'with' block
    # above makes 'sess' the default session.
    v.load([3, 4], sess)
    print(v.eval()) # prints [3 4]

numpy

Посмотреть исходный код

numpy()

read_value

Посмотреть исходный код

read_value()

Создаёт операцию, считывающую значение этой переменной.

Используйте этот метод при нескольких операциях чтения или если значение нужно считывать только после выполнения некоторого условия.

read_value_no_copy

Посмотреть исходный код

read_value_no_copy()

Создаёт операцию, считывающую значение этой переменной без копирования.

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

ref

Посмотреть исходный код

ref()

Возвращает хешируемый объект-ссылку на эту Variable.

Основной сценарий использования этого API — добавление переменных в множество или словарь. Мы не можем добавлять переменные в множество или словарь, поскольку variable.__hash__() больше недоступен начиная с TensorFlow 2.0.

Следующий код будет вызывать исключение начиная с версии 2.0

x = tf.Variable(5)
y = tf.Variable(10)
z = tf.Variable(10)
variable_set = {x, y, z}
Traceback (most recent call last):

TypeError: Variable is unhashable. Instead, use tensor.ref() as the key.
variable_dict = {x: 'five', y: 'ten'}
Traceback (most recent call last):

TypeError: Variable is unhashable. Instead, use tensor.ref() as the key.

Вместо этого можно использовать variable.ref().

variable_set = {x.ref(), y.ref(), z.ref()}
x.ref() in variable_set
True
variable_dict = {x.ref(): 'five', y.ref(): 'ten', z.ref(): 'ten'}
variable_dict[y.ref()]
'ten'

Кроме того, объект-ссылка предоставляет функцию .deref(), которая возвращает исходную Variable.

x = tf.Variable(5)
x.ref().deref()
<tf.Variable 'Variable:0' shape=() dtype=int32, numpy=5>

scatter_add

Посмотреть исходный код

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

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

scatter_div

Посмотреть исходный код

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

Делит эту переменную на tf.IndexedSlices.

scatter_max

Посмотреть исходный код

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

Обновляет эту переменную, присваивая ей максимум из tf.IndexedSlices и её текущего значения.

scatter_min

Посмотреть исходный код

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

Обновляет эту переменную, присваивая ей минимум из tf.IndexedSlices и её текущего значения.

scatter_mul

Посмотреть исходный код

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

Умножает эту переменную на tf.IndexedSlices.

scatter_nd_add

Посмотреть исходный код

scatter_nd_add(
    indices, updates, name=None
)

Выполняет разреженное сложение для отдельных значений или срезов переменной.

ref — это Tensor ранга P, а indices — это Tensor ранга Q.

indices должен быть целочисленным тензором, содержащим индексы в ref. Он должен иметь форму [d_0, ..., d_{Q-2}, K], где 0 < K <= P.

Внутреннее измерение indices (длиной K) соответствует индексам элементов (если K = P) или срезов (если K < P) вдоль измерения номер K в ref.

updates — это Tensor ранга Q-1+P-K с формой:

[d_0, ..., d_{Q-2}, ref.shape[K], ..., ref.shape[P-1]].

Например, предположим, что мы хотим добавить 4 разбросанных элемента в тензор ранга 1 из 8 элементов. В Python это обновление выглядело бы так:

ref = tf.Variable([1, 2, 3, 4, 5, 6, 7, 8])
indices = tf.constant([[4], [3], [1] ,[7]])
updates = tf.constant([9, 10, 11, 12])
add = ref.scatter_nd_add(indices, updates)
with tf.compat.v1.Session() as sess:
  print sess.run(add)

В результате ref будет обновлён следующим образом:

[1, 13, 3, 14, 14, 6, 7, 20]

Подробнее об обновлении срезов см. в разделе tf.scatter_nd.

scatter_nd_max

Посмотреть исходный код

scatter_nd_max(
    indices, updates, name=None
)

Обновляет эту переменную, устанавливая максимум из tf.IndexedSlices и её текущего значения.

ref — это Tensor ранга P, а indices — это Tensor ранга Q.

indices должен быть целочисленным тензором, содержащим индексы в ref. Он должен иметь форму [d_0, ..., d_{Q-2}, K], где 0 < K <= P.

Внутреннее измерение indices (длиной K) соответствует индексам элементов (если K = P) или срезов (если K < P) вдоль измерения номер K в ref.

updates — это Tensor ранга Q-1+P-K с формой:

[d_0, ..., d_{Q-2}, ref.shape[K], ..., ref.shape[P-1]].

Подробнее об обновлении срезов см. в разделе tf.scatter_nd.

scatter_nd_min

Посмотреть исходный код

scatter_nd_min(
    indices, updates, name=None
)

Обновляет эту переменную, устанавливая минимум из tf.IndexedSlices и её текущего значения.

ref — это Tensor ранга P, а indices — это Tensor ранга Q.

indices должен быть целочисленным тензором, содержащим индексы в ref. Он должен иметь форму [d_0, ..., d_{Q-2}, K], где 0 < K <= P.

Внутреннее измерение indices (длиной K) соответствует индексам элементов (если K = P) или срезов (если K < P) вдоль измерения номер K в ref.

updates — это Tensor ранга Q-1+P-K с формой:

[d_0, ..., d_{Q-2}, ref.shape[K], ..., ref.shape[P-1]].

Подробнее об обновлении срезов см. в разделе tf.scatter_nd.

scatter_nd_sub

Посмотреть исходный код

scatter_nd_sub(
    indices, updates, name=None
)

Выполняет разреженное вычитание отдельных значений или срезов в Variable.

ref — это Tensor ранга P, а indices — это Tensor ранга Q.

indices должен быть целочисленным тензором, содержащим индексы в ref. Он должен иметь форму [d_0, ..., d_{Q-2}, K], где 0 < K <= P.

Внутреннее измерение indices (длиной K) соответствует индексам элементов (если K = P) или срезов (если K < P) вдоль измерения номер K в ref.

updates — это Tensor ранга Q-1+P-K с формой:

[d_0, ..., d_{Q-2}, ref.shape[K], ..., ref.shape[P-1]].

Например, предположим, что мы хотим добавить 4 разбросанных элемента в тензор ранга 1 из 8 элементов. В Python это обновление выглядело бы так:

ref = tf.Variable([1, 2, 3, 4, 5, 6, 7, 8])
indices = tf.constant([[4], [3], [1] ,[7]])
updates = tf.constant([9, 10, 11, 12])
op = ref.scatter_nd_sub(indices, updates)
with tf.compat.v1.Session() as sess:
  print sess.run(op)

В результате ref будет обновлён следующим образом:

[1, -9, 3, -6, -6, 6, 7, -4]

Подробнее об обновлении срезов см. в разделе tf.scatter_nd.

scatter_nd_update

Посмотреть исходный код

scatter_nd_update(
    indices, updates, name=None
)

Выполняет разреженное присваивание отдельных значений или срезов в Variable.

ref — это Tensor ранга P, а indices — это Tensor ранга Q.

indices должен быть целочисленным тензором, содержащим индексы в ref. Он должен иметь форму [d_0, ..., d_{Q-2}, K], где 0 < K <= P.

Внутреннее измерение indices (длиной K) соответствует индексам элементов (если K = P) или срезов (если K < P) вдоль измерения номер K в ref.

updates — это Tensor ранга Q-1+P-K с формой:

[d_0, ..., d_{Q-2}, ref.shape[K], ..., ref.shape[P-1]].

Например, предположим, что мы хотим добавить 4 разбросанных элемента в тензор ранга 1 из 8 элементов. В Python это обновление выглядело бы так:

ref = tf.Variable([1, 2, 3, 4, 5, 6, 7, 8])
indices = tf.constant([[4], [3], [1] ,[7]])
updates = tf.constant([9, 10, 11, 12])
op = ref.scatter_nd_update(indices, updates)
with tf.compat.v1.Session() as sess:
  print sess.run(op)

В результате ref будет обновлён следующим образом:

[1, 11, 3, 10, 9, 6, 7, 12]

Подробнее об обновлении срезов см. в разделе tf.scatter_nd.

scatter_sub

Посмотреть исходный код

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

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

scatter_update

Посмотреть исходный код

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

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

set_shape

Посмотреть исходный код

set_shape(
    shape
)

Переопределяет форму этой переменной.

sparse_read

Посмотреть исходный код

sparse_read(
    indices, name=None
)

Разреженно считывает значение этой переменной, используя gather.

to_proto

Посмотреть исходный код

to_proto(
    export_scope=None
)

Преобразует ResourceVariable в протокол буфера VariableDef.

value

Посмотреть исходный код

value()

Кэшированная операция, считывающая значение этой переменной.

__abs__

Посмотреть исходный код

__abs__(
    name=None
)

__add__

Посмотреть исходный код

__add__(
    y
)

__and__

Посмотреть исходный код

__and__(
    y
)

__array__

Посмотреть исходный код

__array__(
    dtype=None
)

Позволяет напрямую преобразовать значение в массив numpy.

np.array(tf.Variable([1.0]))
array([1.], dtype=float32)

__bool__

Посмотреть исходный код

__bool__()

__div__

Посмотреть исходный код

__div__(
    y
)

__eq__

Посмотреть исходный код

__eq__(
    other
)

Поэлементно сравнивает две переменные на равенство.

__floordiv__

Посмотреть исходный код

__floordiv__(
    y
)

__ge__

__ge__(
    y: Annotated[Any, tf.raw_ops.Any],
    name=None
) -> Annotated[Any, tf.raw_ops.Any]

Поэлементно возвращает истинность выражения (x >= y).

Примечание: math.greater_equal поддерживает широковещательное вещание. Подробнее о широковещательном вещании — здесь

Пример:

x = tf.constant([5, 4, 6, 7])
y = tf.constant([5, 2, 5, 10])
tf.math.greater_equal(x, y) ==> [True, True, True, False]

x = tf.constant([5, 4, 6, 7])
y = tf.constant([5])
tf.math.greater_equal(x, y) ==> [True, False, True, True]

__getitem__

Посмотреть исходный код

__getitem__(
    slice_spec
)

Создаёт вспомогательный объект среза для заданной переменной.

Это позволяет создать подтензор из части текущего содержимого переменной. Подробные примеры создания срезов см. в разделе tf.Tensor.getitem.

Кроме того, эта функция позволяет присваивать значения выбранному диапазону. Это аналогично функциональности __setitem__ в Python. Однако синтаксис отличается, чтобы пользователь мог сохранить операцию присваивания для группировки или передачи в sess.run() в TF1. Например:

import tensorflow as tf
A = tf.Variable([[1,2,3], [4,5,6], [7,8,9]], dtype=tf.float32)
print(A[:2, :2])  # => [[1,2], [4,5]]

A[:2,:2].assign(22. * tf.ones((2, 2))))
print(A) # => [[22, 22, 3], [22, 22, 6], [7,8,9]]

Обратите внимание, что присваивания пока не поддерживают семантику широковещательного вещания NumPy.

__gt__

__gt__(
    y: Annotated[Any, tf.raw_ops.Any],
    name=None
) -> Annotated[Any, tf.raw_ops.Any]

Поэлементно возвращает истинность выражения (x > y).

Примечание: math.greater поддерживает широковещательное вещание. Подробнее о широковещательном вещании — здесь

Пример:

x = tf.constant([5, 4, 6])
y = tf.constant([5, 2, 5])
tf.math.greater(x, y) ==> [False, True, True]

x = tf.constant([5, 4, 6])
y = tf.constant([5])
tf.math.greater(x, y) ==> [False, False, True]

__invert__

Посмотреть исходный код

__invert__(
    name=None
)

__iter__

Посмотреть исходный код

__iter__()

При eager-выполнении выполняет итерацию по значению переменной.

__le__

__le__(
    y: Annotated[Any, tf.raw_ops.Any],
    name=None
) -> Annotated[Any, tf.raw_ops.Any]

Поэлементно возвращает истинность выражения (x <= y).

Примечание: math.less_equal поддерживает широковещательное вещание. Подробнее о широковещательном вещании — здесь

Пример:

x = tf.constant([5, 4, 6])
y = tf.constant([5])
tf.math.less_equal(x, y) ==> [True, True, False]

x = tf.constant([5, 4, 6])
y = tf.constant([5, 6, 6])
tf.math.less_equal(x, y) ==> [True, True, True]

__lt__

__lt__(
    y: Annotated[Any, tf.raw_ops.Any],
    name=None
) -> Annotated[Any, tf.raw_ops.Any]

Поэлементно возвращает истинность выражения (x < y).

Примечание: math.less поддерживает широковещательное вещание. Подробнее о широковещательном вещании — здесь

Пример:

x = tf.constant([5, 4, 6])
y = tf.constant([5])
tf.math.less(x, y) ==> [False, True, False]

x = tf.constant([5, 4, 6])
y = tf.constant([5, 6, 7])
tf.math.less(x, y) ==> [False, True, True]

__matmul__

Посмотреть исходный код

__matmul__(
    y
)

__mod__

Посмотреть исходный код

__mod__(
    y
)

__mul__

Посмотреть исходный код

__mul__(
    y
)

__ne__

Посмотреть исходный код

__ne__(
    other
)

Поэлементно сравнивает две переменные на равенство.

__neg__

__neg__(
    name=None
) -> Annotated[Any, tf.raw_ops.Any]

Вычисляет поэлементное отрицательное значение.

То есть \(y = -x\).

__nonzero__

Посмотреть исходный код

__nonzero__()

__or__

Посмотреть исходный код

__or__(
    y
)

__pow__

Посмотреть исходный код

__pow__(
    y
)

__radd__

Посмотреть исходный код

__radd__(
    x
)

__rand__

Посмотреть исходный код

__rand__(
    x
)

__rdiv__

Посмотреть исходный код

__rdiv__(
    x
)

__rfloordiv__

Посмотреть исходный код

__rfloordiv__(
    x
)

__rmatmul__

Посмотреть исходный код

__rmatmul__(
    x
)

__rmod__

Посмотреть исходный код

__rmod__(
    x
)

__rmul__

Посмотреть исходный код

__rmul__(
    x
)

__ror__

Посмотреть исходный код

__ror__(
    x
)

__rpow__

Посмотреть исходный код

__rpow__(
    x
)

__rsub__

Посмотреть исходный код

__rsub__(
    x
)

__rtruediv__

Посмотреть исходный код

__rtruediv__(
    x
)

__rxor__

Посмотреть исходный код

__rxor__(
    x
)

__sub__

Посмотреть исходный код

__sub__(
    y
)

__truediv__

Посмотреть исходный код

__truediv__(
    y
)

__xor__

Посмотреть исходный код

__xor__(
    y
)