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

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

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

Узнайте больше о структуре операции в разделах Фигуры и макеты, а также Плиточный макет .

Пресс

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

Поэлементно abs x -> |x| .

Abs(operand)

Информацию о StableHLO см. в разделе StableHLO - abs .

Добавлять

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

Выполняет поэлементное сложение lhs и rhs .

Add(lhs, rhs)

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

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

Add(lhs,rhs, broadcast_dimensions)

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

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

Информацию о StableHLO смотрите в разделе StableHLO - add .

AddDependency

См. также HloInstruction::AddDependency .

AddDependency может появляться в дампах HLO, но они не предназначены для ручного создания конечными пользователями.

После всего

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

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

AfterAll(tokens)

Информацию о StableHLO см. в разделе StableHLO-after_all .

AllGather

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

Выполняет конкатенацию реплик.

AllGather(operand, all_gather_dimension, shard_count, replica_groups, channel_id, layout, use_global_device_ids)

• 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 могут взаимодействовать друг с другом.
• use_global_device_ids Возвращает true, если идентификаторы в конфигурации ReplicaGroup представляют собой глобальный идентификатор (replica_id * partition_count + partition_id), а не идентификатор реплики. Это обеспечивает более гибкую группировку устройств, если этот all-reduce является как кросс-раздельным, так и кросс-реплиным.

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

API AllGather внутренне разлагается на 2 инструкции HLO ( AllGatherStart и AllGatherDone ).

См. также HloInstruction::CreateAllGatherStart .

AllGatherStart и AllGatherDone служат примитивами в HLO. Эти операции могут появляться в дампах HLO, но они не предназначены для ручной сборки конечными пользователями.

Информацию о StableHLO см. на странице StableHLO - all_gather .

AllReduce

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

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

AllReduce(operand, computation, replica_groups, channel_id, shape_with_layout, use_global_device_ids)

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

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

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

API AllReduce внутренне разбит на 2 инструкции HLO ( AllReduceStart и AllReduceDone ).

См. также HloInstruction::CreateAllReduceStart .

AllReduceStart и AllReduceDone служат примитивами в HLO. Эти операции могут появляться в дампах HLO, но они не предназначены для ручного создания конечными пользователями.

CrossReplicaSum

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

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

CrossReplicaSum(operand, replica_groups)

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

ВсеВсем

См. также 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. Затем еще один AllToAll будет применен внутри реплик 4, 5, 0, и порядок объединения также будет 4, 5, 0. Если replica_groups пуст, все реплики принадлежат одной группе в порядке объединения их появления.

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

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

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

Дополнительную информацию о формах и макетах см. в разделе xla::shapes.

Информацию о StableHLO см. в разделе StableHLO - all_to_all .

AllToAll - Пример 1.

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 части по размерности 1, поэтому каждая часть имеет вид f32[4,4]. Эти 4 части распределяются по всем ядрам. Затем каждое ядро ​​объединяет полученные части по размерности 0 в порядке от ядер 0 до 4. Таким образом, выход каждого ядра имеет вид f32[16,4].

AllToAll - Пример 2 - StableHLO

В приведенном выше примере в алгоритме AllToAll участвуют две реплики. В каждой реплике операнд имеет размер f32[2,4]. Операнд разделён на две части по размерности 1, поэтому каждая часть имеет размер f32[2,2]. Эти две части затем обмениваются между репликами в соответствии с их положением в группе реплик. Каждая реплика собирает соответствующую часть из обоих операндов и объединяет их по размерности 0. В результате выход каждой реплики имеет размер f32[4,2].

RaggedAllToAll

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

RaggedAllToAll выполняет коллективную операцию «все ко всем», где входными и выходными данными являются рваные тензоры.

RaggedAllToAll(input, input_offsets, send_sizes, output, output_offsets, recv_sizes, replica_groups, channel_id)

Оборванные тензоры определяются набором из трех тензоров:

• data : тензор data «рваный» вдоль своего самого внешнего измерения, вдоль которого каждый индексированный элемент имеет переменный размер.
• offsets : тензор offsets индексирует самое внешнее измерение тензора data и представляет собой начальное смещение каждого неровного элемента тензора data .
• sizes : тензор sizes представляет собой размер каждого неровного элемента тензора data , где размер указывается в единицах подэлементов. Подэлемент определяется как суффикс формы тензора «данных», полученный путем удаления самого внешнего «неровного» измерения.
• Тензоры offsets и sizes должны иметь одинаковый размер.

Пример рваного тензора:

data: [8,3] =
{ {a,b,c},{d,e,f},{g,h,i},{j,k,l},{m,n,o},{p,q,r},{s,t,u},{v,w,x} }

offsets: [3] = {0, 1, 4}

sizes: [3] = {1, 3, 4}

// Index 'data' at 'offsets'[0], 'sizes'[0]' // {a,b,c}

// Index 'data' at 'offsets'[1], 'sizes'[1]' // {d,e,f},{g,h,i},{j,k,l}

// Index 'data' at 'offsets'[2], 'sizes'[2]' // {m,n,o},{p,q,r},{s,t,u},{v,w,x}

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

Для i-го смещения вывода текущая реплика отправит обновление input[input_offsets[i]:input_offsets[i]+input_sizes[i]] на i -ю реплику, которое будет записано в output_i[output_offsets[i]:output_offsets[i]+send_sizes[i]] в i -й реплике output .

Например, если у нас есть 2 реплики:

replica 0:
input: [1, 2, 2]
output:[0, 0, 0, 0]
input_offsets: [0, 1]
send_sizes: [1, 2]
output_offsets: [0, 0]
recv_sizes: [1, 1]

replica 1:
input: [3, 4, 0]
output: [0, 0, 0, 0]
input_offsets: [0, 1]
send_sizes: [1, 1]
output_offsets: [1, 2]
recv_sizes: [2, 1]

// replica 0's result will be: [1, 3, 0, 0]
// replica 1's result will be: [2, 2, 4, 0]

У оборванного и бескомпромиссного HLO есть следующие аргументы:

• input : неровный тензор входных данных.
• output : неровный тензор выходных данных.
• input_offsets : тензор неровных входных смещений.
• send_sizes : тензор неровных размеров отправки.
• output_offsets : массив неровных смещений в выходных данных целевой реплики.
• recv_sizes : тензор неровных размеров recv.

Тензоры *_offsets и *_sizes должны иметь одинаковую форму.

Для тензоров *_offsets и *_sizes поддерживаются две формы:

• [num_devices] , где ragged-all-to-all может отправить не более одного обновления на каждое удалённое устройство в группе реплик. Например:

for (remote_device_id : replica_group) {
     SEND input[input_offsets[remote_device_id]],
     output[output_offsets[remote_device_id]],
     send_sizes[remote_device_id] }

• [num_devices, num_updates] , где ragged-all-to-all может отправить до num_updates обновлений одному и тому же удаленному устройству (каждое с разным смещением) для каждого удаленного устройства в группе реплик.

Например:

for (remote_device_id : replica_group) {
    for (update_idx : num_updates) {
        SEND input[input_offsets[remote_device_id][update_idx]],
        output[output_offsets[remote_device_id][update_idx]]],
        send_sizes[remote_device_id][update_idx] } }

И

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

Выполняет поэлементную операцию И двух тензоров lhs и rhs .

And(lhs, rhs)

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

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

And(lhs,rhs, broadcast_dimensions)

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

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

Информацию о StableHLO см. в разделах StableHLO - и .

Асинхронный

См. также HloInstruction::CreateAsyncStart , HloInstruction::CreateAsyncUpdate , HloInstruction::CreateAsyncDone .

AsyncDone , AsyncStart и AsyncUpdate — это внутренние инструкции HLO, используемые для асинхронных операций и служащие примитивами в HLO. Эти операции могут появляться в дампах HLO, но они не предназначены для ручного создания конечными пользователями.

Атан2

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

Выполняет поэлементную операцию atan2 над lhs и rhs .

Atan2(lhs, rhs)

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

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

Atan2(lhs,rhs, broadcast_dimensions)

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

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

