Семантика операции

Ниже описывается семантика операций, определенных в интерфейсе XlaBuilder . Обычно эти операции однозначно сопоставляются с операциями, определенными в интерфейсе RPC в xla_data.proto .

Примечание по номенклатуре: обобщенный тип данных, с которым работает XLA, представляет собой N-мерный массив, содержащий элементы некоторого универсального типа (например, 32-битное число с плавающей запятой). В документации массив используется для обозначения массива произвольной размерности. Для удобства особые случаи имеют более конкретные и привычные названия; например, вектор — это одномерный массив, а матрица — двумерный массив.

После всего

См. также XlaBuilder::AfterAll .

AfterAll принимает переменное количество токенов и создает один токен. Токены — это примитивные типы, которые можно объединять между побочными операциями для обеспечения порядка. AfterAll можно использовать как объединение токенов для упорядочивания операции после набора операций.

AfterAll(operands)

Всесобрать

См. также XlaBuilder::AllGather .

Выполняет объединение реплик.

AllGather(operand, all_gather_dim, shard_count, replica_group_ids, channel_id)

• replica_groups — список групп реплик, между которыми выполняется конкатенация (идентификатор реплики для текущей реплики можно получить с помощью ReplicaId ). Порядок реплик в каждой группе определяет порядок, в котором их входы располагаются в результате. replica_groups должны быть либо пустыми (в этом случае все реплики принадлежат одной группе, упорядоченной от 0 до N - 1 ), либо содержать то же количество элементов, что и количество реплик. Например, replica_groups = {0, 2}, {1, 3} выполняет конкатенацию между репликами 0 и 2 , а также 1 и 3 .
• shard_count — размер каждой группы реплик. Нам это нужно в тех случаях, когда replica_groups пусты.
• channel_id используется для межмодульной связи: только операции all-gather с одинаковым channel_id могут взаимодействовать друг с другом.

Выходная форма — это входная форма, в которой all_gather_dim увеличен в разы shard_count . Например, если есть две реплики и операнд имеет значение [1.0, 2.5] и [3.0, 5.25] соответственно для двух реплик, то выходное значение этой операции, где all_gather_dim равно 0 будет [1.0, 2.5, 3.0, 5.25] на обеих репликах.

AllReduce

См. также XlaBuilder::AllReduce .

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

AllReduce(operand, computation, replica_group_ids, channel_id)

• Если operand представляет собой кортеж массивов, полное сокращение выполняется для каждого элемента кортежа.
• replica_groups — список групп реплик, между которыми выполняется сокращение (идентификатор реплики для текущей реплики можно получить с помощью ReplicaId ). replica_groups должны быть либо пустыми (в этом случае все реплики принадлежат одной группе), либо содержать то же количество элементов, что и количество реплик. Например, replica_groups = {0, 2}, {1, 3} выполняет сокращение между репликами 0 и 2 , а также 1 и 3 .
• channel_id используется для межмодульной связи: только операции all-reduce с одинаковым channel_id могут взаимодействовать друг с другом.

Выходная форма такая же, как и входная. Например, если есть две реплики и операнд имеет значение [1.0, 2.5] и [3.0, 5.25] соответственно для двух реплик, то выходное значение этой операции и вычисления суммирования будет [4.0, 7.75] для обеих реплик. реплики. Если входные данные представляют собой кортеж, выходные данные также являются кортежами.

Для вычисления результата AllReduce требуется один вход от каждой реплики, поэтому, если одна реплика выполняет узел AllReduce больше раз, чем другая, то бывшая реплика будет ждать вечно. Поскольку все реплики выполняют одну и ту же программу, это может произойти не так уж и много способов, но это возможно, когда состояние цикла while зависит от данных из ввода, а поступающие данные заставляют цикл while повторяться больше раз. на одной реплике, чем на другой.

ВсеВсеВсе

См. также XlaBuilder::AllToAll .

AllToAll — это коллективная операция, которая отправляет данные со всех ядер на все ядра. Он имеет две фазы:

1. Фаза разброса. На каждом ядре операнд разбивается на число блоков split_count по split_dimensions , и блоки распределяются по всем ядрам, например, i-й блок отправляется на i-е ядро.
2. Фаза сбора. Каждое ядро ​​объединяет полученные блоки по concat_dimension .

Участвующие ядра можно настроить следующим образом:

• replica_groups : каждая ReplicaGroup содержит список идентификаторов реплик, участвующих в вычислении (идентификатор реплики для текущей реплики можно получить с помощью ReplicaId ). AllToAll будет применяться внутри подгрупп в указанном порядке. Например, replica_groups = { {1,2,3}, {4,5,0} } означает, что AllToAll будет применяться внутри реплик {1, 2, 3} и на этапе сбора, а полученные блоки будут быть объединены в том же порядке: 1, 2, 3. Затем в репликах 4, 5, 0 будет применен еще один AllToAll, а порядок объединения также равен 4, 5, 0. Если в replica_groups пусто, все реплики принадлежат одной группы в порядке их появления.

Предпосылки:

• Размер измерения операнда в split_dimension делится на split_count .
• Форма операнда не является кортежем.

AllToAll(operand, split_dimension, concat_dimension, split_count, replica_groups)

Ниже показан пример Alltoall.

XlaBuilder b("alltoall");
auto x = Parameter(&b, 0, ShapeUtil::MakeShape(F32, {4, 16}), "x");
AllToAll(x, /*split_dimension=*/1, /*concat_dimension=*/0, /*split_count=*/4);

В этом примере в Alltoall участвуют 4 ядра. В каждом ядре операнд разбивается на 4 части по размерности 0, поэтому каждая часть имеет форму f32[4,4]. 4 части разбросаны по всем ядрам. Затем каждое ядро ​​объединяет полученные части по размерности 1 в порядке ядра 0-4. Таким образом, выходные данные каждого ядра имеют форму f32[16,4].

ПакетныйНормаГрад

См. также XlaBuilder::BatchNormGrad и исходный документ по пакетной нормализации для подробного описания алгоритма.

Рассчитывает градиенты нормы партии.

BatchNormGrad(operand, scale, mean, variance, grad_output, epsilon, feature_index)

Для каждого объекта в измерении объекта ( feature_index — это индекс измерения объекта в operand ) операция вычисляет градиенты относительно operand , offset и scale по всем остальным измерениям. feature_index должен быть допустимым индексом для измерения объекта в operand .

Три градиента определяются следующими формулами (предполагая, что в качестве operand используется 4-мерный массив и с индексом измерения объекта l , размером пакета m и пространственными размерами w и h ):

\[ \begin{split} c_l&= \frac{1}{mwh}\sum_{i=1}^m\sum_{j=1}^w\sum_{k=1}^h \left( \nabla y_{ijkl} \frac{x_{ijkl} - \mu_l}{\sigma^2_l+\epsilon} \right) \\\\ d_l&= \frac{1}{mwh}\sum_{i=1}^m\sum_{j=1}^w\sum_{k=1}^h \nabla y_{ijkl} \\\\ \nabla x_{ijkl} &= \frac{\gamma_{l} }{\sqrt{\sigma^2_{l}+\epsilon} } \left( \nabla y_{ijkl} - d_l - c_l (x_{ijkl} - \mu_{l}) \right) \\\\ \nabla \gamma_l &= \sum_{i=1}^m\sum_{j=1}^w\sum_{k=1}^h \left( \nabla y_{ijkl} \frac{x_{ijkl} - \mu_l}{\sqrt{\sigma^2_{l}+\epsilon} } \right) \\\\\ \nabla \beta_l &= \sum_{i=1}^m\sum_{j=1}^w\sum_{k=1}^h \nabla y_{ijkl} \end{split} \]

Входные данные: mean и variance представляют значения моментов по партиям и пространственным измерениям.

Тип вывода — это кортеж из трех дескрипторов:

Пакетная нормаВывод

См. также XlaBuilder::BatchNormInference и исходный документ по пакетной нормализации для подробного описания алгоритма.

Нормализует массив по пакетным и пространственным измерениям.

BatchNormInference(operand, scale, offset, mean, variance, epsilon, feature_index)

Для каждого объекта в измерении объекта ( feature_index — это индекс измерения объекта в operand ) операция вычисляет среднее значение и дисперсию по всем остальным измерениям и использует среднее значение и дисперсию для нормализации каждого элемента в operand . feature_index должен быть допустимым индексом для измерения объекта в operand .

BatchNormInference эквивалентен вызову BatchNormTraining без вычисления mean и variance для каждой партии. Вместо этого в качестве оценочных значений используются входное mean и variance . Цель этой операции — уменьшить задержку вывода, отсюда и название BatchNormInference .

Выходные данные представляют собой n-мерный нормализованный массив той же формы, что и входной operand .

Пакетная нормаОбучение

См. также XlaBuilder::BatchNormTraining и the original batch normalization paper для подробного описания алгоритма.

Нормализует массив по пакетным и пространственным измерениям.

BatchNormTraining(operand, scale, offset, epsilon, feature_index)

Для каждого объекта в измерении объекта ( feature_index — это индекс измерения объекта в operand ) операция вычисляет среднее значение и дисперсию по всем остальным измерениям и использует среднее значение и дисперсию для нормализации каждого элемента в operand . feature_index должен быть допустимым индексом для измерения объекта в operand .

Алгоритм выглядит следующим образом для каждого пакета в operand \(x\) который содержит m элементов с w и h в качестве размера пространственного измерения (при условии, что operand представляет собой 4-мерный массив):

• Вычисляет среднее значение партии \(\mu_l\) для каждого объекта l в измерении объекта:\(\mu_l=\frac{1}{mwh}\sum_{i=1}^m\sum_{j=1}^w\sum_{k=1}^h x_{ijkl}\)

• Рассчитывает отклонение партии \(\sigma^2_l\): $\sigma^2 l=\frac{1}{mwh}\sum {i=1}^m\sum {j=1}^w\sum {k=1}^h (x_{ijkl} - \ му_л)^2$

• Нормализует, масштабирует и сдвигает:\(y_{ijkl}=\frac{\gamma_l(x_{ijkl}-\mu_l)}{\sqrt[2]{\sigma^2_l+\epsilon} }+\beta_l\)

Значение эпсилон, обычно небольшое число, добавляется во избежание ошибок деления на ноль.

Тип вывода — это кортеж из трех XlaOp :

batch_mean и batch_var — это моменты, рассчитанные для партии и пространственных измерений с использованием приведенных выше формул.

BitcastConvertType

См. также XlaBuilder::BitcastConvertType .

Подобно tf.bitcast в TensorFlow, выполняет поэлементную операцию преобразования битов из формы данных в целевую форму. Размер ввода и вывода должен совпадать: например, элементы s32 становятся элементами f32 посредством процедуры битового вещания, а один элемент s32 станет четырьмя элементами s8 . Bitcast реализован как низкоуровневое приведение, поэтому машины с разными представлениями чисел с плавающей запятой будут давать разные результаты.

BitcastConvertType(operand, new_element_type)