Информацию о StableHLO см. на странице StableHLO - atan2 .

BatchNormGrad

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

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

BatchNormGrad(operand, scale, batch_mean, batch_var, 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} \]

Входные данные batch_mean и batch_var представляют собой значения моментов по пакетным и пространственным измерениям.

Выходной тип — кортеж из трех дескрипторов:

Информацию о StableHLO см. в разделе StableHLO - batch_norm_grad .

BatchNormInference

См. также 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 .

Информацию о StableHLO см. в разделе StableHLO - batch_norm_inference .

BatchNormTraining

Подробное описание алгоритма см. также в 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} - \mu_l)^2$

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

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

Выходной тип — кортеж из трех XlaOp :

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

Информацию о StableHLO см. в разделе StableHLO - batch_norm_training .

Биткаст

См. также HloInstruction::CreateBitcast .

Bitcast может появляться в дампах HLO, но они не предназначены для ручного создания конечными пользователями.

BitcastConvertType

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

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

BitcastConvertType(operand, new_element_type)

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

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

Информацию о StableHLO см. в разделе StableHLO - bitcast_convert .

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 .

Информацию о StableHLO смотрите в разделе StableHLO - broadcast .

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, operands...)

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

CompositeCall

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

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

Поле версии (по умолчанию 0) используется для обозначения момента изменения семантики композита.

Эта операция реализована как kCall с атрибутом is_composite=true . Поле decomposition определяется атрибутом computation . Атрибуты frontend хранят оставшиеся атрибуты с префиксом composite.

Пример операции CompositeCall:

f32[] call(f32[] %cst), to_apply=%computation, is_composite=true,
frontend_attributes = {
  composite.name="foo.bar",
  composite.attributes={n = 1 : i32, tensor = dense<1> : tensor<i32>},
  composite.version="1"
}

CompositeCall(computation, operands..., name, attributes, version)

decomposition операции не является вызываемым полем, а вместо этого отображается как атрибут to_apply, который указывает на функцию, содержащую реализацию более низкого уровня, т. е. to_apply=%funcname

Более подробную информацию о композите и разложении можно найти в спецификации StableHLO .

Cbrt

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

Поэлементная операция извлечения кубического корня x -> cbrt(x) .

Cbrt(operand)

Cbrt также поддерживает необязательный аргумент result_accuracy :

Cbrt(operand, result_accuracy)

Дополнительную информацию о result_accuracy см. в разделе Точность результата .

Информацию о StableHLO см. на странице StableHLO - cbrt .

Потолок

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

Поэлементно ceil x -> ⌈x⌉ .

Ceil(operand)

Информацию о StableHLO см. на странице StableHLO - ceil .

Холецкий

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

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

Cholesky(a, lower)

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

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

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

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

Информацию о StableHLO см. на странице StableHLO-cholesky .

Зажим

См. также 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};

Информацию о StableHLO см. в разделе StableHLO-clamp .

Крах

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

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

Collapse(operand, dimensions)

Collapse заменяет заданное подмножество измерений операнда одним измерением. Входные аргументы — произвольный массив типа 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} };

Клз

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

Поэлементный подсчет начальных нулей.

Clz(operand)

CollectiveBroadcast

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

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

CollectiveBroadcast(operand, replica_groups, channel_id)

Информацию о StableHLO см. на странице StableHLO-collective_broadcast .

CollectivePermute

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

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

CollectivePermute(operand, source_target_pairs, channel_id, inplace)

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

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

API операции CollectivePermute внутренне разлагается на 2 инструкции HLO ( CollectivePermuteStart и CollectivePermuteDone ).

См. также HloInstruction::CreateCollectivePermuteStart .

CollectivePermuteStart и CollectivePermuteDone служат примитивами в HLO. Эти операции могут появляться в дампах HLO, но они не предназначены для ручного создания конечными пользователями.

Информацию о StableHLO см. в разделе StableHLO - collective_permute .

Сравнивать

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

Выполняет поэлементное сравнение lhs и rhs следующих элементов:

Уравнение

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

Выполняет поэлементное сравнение на равенство для lhs и rhs .

\(lhs = rhs\)

Eq(lhs, rhs)

The arguments' shapes have to be either similar or compatible. See the broadcasting documentation about what it means for shapes to be compatible. The result of an operation has a shape which is the result of broadcasting the two input arrays. In this variant, operations between arrays of different ranks are not supported, unless one of the operands is a scalar.

An alternative variant with different-dimensional broadcasting support exists for Eq:

Eq(lhs,rhs, broadcast_dimensions)

This variant of the operation should be used for arithmetic operations between arrays of different ranks (such as adding a matrix to a vector).

The additional broadcast_dimensions operand is a slice of integers specifying the dimensions to use for broadcasting the operands. The semantics are described in detail on the broadcasting page .

Support a total order over the floating point numbers exists for Eq, by enforcing:

\[-NaN < -Inf < -Finite < -0 < +0 < +Finite < +Inf < +NaN.\]

EqTotalOrder(lhs,rhs, broadcast_dimensions)

For StableHLO information see StableHLO - compare .

Не

See also XlaBuilder::Ne .

Performs element-wise not equal-to comparison of lhs and rhs .

\(lhs != rhs\)

Ne(lhs, rhs)

The arguments' shapes have to be either similar or compatible. See the broadcasting documentation about what it means for shapes to be compatible. The result of an operation has a shape which is the result of broadcasting the two input arrays. In this variant, operations between arrays of different ranks are not supported, unless one of the operands is a scalar.

An alternative variant with different-dimensional broadcasting support exists for Ne:

Ne(lhs,rhs, broadcast_dimensions)

This variant of the operation should be used for arithmetic operations between arrays of different ranks (such as adding a matrix to a vector).

The additional broadcast_dimensions operand is a slice of integers specifying the dimensions to use for broadcasting the operands. The semantics are described in detail on the broadcasting page .

Support a total order over the floating point numbers exists for Ne, by enforcing:

\[-NaN < -Inf < -Finite < -0 < +0 < +Finite < +Inf < +NaN.\]

NeTotalOrder(lhs,rhs, broadcast_dimensions)

For StableHLO information see StableHLO - compare .

Ге

See also XlaBuilder::Ge .

Performs element-wise greater-or-equal-than comparison of lhs and rhs .

\(lhs >= rhs\)

Ge(lhs, rhs)

The arguments' shapes have to be either similar or compatible. See the broadcasting documentation about what it means for shapes to be compatible. The result of an operation has a shape which is the result of broadcasting the two input arrays. In this variant, operations between arrays of different ranks are not supported, unless one of the operands is a scalar.

An alternative variant with different-dimensional broadcasting support exists for Ge:

Ge(lhs,rhs, broadcast_dimensions)

This variant of the operation should be used for arithmetic operations between arrays of different ranks (such as adding a matrix to a vector).

The additional broadcast_dimensions operand is a slice of integers specifying the dimensions to use for broadcasting the operands. The semantics are described in detail on the broadcasting page .

Support a total order over the floating point numbers exists for Gt, by enforcing:

\[-NaN < -Inf < -Finite < -0 < +0 < +Finite < +Inf < +NaN.\]

GtTotalOrder(lhs,rhs, broadcast_dimensions)

For StableHLO information see StableHLO - compare .

Gt

See also XlaBuilder::Gt .

Performs element-wise greater-than comparison of lhs and rhs .

\(lhs > rhs\)

Gt(lhs, rhs)

The arguments' shapes have to be either similar or compatible. See the broadcasting documentation about what it means for shapes to be compatible. The result of an operation has a shape which is the result of broadcasting the two input arrays. In this variant, operations between arrays of different ranks are not supported, unless one of the operands is a scalar.

An alternative variant with different-dimensional broadcasting support exists for Gt:

Gt(lhs,rhs, broadcast_dimensions)

This variant of the operation should be used for arithmetic operations between arrays of different ranks (such as adding a matrix to a vector).

The additional broadcast_dimensions operand is a slice of integers specifying the dimensions to use for broadcasting the operands. The semantics are described in detail on the broadcasting page .

For StableHLO information see StableHLO - compare .

Ле

See also XlaBuilder::Le .

Performs element-wise less-or-equal-than comparison of lhs and rhs .

\(lhs <= rhs\)

Le(lhs, rhs)

The arguments' shapes have to be either similar or compatible. See the broadcasting documentation about what it means for shapes to be compatible. The result of an operation has a shape which is the result of broadcasting the two input arrays. In this variant, operations between arrays of different ranks are not supported, unless one of the operands is a scalar.

An alternative variant with different-dimensional broadcasting support exists for Le:

Le(lhs,rhs, broadcast_dimensions)

This variant of the operation should be used for arithmetic operations between arrays of different ranks (such as adding a matrix to a vector).

The additional broadcast_dimensions operand is a slice of integers specifying the dimensions to use for broadcasting the operands. The semantics are described in detail on the broadcasting page .

Support a total order over the floating point numbers exists for Le, by enforcing:

\[-NaN < -Inf < -Finite < -0 < +0 < +Finite < +Inf < +NaN.\]

LeTotalOrder(lhs,rhs, broadcast_dimensions)

For StableHLO information see StableHLO - compare .

лейтенант

See also XlaBuilder::Lt .

Performs element-wise less-than comparison of lhs and rhs .

\(lhs < rhs\)

Lt(lhs, rhs)

The arguments' shapes have to be either similar or compatible. See the broadcasting documentation about what it means for shapes to be compatible. The result of an operation has a shape which is the result of broadcasting the two input arrays. In this variant, operations between arrays of different ranks are not supported, unless one of the operands is a scalar.

An alternative variant with different-dimensional broadcasting support exists for Lt:

Lt(lhs,rhs, broadcast_dimensions)

This variant of the operation should be used for arithmetic operations between arrays of different ranks (such as adding a matrix to a vector).

The additional broadcast_dimensions operand is a slice of integers specifying the dimensions to use for broadcasting the operands. The semantics are described in detail on the broadcasting page .

Support a total order over the floating point numbers exists for Lt, by enforcing:

\[-NaN < -Inf < -Finite < -0 < +0 < +Finite < +Inf < +NaN.\]

LtTotalOrder(lhs,rhs, broadcast_dimensions)

For StableHLO information see StableHLO - compare .

Сложный

See also XlaBuilder::Complex .

Performs element-wise conversion to a complex value from a pair of real and imaginary values, lhs and rhs .

Complex(lhs, rhs)

The arguments' shapes have to be either similar or compatible. See the broadcasting documentation about what it means for shapes to be compatible. The result of an operation has a shape which is the result of broadcasting the two input arrays. In this variant, operations between arrays of different ranks are not supported, unless one of the operands is a scalar.

An alternative variant with different-dimensional broadcasting support exists for Complex:

Complex(lhs,rhs, broadcast_dimensions)

This variant of the operation should be used for arithmetic operations between arrays of different ranks (such as adding a matrix to a vector).

The additional broadcast_dimensions operand is a slice of integers specifying the dimensions to use for broadcasting the operands. The semantics are described in detail on the broadcasting page .

For StableHLO information see StableHLO - complex .

ConcatInDim (Concatenate)

See also XlaBuilder::ConcatInDim .

Concatenate composes an array from multiple array operands. The array has the same number of dimensions as each of the input array operands (which must have the same number of dimensions as each other) and contains the arguments in the order that they were specified.

Concatenate(operands..., dimension)

With the exception of dimension all dimensions must be the same. This is because XLA does not support "ragged" arrays. Also note that 0-dimensional values cannot be concatenated (as it's impossible to name the dimension along which the concatenation occurs).

1-dimensional example:

Concat({ {2, 3}, {4, 5}, {6, 7} }, 0)
//Output:  {2, 3, 4, 5, 6, 7}

2-dimensional example:

let a = { {1, 2},
         {3, 4},
         {5, 6} };

let b = { {7, 8} };

Concat({a, b}, 0)

//Output:  { {1, 2},
//          {3, 4},
//          {5, 6},
//          {7, 8} }

Diagram:

For StableHLO information see StableHLO - concatenate .

Условный

See also XlaBuilder::Conditional .

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

Executes true_computation if predicate is true , false_computation if predicate is false , and returns the result.

The true_computation must take in a single argument of type \(T_0\) and will be invoked with true_operand which must be of the same type. The false_computation must take in a single argument of type \(T_1\) and will be invoked with false_operand which must be of the same type. The type of the returned value of true_computation and false_computation must be the same.

Note that only one of true_computation and false_computation will be executed depending on the value of predicate .

Conditional(branch_index, branch_computations, branch_operands)

Executes branch_computations[branch_index] , and returns the result. If branch_index is an S32 which is < 0 or >= N, then branch_computations[N-1] is executed as the default branch.

Each branch_computations[b] must take in a single argument of type \(T_b\) and will be invoked with branch_operands[b] which must be of the same type. The type of the returned value of each branch_computations[b] must be the same.

Note that only one of the branch_computations will be executed depending on the value of branch_index .

For StableHLO information see StableHLO - if .

Постоянный

See also XlaBuilder::ConstantLiteral .

Produces an output from a constant literal .

Constant(literal)

For StableHLO information see StableHLO - constant .

ConvertElementType

See also XlaBuilder::ConvertElementType .

Similar to an element-wise static_cast in C++, ConvertElementType performs an element-wise conversion operation from a data shape to a target shape. The dimensions must match, and the conversion is an element-wise one; eg s32 elements become f32 elements via an s32 -to- f32 conversion routine.

ConvertElementType(operand, new_element_type)

The dimensions of the operand and the target shape must match. The source and destination element types must not be tuples.

A conversion such as T=s32 to U=f32 will perform a normalizing int-to-float conversion routine such as round-to-nearest-even.

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

For StableHLO information see StableHLO - convert .

Conv (Convolution)

See also XlaBuilder::Conv .

Computes a convolution of the kind used in neural networks. Here, a convolution can be thought of as a n-dimensional window moving across a n-dimensional base area and a computation is performed for each possible position of the window.

Conv Enqueues a convolution instruction onto the computation, which uses the default convolution dimension numbers with no dilation.

The padding is specified in a short-hand way as either SAME or VALID. SAME padding pads the input ( lhs ) with zeroes so that the output has the same shape as the input when not taking striding into account. VALID padding simply means no padding.

Conv(lhs, rhs, window_strides, padding, feature_group_count, batch_group_count, precision_config, preferred_element_type)

Increasing levels of controls are available for Conv :

• ConvWithGeneralPadding
• ConvWithGeneralDimensions
• ConvGeneral
• ConvGeneralDilated

Let n be the number of spatial dimensions. The lhs argument is an (n+2)-dimensional array describing the base area. This is called the input, even though of course the rhs is also an input. In a neural network, these are the input activations. The n+2 dimensions are, in this order:

• batch : Each coordinate in this dimension represents an independent input for which convolution is carried out.
• z/depth/features : Each (y,x) position in the base area has a vector associated to it, which goes into this dimension.
• spatial_dims : Describes the n spatial dimensions that define the base area that the window moves across.

The rhs argument is an (n+2)-dimensional array describing the convolutional filter/kernel/window. The dimensions are, in this order:

• output-z : The z dimension of the output.
• input-z : The size of this dimension times feature_group_count should equal the size of the z dimension in lhs.
• spatial_dims : Describes the n spatial dimensions that define the nd window that moves across the base area.

The window_strides argument specifies the stride of the convolutional window in the spatial dimensions. For example, if the stride in the first spatial dimension is 3, then the window can only be placed at coordinates where the first spatial index is divisible by 3.

The padding argument specifies the amount of zero padding to be applied to the base area. The amount of padding can be negative -- the absolute value of negative padding indicates the number of elements to remove from the specified dimension before doing the convolution. padding[0] specifies the padding for dimension y and padding[1] specifies the padding for dimension x . Each pair has the low padding as the first element and the high padding as the second element. The low padding is applied in the direction of lower indices while the high padding is applied in the direction of higher indices. For example, if padding[1] is (2,3) then there will be a padding by 2 zeroes on the left and by 3 zeroes on the right in the second spatial dimension. Using padding is equivalent to inserting those same zero values into the input ( lhs ) before doing the convolution.

The lhs_dilation and rhs_dilation arguments specify the dilation factor to be applied to the lhs and rhs, respectively, in each spatial dimension. If the dilation factor in a spatial dimension is d, then d-1 holes are implicitly placed between each of the entries in that dimension, increasing the size of the array. The holes are filled with a no-op value, which for convolution means zeroes.

Dilation of the rhs is also called atrous convolution. For more details, see tf.nn.atrous_conv2d . Dilation of the lhs is also called transposed convolution. For more details, see tf.nn.conv2d_transpose .

The feature_group_count argument (default value 1) can be used for grouped convolutions. feature_group_count needs to be a divisor of both the input and the output feature dimension. If feature_group_count is greater than 1, it means that conceptually the input and output feature dimension and the rhs output feature dimension are split evenly into many feature_group_count groups, each group consisting of a consecutive subsequence of features. The input feature dimension of rhs needs to be equal to the lhs input feature dimension divided by feature_group_count (so it already has the size of a group of input features). The i-th groups are used together to compute feature_group_count for many separate convolutions. The results of these convolutions are concatenated together in the output feature dimension.

For depthwise convolution the feature_group_count argument would be set to the input feature dimension, and the filter would be reshaped from [filter_height, filter_width, in_channels, channel_multiplier] to [filter_height, filter_width, 1, in_channels * channel_multiplier] . For more details, see tf.nn.depthwise_conv2d .

The batch_group_count (default value 1) argument can be used for grouped filters during backpropagation. batch_group_count needs to be a divisor of the size of the lhs (input) batch dimension. If batch_group_count is greater than 1, it means that the output batch dimension should be of size input batch / batch_group_count . The batch_group_count must be a divisor of the output feature size.

The output shape has these dimensions, in this order:

• batch : The size of this dimension times batch_group_count should equal the size of the batch dimension in lhs.
• z : Same size as output-z on the kernel ( rhs ).
• spatial_dims : One value for each valid placement of the convolutional window.

The figure above shows how the batch_group_count field works. Effectively, we slice each lhs batch into batch_group_count groups, and do the same for the output features. Then, for each of these groups we do pairwise convolutions and concatenate the output along the output feature dimension. The operational semantics of all the other dimensions (feature and spatial) remain the same.

The valid placements of the convolutional window are determined by the strides and the size of the base area after padding.

To describe what a convolution does, consider a 2d convolution, and pick some fixed batch , z , y , x coordinates in the output. Then (y,x) is a position of a corner of the window within the base area (eg the upper left corner, depending on how you interpret the spatial dimensions). We now have a 2d window, taken from the base area, where each 2d point is associated to a 1d vector, so we get a 3d box. From the convolutional kernel, since we fixed the output coordinate z , we also have a 3d box. The two boxes have the same dimensions, so we can take the sum of the element-wise products between the two boxes (similar to a dot product). That is the output value.

Note that if output-z is eg, 5, then each position of the window produces 5 values in the output into the z dimension of the output. These values differ in what part of the convolutional kernel is used - there is a separate 3d box of values used for each output-z coordinate. So you could think of it as 5 separate convolutions with a different filter for each of them.

Here is pseudo-code for a 2d convolution with padding and striding:

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;
}