Размеры операнда и целевой формы должны совпадать, за исключением последнего измерения, которое изменится на соотношение размера примитива до и после преобразования.

Типы элементов источника и назначения не должны быть кортежами.

Bitcast-преобразование в примитивный тип разной ширины

Инструкция BitcastConvert HLO поддерживает случай, когда размер выходного элемента типа T' не равен размеру входного элемента T . Поскольку вся операция концептуально является битовой передачей и не меняет базовые байты, форма выходного элемента должна измениться. Для B = sizeof(T), B' = sizeof(T') возможны два случая.

Во-первых, когда B > B' , выходная форма получает новое наименьшее измерение размера B/B' . Например:

  f16[10,2]{1,0} %output = f16[10,2]{1,0} bitcast-convert(f32[10]{0} %input)

Для эффективных скаляров правило остается тем же:

  f16[2]{0} %output = f16[2]{0} bitcast-convert(f32[] %input)

Альтернативно, для B' > B инструкция требует, чтобы последний логический размер входной формы был равен B'/B , и этот размер удаляется во время преобразования:

  f32[10]{0} %output = f32[10]{0} bitcast-convert(f16[10,2]{1,0} %input)

Обратите внимание, что преобразования между различными разрядностями не выполняются поэлементно.

Транслировать

См. также XlaBuilder::Broadcast .

Добавляет измерения в массив путем дублирования данных в массиве.

Broadcast(operand, broadcast_sizes)

Новые измерения вставляются слева, т.е. если broadcast_sizes имеет значения {a0, ..., aN} а форма операнда имеет размеры {b0, ..., bM} то форма вывода имеет размеры {a0, ..., aN, b0, ..., bM} .

Новый размерный индекс копий операнда, т.е.

output[i0, ..., iN, j0, ..., jM] = operand[j0, ..., jM]

Например, если operand — скаляр f32 со значением 2.0f , а broadcast_sizes — {2, 3} , то результатом будет массив формы f32[2, 3] и все значения в результате будут 2.0f .

BroadcastInDim

См. также XlaBuilder::BroadcastInDim .

Увеличивает размер и ранг массива путем дублирования данных в массиве.

BroadcastInDim(operand, out_dim_size, broadcast_dimensions)

Похож на Broadcast, но позволяет добавлять измерения где угодно и расширять существующие измерения размером 1.

operand транслируется в форму, описанную out_dim_size . broadcast_dimensions сопоставляет размеры operand с размерами целевой фигуры, т.е. i-е измерение операнда сопоставляется с Broadcast_dimension[i]-м измерением выходной формы. Размеры operand должны иметь размер 1 или совпадать с размером в выходной фигуре, с которой они сопоставляются. Остальные измерения заполняются измерениями размера 1. Затем вещание вырожденного измерения транслируется по этим вырожденным измерениям для достижения выходной формы. Семантика подробно описана на странице трансляции .

Вызов

См. также XlaBuilder::Call .

Вызывает вычисление с заданными аргументами.

Call(computation, args...)

Арность и типы args должны соответствовать параметрам computation . Допускается отсутствие args .

Холеский

См. также XlaBuilder::Cholesky .

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

Cholesky(a, lower)

Если lower имеет true , вычисляет нижние треугольные матрицы l такие, что $a = l . л^Т$. Если lower имеет значение false , вычисляет верхнетреугольные матрицы u такие, что\(a = u^T . u\).

Входные данные считываются только из нижнего/верхнего треугольника a , в зависимости от значения lower . Значения из другого треугольника игнорируются. Выходные данные возвращаются в том же треугольнике; значения в другом треугольнике определяются реализацией и могут быть любыми.

Если ранг a больше 2, a рассматривается как пакет матриц, где все измерения, за исключением младших двух, являются пакетными измерениями.

Если a не является симметричным (эрмитовым) положительно определенным, результат определяется реализацией.

Зажим

См. также XlaBuilder::Clamp .

Фиксирует операнд в пределах диапазона между минимальным и максимальным значением.

Clamp(min, operand, max)

Учитывая операнд и минимальное и максимальное значения, возвращает операнд, если он находится в диапазоне между минимальным и максимальным, иначе возвращает минимальное значение, если операнд находится ниже этого диапазона, или максимальное значение, если операнд находится выше этого диапазона. То есть clamp(a, x, b) = min(max(a, x), b) .

Все три массива должны быть одинаковой формы. В качестве альтернативы, в качестве ограниченной формы широковещания , min и/или max могут быть скаляром типа T

Пример со скалярными min и max :

let operand: s32[3] = {-1, 5, 9};
let min: s32 = 0;
let max: s32 = 6;
==>
Clamp(min, operand, max) = s32[3]{0, 5, 6};

Крах

См. также XlaBuilder::Collapse и операцию tf.reshape .

Сворачивает размеры массива в одно измерение.

Collapse(operand, dimensions)

Свернуть заменяет заданное подмножество измерений операнда одним измерением. Входные аргументы представляют собой произвольный массив типа T и вектор индексов размерностей, постоянный во время компиляции. Индексы измерений должны представлять собой упорядоченное (от низкого до высокого числа измерений) последовательное подмножество измерений T. Таким образом, {0, 1, 2}, {0, 1} или {1, 2} являются допустимыми наборами измерений, а {1, 0} или {0, 2} — нет. Они заменяются одним новым размером, находящимся в той же позиции в последовательности размеров, что и те, которые они заменяют, с новым размером размера, равным произведению размеров исходного размера. Наименьшее число измерений в dimensions — это самое медленно меняющееся измерение (наиболее важное) в гнезде циклов, которое схлопывает эти измерения, а наибольшее число измерений — это наиболее быстро меняющееся (наиболее незначительное) измерение. См. оператор tf.reshape если требуется более общий порядок свертывания.

Например, пусть v — массив из 24 элементов:

let v = f32[4x2x3] { { {10, 11, 12},  {15, 16, 17} },
{ {20, 21, 22},  {25, 26, 27} },
{ {30, 31, 32},  {35, 36, 37} },
{ {40, 41, 42},  {45, 46, 47} } };

// Collapse to a single dimension, leaving one dimension.
let v012 = Collapse(v, {0,1,2});
then v012 == f32[24] {10, 11, 12, 15, 16, 17,
20, 21, 22, 25, 26, 27,
30, 31, 32, 35, 36, 37,
40, 41, 42, 45, 46, 47};

// Collapse the two lower dimensions, leaving two dimensions.
let v01 = Collapse(v, {0,1});
then v01 == f32[4x6] { {10, 11, 12, 15, 16, 17},
{20, 21, 22, 25, 26, 27},
{30, 31, 32, 35, 36, 37},
{40, 41, 42, 45, 46, 47} };

// Collapse the two higher dimensions, leaving two dimensions.
let v12 = Collapse(v, {1,2});
then v12 == f32[8x3] { {10, 11, 12},
{15, 16, 17},
{20, 21, 22},
{25, 26, 27},
{30, 31, 32},
{35, 36, 37},
{40, 41, 42},
{45, 46, 47} };

КоллективныйPermute

См. также XlaBuilder::CollectivePermute .

CollectivePermute — это коллективная операция, которая отправляет и получает перекрестные реплики данных.

CollectivePermute(operand, source_target_pairs)

Обратите внимание, что на source_target_pair существуют следующие ограничения:

• Любые две пары не должны иметь одинаковый идентификатор целевой реплики и не должны иметь одинаковый идентификатор исходной реплики.
• Если идентификатор реплики не является целью ни в одной паре, то выходные данные этой реплики представляют собой тензор, состоящий из 0(ов) той же формы, что и входные данные.

Объединить

См. также XlaBuilder::ConcatInDim .

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

Concatenate(operands..., dimension)

За исключением dimension все размеры должны быть одинаковыми. Это связано с тем, что XLA не поддерживает «рваные» массивы. Также обратите внимание, что значения ранга 0 не могут быть объединены (поскольку невозможно указать измерение, по которому происходит объединение).

1-мерный пример:

Concat({ {2, 3}, {4, 5}, {6, 7} }, 0)
>>> {2, 3, 4, 5, 6, 7}

2-мерный пример:

let a = {
{1, 2},
{3, 4},
{5, 6},
};
let b = {
{7, 8},
};
Concat({a, b}, 0)
>>> {
{1, 2},
{3, 4},
{5, 6},
{7, 8},
}

Диаграмма:

Условный

См. также XlaBuilder::Conditional .

Conditional(pred, true_operand, true_computation, false_operand, false_computation)

Выполняет true_computation , если pred имеет true , false_computation , если pred имеет значение false , и возвращает результат.

true_computation должен принимать один аргумент типа \(T_0\) и будет вызываться с true_operand , который должен быть того же типа. false_computation должно принимать один аргумент типа \(T_1\) и будет вызываться с false_operand , который должен быть того же типа. Тип возвращаемого значения true_computation и false_computation должен быть одинаковым.

Обратите внимание, что в зависимости от значения pred будет выполнено только одно из true_computation и false_computation .

Conditional(branch_index, branch_computations, branch_operands)

Выполняет branch_computations[branch_index] и возвращает результат. Если branch_index — это S32 , который равен < 0 или >= N, то branch_computations[N-1] выполняется как ветвь по умолчанию.

Каждая branch_computations[b] должна принимать один аргумент типа \(T_b\) и будет вызываться с помощью branch_operands[b] который должен быть того же типа. Тип возвращаемого значения каждого из branch_computations[b] должен быть одинаковым.

Обратите внимание, что только одно из branch_computations будет выполнено в зависимости от значения branch_index .

Конв (свертка)

См. также XlaBuilder::Conv .

Как ConvWithGeneralPadding, но заполнение указывается сокращенно как SAME или VALID. SAME дополнение дополняет входные данные ( lhs ) нулями, чтобы выходные данные имели ту же форму, что и входные, если не принимать во внимание шаг. ДЕЙСТВИТЕЛЬНОЕ дополнение просто означает отсутствие заполнения.

ConvWithGeneralPadding (свертка)

См. также XlaBuilder::ConvWithGeneralPadding .

Вычисляет свертку, используемую в нейронных сетях. Здесь свертку можно рассматривать как n-мерное окно, перемещающееся по n-мерной базовой области, и вычисления выполняются для каждой возможной позиции окна.

Пусть n — количество пространственных измерений. Аргумент lhs представляет собой массив ранга n+2, описывающий базовую область. Это называется входом, хотя, конечно, правая часть тоже является входом. В нейронной сети это входные активации. Размеры n+2 в следующем порядке:

• batch : каждая координата в этом измерении представляет собой независимый вход, для которого выполняется свертка.
• z/depth/features : каждая позиция (y,x) в базовой области имеет связанный с ней вектор, который входит в это измерение.
• spatial_dims : описывает n пространственных измерений, определяющих базовую область, по которой перемещается окно.

Аргумент rhs представляет собой массив ранга n+2, описывающий сверточный фильтр/ядро/окно. Размеры в таком порядке:

• output-z : размер выходных данных по оси z
• input-z : размер этого измерения, умноженный на feature_group_count должен равняться размеру измерения z в левой стороне.
• spatial_dims : описывает n пространственных измерений, которые определяют окно, перемещающееся по базовой области.

Аргумент window_strides определяет шаг сверточного окна в пространственных измерениях. Например, если шаг в первом пространственном измерении равен 3, то окно можно разместить только в координатах, где первый пространственный индекс делится на 3.

Аргумент padding указывает величину заполнения нулями, которая будет применена к базовой области. Величина заполнения может быть отрицательной — абсолютное значение отрицательного заполнения указывает количество элементов, которые необходимо удалить из указанного измерения перед выполнением свертки. padding[0] задает заполнение для измерения y , а padding[1] задает заполнение для измерения x . Каждая пара имеет нижнее дополнение в качестве первого элемента и высокое дополнение в качестве второго элемента. Низкое заполнение применяется в направлении более низких индексов, тогда как высокое заполнение применяется в направлении более высоких индексов. Например, если padding[1] равно (2,3) , то во втором пространственном измерении будет дополнение на 2 нуля слева и на 3 нуля справа. Использование заполнения эквивалентно вставке тех же нулевых значений во входные данные ( lhs ) перед выполнением свертки.

Аргументы lhs_dilation и rhs_dilation определяют коэффициент расширения, который будет применяться к левой и правой границам соответственно в каждом пространственном измерении. Если коэффициент расширения в пространственном измерении равен d, то между каждым элементом этого измерения неявно размещаются отверстия d-1, увеличивая размер массива. Дыры заполняются пустым значением, что для свертки означает нули.

Дилатацию резцов также называют атрозной извилиной. Более подробную информацию см. в tf.nn.atrous_conv2d . Расширение левой стороны также называется транспонированной сверткой. Более подробную информацию см. в tf.nn.conv2d_transpose .

Аргумент feature_group_count (значение по умолчанию 1) можно использовать для сгруппированных сверток. feature_group_count должен быть делителем как входного, так и выходного измерения объекта. Если feature_group_count больше 1, это означает, что концептуально измерение входного и выходного объекта, а также измерение выходного объекта rhs равномерно разделены на множество групп feature_group_count , каждая группа состоит из последовательной подпоследовательности объектов. Размер входного объекта rhs должен быть равен размеру входного объекта lhs разделенному на feature_group_count (так что он уже имеет размер группы входных объектов). i-ые группы используются вместе для вычисления feature_group_count для множества отдельных сверток. Результаты этих сверток объединяются в измерении выходного объекта.

Для глубинной свертки аргумент feature_group_count будет установлен в размер входного объекта, а форма фильтра будет изменена с [filter_height, filter_width, in_channels, channel_multiplier] на [filter_height, filter_width, 1, in_channels * channel_multiplier] . Более подробную информацию см. в tf.nn.depthwise_conv2d .

Аргумент batch_group_count (значение по умолчанию 1) можно использовать для сгруппированных фильтров во время обратного распространения ошибки. batch_group_count должен быть делителем размера lhs (входного) измерения пакета. Если batch_group_count больше 1, это означает, что размерность выходного пакета должна иметь размер input batch / batch_group_count . batch_group_count должен быть делителем размера выходного объекта.

Выходная форма имеет следующие размеры в следующем порядке:

• batch : размер этого измерения, умноженный на batch_group_count должен равняться размеру измерения batch в левых единицах измерения.
• z : тот же размер, что и у output-z в ядре ( rhs ).
• spatial_dims : одно значение для каждого допустимого размещения сверточного окна.

На рисунке выше показано, как работает поле batch_group_count . По сути, мы делим каждый пакет lhs на группы batch_group_count и делаем то же самое для выходных объектов. Затем для каждой из этих групп мы выполняем попарные свертки и объединяем выходные данные по измерению выходного объекта. Операционная семантика всех других измерений (особенностей и пространственного) остается прежней.

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

Чтобы описать, что делает свертка, рассмотрим двумерную свертку и выберите на выходе некоторую фиксированную batch координат z , y , x . Тогда (y,x) — это положение угла окна в базовой области (например, верхний левый угол, в зависимости от того, как вы интерпретируете пространственные измерения). Теперь у нас есть 2D-окно, взятое из базовой области, где каждая 2D-точка связана с 1D-вектором, поэтому мы получаем 3D-окно. Из сверточного ядра, поскольку мы зафиксировали выходную координату z , у нас также есть 3D-бокс. Два блока имеют одинаковые размеры, поэтому мы можем взять сумму поэлементных произведений между двумя блоками (аналогично скалярному произведению). Это выходное значение.

Обратите внимание, что если output-z равно, например, 5, то каждая позиция окна создает 5 значений на выходе в измерении z вывода. Эти значения различаются тем, какая часть сверточного ядра используется — для каждой координаты output-z используется отдельный трехмерный блок значений. Таким образом, вы можете думать об этом как о 5 отдельных свертках с разными фильтрами для каждой из них.

Вот псевдокод для 2d-свертки с заполнением и шагом:

for (b, oz, oy, ox) {  // output coordinates
  value = 0;
  for (iz, ky, kx) {  // kernel coordinates and input z
    iy = oy*stride_y + ky - pad_low_y;
    ix = ox*stride_x + kx - pad_low_x;
    if ((iy, ix) inside the base area considered without padding) {
      value += input(b, iz, iy, ix) * kernel(oz, iz, ky, kx);
    }
  }
  output(b, oz, oy, ox) = value;
}

КонвертироватьЭлементТип

См. также XlaBuilder::ConvertElementType .

Подобно поэлементному static_cast в C++, выполняет поэлементную операцию преобразования из фигуры данных в целевую фигуру. Размеры должны совпадать, а преобразование — поэлементное; например, элементы s32 становятся элементами f32 посредством процедуры преобразования s32 в f32 .

ConvertElementType(operand, new_element_type)

Размеры операнда и целевой формы должны совпадать. Типы элементов источника и назначения не должны быть кортежами.

Преобразование, такое как T=s32 в U=f32 выполнит процедуру нормализации преобразования целого числа в число с плавающей запятой, например округление до ближайшего четного.

let a: s32[3] = {0, 1, 2};
let b: f32[3] = convert(a, f32);
then b == f32[3]{0.0, 1.0, 2.0}

CrossReplicaSum

Выполняет AllReduce с вычислением суммирования.

Пользовательский вызов

См. также XlaBuilder::CustomCall .

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

CustomCall(target_name, args..., shape)

Сигнатура функции одинакова, независимо от арности или типа аргументов:

extern "C" void target_name(void* out, void** in);

Например, если CustomCall используется следующим образом:

let x = f32[2] {1,2};
let y = f32[2x3] { {10, 20, 30}, {40, 50, 60} };

CustomCall("myfunc", {x, y}, f32[3x3])

Вот пример реализации myfunc :

extern "C" void myfunc(void* out, void** in) {
  float (&x)[2] = *static_cast<float(*)[2]>(in[0]);
  float (&y)[2][3] = *static_cast<float(*)[2][3]>(in[1]);
  EXPECT_EQ(1, x[0]);
  EXPECT_EQ(2, x[1]);
  EXPECT_EQ(10, y[0][0]);
  EXPECT_EQ(20, y[0][1]);
  EXPECT_EQ(30, y[0][2]);
  EXPECT_EQ(40, y[1][0]);
  EXPECT_EQ(50, y[1][1]);
  EXPECT_EQ(60, y[1][2]);
  float (&z)[3][3] = *static_cast<float(*)[3][3]>(out);
  z[0][0] = x[1] + y[1][0];
  // ...
}

Предоставляемая пользователем функция не должна иметь побочных эффектов, а ее выполнение должно быть идемпотентным.

Точка

См. также XlaBuilder::Dot .

Dot(lhs, rhs)

Точная семантика этой операции зависит от рангов операндов:

Операция выполняет суммирование произведений по второму измерению lhs (или первому, если она имеет ранг 1) и первому измерению rhs . Это «сжатые» размеры. Сжатые размеры lhs и rhs должны быть одинакового размера. На практике его можно использовать для скалярного произведения векторов, умножения вектора/матрицы или умножения матрицы/матрицы.

ТочкаОбщий

См. также XlaBuilder::DotGeneral .

DotGeneral(lhs, rhs, dimension_numbers)

Аналогичен Dot, но позволяет указывать номера размеров контрактов и партий как для lhs , так и для rhs .

DotGeneral выполняет суммирование продуктов по контрактным измерениям, указанным в dimension_numbers .

Соответствующие номера контрактных размеров lhs и rhs не обязательно должны быть одинаковыми, но должны иметь одинаковые размеры.

Пример с номерами сжимающих размеров:

lhs = { {1.0, 2.0, 3.0},
{4.0, 5.0, 6.0} }

rhs = { {1.0, 1.0, 1.0},
{2.0, 2.0, 2.0} }

DotDimensionNumbers dnums;
dnums.add_lhs_contracting_dimensions(1);
dnums.add_rhs_contracting_dimensions(1);

DotGeneral(lhs, rhs, dnums) -> { {6.0, 12.0},
{15.0, 30.0} }

Связанные номера размеров партии из lhs и rhs должны иметь одинаковые размеры.

Пример с номерами размеров партии (размер партии 2, матрицы 2x2):

lhs = { { {1.0, 2.0},
{3.0, 4.0} },
{ {5.0, 6.0},
{7.0, 8.0} } }

rhs = { { {1.0, 0.0},
{0.0, 1.0} },
{ {1.0, 0.0},
{0.0, 1.0} } }

DotDimensionNumbers dnums;
dnums.add_lhs_contracting_dimensions(2);
dnums.add_rhs_contracting_dimensions(1);
dnums.add_lhs_batch_dimensions(0);
dnums.add_rhs_batch_dimensions(0);

DotGeneral(lhs, rhs, dnums) -> { { {1.0, 2.0},
{3.0, 4.0} },
{ {5.0, 6.0},
{7.0, 8.0} } }

Отсюда следует, что результирующий размерный номер начинается с размера партии, затем с lhs несужающегося/непартийного размера и, наконец, с rhs несжимающегося/непартийного размера.

Динамический срез

См. также XlaBuilder::DynamicSlice .

DynamicSlice извлекает подмассив из входного массива в динамическом start_indices . Размер среза в каждом измерении передается в size_indices , который определяет конечную точку эксклюзивных интервалов среза в каждом измерении: [start, start + size). Форма start_indices должна иметь ранг == 1, а размерность равна рангу operand .

DynamicSlice(operand, start_indices, size_indices)

Эффективные индексы среза вычисляются путем применения следующего преобразования для каждого индекса i в [1, N) перед выполнением среза:

start_indices[i] = clamp(start_indices[i], 0, operand.dimension_size[i] - size_indices[i])

Это гарантирует, что извлеченный фрагмент всегда находится в пределах массива операндов. Если срез находится в границах до применения преобразования, преобразование не оказывает никакого эффекта.

1-мерный пример:

let a = {0.0, 1.0, 2.0, 3.0, 4.0}
let s = {2}

DynamicSlice(a, s, {2}) produces:
{2.0, 3.0}

2-мерный пример:

let b =
{ {0.0,  1.0,  2.0},
{3.0,  4.0,  5.0},
{6.0,  7.0,  8.0},
{9.0, 10.0, 11.0} }
let s = {2, 1}

DynamicSlice(b, s, {2, 2}) produces:
{ { 7.0,  8.0},
{10.0, 11.0} }

ДинамическийUpdateSlice

См. также XlaBuilder::DynamicUpdateSlice .

DynamicUpdateSlice генерирует результат, который является значением operand входного массива, с update среза, перезаписанным в start_indices . Форма update определяет форму подмассива обновляемого результата. Форма start_indices должна иметь ранг == 1, а размерность равна рангу operand .

DynamicUpdateSlice(operand, update, start_indices)

Эффективные индексы срезов вычисляются путем применения следующего преобразования для каждого индекса i в [1, N) перед выполнением среза:

start_indices[i] = clamp(start_indices[i], 0, operand.dimension_size[i] - update.dimension_size[i])

Это гарантирует, что обновленный ломтик всегда вводится в отношении массива операнда. Если срез вводится до применения преобразования, преобразование не оказывает эффекта.

1-мерный пример:

let a = {0.0, 1.0, 2.0, 3.0, 4.0}
let u = {5.0, 6.0}
let s = {2}

DynamicUpdateSlice(a, u, s) produces:
{0.0, 1.0, 5.0, 6.0, 4.0}

2-мерный пример:

let b =
{ {0.0,  1.0,  2.0},
{3.0,  4.0,  5.0},
{6.0,  7.0,  8.0},
{9.0, 10.0, 11.0} }
let u =
{ {12.0,  13.0},
{14.0,  15.0},
{16.0,  17.0} }

let s = {1, 1}

DynamicUpdateSlice(b, u, s) produces:
{ {0.0,  1.0,  2.0},
{3.0, 12.0, 13.0},
{6.0, 14.0, 15.0},
{9.0, 16.0, 17.0} }

Элементные бинарные арифметические операции

Смотрите также XlaBuilder::Add .

Поддерживается набор бинарных арифметических операций.

Op(lhs, rhs)

Где Op является одним из Add (добавление), Sub (вычитание), Mul (умножение), Div (деление), Pow (power), Rem (остаток), Max (максимум), Min (минимум) And (логично и))) , Or (логический или), Xor (логический Xor), ShiftLeft (левый сдвиг), ShiftRightArithmetic (арифметический правый сдвиг), ShiftRightLogical (логический правый сдвиг), Atan2 (2-argument arctangent) или сложные (комбинирует реальные и воображаемые части в части в атан2 (2-аргмент arctangent) или Complex (объединяет реальные и воображаемые части (2-аргмент сложное число)

Формы аргументов должны быть либо похожими, либо совместимыми. Посмотрите на вещательную документацию о том, что это значит, чтобы формы были совместимыми. Результат операции имеет форму, которая является результатом трансляции двух входных массивов. В этом варианте операции между массивами разных рангов не поддерживаются, если только один из операндов не является скалярным.

Когда Op является Rem , знак результата получен из дивидендов, и абсолютное значение результата всегда меньше, чем абсолютное значение делителя.

Чрезмерное подразделение переполнение (подписанное/беззнательное подразделение/остаток по нулю или подписанному разделению/остаткам INT_SMIN с -1 ) создает определенное значение реализацией.

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

Op(lhs, rhs, broadcast_dimensions)

Где Op такой же, как и выше. Этот вариант операции должен использоваться для арифметических операций между массивами разных рангов (например, добавление матрицы в вектор).

Дополнительный операнд broadcast_dimensions представляет собой кусок целых чисел, используемых для расширения ранга операнда с низким уровнем ранга до ранга операнда с более высоким рейтингом. broadcast_dimensions отображает размеры формы нижнего ранга по размерам формы с более высоким уровнем. Незастремленные размеры расширенной формы заполнены размерами одного размера. Затем вещание вырожденного измерения транслирует формы вдоль этих вырожденных размеров, чтобы выровнять формы обоих операндов. Семантика подробно описана на странице вещания .

Элементные операции сравнения

Смотрите также XlaBuilder::Eq .

Поддерживается набор стандартных бинарных операций. Обратите внимание, что стандартная семантика сравнения IEEE 754 применяется при сравнении типов с плавающей точкой.

Op(lhs, rhs)

Где Op является одним из Eq (равный), Ne (не равен), Ge (больший или равный, чем), Gt (больше, чем), Le (менее или равна, чем), Lt (меньше, чем). Другой набор операторов, EQTotAlOrder, NetOtalOrder, GetOtalOrder, GttotAlOrder, LetotalOrder и LttotalOrder, обеспечивают те же функциональные возможности, за исключением того, что они дополнительно поддерживают общий порядок по номерам с плавающей запятой, путем обеспечения соблюдения -nan <-inf <-finite <-0. <+0 < +конечный < +inf < +nan.

Формы аргументов должны быть либо похожими, либо совместимыми. Посмотрите на вещательную документацию о том, что это значит, чтобы формы были совместимыми. Результат операции имеет форму, которая является результатом трансляции двух входных массивов с помощью PRED . В этом варианте операции между массивами разных рангов не поддерживаются, если только один из операндов не является скалярным.

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

Op(lhs, rhs, broadcast_dimensions)

Где Op такой же, как и выше. Этот вариант операции должен использоваться для операций сравнения между массивами разных рангов (например, добавление матрицы в вектор).

Дополнительный операнд broadcast_dimensions представляет собой кусок целых чисел, указывающий размеры для использования для трансляции операндов. Семантика подробно описана на странице вещания .

Элементные унарные функции

Xlabuilder поддерживает эти элементные унарные функции:

Abs(operand) по элементу ABS x -> |x| .

Cbrt(operand) Элементный кубический корневой операция x -> cbrt(x) .

Ceil(operand) элементный ceil x -> ⌈x⌉ .

Clz(operand) по элементу Count ведущий нули.

Cos(operand) косинус x -> cos(x) .

Erf(operand) Функция ошибки x -> erf(x) , где

\(\text{erf}(x) = \frac{2}{\sqrt{\pi} }\int_0^x e^{-t^2} \, dt\).

Exp(operand) по элементу естественной экспоненциал x -> e^x .

Expm1(operand) по элементу естественной экспоненты минус один x -> e^x - 1 .

Floor(operand) по этапу x -> ⌊x⌋ .

Imag(operand) элементная воображаемая часть сложной (или реальной) формы. x -> imag(x) . Если операнд является типом плавающей запятой, возвращает 0.

IsFinite(operand) проверяет, конечен ли каждый элемент operand , то есть не является положительной или отрицательной бесконечной и не является NaN . Возвращает массив значений PRED с той же формой, что и вход, где каждый элемент true если и только тогда, когда соответствующий входной элемент является конечным.

Log(operand) по элементу естественный логарифм x -> ln(x) .

Log1p(operand) по элементу сдвинуто естественный логарифм x -> ln(1+x) .

Logistic(operand) Учебная функция по элементам x -> logistic(x) .

Neg(operand) отрицание элемента x -> -x .

Not(operand) по элементу логично, а не x -> !(x) .

PopulationCount(operand) вычисляет количество битов, установленных в каждом элементе operand .

Real(operand) элементная реальная часть сложной (или реальной) формы. x -> real(x) . Если операнд является типом плавающей запятой, возвращает то же значение.

Round(operand) в стиле элемент, связанный с нуля.

RoundNearestEven(operand) по элементу округление, в ближайшее время.

Rsqrt(operand) по элементу Взаимная операция квадратного корня x -> 1.0 / sqrt(x) .

Sign(operand) x -> sgn(x)

\[\text{sgn}(x) = \begin{cases} -1 & x < 0\\ -0 & x = -0\\ NaN & x = NaN\\ +0 & x = +0\\ 1 & x > 0 \end{cases}\]

Использование оператора сравнения типа элемента operand .

Sin(operand) элементный sine x -> sin(x) .

Sqrt(operand) Элементный квадратный корень операции x -> sqrt(x) .

Tan(operand) по элементу Tangent x -> tan(x) .

Tanh(operand) Гиперболическая тангенс x -> tanh(x) .

Функция применяется к каждому элементу в массиве operand , что приводит к массиву с одинаковой формой. Это разрешено, чтобы operand был скалярным (ранг 0).

ФФТ

Операция FFT XLA реализует прямое и обратное преобразование Фурье для реальных и сложных входов/выходов. Поддерживаются многомерные FFT на 3 осях.

Смотрите также XlaBuilder::Fft .

Многомерные БПФ

Когда предоставляется более 1 fft_length , это эквивалентно применению каскада операций FFT к каждой из внутренних оси. Обратите внимание, что для реальных сложных и сложных-> реальных случаев, внутреннее преобразование оси (эффективно) выполняется первым (RFFT; последнее для IRFFT), поэтому внутренняя ось-это та, которая меняет размер. Другие преобразования оси будут тогда сложными.

Детали реализации

ЦП FFT поддерживается Tensorfft Eigen. GPU FFT использует Cufft.

Собирать

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

Общая семантика

Смотрите также XlaBuilder::Gather . Для более интуитивного описания см. Раздел «Неформальное описание» ниже.

gather(operand, start_indices, offset_dims, collapsed_slice_dims, slice_sizes, start_index_map)

Для удобства мы помечаем размеры в выходном массиве, а не в offset_dims как batch_dims .

Вывод представляет собой массив ранга batch_dims.size + offset_dims.size .

operand.rank должен равняться сумме offset_dims.size и collapsed_slice_dims.size . Кроме того, slice_sizes.size должен быть равен operand.rank .

Если index_vector_dim равен start_indices.rank мы неявно считаем, что start_indices иметь 1 размер (то есть, если start_indices имел форму [6,7] , а index_vector_dim - 2 , то мы неявно рассматриваем форму start_indices [6,7,1] ).

Границы для выходного массива вдоль измерения i вычисляются следующим образом:

1. Если i присутствует k batch_dims (то есть равна batch_dims[k] index_vector_dim k k ), то мы выбираем соответствующие границы измерений из start_indices.shape , пропуская index_vector_dim start_indices.shape.dims start_indices.shape.dims [ k + 1 ] в противном случае).

2. Если i присутствует k offset_dims (то есть равен offset_dims [ k ] для некоторого k ), slice_sizes мы выбираем соответствующую границу из slice_sizes collapsed_slice_dims учета collapsed_slice_dims adjusted_slice_sizes то есть мы выбираем adjusted_slice_sizes ).