precision_config is used to indicate the precision configuration. The level dictates whether hardware should attempt to generate more machine code instructions to provide more accurate dtype emulation when needed (ie emulating f32 on a TPU that only supports bf16 matmuls). Values may be DEFAULT , HIGH , HIGHEST . Additional details in the MXU sections .

preferred_element_type is a scalar element of higher/lower precision output types used for accumulation. preferred_element_type recommends the accumulation type for the given operation, however it is not guaranteed. This allows for some hardware backends to instead accumulate in a different type and convert to the preferred output type.

For StableHLO information see StableHLO - convolution .

ConvWithGeneralPadding

See also XlaBuilder::ConvWithGeneralPadding .

ConvWithGeneralPadding(lhs, rhs, window_strides, padding, feature_group_count, batch_group_count, precision_config, preferred_element_type)

Same as Conv where padding configuration is explicit.

ConvWithGeneralDimensions

See also XlaBuilder::ConvWithGeneralDimensions .

ConvWithGeneralDimensions(lhs, rhs, window_strides, padding, dimension_numbers, feature_group_count, batch_group_count, precision_config, preferred_element_type)

Same as Conv where dimension numbers are explicit.

ConvGeneral

See also XlaBuilder::ConvGeneral .

ConvGeneral(lhs, rhs, window_strides, padding, dimension_numbers, feature_group_count, batch_group_count, precision_config, preferred_element_type)

Same as Conv where dimension numbers and padding configuration is explicit

ConvGeneralDilated

See also XlaBuilder::ConvGeneralDilated .

ConvGeneralDilated(lhs, rhs, window_strides, padding, lhs_dilation, rhs_dilation, dimension_numbers, feature_group_count, batch_group_count, precision_config, preferred_element_type, window_reversal)

Same as Conv where padding configuration, dilation factors, and dimension numbers are explicit.

Копировать

See also HloInstruction::CreateCopyStart .

Copy is internally decomposed into 2 HLO instructions CopyStart and CopyDone . Copy along with CopyStart and CopyDone serve as primitives in HLO. These ops may appear in HLO dumps, but they are not intended to be constructed manually by end users.

Потому что

See also XlaBuilder::Cos .

Element-wise cosine x -> cos(x) .

Cos(operand)

Cos also supports the optional result_accuracy argument:

Cos(operand, result_accuracy)

For more information on result_accuracy see Result Accuracy .

For StableHLO information see StableHLO - cosine .

Cosh

See also XlaBuilder::Cosh .

Element-wise hyperbolic cosine x -> cosh(x) .

Cosh(operand)

Cosh also supports the optional result_accuracy argument:

Cosh(operand, result_accuracy)

For more information on result_accuracy see Result Accuracy .

CustomCall

See also XlaBuilder::CustomCall .

Call a user-provided function within a computation.

CustomCall documentation is provided in Developer details - XLA Custom Calls

For StableHLO information see StableHLO - custom_call .

Див

See also XlaBuilder::Div .

Performs element-wise division of dividend lhs and divisor rhs .

Div(lhs, rhs)

Integer division overflow (signed/unsigned division/remainder by zero or signed division/remainder of INT_SMIN with -1 ) produces an implementation defined value.

The arguments' shapes have to be either similar or compatible. See the broadcasting documentation about what it means for shapes to be compatible. The result of an operation has a shape which is the result of broadcasting the two input arrays. In this variant, operations between arrays of different ranks are not supported, unless one of the operands is a scalar.

An alternative variant with different-dimensional broadcasting support exists for Div:

Div(lhs,rhs, broadcast_dimensions)

This variant of the operation should be used for arithmetic operations between arrays of different ranks (such as adding a matrix to a vector).

The additional broadcast_dimensions operand is a slice of integers specifying the dimensions to use for broadcasting the operands. The semantics are described in detail on the broadcasting page .

For StableHLO information see StableHLO - divide .

Домен

See also HloInstruction::CreateDomain .

Domain may appear in HLO dumps, but it is not intended to be constructed manually by end users.

Точка

See also XlaBuilder::Dot .

Dot(lhs, rhs, precision_config, preferred_element_type)

The exact semantics of this operation depend on the ranks of the operands:

The operation performs sum of products over the second dimension of lhs (or the first if it has 1 dimension) and the first dimension of rhs . These are the "contracted" dimensions. The contracted dimensions of lhs and rhs must be of the same size. In practice, it can be used to perform dot products between vectors, vector/matrix multiplications or matrix/matrix multiplications.

precision_config is used to indicate the precision configuration. The level dictates whether hardware should attempt to generate more machine code instructions to provide more accurate dtype emulation when needed (ie emulating f32 on a TPU that only supports bf16 matmuls). Values may be DEFAULT , HIGH , HIGHEST . Additional details in the MXU sections .

preferred_element_type is a scalar element of higher/lower precision output types used for accumulation. preferred_element_type recommends the accumulation type for the given operation, however it is not guaranteed. This allows for some hardware backends to instead accumulate in a different type and convert to the preferred output type.

For StableHLO information see StableHLO - dot .

DotGeneral

See also XlaBuilder::DotGeneral .

DotGeneral(lhs, rhs, dimension_numbers, precision_config, preferred_element_type)

Similar to Dot, but allows contracting and batch dimension numbers to be specified for both the lhs and rhs .

DotGeneral performs the sum of products over contracting dimensions specified in dimension_numbers .

Associated contracting dimension numbers from the lhs and rhs do not need to be the same but must have the same dimension sizes.

Example with contracting dimension numbers:

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} }

Associated batch dimension numbers from the lhs and rhs must have the same dimension sizes.

Example with batch dimension numbers (batch size 2, 2x2 matrices):

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} } }

It follows that the resulting dimension number starts with the batch dimension, then the lhs non-contracting/non-batch dimension, and finally the rhs non-contracting/non-batch dimension.

precision_config is used to indicate the precision configuration. The level dictates whether hardware should attempt to generate more machine code instructions to provide more accurate dtype emulation when needed (ie emulating f32 on a TPU that only supports bf16 matmuls). Values may be DEFAULT , HIGH , HIGHEST . Additional details can be found in the MXU sections .

preferred_element_type is a scalar element of higher/lower precision output types used for accumulation. preferred_element_type recommends the accumulation type for the given operation, however it is not guaranteed. This allows for some hardware backends to instead accumulate in a different type and convert to the preferred output type.

For StableHLO information see StableHLO - dot_general .

ScaledDot

See also XlaBuilder::ScaledDot .

ScaledDot(lhs, lhs_scale, rhs, rhs_scale, dimension_number, precision_config,preferred_element_type)

Similar to DotGeneral .

Creates a scaled dot op with operands 'lhs', 'lhs_scale', 'rhs', and 'rhs_scale', with contracting and batch dimensions specified in 'dimension_numbers'.

RaggedDot

See also XlaBuilder::RaggedDot .

For a breakdown of RaggedDot computation see StableHLO - chlo.ragged_dot

DynamicReshape

See also XlaBuilder::DynamicReshape .

This operation is functionally identical to reshape , but the result shape is specified dynamically via output_shape.

DynamicReshape(operand, dim_sizes, new_size_bounds, dims_are_dynamic)

For StableHLO information see StableHLO - dynamic_reshape .

DynamicSlice

See also XlaBuilder::DynamicSlice .

DynamicSlice extracts a sub-array from the input array at dynamic start_indices . The size of the slice in each dimension is passed in size_indices , which specify the end point of exclusive slice intervals in each dimension: [start, start + size). The shape of start_indices must be 1-dimensional, with dimension size equal to the number of dimensions of operand .

DynamicSlice(operand, start_indices, slice_sizes)

The effective slice indices are computed by applying the following transformation for each index i in [1, N) before performing the slice:

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

This ensures that the extracted slice is always in-bounds with respect to the operand array. If the slice is in-bounds before the transformation is applied, the transformation has no effect.

1-dimensional example:

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

DynamicSlice(a, s, {2});
// Result: {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} }
let s = {2, 1}

DynamicSlice(b, s, {2, 2});
//Result:
// { { 7.0,  8.0},
//   {10.0, 11.0} }

For StableHLO information see StableHLO - dynamic_slice .

DynamicUpdateSlice

See also XlaBuilder::DynamicUpdateSlice .

DynamicUpdateSlice generates a result which is the value of the input array operand , with a slice update overwritten at start_indices . The shape of update determines the shape of the sub-array of the result which is updated. The shape of start_indices must be 1-dimensional, with dimension size equal to the number of dimensions of operand .

DynamicUpdateSlice(operand, update, start_indices)

The effective slice indices are computed by applying the following transformation for each index i in [1, N) before performing the slice:

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

This ensures that the updated slice is always in-bounds with respect to the operand array. If the slice is in-bounds before the transformation is applied, the transformation has no effect.

1-dimensional example:

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)
// Result: {0.0, 1.0, 5.0, 6.0, 4.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} }
let u =
{ {12.0, 13.0},
  {14.0, 15.0},
  {16.0, 17.0} }

let s = {1, 1}

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

For StableHLO information see StableHLO - dynamic_update_slice .

Erf

See also XlaBuilder::Erf .

Element-wise error function x -> erf(x) where:

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

Erf(operand)

Erf also supports the optional result_accuracy argument:

Erf(operand, result_accuracy)

For more information on result_accuracy see Result Accuracy .

Опыт

See also XlaBuilder::Exp .

Element-wise natural exponential x -> e^x .

Exp(operand)

Exp also supports the optional result_accuracy argument:

Exp(operand, result_accuracy)

For more information on result_accuracy see Result Accuracy .

For StableHLO information see StableHLO - exponential .

Expm1

See also XlaBuilder::Expm1 .

Element-wise natural exponential minus one x -> e^x - 1 .

Expm1(operand)

Expm1 also supports the optional result_accuracy argument:

Expm1(operand, result_accuracy)

For more information on result_accuracy see Result Accuracy .

For StableHLO information see StableHLO - exponential_minus_one .

Fft

See also XlaBuilder::Fft .

The XLA FFT operation implements the forward and inverse Fourier Transforms for real and complex inputs/outputs. Multidimensional FFTs on up to 3 axes are supported.

Fft(operand, ftt_type, fft_length)

For StableHLO information see StableHLO - fft .

Multidimensional FFT

When more than 1 fft_length is provided, this is equivalent to applying a cascade of FFT operations to each of the innermost axes. Note that for the real->complex and complex->real cases, the innermost axis transform is (effectively) performed first (RFFT; last for IRFFT), which is why the innermost axis is the one which changes size. Other axis transforms will then be complex->complex.

Подробности реализации

CPU FFT is backed by Eigen's TensorFFT. GPU FFT uses cuFFT.

Пол

See also XlaBuilder::Floor .

Element-wise floor x -> ⌊x⌋ .

Floor(operand)

For StableHLO information see StableHLO - floor .

Слияние

See also HloInstruction::CreateFusion .

Fusion operation represents HLO instructions and serves as a primitive in HLO. This op may appear in HLO dumps but is not intended to be constructed manually by end users.

Собирать

The XLA gather operation stitches together several slices (each slice at a potentially different runtime offset) of an input array.

For StableHLO information see StableHLO - gather .

General Semantics

See also XlaBuilder::Gather . For a more intuitive description, see the "Informal Description" section below.

gather(operand, start_indices, dimension_numbers, slice_sizes, indices_are_sorted)

For convenience, we label dimensions in the output array not in offset_dims as batch_dims .

The output is an array with batch_dims.size + offset_dims.size dimensions.

The operand.rank must equal the sum of offset_dims.size and collapsed_slice_dims.size . Also, slice_sizes.size has to be equal to operand.rank .

If index_vector_dim is equal to start_indices.rank we implicitly consider start_indices to have a trailing 1 dimension (ie if start_indices was of shape [6,7] and index_vector_dim is 2 then we implicitly consider the shape of start_indices to be [6,7,1] ).

The bounds for the output array along dimension i is computed as follows:

1. If i is present in batch_dims (ie is equal to batch_dims[k] for some k ) then we pick the corresponding dimension bounds out of start_indices.shape , skipping index_vector_dim (ie pick start_indices.shape.dims [ k ] if k < index_vector_dim and start_indices.shape.dims [ k + 1 ] otherwise).

2. If i is present in offset_dims (ie equal to offset_dims [ k ] for some k ) then we pick the corresponding bound out of slice_sizes after accounting for collapsed_slice_dims (ie we pick adjusted_slice_sizes [ k ] where adjusted_slice_sizes is slice_sizes with the bounds at indices collapsed_slice_dims removed).