Формально, индекс операнда In соответствии с данным Out индексом рассчитывается следующим образом:

1. Пусть G = { Out [ k ] для k в batch_dims }. Используйте G , чтобы вырезать вектор S так что S [ i ] = start_indices [combine ( G , i )], где комбинация (a, b) вставки b в положении index_vector_dim в A. Обратите внимание, что это хорошо определено, даже если G пуст : Если G пуст, то S = start_indices .

2. Создайте начальный индекс, S in , в operand используя S , рассеяв S используя start_index_map . Точнее:

   1. S in [ start_index_map [ k ]] = S [ k ], если k < start_index_map.size .

   2. S in [ _ ] = 0 в противном случае.

3. Создайте индекс O in in operand , разбросав индексы в смещенных размерах Out соответствии с набором collapsed_slice_dims . Точнее:

   1. O in [ remapped_offset_dims ( k )] = Out [ offset_dims [ k ]], если k < offset_dims.size ( remapped_offset_dims определен ниже).

   2. O in [ _ ] = 0 в противном случае.

4. In is O in + S in + с добавлением элемента.

remapped_offset_dims - это монотонная функция с доменом [ 0 , offset_dims.size ) и диапазоном [ 0 , operand.rank ) \ collapsed_slice_dims . 0 1 3 2 collapsed_slice_dims 0 remapped_offset_dims offset_dims.size 2 4 1 operand.rank 6 4 3 5