Formally, the operand index In corresponding to a given output index Out is calculated as follows:

1. Let G = { Out [ k ] for k in batch_dims }. Use G to slice out a vector S such that S [ i ] = start_indices [Combine( G , i )] where Combine(A, b) inserts b at position index_vector_dim into A. Note that this is well defined even if G is empty: If G is empty then S = start_indices .

2. Create a starting index, S in , into operand using S by scattering S using start_index_map . More precisely:

   1. S in [ start_index_map [ k ]] = S [ k ] if k < start_index_map.size .

   2. S in [ _ ] = 0 otherwise.

3. Create an index O in into operand by scattering the indices at the offset dimensions in Out according to the collapsed_slice_dims set. More precisely:

   1. O in [ remapped_offset_dims ( k )] = Out [ offset_dims [ k ]] if k < offset_dims.size ( remapped_offset_dims is defined below).

   2. O in [ _ ] = 0 otherwise.

4. In is O in + S in where + is element-wise addition.

remapped_offset_dims is a monotonic function with domain [ 0 , offset_dims.size ) and range [ 0 , operand.rank ) \ collapsed_slice_dims . So if, eg, offset_dims.size is 4 , operand.rank is 6 and collapsed_slice_dims is { 0 , 2 } then remapped_offset_dims is { 0 → 1 , 1 → 3 , 2 → 4 , 3 → 5 }.

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

Informal Description and Examples

Informally, every index Out in the output array corresponds to an element E in the operand array, computed as follows:

• We use the batch dimensions in Out to look up a starting index from start_indices .

• We use start_index_map to map the starting index (whose size may be less than operand.rank) to a "full" starting index into the operand .

• We dynamic-slice out a slice with size slice_sizes using the full starting index.

• We reshape the slice by collapsing the collapsed_slice_dims dimensions. Since all collapsed slice dimensions must have a bound of 1, this reshape is always legal.

• We use the offset dimensions in Out to index into this slice to get the input element, E , corresponding to output index Out .

index_vector_dim is set to start_indices.rank - 1 in all of the examples that follow. More interesting values for index_vector_dim do not change the operation fundamentally, but make the visual representation more cumbersome.

To get an intuition on how all of the above fits together, let's look at an example that gathers 5 slices of shape [8,6] from a [16,11] array. The position of a slice into the [16,11] array can be represented as an index vector of shape S64[2] , so the set of 5 positions can be represented as a S64[5,2] array.

The behavior of the gather operation can then be depicted as an index transformation that takes [ G , O 0 , O 1 ], an index in the output shape, and maps it to an element in the input array in the following way:

We first select an ( X , Y ) vector from the gather indices array using G . The element in the output array at index [ G , O 0 , O 1 ] is then the element in the input array at index [ X + O 0 , Y + O 1 ].

slice_sizes is [8,6] , which decides the range of O ₀ and O ₁ , and this in turn decides the bounds of the slice.

This gather operation acts as a batch dynamic slice with G as the batch dimension.

The gather indices may be multidimensional. For instance, a more general version of the example above using a "gather indices" array of shape [4,5,2] would translate indices like this:

Again, this acts as a batch dynamic slice G 0 and G 1 as the batch dimensions. The slice size is still [8,6] .

The gather operation in XLA generalizes the informal semantics outlined above in the following ways:

1. We can configure which dimensions in the output shape are the offset dimensions (dimensions containing O 0 , O 1 in the last example). The output batch dimensions (dimensions containing G 0 , G 1 in the last example) are defined to be the output dimensions that are not offset dimensions.

2. The number of output offset dimensions explicitly present in the output shape may be smaller than the input number of dimensions. These "missing" dimensions, which are listed explicitly as collapsed_slice_dims , must have a slice size of 1 . Since they have a slice size of 1 the only valid index for them is 0 and eliding them does not introduce ambiguity.

3. The slice extracted from the "Gather Indices" array (( X , Y ) in the last example) may have fewer elements than the input array's number of dimensions, and an explicit mapping dictates how the index should be expanded to have the same number of dimensions as the input.

As a final example, we use (2) and (3) to implement tf.gather_nd :

G 0 and G 1 are used to slice out a starting index from the gather indices array as usual, except the starting index has only one element, X . Similarly, there is only one output offset index with the value O 0 . However, before being used as indices into the input array, these are expanded in accordance to "Gather Index Mapping" ( start_index_map in the formal description) and "Offset Mapping" ( remapped_offset_dims in the formal description) into [ X , 0 ] and [ 0 , O 0 ] respectively, adding up to [ X , O 0 ]. In other words, the output index [ G 0 , G 1 , O 0 ] maps to the input index [ GatherIndices [ G 0 , G 1 , 0 ], O 0 ] which gives us the semantics for tf.gather_nd .

slice_sizes for this case is [1,11] . Intuitively this means that every index X in the gather indices array picks an entire row and the result is the concatenation of all these rows.

GetDimensionSize

See also XlaBuilder::GetDimensionSize .

Returns the size of the given dimension of the operand. The operand must be array shaped.

GetDimensionSize(operand, dimension)

For StableHLO information see StableHLO - get_dimension_size .

GetTupleElement

See also XlaBuilder::GetTupleElement .

Indexes into a tuple with a compile-time-constant value.

The value must be a compile-time-constant so that shape inference can determine the type of the resulting value.

This is analogous to std::get<int N>(t) in C++. Conceptually:

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.

See also tf.tuple .

GetTupleElement(tuple_data, index)

For StableHLO information see StableHLO - get_tuple_element .

Imag

See also XlaBuilder::Imag .

Element-wise imaginary part of a complex (or real) shape. x -> imag(x) . If the operand is a floating point type, returns 0.

Imag(operand)

For StableHLO information see StableHLO - imag .

Infeed

See also XlaBuilder::Infeed .

Infeed(shape, config)

Reads a single data item from the implicit Infeed streaming interface of the device, interpreting the data as the given shape and its layout, and returns a XlaOp of the data. Multiple Infeed operations are allowed in a computation, but there must be a total order among the Infeed operations. For example, two Infeed 's in the code below have a total order since there is a dependency between the while loops.

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

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

Nested tuple shapes are not supported. For an empty tuple shape, the Infeed operation is effectively a no-op and proceeds without reading any data from the Infeed of the device.

For StableHLO information see StableHLO - infeed .

Йота

See also XlaBuilder::Iota .

Iota(shape, iota_dimension)

Builds a constant literal on device rather than a potentially large host transfer. Creates an array that has specified shape and holds values starting at zero and incrementing by one along the specified dimension. For floating-point types, the produced array is equivalent to ConvertElementType(Iota(...)) where the Iota is of integral type and the conversion is to the floating-point type.

For example, Iota(s32[4, 8], 0) returns

[[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) returns

[[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 ]]

For StableHLO information see StableHLO - iota .

IsFinite

See also XlaBuilder::IsFinite .

Tests whether each element of operand is finite, ie, is not positive or negative infinity, and is not NaN . Returns an array of PRED values with the same shape as the input, where each element is true if and only if the corresponding input element is finite.

IsFinite(operand)

For StableHLO information see StableHLO - is_finite .

Бревно

See also XlaBuilder::Log .

Element-wise natural logarithm x -> ln(x) .

Log(operand)

Log also supports the optional result_accuracy argument:

Log(operand, result_accuracy)

For more information on result_accuracy see Result Accuracy .

For StableHLO information see StableHLO - log .

Log1p

See also XlaBuilder::Log1p .

Element-wise shifted natural logarithm x -> ln(1+x) .

Log1p(operand)

Log1p also supports the optional result_accuracy argument:

Log1p(operand, result_accuracy)

For more information on result_accuracy see Result Accuracy .

For StableHLO information see StableHLO - log_plus_one .

Логистика

See also XlaBuilder::Logistic .

Element-wise logistic function computation x -> logistic(x) .

Logistic(operand)

Logistic also supports the optional result_accuracy argument:

Logistic(operand, result_accuracy)

For more information on result_accuracy see Result Accuracy .

For StableHLO information see StableHLO - logistic .

Карта

See also XlaBuilder::Map .

Map(operands..., computation, dimensions)

Applies a scalar function over the given operands arrays, producing an array of the same dimensions where each element is the result of the mapped function applied to the corresponding elements in the input arrays.

The mapped function is an arbitrary computation with the restriction that it has N inputs of scalar type T and a single output with type S . The output has the same dimensions as the operands except that the element type T is replaced with S.

For example: Map(op1, op2, op3, computation, par1) maps elem_out <- computation(elem1, elem2, elem3, par1) at each (multi-dimensional) index in the input arrays to produce the output array.

For StableHLO information see StableHLO - map .

Макс

See also XlaBuilder::Max .

Performs element-wise max operation on tensors lhs and rhs .

Max(lhs, rhs)

The arguments' shapes have to be either similar or compatible. See the broadcasting documentation about what it means for shapes to be compatible. The result of an operation has a shape which is the result of broadcasting the two input arrays. In this variant, operations between arrays of different ranks are not supported, unless one of the operands is a scalar.

An alternative variant with different-dimensional broadcasting support exists for Max:

Max(lhs,rhs, broadcast_dimensions)

This variant of the operation should be used for arithmetic operations between arrays of different ranks (such as adding a matrix to a vector).

The additional broadcast_dimensions operand is a slice of integers specifying the dimensions to use for broadcasting the operands. The semantics are described in detail on the broadcasting page .

For StableHLO information see StableHLO - maximum .

Мин.

See also XlaBuilder::Min .

Performs element-wise min operation on lhs and rhs .

Min(lhs, rhs)

The arguments' shapes have to be either similar or compatible. See the broadcasting documentation about what it means for shapes to be compatible. The result of an operation has a shape which is the result of broadcasting the two input arrays. In this variant, operations between arrays of different ranks are not supported, unless one of the operands is a scalar.

An alternative variant with different-dimensional broadcasting support exists for Min:

Min(lhs,rhs, broadcast_dimensions)

This variant of the operation should be used for arithmetic operations between arrays of different ranks (such as adding a matrix to a vector).

The additional broadcast_dimensions operand is a slice of integers specifying the dimensions to use for broadcasting the operands. The semantics are described in detail on the broadcasting page .

For StableHLO information see StableHLO - minimum .

Мул

See also XlaBuilder::Mul .

Performs element-wise product of lhs and rhs .

Mul(lhs, rhs)

The arguments' shapes have to be either similar or compatible. See the broadcasting documentation about what it means for shapes to be compatible. The result of an operation has a shape which is the result of broadcasting the two input arrays. In this variant, operations between arrays of different ranks are not supported, unless one of the operands is a scalar.

An alternative variant with different-dimensional broadcasting support exists for Mul:

Mul(lhs,rhs, broadcast_dimensions)

This variant of the operation should be used for arithmetic operations between arrays of different ranks (such as adding a matrix to a vector).

The additional broadcast_dimensions operand is a slice of integers specifying the dimensions to use for broadcasting the operands. The semantics are described in detail on the broadcasting page .

For StableHLO information see StableHLO - multiply .

Neg

See also XlaBuilder::Neg .

Element-wise negation x -> -x .

Neg(operand)

For StableHLO information see StableHLO - negate

Нет

See also XlaBuilder::Not .

Element-wise logical not x -> !(x) .

Not(operand)

For StableHLO information see StableHLO - not .

OptimizationBarrier

See also XlaBuilder::OptimizationBarrier .

Blocks any optimization pass from moving computations across the barrier.

OptimizationBarrier(operand)

Ensures that all inputs are evaluated before any operators that depend on the barrier's outputs.

For StableHLO information see StableHLO - optimization_barrier .

Или

See also XlaBuilder::Or .

Performs element-wise OR of lhs and rhs .

Or(lhs, rhs)

The arguments' shapes have to be either similar or compatible. See the broadcasting documentation about what it means for shapes to be compatible. The result of an operation has a shape which is the result of broadcasting the two input arrays. In this variant, operations between arrays of different ranks are not supported, unless one of the operands is a scalar.

An alternative variant with different-dimensional broadcasting support exists for Or:

Or(lhs,rhs, broadcast_dimensions)

This variant of the operation should be used for arithmetic operations between arrays of different ranks (such as adding a matrix to a vector).

The additional broadcast_dimensions operand is a slice of integers specifying the dimensions to use for broadcasting the operands. The semantics are described in detail on the broadcasting page .

For StableHLO information see StableHLO - or .

Outfeed

See also XlaBuilder::Outfeed .

Writes inputs to the outfeed.

Outfeed(operand, shape_with_layout, outfeed_config)

shape_with_layout communicates the laid out shape that we want to outfeed.

For StableHLO information see StableHLO - outfeed .

Пэд

See also XlaBuilder::Pad .

Pad(operand, padding_value, padding_config)

Expands the given operand array by padding around the array as well as between the elements of the array with the given padding_value . padding_config specifies the amount of edge padding and the interior padding for each dimension.

PaddingConfig is a repeated field of PaddingConfigDimension , which contains three fields for each dimension: edge_padding_low , edge_padding_high , and interior_padding .

edge_padding_low and edge_padding_high specify the amount of padding added at the low-end (next to index 0) and the high-end (next to the highest index) of each dimension respectively. The amount of edge padding can be negative -- the absolute value of negative padding indicates the number of elements to remove from the specified dimension.

interior_padding specifies the amount of padding added between any two elements in each dimension; it may not be negative. Interior padding occurs logically before edge padding, so in the case of negative edge padding, elements are removed from the interior-padded operand.

This operation is a no-op if the edge padding pairs are all (0, 0) and the interior padding values are all 0. The figure below shows examples of different edge_padding and interior_padding values for a two-dimensional array.

For StableHLO information see StableHLO - pad .

Параметр

See also XlaBuilder::Parameter .

Parameter represents an argument input to a computation.

PartitionID

See also XlaBuilder::BuildPartitionId .

Produces partition_id of the current process.

PartitionID(shape)

PartitionID may appear in HLO dumps but it is not intended to be constructed manually by end users.

For StableHLO information see StableHLO - partition_id .

PopulationCount

See also XlaBuilder::PopulationCount .

Computes the number of bits set in each element of operand .

PopulationCount(operand)

For StableHLO information see StableHLO - popcnt .

Пау

See also XlaBuilder::Pow .

Performs element-wise exponentiation of lhs by rhs .

Pow(lhs, rhs)

The arguments' shapes have to be either similar or compatible. See the broadcasting documentation about what it means for shapes to be compatible. The result of an operation has a shape which is the result of broadcasting the two input arrays. In this variant, operations between arrays of different ranks are not supported, unless one of the operands is a scalar.

An alternative variant with different-dimensional broadcasting support exists for Pow:

Pow(lhs,rhs, broadcast_dimensions)

This variant of the operation should be used for arithmetic operations between arrays of different ranks (such as adding a matrix to a vector).

The additional broadcast_dimensions operand is a slice of integers specifying the dimensions to use for broadcasting the operands. The semantics are described in detail on the broadcasting page .

For StableHLO information see StableHLO - power .

Настоящий

See also XlaBuilder::Real .

Element-wise real part of a complex (or real) shape. x -> real(x) . If the operand is a floating point type, Real returns the same value.

Real(operand)

For StableHLO information see StableHLO - real .

Recv

See also XlaBuilder::Recv .

Recv , RecvWithTokens , and RecvToHost are operations that serve as communication primitives in HLO. These ops typically appear in HLO dumps as part of low-level input/output or cross-device transfer, but they are not intended to be constructed manually by end users.

Recv(shape, handle)

Receives data of the given shape from a Send instruction in another computation that shares the same channel handle. Returns a XlaOp for the received data.

For StableHLO information see StableHLO - recv .

RecvDone

See also HloInstruction::CreateRecv and HloInstruction::CreateRecvDone .

Similar to Send , the client API of Recv operation represents synchronous communication. However, the instruction is internally decomposed into 2 HLO instructions ( Recv and RecvDone ) to enable asynchronous data transfers.

Recv(const Shape& shape, int64 channel_id)

Allocates resources required to receive data from a Send instruction with the same channel_id. Returns a context for the allocated resources, which is used by a following RecvDone instruction to wait for the completion of the data transfer. The context is a tuple of {receive buffer (shape), request identifier (U32)} and it can only be used by a RecvDone instruction.

Given a context created by a Recv instruction, waits for the data transfer to complete and return the received data.

Уменьшать

See also XlaBuilder::Reduce .

Applies a reduction function to one or more arrays in parallel.

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

Где:

• N is required to be greater or equal to 1.
• The computation has to be "roughly" associative (see below).
• All input arrays must have the same dimensions.
• All initial values have to form an identity under computation .
• If N = 1 , Collate(T) is T .
• If N > 1 , Collate(T_0, ..., T_{N-1}) is a tuple of N elements of type T .

This operation reduces one or more dimensions of each input array into scalars. The number of dimensions of each returned array is number_of_dimensions(operand) - len(dimensions) . The output of the op is Collate(Q_0, ..., Q_N) where Q_i is an array of type T_i , the dimensions of which are described below.

Different backends are allowed to reassociate the reduction computation. This can lead to numerical differences, as some reduction functions like addition are not associative for floats. However, if the range of the data is limited, floating-point addition is close enough to be associative for most practical uses.

For StableHLO information see StableHLO - reduce .

Примеры

When reducing across one dimension in a single 1D array with values [10, 11, 12, 13] , with reduction function f (this is computation ) then that could be computed as

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

but there are also many other possibilities, eg

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

The following is a rough pseudo-code example of how reduction could be implemented, using summation as the reduction computation with an initial value of 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 number of dimensions 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]