Если indices_are_sorted установлен на TRUE, то xLA может предположить, что start_indices сортируется (в порядке возрастания, после рассеяния его значений в соответствии с start_index_map ) пользователем. Если это не так, то семантика определяется реализацией.

Неформальное описание и примеры

Неофициально, каждый индекс в Out массиве соответствует элементу E в массиве операнда, рассчитанных следующим образом:

• Мы используем пакетные размеры Out чтобы найти начальный индекс от start_indices .

• Мы используем start_index_map для сопоставления начального индекса (размер которого может быть меньше, чем operand .

• Мы динамично выкладываем ломтик с размером slice_sizes используя полный начальный индекс.

• Мы изменяем срез, обрушив измерения collapsed_slice_dims . Поскольку все разрушенные размеры среза должны иметь границу 1, этот решап всегда является законным.

• Мы используем размеры Out , чтобы индекс в этот срез, чтобы получить входной элемент, E , соответствующий Out индексу.

index_vector_dim установлен на start_indices.rank - 1 во всех последующих примерах. Более интересные значения для index_vector_dim не изменяют операцию в основном, но делают визуальное представление более громоздким.

Чтобы получить интуицию о том, как все вышеперечисленное соединяется вместе, давайте посмотрим на пример, который собирает 5 ломтиков формы [8,6] из массива [16,11] . Положение среза в массив [16,11] может быть представлена ​​в виде индексного вектора формы S64[2] , поэтому набор из 5 позиций может быть представлен как массив S64[5,2] .

Поведение операции сбора может затем быть изображено как преобразование индекса, которое принимает [ G , O 0 , O 1 ], индекс в форме вывода и отображает его на элемент в входном массиве следующим образом:

Сначала мы выбираем ( X , Y ) вектор из массива индексов сбора, используя G . Элемент в выходном массиве в индексе [ G , O 0 , O 1 ] затем является элементом в входном массиве в индексе [ X + O 0 , Y + O 1 ].

slice_sizes - это [8,6] , что решает диапазон O ₀ и O ₁ , и это, в свою очередь, решает границы среза.

Эта операция сбора действует как пакетный динамический срез с G в качестве партийного измерения.

Индексы сбора могут быть многомерными. Например, более общая версия примера выше, используя массив формы «сбора» [4,5,2]

Опять же, это действует как пакетный динамический срез G 0 и G 1 в качестве партийных размеров. Размер среза все еще [8,6] .

Операция сбора в XLA обобщает неформальную семантику, изложенную выше следующим образом:

1. Мы можем настроить, какие размеры в форме вывода являются размерами смещения (размеры, содержащие O 0 , O 1 в последнем примере). Размеры выходной партии (размеры, содержащие G 0 , G 1 в последнем примере) определены как выходные размеры, которые не являются смещенными размерами.

2. Количество размеров вывода смещения, явно присутствующих в форме вывода, может быть меньше входного ранга. Эти «отсутствующие» размеры, которые указаны явно в виде collapsed_slice_dims , должны иметь размер среза 1 . Поскольку у них есть размер среза 1 единственный действительный индекс для них - 0 , а эливание их не вводит неоднозначности.

3. Срезис, извлеченный из массива «Сбор индексов» (( X , Y ) в последнем примере), может иметь меньше элементов, чем у ранга входных массиво .

В качестве последнего примера мы используем (2) и (3) для реализации tf.gather_nd :

G 0 и G 1 используются для вырезания начального индекса из массива индексов сбора, за исключением того, что стартовый индекс имеет только один элемент, X . Аналогичным образом, существует только один индекс смещения вывода со значением O 0 . Однако, прежде чем использовать в качестве индексов во входном массиве, они расширяются в соответствии с «сбором картирования индекса» ( start_index_map в формальном описании) и «сопоставление смещения» ( remapped_offset_dims в формальном описании) в [ X , 0 ] и [ 0 , O 0 ] соответственно, добавление до [ X , O 0 ]. Другими словами, выходной индекс [ G 0 , G 1 , O 0 ] отображается на входной индекс [ GatherIndices [ G 0 , G 1 , 0 ], O 0 ], что дает нам семантику для tf.gather_nd .

slice_sizes для этого случая [1,11] . Интуитивно это означает, что каждый индекс X в индексах сбора выбирает целый ряд, и результатом является объединение всех этих строк.

GetDimensionSize

Смотрите также XlaBuilder::GetDimensionSize .

Возвращает размер данного измерения операнда. Операнд должен быть в форме массива.

GetDimensionSize(operand, dimension)

SetDimensionize

Смотрите также XlaBuilder::SetDimensionSize .

Устанавливает динамический размер данного измерения XLAOP. Операнд должен быть в форме массива.

SetDimensionSize(operand, size, dimension)

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

Наполненные значения будут игнорироваться вниз по течению сокращения OPS.

let v: f32[10] = f32[10]{1, 2, 3, 4, 5, 6, 7, 8, 9, 10};
let five: s32 = 5;
let six: s32 = 6;

// Setting dynamic dimension size doesn't change the upper bound of the static
// shape.
let padded_v_five: f32[10] = set_dimension_size(v, five, /*dimension=*/0);
let padded_v_six: f32[10] = set_dimension_size(v, six, /*dimension=*/0);

// sum == 1 + 2 + 3 + 4 + 5
let sum:f32[] = reduce_sum(padded_v_five);
// product == 1 * 2 * 3 * 4 * 5
let product:f32[] = reduce_product(padded_v_five);

// Changing padding size will yield different result.
// sum == 1 + 2 + 3 + 4 + 5 + 6
let sum:f32[] = reduce_sum(padded_v_six);

GetTupleElement

Смотрите также XlaBuilder::GetTupleElement .

Индексам в кортеж со значением с компиляцией.

Значение должно быть конфигуляционным временем, так что вывод формы может определить тип полученного значения.

Это аналогично std::get<int N>(t) в C ++. Концептуально:

let v: f32[10] = f32[10]{0, 1, 2, 3, 4, 5, 6, 7, 8, 9};
let s: s32 = 5;
let t: (f32[10], s32) = tuple(v, s);
let element_1: s32 = gettupleelement(t, 1);  // Inferred shape matches s32.

Смотрите также tf.tuple .

Наполнение

Смотрите также XlaBuilder::Infeed .

Infeed(shape)

Считает один элемент данных из неявного потокового интерфейса устройства, интерпретируя данные как данную форму и его макет, и возвращает XlaOp данных. В вычислении допускаются многочисленные операции на многородке, но среди операций на дохне должен быть полный заказ. Например, две добычи в приведенном ниже коде имеют общий заказ, поскольку между петлями находится зависимость.

result1 = while (condition, init = init_value) {
  Infeed(shape)
}

result2 = while (condition, init = result1) {
  Infeed(shape)
}

Вложенные формы кортежа не поддерживаются. Для пустой формы корзины операция до кончика является фактически не-операционной и продолжается, не считывая какие-либо данные из дохода устройства.

Йота

Смотрите также XlaBuilder::Iota .

Iota(shape, iota_dimension)

Создает постоянный буквал на устройстве, а не потенциально большую передачу хоста. Создает массив, который указал форму и содержит значения, начинающиеся с нуля и увеличивая один вдоль указанного измерения. Для типов с плавающей точкой полученная массив эквивалентен ConvertElementType(Iota(...)) где Iota имеет интегральный тип, а преобразование-в тип с плавающей точкой.

Например, Iota(s32[4, 8], 0) возвращает

  [[0, 0, 0, 0, 0, 0, 0, 0 ],
   [1, 1, 1, 1, 1, 1, 1, 1 ],
   [2, 2, 2, 2, 2, 2, 2, 2 ],
   [3, 3, 3, 3, 3, 3, 3, 3 ]]

Iota(s32[4, 8], 1) возвращает

  [[0, 1, 2, 3, 4, 5, 6, 7 ],
   [0, 1, 2, 3, 4, 5, 6, 7 ],
   [0, 1, 2, 3, 4, 5, 6, 7 ],
   [0, 1, 2, 3, 4, 5, 6, 7 ]]

Карта

Смотрите также XlaBuilder::Map .

Map(operands..., computation)

Применяет скалярную функцию по данным массивам operands , создавая массив тех же размеров, где каждый элемент является результатом отображенной функции, применяемой к соответствующим элементам в входных массивах.

Функция отображения представляет собой произвольное вычисление с ограничением, которое имеет n входов скалярного типа T и один вывод с типом S Выход имеет те же размеры, что и операнды, за исключением того, что тип элемента T заменяется S.

Например: Map(op1, op2, op3, computation, par1) отображает elem_out <- computation(elem1, elem2, elem3, par1) в каждом (многомерном) индексе в входных массивах для получения выходной массивы.

Оптимизация Barrier

Блокирует любой оптимизационный проход от перемещения вычислений по всему барьеру.

Гарантирует, что все входы оцениваются перед любыми операторами, которые зависят от выходов барьера.

Подушка

Смотрите также XlaBuilder::Pad .

Pad(operand, padding_value, padding_config)

Расширяет заданный массив operand , пробиваясь вокруг массива, а также между элементами массива с помощью данного padding_value . padding_config Указывает количество краевой прокладки и внутренней прокладки для каждого измерения.

PaddingConfig - это повторное поле PaddingConfigDimension , которое содержит три поля для каждого измерения: edge_padding_low , edge_padding_high и interior_padding .

edge_padding_low и edge_padding_high Укажите количество заполнения, добавленное в низком уровне (рядом с индексом 0) и высококачественным (рядом с самым высоким индексом) каждого измерения соответственно. Количество краевой прокладки может быть отрицательным - абсолютное значение отрицательной прокладки указывает количество элементов для удаления из указанного измерения.

interior_padding указывает количество прокладки, добавленное между любыми двумя элементами в каждом измерении; Это не может быть негативным. Внутренняя прокладка происходит логически перед набережной, поэтому в случае отрицательной блокноты, элементы удаляются из операнда с внутренними укладками.

Эта операция является no-op, если все пары блюд с краем являются (0, 0), а значения внутренней прокладки-все 0. На рисунке ниже показаны примеры различных значений edge_padding и interior_padding для двумерного массива.

Рекв

Смотрите также XlaBuilder::Recv .

Recv(shape, channel_handle)

Получает данные данной формы из инструкции Send в другом вычислении, в котором находится тот же рукояток канала. Возвращает XLAOP для полученных данных.

Клиентский API операции Recv представляет синхронную связь. Тем не менее, инструкция внутренне разложена на 2 инструкции HLO ( Recv и RecvDone ), чтобы обеспечить асинхронные передачи данных. См. Также HloInstruction::CreateRecv и HloInstruction::CreateRecvDone .

Recv(const Shape& shape, int64 channel_id)

Выделяет ресурсы, необходимые для получения данных из инструкции Send с одним и тем же каналом. Возвращает контекст для выделенных ресурсов, который используется следующей инструкцией RecvDone , чтобы дождаться завершения передачи данных. Контекст представляет собой кортеж из {полученного буфера (форма), идентификатора запроса (U32)}, и он может использоваться только инструкцией RecvDone .

RecvDone(HloInstruction context)

Учитывая контекст, созданный инструкцией Recv , ожидает завершения передачи данных и возвращает полученные данные.

Уменьшать

Смотрите также XlaBuilder::Reduce .

Применяет функцию сокращения на один или несколько массивов параллельно.

Reduce(operands..., init_values..., computation, dimensions)

Где:

• N должен быть больше или равен 1.
• Вычисление должно быть «примерно» ассоциативным (см. Ниже).
• Все входные массивы должны иметь одинаковые размеры.
• Все начальные значения должны сформировать идентичность в computation .
• Если N = 1 , Collate(T) - это T .
• Если N > 1 , Collate(T_0, ..., T_{N-1}) -это кортеж N элементов типа T .

Эта операция уменьшает один или несколько измерений каждого входного массива на скаляры. Рангом каждого возвращенного массива является rank(operand) - len(dimensions) . Вывод OP Collate(Q_0, ..., Q_N) где Q_i - это массив типа T_i , размеры которых описаны ниже.

Различным бэкэндам разрешено восстановить вычисление сокращения. Это может привести к численным различиям, поскольку некоторые функции восстановления, такие как добавление, не являются ассоциативными для поплавок. Однако, если диапазон данных ограничен, добавление с плавающей запятой достаточно близко к ассоциативному для большинства практических целей.

Примеры

При сокращении одного измерения в одном 1D массиве со значениями [10, 11, 12, 13] , с функцией восстановления f (это computation ), которое можно было рассчитать как

f(10, f(11, f(12, f(init_value, 13)))

Но есть и много других возможностей, например,

f(init_value, f(f(10, f(init_value, 11)), f(f(init_value, 12), f(init_value, 13))))

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

result_shape <- remove all dims in dimensions from operand_shape

# Iterate over all elements in result_shape. The number of r's here is equal
# to the rank of the result
for r0 in range(result_shape[0]), r1 in range(result_shape[1]), ...:
  # Initialize this result element
  result[r0, r1...] <- 0

  # Iterate over all the reduction dimensions
  for d0 in range(dimensions[0]), d1 in range(dimensions[1]), ...:
    # Increment the result element with the value of the operand's element.
    # The index of the operand's element is constructed from all ri's and di's
    # in the right order (by construction ri's and di's together index over the
    # whole operand shape).
    result[r0, r1...] += operand[ri... di]

Вот пример уменьшения 2D -массива (матрица). Форма имеет ранг 2, размер 0 размера 2 и размер 1 размера 3:

Результаты уменьшения размеров 0 или 1 с функцией «добавить»:

Обратите внимание, что оба результата сокращения являются 1D массивами. Диаграмма показывает один как столбец, а другой - как строка только для визуального удобства.

Для более сложного примера, вот 3D -массив. Его ранг составляет 3, измерение 0 размера 4, размер 1 размера 2 и размер 2 размера 3. Для простоты значения от 1 до 6 воспроизводится по всему измерению 0.

Подобно 2D -примеру, мы можем уменьшить только одно измерение. Например, если мы уменьшим размер 0, мы получим массив Rank-2, где все значения по всему измерению 0 были сложены в скаляр:

|  4   8  12 |
| 16  20  24 |

Если мы уменьшим размер 2, мы также получим массив Rank-2, где все значения по всему измерению 2 были сложены на скаляр:

| 6  15 |
| 6  15 |
| 6  15 |
| 6  15 |

Обратите внимание, что относительный порядок между оставшимися размерами на входе сохраняется на выходе, но некоторые измерения могут получить новые числа (с момента изменения ранга).

Мы также можем уменьшить несколько измерений. Дополнительные размеры 0 и 1 создают 1D массив [20, 28, 36] .

Уменьшение трехмерного массива по всем его размерам создает скаляр 84 .

Вариадический уменьшается

Когда N > 1 уменьшите функциональное приложение немного более сложное, так как оно применяется одновременно ко всем входам. Операнды поставляются в вычисление в следующем порядке:

• Запуск пониженной стоимости для первого операнда
• ...
• Запуск пониженной стоимости для N'th Operand
• Входное значение для первого операнда
• ...
• Входное значение для N'th Operand

Например, рассмотрим следующую функцию восстановления, которая может использоваться для вычисления максимального и argmax 1-D массива параллельно:

f: (Float, Int, Float, Int) -> Float, Int
f(max, argmax, value, index):
  if value >= max:
    return (value, index)
  else:
    return (max, argmax)

Для 1-D входных массивов V = Float[N], K = Int[N] и значений init I_V = Float, I_K = Int , результат f_(N-1) уменьшения в единственном входном измерении эквивалентно Следующее рекурсивное применение:

f_0 = f(I_V, I_K, V_0, K_0)
f_1 = f(f_0.first, f_0.second, V_1, K_1)
...
f_(N-1) = f(f_(N-2).first, f_(N-2).second, V_(N-1), K_(N-1))

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

Сокращение

См. Также XlaBuilder::ReducePrecision .

Моделируют эффект преобразования значений с плавающей точкой в ​​формат с более низким определением (например, IEEE-FP16) и обратно в исходный формат. Количество элементов и битов Mantissa в формате более низкого определения может быть указано произвольно, хотя все размеры битов не могут быть поддержаны во всех аппаратных реализациях.

ReducePrecision(operand, mantissa_bits, exponent_bits)

Результатом является массив типа T Входные значения округлены до ближайшего значения, представляемого данным числом битов Mantissa (с использованием «связей даже« семантики »), и любые значения, которые превышают диапазон, указанный по количеству битов, связанных с положительной или отрицательной бесконечной. Значения NaN сохраняются, хотя они могут быть преобразованы в канонические значения NaN .

Формат с более низким определением должен иметь по крайней мере один бит показателя (чтобы отличить нулевое значение от бесконечности, поскольку оба имеют нулевую мантиссу) и должны иметь неотрицательное количество битов мантиссы. Количество показателей или битов мантиссы может превышать соответствующее значение для типа T ; Соответствующая часть преобразования тогда просто не-операционная.

Восстанавливается

Смотрите также XlaBuilder::ReduceScatter .

REDUCESCATTER - это коллективная операция, которая эффективно выполняет AllReduce, а затем рассеивает результат, разделяя его на блоки shard_count вдоль scatter_dimension , а реплика i в группе реплики получает ith .

ReduceScatter(operand, computation, scatter_dim, shard_count, replica_group_ids, channel_id)

• Когда operand представляет собой кортеж с массивами, уменьшение рассеяния выполняется на каждом элементе кортежа.
• replica_groups - это список групп реплик, между которыми выполняется сокращение (идентификатор реплики для текущей реплики может быть извлечен с использованием ReplicaId ). Порядок реплик в каждой группе определяет порядок, в котором будет разбросан результат всеобъемлющего. replica_groups должны быть либо пусты (в этом случае все реплики принадлежат к одной группе), либо содержать такое же количество элементов, что и количество реплик. Когда есть несколько групп реплик, все они должны быть одинакового размера. Например, replica_groups = {0, 2}, {1, 3} выполняет сокращение между репликатами 0 и 2 и 1 и 3 и затем рассеивает результат.
• shard_count - это размер каждой группы копий. Нам нужно это в тех случаях, когда replica_groups пусты. Если replica_groups не пуст, shard_count должен быть равен размеру каждой группы реплик.
• channel_id используется для передачи передачи модулей: только операции reduce-scatter с одним и тем же channel_id может общаться друг с другом.

Выходная форма - это форма ввода с scatter_dimension сделанным shard_count Times меньше. Например, если есть две реплики, а операнд имеет значение [1.0, 2.25] и [3.0, 5.25] соответственно на две реплики, то выходное значение из этого OP, где scatter_dim - 0 будет [4.0] для первого Реплика и [7.5] для второй копии.

Уменьшить WWINDOW

См. Также XlaBuilder::ReduceWindow .

Применяет функцию восстановления ко всем элементам в каждом окне последовательности n многомерных массивов, создавая один или кортеж из n многомерных массивов в качестве вывода. Каждый выходной массив имеет одинаковое количество элементов, что и количество допустимых позиций окна. Объединенный слой может быть выражен в виде ReduceWindow . Подобно Reduce , приложенное computation всегда передается init_values ​​с левой стороны.

ReduceWindow(operands..., init_values..., computation, window_dimensions, window_strides, padding)

Где:

• N должен быть больше или равен 1.
• Все входные массивы должны иметь одинаковые размеры.
• Если N = 1 , Collate(T) - это T .
• Если N > 1 , Collate(T_0, ..., T_{N-1}) -это кортеж N элементов типа (T0,...T{N-1}) .

Ниже код и рисунок показан пример использования ReduceWindow . Ввод - это матрица размера [4x6], а как window_dimensions, так и window_stride_dimensions [2x3].

// Create a computation for the reduction (maximum).
XlaComputation max;
{
  XlaBuilder builder(client_, "max");
  auto y = builder.Parameter(0, ShapeUtil::MakeShape(F32, {}), "y");
  auto x = builder.Parameter(1, ShapeUtil::MakeShape(F32, {}), "x");
  builder.Max(y, x);
  max = builder.Build().value();
}

// Create a ReduceWindow computation with the max reduction computation.
XlaBuilder builder(client_, "reduce_window_2x3");
auto shape = ShapeUtil::MakeShape(F32, {4, 6});
auto input = builder.Parameter(0, shape, "input");
builder.ReduceWindow(
    input,
    /*init_val=*/builder.ConstantLiteral(LiteralUtil::MinValue(F32)),
    *max,
    /*window_dimensions=*/{2, 3},
    /*window_stride_dimensions=*/{2, 3},
    Padding::kValid);

Шаг 1 в измерении указывает, что положение окна в измерении составляет 1 элемент от его соседнего окна. Чтобы указать, что ни одно окна перекрывается друг с другом, Window_stride_dimensions должен быть равным Window_dimensions. Рисунок ниже иллюстрирует использование двух разных значений шага. Заполнение применяется к каждому измерению ввода, а вычисления одинаковы, как если бы вход пришел с размерами, которые он имеет после заполнения.

For a non-trivial padding example, consider computing reduce-window minimum (initial value is MAX_FLOAT ) with dimension 3 and stride 2 over the input array [10000, 1000, 100, 10, 1] . Padding kValid computes minimums over two valid windows: [10000, 1000, 100] and [100, 10, 1] , resulting in the output [100, 1] . Padding kSame first pads the array so that the shape after the reduce-window would be the same as input for stride one by adding initial elements on both sides, getting [MAX_VALUE, 10000, 1000, 100, 10, 1, MAX_VALUE] . Running reduce-window over the padded array operates on three windows [MAX_VALUE, 10000, 1000] , [1000, 100, 10] , [10, 1, MAX_VALUE] , and yields [1000, 10, 1] .

The evaluation order of the reduction function is arbitrary and may be non-deterministic. Therefore, the reduction function should not be overly sensitive to reassociation. See the discussion about associativity in the context of Reduce for more details.

ReplicaId

See also XlaBuilder::ReplicaId .

Returns the unique ID (U32 scalar) of the replica.

ReplicaId()

The unique ID of each replica is an unsigned integer in the interval [0, N) , where N is the number of replicas. Since all the replicas are running the same program, a ReplicaId() call in the program will return a different value on each replica.

Reshape

See also XlaBuilder::Reshape and the Collapse operation.

Reshapes the dimensions of an array into a new configuration.

Reshape(operand, new_sizes) Reshape(operand, dimensions, new_sizes)

Conceptually, reshape first flattens an array into a one-dimensional vector of data values, and then refines this vector into a new shape. The input arguments are an arbitrary array of type T, a compile-time-constant vector of dimension indices, and a compile-time-constant vector of dimension sizes for the result. The values in the dimension vector, if given, must be a permutation of all of T's dimensions; the default if not given is {0, ..., rank - 1} . The order of the dimensions in dimensions is from slowest-varying dimension (most major) to fastest-varying dimension (most minor) in the loop nest which collapses the input array into a single dimension. The new_sizes vector determines the size of the output array. The value at index 0 in new_sizes is the size of dimension 0, the value at index 1 is the size of dimension 1, and so on. The product of the new_size dimensions must equal the product of the operand's dimension sizes. When refining the collapsed array into the multidimensional array defined by new_sizes , the dimensions in new_sizes are ordered from slowest varying (most major) and to fastest varying (most minor).

For example, let v be an array of 24 elements:

let v = f32[4x2x3] { { {10, 11, 12}, {15, 16, 17} },
                    { {20, 21, 22}, {25, 26, 27} },
                    { {30, 31, 32}, {35, 36, 37} },
                    { {40, 41, 42}, {45, 46, 47} } };

In-order collapse:
let v012_24 = Reshape(v, {0,1,2}, {24});
then v012_24 == f32[24] {10, 11, 12, 15, 16, 17, 20, 21, 22, 25, 26, 27,
                         30, 31, 32, 35, 36, 37, 40, 41, 42, 45, 46, 47};

let v012_83 = Reshape(v, {0,1,2}, {8,3});
then v012_83 == f32[8x3] { {10, 11, 12}, {15, 16, 17},
                          {20, 21, 22}, {25, 26, 27},
                          {30, 31, 32}, {35, 36, 37},
                          {40, 41, 42}, {45, 46, 47} };

Out-of-order collapse:
let v021_24 = Reshape(v, {1,2,0}, {24});
then v012_24 == f32[24]  {10, 20, 30, 40, 11, 21, 31, 41, 12, 22, 32, 42,
                          15, 25, 35, 45, 16, 26, 36, 46, 17, 27, 37, 47};

let v021_83 = Reshape(v, {1,2,0}, {8,3});
then v021_83 == f32[8x3] { {10, 20, 30}, {40, 11, 21},
                          {31, 41, 12}, {22, 32, 42},
                          {15, 25, 35}, {45, 16, 26},
                          {36, 46, 17}, {27, 37, 47} };


let v021_262 = Reshape(v, {1,2,0}, {2,6,2});
then v021_262 == f32[2x6x2] { { {10, 20}, {30, 40},
                              {11, 21}, {31, 41},
                              {12, 22}, {32, 42} },
                             { {15, 25}, {35, 45},
                              {16, 26}, {36, 46},
                              {17, 27}, {37, 47} } };

As a special case, reshape can transform a single-element array to a scalar and vice versa. Например,

Reshape(f32[1x1] { {5} }, {0,1}, {}) == 5;
Reshape(5, {}, {1,1}) == f32[1x1] { {5} };

Rev (reverse)

See also XlaBuilder::Rev .

Rev(operand, dimensions)

Reverses the order of elements in the operand array along the specified dimensions , generating an output array of the same shape. Each element of the operand array at a multidimensional index is stored into the output array at a transformed index. The multidimensional index is transformed by reversing the index in each dimension to be reversed (ie, if a dimension of size N is one of the reversing dimensions, its index i is transformed into N - 1 - i).

One use for the Rev operation is to reverse the convolution weight array along the two window dimensions during the gradient computation in neural networks.

RngNormal

See also XlaBuilder::RngNormal .

Constructs an output of a given shape with random numbers generated following the \(N(\mu, \sigma)\) нормальное распределение. The parameters \(\mu\) и \(\sigma\), and output shape have to have a floating point elemental type. The parameters furthermore have to be scalar valued.

RngNormal(mu, sigma, shape)

RngUniform

See also XlaBuilder::RngUniform .

Constructs an output of a given shape with random numbers generated following the uniform distribution over the interval \([a,b)\). The parameters and output element type have to be a boolean type, an integral type or a floating point types, and the types have to be consistent. The CPU and GPU backends currently only support F64, F32, F16, BF16, S64, U64, S32 and U32. Furthermore, the parameters need to be scalar valued. Если \(b <= a\) the result is implementation-defined.

RngUniform(a, b, shape)

RngBitGenerator

Generates an output with a given shape filled with uniform random bits using the specified algorithm (or backend default) and returns an updated state (with the same shape as initial state) and the generated random data.

Initial state is the initial state of the current random number generation. It and the required shape and valid values are dependent on the algorithm used.

The output is guaranteed to be a deterministic function of the initial state but it is not guaranteed to be deterministic between backends and different compiler versions.

RngBitGenerator(algorithm, key, shape)

Available values for algorithm :

• rng_default : Backend specific algorithm with backend specific shape requirements.

• rng_three_fry : ThreeFry counter-based PRNG algorithm. The initial_state shape is u64[2] with arbitrary values. Salmon et al. SC 2011. Parallel random numbers: as easy as 1, 2, 3.

• rng_philox : Philox algorithm to generate random numbers in parallel. The initial_state shape is u64[3] with arbitrary values. Salmon et al. SC 2011. Parallel random numbers: as easy as 1, 2, 3.

Разброс

The XLA scatter operation generates a sequence of results which are the values of the input array operands , with several slices (at indices specified by scatter_indices ) updated with the sequence of values in updates using update_computation .

See also XlaBuilder::Scatter .

scatter(operands..., scatter_indices, updates..., update_computation, index_vector_dim, update_window_dims, inserted_window_dims, scatter_dims_to_operand_dims)

Где:

• N is required to be greater or equal to 1.
• operands [ 0 ], ..., operands [ N-1 ] must all have the same dimensions.
• updates [ 0 ], ..., updates [ N-1 ] must all have the same dimensions.
• If N = 1 , Collate(T) is T .
• If N > 1 , Collate(T_0, ..., T_N) is a tuple of N elements of type T .

If index_vector_dim is equal to scatter_indices.rank we implicitly consider scatter_indices to have a trailing 1 dimension.

We define update_scatter_dims of type ArraySlice<int64> as the set of dimensions in updates shape that are not in update_window_dims , in ascending order.

The arguments of scatter should follow these constraints:

• Each updates array must be of rank update_window_dims.size + scatter_indices.rank - 1 .

• Bounds of dimension i in each updates array must conform to the following:

  • If i is present in update_window_dims (ie equal to update_window_dims [ k ] for some k ), then the bound of dimension i in updates must not exceed the corresponding bound of operand after accounting for the inserted_window_dims (ie adjusted_window_bounds [ k ], where adjusted_window_bounds contains the bounds of operand with the bounds at indices inserted_window_dims removed).
  • If i is present in update_scatter_dims (ie equal to update_scatter_dims [ k ] for some k ), then the bound of dimension i in updates must be equal to the corresponding bound of scatter_indices , skipping index_vector_dim (ie scatter_indices.shape.dims [ k ], if k < index_vector_dim and scatter_indices.shape.dims [ k+1 ] otherwise).

• update_window_dims must be in ascending order, not have any repeating dimension numbers, and be in the range [0, updates.rank) .

• inserted_window_dims must be in ascending order, not have any repeating dimension numbers, and be in the range [0, operand.rank) .

• operand.rank must equal the sum of update_window_dims.size and inserted_window_dims.size .

• scatter_dims_to_operand_dims.size must be equal to scatter_indices.shape.dims [ index_vector_dim ], and its values must be in the range [0, operand.rank) .

For a given index U in each updates array, the corresponding index I in the corresponding operands array into which this update has to be applied is computed as follows:

1. Let G = { U [ k ] for k in update_scatter_dims }. Use G to look up an index vector S in the scatter_indices array such that S [ i ] = scatter_indices [Combine( G , i )] where Combine(A, b) inserts b at positions index_vector_dim into A.
2. Create an index S in into operand using S by scattering S using the scatter_dims_to_operand_dims map. More formally:
   1. S in [ scatter_dims_to_operand_dims [ k ]] = S [ k ] if k < scatter_dims_to_operand_dims.size .
   2. S in [ _ ] = 0 otherwise.
3. Create an index W in into each operands array by scattering the indices at update_window_dims in U according to inserted_window_dims . More formally:
   1. W in [ window_dims_to_operand_dims ( k )] = U [ k ] if k is in update_window_dims , where window_dims_to_operand_dims is the monotonic function with domain [ 0 , update_window_dims.size ) and range [ 0 , operand.rank ) \ inserted_window_dims . (For example, if update_window_dims.size is 4 , operand.rank is 6 , and inserted_window_dims is { 0 , 2 } then window_dims_to_operand_dims is { 0 → 1 , 1 → 3 , 2 → 4 , 3 → 5 }).
   2. W in [ _ ] = 0 otherwise.
4. I is W in + S in where + is element-wise addition.

In summary, the scatter operation can be defined as follows.

• Initialize output with operands , ie for all indices J , for all indices O in the operands [ J ] array:
  output [ J ][ O ] = operands [ J ][ O ]
• For every index U in the updates [ J ] array and the corresponding index O in the operand [ J ] array, if O is a valid index for output :
  (output [ 0 ][ O ], ..., output [ N-1 ][ O ]) = update_computation ( output [ 0 ][ O ], ..., , output [ N-1 ][ O ], updates [ 0 ][ U ], ..., updates [ N-1 ][ U ])

The order in which updates are applied is non-deterministic. So, when multiple indices in updates refer to the same index in operands , the corresponding value in output will be non-deterministic.

Note that the first parameter that is passed into the update_computation will always be the current value from the output array and the second parameter will always be the value from the updates array. This is important specifically for cases when the update_computation is not commutative .

If indices_are_sorted is set to true then XLA can assume that scatter_indices are sorted (in ascending order, after scattering its values according to scatter_dims_to_operand_dims ) by the user. If they are not then the semantics are implementation defined.

If unique_indices is set to true then XLA can assume that all elements scattered to are unique. So XLA could use non-atomic operations. If unique_indices is set to true and the indices being scattered to are not unique then the semantics is implementation defined.

Informally, the scatter op can be viewed as an inverse of the gather op, ie the scatter op updates the elements in the input that are extracted by the corresponding gather op.

For a detailed informal description and examples, refer to the "Informal Description" section under Gather .

Выбирать

See also XlaBuilder::Select .

Constructs an output array from elements of two input arrays, based on the values of a predicate array.

Select(pred, on_true, on_false)

The arrays on_true and on_false must have the same shape. This is also the shape of the output array. The array pred must have the same dimensionality as on_true and on_false , with the PRED element type.

For each element P of pred , the corresponding element of the output array is taken from on_true if the value of P is true , and from on_false if the value of P is false . As a restricted form of broadcasting , pred can be a scalar of type PRED . In this case, the output array is taken wholly from on_true if pred is true , and from on_false if pred is false .

Example with non-scalar pred :

let pred: PRED[4] = {true, false, false, true};
let v1: s32[4] = {1, 2, 3, 4};
let v2: s32[4] = {100, 200, 300, 400};
==>
Select(pred, v1, v2) = s32[4]{1, 200, 300, 4};

Example with scalar pred :

let pred: PRED = true;
let v1: s32[4] = {1, 2, 3, 4};
let v2: s32[4] = {100, 200, 300, 400};
==>
Select(pred, v1, v2) = s32[4]{1, 2, 3, 4};

Selections between tuples are supported. Tuples are considered to be scalar types for this purpose. If on_true and on_false are tuples (which must have the same shape!) then pred has to be a scalar of type PRED .

SelectAndScatter

See also XlaBuilder::SelectAndScatter .

This operation can be considered as a composite operation that first computes ReduceWindow on the operand array to select an element from each window, and then scatters the source array to the indices of the selected elements to construct an output array with the same shape as the operand множество. The binary select function is used to select an element from each window by applying it across each window, and it is called with the property that the first parameter's index vector is lexicographically less than the second parameter's index vector. The select function returns true if the first parameter is selected and returns false if the second parameter is selected, and the function must hold transitivity (ie, if select(a, b) and select(b, c) are true , then select(a, c) is also true ) so that the selected element does not depend on the order of the elements traversed for a given window.

The function scatter is applied at each selected index in the output array. It takes two scalar parameters:

1. Current value at the selected index in the output array
2. The scatter value from source that applies to the selected index

It combines the two parameters and returns a scalar value that's used to update the value at the selected index in the output array. Initially, all indices of the output array are set to init_value .

The output array has the same shape as the operand array and the source array must have the same shape as the result of applying a ReduceWindow operation on the operand array. SelectAndScatter can be used to backpropagate the gradient values for a pooling layer in a neural network.

SelectAndScatter(operand, select, window_dimensions, window_strides, padding, source, init_value, scatter)

The figure below shows examples of using SelectAndScatter , with the select function computing the maximal value among its parameters. Note that when the windows overlap, as in the figure (2) below, an index of the operand array may be selected multiple times by different windows. In the figure, the element of value 9 is selected by both of the top windows (blue and red) and the binary addition scatter function produces the output element of value 8 (2 + 6).

The evaluation order of the scatter function is arbitrary and may be non-deterministic. Therefore, the scatter function should not be overly sensitive to reassociation. See the discussion about associativity in the context of Reduce for more details.

Отправлять

See also XlaBuilder::Send .

Send(operand, channel_handle)

Sends the given operand data to a Recv instruction in another computation that shares the same channel handle. Does not return any data.

Similar to the Recv operation, the client API of Send operation represents synchronous communication, and is internally decomposed into 2 HLO instructions ( Send and SendDone ) to enable asynchronous data transfers. See also HloInstruction::CreateSend and HloInstruction::CreateSendDone .

Send(HloInstruction operand, int64 channel_id)

Initiates an asynchronous transfer of the operand to the resources allocated by the Recv instruction with the same channel id. Returns a context, which is used by a following SendDone instruction to wait for the completion of the data transfer. The context is a tuple of {operand (shape), request identifier (U32)} and it can only be used by a SendDone instruction.

SendDone(HloInstruction context)

Given a context created by a Send instruction, waits for the data transfer to complete. The instruction does not return any data.

Scheduling of channel instructions

The execution order of the 4 instructions for each channel ( Recv , RecvDone , Send , SendDone ) is as below.

• Recv happens before Send
• Send happens before RecvDone
• Recv happens before RecvDone
• Send happens before SendDone

When the backend compilers generate a linear schedule for each computation that communicates via channel instructions, there must not be cycles across the computations. For example, below schedules lead to deadlocks.

Срез

See also XlaBuilder::Slice .

Slicing extracts a sub-array from the input array. The sub-array is of the same rank as the input and contains the values inside a bounding box within the input array where the dimensions and indices of the bounding box are given as arguments to the slice operation.

Slice(operand, start_indices, limit_indices, strides)

1-dimensional example:

let a = {0.0, 1.0, 2.0, 3.0, 4.0}
Slice(a, {2}, {4}) produces:
  {2.0, 3.0}

2-dimensional example:

let b =
 { {0.0,  1.0,  2.0},
   {3.0,  4.0,  5.0},
   {6.0,  7.0,  8.0},
   {9.0, 10.0, 11.0} }

Slice(b, {2, 1}, {4, 3}) produces:
  { { 7.0,  8.0},
    {10.0, 11.0} }

Сортировать

See also XlaBuilder::Sort .

Sort(operands, comparator, dimension, is_stable)

If only one operand is provided:

• If the operand is a rank-1 tensor (an array), the result is a sorted array. If you want to sort the array into ascending order, the comparator should perform a less-than comparison. Formally, after the array is sorted, it holds for all index positions i, j with i < j that either comparator(value[i], value[j]) = comparator(value[j], value[i]) = false or comparator(value[i], value[j]) = true .

• If the operand has higher rank, the operand is sorted along the provided dimension. For example, for a rank-2 tensor (a matrix), a dimension value of 0 will independently sort every column, and a dimension value of 1 will independently sort each row. If no dimension number is provided, then the last dimension is chosen by default. For the dimension which is sorted, the same sorting order applies as in the rank-1 case.

If n > 1 operands are provided:

• All n operands must be tensors with the same dimensions. The element types of the tensors may be different.

• All operands are sorted together, not individually. Conceptually the operands are treated as a tuple. When checking whether the elements of each operand at index positions i and j need to be swapped, the comparator is called with 2 * n scalar parameters, where parameter 2 * k corresponds to the value at position i from the k-th operand, and parameter 2 * k + 1 corresponds to the value at position j from the k-th operand. Usually, the comparator would thus compare parameters 2 * k and 2 * k + 1 with each other and possibly use other parameter pairs as tie breakers.

• The result is a tuple that consists of the operands in sorted order (along the provided dimension, as above). The i-th operand of the tuple corresponds to the i-th operand of Sort.

For example, if there are three operands operand0 = [3, 1] , operand1 = [42, 50] , operand2 = [-3.0, 1.1] , and the comparator compares only the values of operand0 with less-than, then the output of the sort is the tuple ([1, 3], [50, 42], [1.1, -3.0]) .

If is_stable is set to true, the sort is guaranteed to be stable, that is, if there are elements which are considered to be equal by the comparator, the relative order of the equal values is preserved. Two elements e1 and e2 are equal if and only if comparator(e1, e2) = comparator(e2, e1) = false . By default, is_stable is set to false.

Transpose

See also the tf.reshape operation.

Transpose(operand)

Permutes the operand dimensions with the given permutation, so ∀ i . 0 ≤ i < rank ⇒ input_dimensions[permutation[i]] = output_dimensions[i] .

This is the same as Reshape(operand, permutation, Permute(permutation, operand.shape.dimensions)).

TriangularSolve

See also XlaBuilder::TriangularSolve .

Solves systems of linear equations with lower or upper triangular coefficient matrices by forward- or back-substitution. Broadcasting along leading dimensions, this routine solves one of the matrix systems op(a) * x = b , or x * op(a) = b , for the variable x , given a and b , where op(a) is either op(a) = a , or op(a) = Transpose(a) , or op(a) = Conj(Transpose(a)) .

TriangularSolve(a, b, left_side, lower, unit_diagonal, transpose_a)

Input data is read only from the lower/upper triangle of a , depending on the value of lower . Values from the other triangle are ignored. Output data is returned in the same triangle; the values in the other triangle are implementation-defined and may be anything.

If the rank of a and b are greater than 2, they are treated as batches of matrices, where all except the minor 2 dimensions are batch dimensions. a and b must have equal batch dimensions.

Tuple

See also XlaBuilder::Tuple .

A tuple containing a variable number of data handles, each of which has its own shape.

This is analogous to std::tuple in C++. Концептуально:

let v: f32[10] = f32[10]{0, 1, 2, 3, 4, 5, 6, 7, 8, 9};
let s: s32 = 5;
let t: (f32[10], s32) = tuple(v, s);

Tuples can be deconstructed (accessed) via the GetTupleElement operation.

Пока

See also XlaBuilder::While .

While(condition, body, init)

Sequentially executes the body until the condition fails. This is similar to a typical while loop in many other languages except for the differences and restrictions listed below.

• A While node returns a value of type T , which is the result from the last execution of the body .
• The shape of the type T is statically determined and must be the same across all iterations.

The T parameters of the computations are initialized with the init value in the first iteration and are automatically updated to the new result from body in each subsequent iteration.

One main use case of the While node is to implement the repeated execution of training in neural networks. Simplified pseudocode is shown below with a graph that represents the computation. The code can be found in while_test.cc . The type T in this example is a Tuple consisting of an int32 for the iteration count and a vector[10] for the accumulator. For 1000 iterations, the loop keeps adding a constant vector to the accumulator.

// Pseudocode for the computation.
init = {0, zero_vector[10]} // Tuple of int32 and float[10].
result = init;
while (result(0) < 1000) {
  iteration = result(0) + 1;
  new_vector = result(1) + constant_vector[10];
  result = {iteration, new_vector};
}