Here's an example of reducing a 2D array (matrix). The shape has 2 dimensions, dimension 0 of size 2 and dimension 1 of size 3:

Results of reducing dimensions 0 or 1 with an "add" function:

Note that both reduction results are 1D arrays. The diagram shows one as column and another as row just for visual convenience.

For a more complex example, here is a 3D array. Its number of dimensions is 3, dimension 0 of size 4, dimension 1 of size 2 and dimension 2 of size 3. For simplicity, the values 1 to 6 are replicated across dimension 0.

Similarly to the 2D example, we can reduce just one dimension. If we reduce dimension 0, for example, we get a 2-dimensional array where all values across dimension 0 were folded into a scalar:

|  4   8  12 |
| 16  20  24 |

If we reduce dimension 2, we also get a 2-dimensional array where all values across dimension 2 were folded into a scalar:

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

Note that the relative order between the remaining dimensions in the input is preserved in the output, but some dimensions may get assigned new numbers (since the number of dimensions changes).

We can also reduce multiple dimensions. Add-reducing dimensions 0 and 1 produces the 1D array [20, 28, 36] .

Reducing the 3D array over all its dimensions produces the scalar 84 .

Variadic Reduce

When N > 1 , reduce function application is slightly more complex, as it is applied simultaneously to all inputs. The operands are supplied to the computation in the following order:

• Running reduced value for the first operand
• ...
• Running reduced value for the N'th operand
• Input value for the first operand
• ...
• Input value for the N'th operand

For example, consider the following reduction function, which can be used to compute the max and the argmax of a 1-D array in parallel:

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

For 1-D Input arrays V = Float[N], K = Int[N] , and init values I_V = Float, I_K = Int , the result f_(N-1) of reducing across the only input dimension is equivalent to the following recursive application:

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))

Applying this reduction to an array of values, and an array of sequential indices (ie iota), will co-iterate over the arrays, and return a tuple containing the maximal value and the matching index.

ReducePrecision

See also XlaBuilder::ReducePrecision .

Models the effect of converting floating-point values to a lower-precision format (such as IEEE-FP16) and back to the original format. The number of exponent and mantissa bits in the lower-precision format can be specified arbitrarily, although all bit sizes may not be supported on all hardware implementations.

ReducePrecision(operand, exponent_bits, mantissa_bits)

The result is an array of type T . The input values are rounded to the nearest value representable with the given number of mantissa bits (using "ties to even" semantics), and any values that exceed the range specified by the number of exponent bits are clamped to positive or negative infinity. NaN values are retained, although they may be converted to canonical NaN values.

The lower-precision format must have at least one exponent bit (in order to distinguish a zero value from an infinity, since both have a zero mantissa), and must have a non-negative number of mantissa bits. The number of exponent or mantissa bits may exceed the corresponding value for type T ; the corresponding portion of the conversion is then simply a no-op.

For StableHLO information see StableHLO - reduce_precision .

ReduceScatter

See also XlaBuilder::ReduceScatter .

ReduceScatter is a collective operation that effectively does an AllReduce and then scatters the result by splitting it into shard_count blocks along the scatter_dimension and replica i in the replica group receives the ith shard.

ReduceScatter(operand, computation, scatter_dimension, shard_count, replica_groups, channel_id, layout, use_global_device_ids)

• When operand is a tuple of arrays, the reduce-scatter is performed on each element of the tuple.
• replica_groups is a list of replica groups between which the reduction is performed (replica id for the current replica can be retrieved using ReplicaId ). The order of replicas in each group determines the order in which the all-reduce result will be scattered. replica_groups must either be empty (in which case all replicas belong to a single group), or contain the same number of elements as the number of replicas. When there are more than one replica groups, they all must be of the same size. For example, replica_groups = {0, 2}, {1, 3} performs reduction between the replicas 0 and 2 , and 1 and 3 and then scatters the result.
• shard_count is the size of each replica group. We need this in cases where replica_groups are empty. If replica_groups is not empty, shard_count must be equal to the size of each replica group.
• channel_id is used for cross-module communication: only reduce-scatter operations with the same channel_id can communicate with each other.
• layout See xla::shapes for more information on layouts.
• use_global_device_ids is a user-specified flag. When false (default) the numbers in replica_groups are ReplicaId when true the replica_groups represent a global id of ( ReplicaID * partition_count + partition_id ). For example:
  • With 2 replicas and 4 partitions,
  • replica_groups={ {0,1,4,5},{2,3,6,7} } and use_global_device_ids=true
  • group[0] = (0,0), (0,1), (1,0), (1,1)
  • group[1] = (0,2), (0,3), (1,2), (1,3)
  • where each pair is (replica_id, partition_id).

The output shape is the input shape with the scatter_dimension made shard_count times smaller. For example, if there are two replicas and the operand has the value [1.0, 2.25] and [3.0, 5.25] respectively on the two replicas, then the output value from this op where scatter_dim is 0 will be [4.0] for the first replica and [7.5] for the second replica.

For StableHLO information see StableHLO - reduce_scatter .

ReduceScatter - Example 1 - StableHLO

In the above example, there are 2 replicas participating in the ReduceScatter. On each replica, the operand has shape f32[2,4]. An all-reduce (sum) is performed across the replicas, producing a reduced value of shape f32[2,4] on each replica. This reduced value is then split into 2 parts along dimension 1, so each part has shape f32[2,2]. Each replica within the process group receives the part corresponding to its position in the group. As a result, the output on each replica has shape f32[2,2].

ReduceWindow

See also XlaBuilder::ReduceWindow .

Applies a reduction function to all elements in each window of a sequence of N multi-dimensional arrays, producing a single or a tuple of N multi-dimensional arrays as output. Each output array has the same number of elements as the number of valid positions of the window. A pooling layer can be expressed as a ReduceWindow . Similar to Reduce , the applied computation is always passed the init_values on the left-hand side.

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

Где:

• N is required to be greater or equal to 1.
• All input arrays must have the same dimensions.
• If N = 1 , Collate(T) is T .
• If N > 1 , Collate(T_0, ..., T_{N-1}) is a tuple of N elements of type (T0,...T{N-1}) .

For StableHLO information see StableHLO - reduce_window .

ReduceWindow - Example 1

Input is a matrix of size [4x6] and both window_dimensions and window_stride_dimensions are [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);