Sémantique des opérations

Ce qui suit décrit la sémantique des opérations définies dans l'interface XlaBuilder . En règle générale, ces opérations sont mappées un à un aux opérations définies dans l'interface RPC dans xla_data.proto .

Une note sur la nomenclature : le type de données généralisé traité par XLA est un tableau à N dimensions contenant des éléments d'un type uniforme (tel que float 32 bits). Dans toute la documentation, array est utilisé pour désigner un tableau de dimensions arbitraires. Pour plus de commodité, les cas spéciaux portent des noms plus spécifiques et familiers ; par exemple, un vecteur est un tableau à 1 dimension et une matrice est un tableau à 2 dimensions.

Après tout

Voir aussi XlaBuilder::AfterAll .

AfterAll prend un nombre variable de jetons et produit un seul jeton. Les jetons sont des types primitifs qui peuvent être enfilés entre des opérations à effets secondaires pour appliquer l'ordre. AfterAll peut être utilisé comme jointure de jetons pour commander une opération après un ensemble d'opérations.

AfterAll(operands)

Arguments Taper Sémantique
operands XlaOp nombre variable de jetons

TousRassembler

Voir aussi XlaBuilder::AllGather .

Effectue la concaténation entre les répliques.

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

Arguments Taper Sémantique
operand XlaOp Tableau pour concaténer les répliques.
all_gather_dim int64 Dimension de concaténation.
shard_count int64 Taille de chaque groupe de réplicas.
replica_groups vecteur de vecteurs de int64 Groupes entre lesquels la concaténation est effectuée.
channel_id int64 facultatif ID de canal en option pour la communication entre modules.
  • replica_groups est une liste de groupes de répliques entre lesquels la concaténation est effectuée (l'identifiant de la réplique actuelle peut être récupéré à l'aide de ReplicaId ). L'ordre des répliques dans chaque groupe détermine l'ordre dans lequel leurs entrées se trouvent dans le résultat. replica_groups doit soit être vide (auquel cas toutes les répliques appartiennent à un seul groupe, classé de 0 à N - 1 ), soit contenir le même nombre d'éléments que le nombre de répliques. Par exemple, replica_groups = {0, 2}, {1, 3} effectue une concaténation entre les réplicas 0 et 2 , et 1 et 3 .
  • shard_count est la taille de chaque groupe de réplicas. Nous en avons besoin dans les cas où replica_groups sont vides.
  • channel_id est utilisé pour la communication entre modules : seules les opérations all-gather avec le même channel_id peuvent communiquer entre elles.

La forme de sortie est la forme d'entrée avec all_gather_dim rendu shard_count fois plus grand. Par exemple, s'il y a deux répliques et que l'opérande a respectivement la valeur [1.0, 2.5] et [3.0, 5.25] sur les deux répliques, alors la valeur de sortie de cette opération où all_gather_dim est 0 sera [1.0, 2.5, 3.0, 5.25] sur les deux répliques.

ToutRéduire

Voir aussi XlaBuilder::AllReduce .

Effectue un calcul personnalisé sur les réplicas.

AllReduce(operand, computation, replica_group_ids, channel_id)

Arguments Taper Sémantique
operand XlaOp Tableau ou un tuple non vide de tableaux à réduire entre les réplicas.
computation XlaComputation Calcul de réduction
replica_groups vecteur de vecteurs de int64 Groupes entre lesquels les réductions sont effectuées
channel_id int64 facultatif ID de canal en option pour la communication entre modules
  • Lorsque operand est un tuple de tableaux, la réduction totale est effectuée sur chaque élément du tuple.
  • replica_groups est une liste de groupes de répliques entre lesquels la réduction est effectuée (l'ID de réplique de la réplique actuelle peut être récupéré à l'aide de ReplicaId ). replica_groups doit soit être vide (auquel cas toutes les répliques appartiennent à un seul groupe), soit contenir le même nombre d'éléments que le nombre de répliques. Par exemple, replica_groups = {0, 2}, {1, 3} effectue une réduction entre les réplicas 0 et 2 , et 1 et 3 .
  • channel_id est utilisé pour la communication entre modules : seules les opérations all-reduce avec le même channel_id peuvent communiquer entre elles.

La forme de sortie est la même que la forme d'entrée. Par exemple, s'il y a deux répliques et que l'opérande a respectivement la valeur [1.0, 2.5] et [3.0, 5.25] sur les deux répliques, alors la valeur de sortie de cette opération et de ce calcul de sommation sera [4.0, 7.75] sur les deux répliques. les répliques. Si l’entrée est un tuple, la sortie est également un tuple.

Le calcul du résultat d' AllReduce nécessite d'avoir une entrée de chaque réplique, donc si une réplique exécute un nœud AllReduce plus de fois qu'une autre, l'ancienne réplique attendra indéfiniment. Étant donné que les répliques exécutent toutes le même programme, il n'y a pas beaucoup de façons pour que cela se produise, mais cela est possible lorsque la condition d'une boucle while dépend des données de l'alimentation et que les données alimentées provoquent une itération de la boucle while plus de fois. sur une réplique que sur une autre.

ToutÀTous

Voir aussi XlaBuilder::AllToAll .

AllToAll est une opération collective qui envoie des données de tous les cœurs à tous les cœurs. Il comporte deux phases :

  1. La phase de diffusion. Sur chaque cœur, l'opérande est divisé en nombre split_count de blocs le long de split_dimensions , et les blocs sont dispersés sur tous les cœurs, par exemple, le ième bloc est envoyé au ième noyau.
  2. La phase de rassemblement. Chaque noyau concatène les blocs reçus le long de concat_dimension .

Les cœurs participants peuvent être configurés par :

  • replica_groups : chaque ReplicaGroup contient une liste d'identifiants de réplique participant au calcul (l'identifiant de réplique de la réplique actuelle peut être récupéré à l'aide de ReplicaId ). AllToAll sera appliqué dans les sous-groupes dans l’ordre spécifié. Par exemple, replica_groups = { {1,2,3}, {4,5,0} } signifie qu'un AllToAll sera appliqué dans les répliques {1, 2, 3} et dans la phase de collecte, et les blocs reçus seront être concaténés dans le même ordre de 1, 2, 3. Ensuite, un autre AllToAll sera appliqué dans les répliques 4, 5, 0, et l'ordre de concaténation est également 4, 5, 0. Si replica_groups est vide, toutes les répliques appartiennent à un groupe, dans l’ordre de concaténation de leur apparition.

Conditions préalables:

  • La taille de la dimension de l'opérande sur split_dimension est divisible par split_count .
  • La forme de l'opérande n'est pas un tuple.

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

Arguments Taper Sémantique
operand XlaOp tableau d'entrée à n dimensions
split_dimension int64 Une valeur dans l'intervalle [0, n) qui nomme la dimension selon laquelle l'opérande est divisé
concat_dimension int64 une valeur dans l'intervalle [0, n) qui nomme la dimension le long de laquelle les blocs divisés sont concaténés
split_count int64 le nombre de cœurs qui participent à cette opération. Si replica_groups est vide, cela doit être le nombre de répliques ; sinon, cela doit être égal au nombre de répliques dans chaque groupe.
replica_groups Vecteur ReplicaGroup chaque groupe contient une liste d'identifiants de réplique.

Ci-dessous montre un exemple d'Alltoall.

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

Dans cet exemple, 4 cœurs participent à Alltoall. Sur chaque noyau, l'opérande est divisé en 4 parties selon la dimension 1, donc chaque partie a la forme f32[4,4]. Les 4 parties sont dispersées sur tous les noyaux. Ensuite, chaque noyau concatène les pièces reçues le long de la dimension 0, dans l'ordre du noyau 0-4. Ainsi, la sortie sur chaque noyau a la forme f32[16,4].

LotNormGrad

Voir également XlaBuilder::BatchNormGrad et le document original de normalisation par lots pour une description détaillée de l'algorithme.

Calcule les gradients de la norme du lot.

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

Arguments Taper Sémantique
operand XlaOp tableau à n dimensions à normaliser (x)
scale XlaOp Tableau à 1 dimension (\(\gamma\))
mean XlaOp Tableau à 1 dimension (\(\mu\))
variance XlaOp Tableau à 1 dimension (\(\sigma^2\))
grad_output XlaOp Dégradés transmis à BatchNormTraining (\( \nabla y\))
epsilon float Valeur Epsilon (\(\epsilon\))
feature_index int64 Index de la dimension de fonctionnalité dans operand

Pour chaque fonctionnalité de la dimension de fonctionnalité ( feature_index est l'index de la dimension de fonctionnalité dans operand ), l'opération calcule les gradients par rapport à operand , offset et scale sur toutes les autres dimensions. Le feature_index doit être un index valide pour la dimension de fonctionnalité dans operand .

Les trois dégradés sont définis par les formules suivantes (en supposant un tableau à 4 dimensions comme operand et avec un indice de dimension de caractéristique l , une taille de lot m et des tailles spatiales w et 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} \]

La mean et variance des entrées représentent la valeur des moments dans les dimensions de lot et spatiales.

Le type de sortie est un tuple de trois handles :

Les sorties Taper Sémantique
grad_operand XlaOp gradient par rapport à operand d'entrée (\( \nabla x\))
grad_scale XlaOp gradient par rapport à scale d'entrée (\( \nabla \gamma\))
grad_offset XlaOp gradient par rapport au offset d'entrée (\( \nabla \beta\))

BatchNormInference

Voir également XlaBuilder::BatchNormInference et le document original de normalisation par lots pour une description détaillée de l'algorithme.

Normalise un tableau dans les dimensions de lot et spatiales.

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

Arguments Taper Sémantique
operand XlaOp tableau à n dimensions à normaliser
scale XlaOp Tableau à 1 dimension
offset XlaOp Tableau à 1 dimension
mean XlaOp Tableau à 1 dimension
variance XlaOp Tableau à 1 dimension
epsilon float Valeur Epsilon
feature_index int64 Index de la dimension de fonctionnalité dans operand

Pour chaque caractéristique de la dimension de caractéristique ( feature_index est l'index de la dimension de caractéristique dans operand ), l'opération calcule la moyenne et la variance sur toutes les autres dimensions et utilise la moyenne et la variance pour normaliser chaque élément de operand . Le feature_index doit être un index valide pour la dimension de fonctionnalité dans operand .

BatchNormInference équivaut à appeler BatchNormTraining sans calculer mean et variance pour chaque lot. Il utilise plutôt la mean et variance d’entrée comme valeurs estimées. Le but de cette opération est de réduire la latence d'inférence, d'où le nom BatchNormInference .

La sortie est un tableau normalisé à n dimensions avec la même forme que operand d'entrée.

BatchNormFormation

Voir également XlaBuilder::BatchNormTraining et the original batch normalization paper pour une description détaillée de l'algorithme.

Normalise un tableau dans les dimensions de lot et spatiales.

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

Arguments Taper Sémantique
operand XlaOp tableau à n dimensions à normaliser (x)
scale XlaOp Tableau à 1 dimension (\(\gamma\))
offset XlaOp Tableau à 1 dimension (\(\beta\))
epsilon float Valeur Epsilon (\(\epsilon\))
feature_index int64 Index de la dimension de fonctionnalité dans operand

Pour chaque caractéristique de la dimension de caractéristique ( feature_index est l'index de la dimension de caractéristique dans operand ), l'opération calcule la moyenne et la variance sur toutes les autres dimensions et utilise la moyenne et la variance pour normaliser chaque élément de operand . Le feature_index doit être un index valide pour la dimension de fonctionnalité dans operand .

L'algorithme se déroule comme suit pour chaque lot de operand \(x\) qui contient m éléments avec w et h comme taille des dimensions spatiales (en supposant que operand est un tableau à 4 dimensions) :

  • Calcule la moyenne du lot \(\mu_l\) pour chaque fonctionnalité l dans la dimension de fonctionnalité :\(\mu_l=\frac{1}{mwh}\sum_{i=1}^m\sum_{j=1}^w\sum_{k=1}^h x_{ijkl}\)

  • Calcule la variance du lot \(\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\)

  • Normalise, met à l'échelle et décale :\(y_{ijkl}=\frac{\gamma_l(x_{ijkl}-\mu_l)}{\sqrt[2]{\sigma^2_l+\epsilon} }+\beta_l\)

La valeur epsilon, généralement un petit nombre, est ajoutée pour éviter les erreurs de division par zéro.

Le type de sortie est un tuple de trois XlaOp :

Les sorties Taper Sémantique
output XlaOp tableau à n dimensions avec la même forme que operand d'entrée (y)
batch_mean XlaOp Tableau à 1 dimension (\(\mu\))
batch_var XlaOp Tableau à 1 dimension (\(\sigma^2\))

batch_mean et batch_var sont des moments calculés sur les dimensions du lot et spatiales à l'aide des formules ci-dessus.

BitcastConvertType

Voir aussi XlaBuilder::BitcastConvertType .

Semblable à un tf.bitcast dans TensorFlow, effectue une opération de bitcast par élément d'une forme de données vers une forme cible. La taille d'entrée et de sortie doit correspondre : par exemple, les éléments s32 deviennent des éléments f32 via la routine bitcast, et un élément s32 deviendra quatre éléments s8 . Bitcast est implémenté comme un cast de bas niveau, donc les machines avec différentes représentations à virgule flottante donneront des résultats différents.

BitcastConvertType(operand, new_element_type)

Arguments Taper Sémantique
operand XlaOp tableau de type T avec dims D
new_element_type PrimitiveType tapez U

Les dimensions de l'opérande et de la forme cible doivent correspondre, à l'exception de la dernière dimension qui changera selon le rapport de la taille primitive avant et après la conversion.

Les types d'éléments source et destination ne doivent pas être des tuples.

Conversion Bitcast en type primitif de largeur différente

L'instruction BitcastConvert HLO prend en charge le cas où la taille du type d'élément de sortie T' n'est pas égale à la taille de l'élément d'entrée T . Comme l'ensemble de l'opération est conceptuellement un bitcast et ne modifie pas les octets sous-jacents, la forme de l'élément de sortie doit changer. Pour B = sizeof(T), B' = sizeof(T') , il y a deux cas possibles.

Premièrement, lorsque B > B' , la forme de sortie obtient une nouvelle dimension la plus mineure de taille B/B' . Par exemple:

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

La règle reste la même pour les scalaires efficaces :

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

Alternativement, pour B' > B l'instruction requiert que la dernière dimension logique de la forme d'entrée soit égale à B'/B , et cette dimension est supprimée lors de la conversion :

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

Notez que les conversions entre différentes largeurs de bits ne se font pas par élément.

Diffuser

Voir aussi XlaBuilder::Broadcast .

Ajoute des dimensions à un tableau en dupliquant les données dans le tableau.

Broadcast(operand, broadcast_sizes)

Arguments Taper Sémantique
operand XlaOp Le tableau à dupliquer
broadcast_sizes ArraySlice<int64> Les tailles des nouvelles dimensions

Les nouvelles dimensions sont insérées à gauche, c'est à dire si broadcast_sizes a des valeurs {a0, ..., aN} et que la forme de l'opérande a des dimensions {b0, ..., bM} alors la forme de la sortie a des dimensions {a0, ..., aN, b0, ..., bM} .

Les nouvelles dimensions indexent en copies de l'opérande, c'est-à-dire

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

Par exemple, si operand est un scalaire f32 avec la valeur 2.0f et que broadcast_sizes est {2, 3} , alors le résultat sera un tableau de forme f32[2, 3] et toutes les valeurs du résultat seront 2.0f .

DiffusionDansDim

Voir aussi XlaBuilder::BroadcastInDim .

Étend la taille et le rang d'un tableau en dupliquant les données dans le tableau.

BroadcastInDim(operand, out_dim_size, broadcast_dimensions)

Arguments Taper Sémantique
operand XlaOp Le tableau à dupliquer
out_dim_size ArraySlice<int64> Les tailles des dimensions de la forme cible
broadcast_dimensions ArraySlice<int64> À quelle dimension de la forme cible correspond chaque dimension de la forme de l'opérande ?

Similaire à Broadcast, mais permet d'ajouter des dimensions n'importe où et d'étendre les dimensions existantes avec la taille 1.

L' operand est diffusé vers la forme décrite par out_dim_size . broadcast_dimensions mappe les dimensions de operand aux dimensions de la forme cible, c'est-à-dire que la iième dimension de l'opérande est mappée à la Broadcast_dimension[i]ième dimension de la forme de sortie. Les dimensions de operand doivent avoir la taille 1 ou être de la même taille que la dimension de la forme de sortie à laquelle elles sont mappées. Les dimensions restantes sont remplies de dimensions de taille 1. La diffusion en dimension dégénérée diffuse ensuite le long de ces dimensions dégénérées pour atteindre la forme de sortie. La sémantique est décrite en détail sur la page de diffusion .

Appel

Voir aussi XlaBuilder::Call .

Appelle un calcul avec les arguments donnés.

Call(computation, args...)

Arguments Taper Sémantique
computation XlaComputation calcul de type T_0, T_1, ..., T_{N-1} -> S avec N paramètres de type arbitraire
args séquence de N XlaOp s N arguments de type arbitraire

L'arité et les types des args doivent correspondre aux paramètres du computation . Il est permis de ne pas avoir args .

Cholesky

Voir aussi XlaBuilder::Cholesky .

Calcule la décomposition de Cholesky d'un lot de matrices définies positives symétriques (hermitiennes).

Cholesky(a, lower)

Arguments Taper Sémantique
a XlaOp un tableau de rang > 2 d'un type complexe ou à virgule flottante.
lower bool s'il faut utiliser le triangle supérieur ou inférieur d' a .

Si lower est true , calcule les matrices triangulaires inférieures l telles que \( a = l . l^T \). Si lower est false , calcule les matrices triangulaires supérieures u telles que \( a = u^T . u \).

Les données d'entrée sont lues uniquement à partir du triangle inférieur/supérieur de a , en fonction de la valeur de lower . Les valeurs de l'autre triangle sont ignorées. Les données de sortie sont renvoyées dans le même triangle ; les valeurs de l'autre triangle sont définies par l'implémentation et peuvent être n'importe quoi.

Si le rang de a est supérieur à 2, a est traité comme un lot de matrices, où toutes, sauf les 2 dimensions mineures, sont des dimensions de lot.

Si a n’est pas défini positif symétrique (hermitien), le résultat est défini par l’implémentation.

Serrer

Voir aussi XlaBuilder::Clamp .

Limite un opérande dans la plage comprise entre une valeur minimale et une valeur maximale.

Clamp(min, operand, max)

Arguments Taper Sémantique
min XlaOp tableau de type T
operand XlaOp tableau de type T
max XlaOp tableau de type T

Étant donné un opérande et des valeurs minimale et maximale, renvoie l'opérande s'il est compris entre le minimum et le maximum, sinon renvoie la valeur minimale si l'opérande est inférieur à cette plage ou la valeur maximale si l'opérande est supérieur à cette plage. Autrement dit, clamp(a, x, b) = min(max(a, x), b) .

Les trois tableaux doivent avoir la même forme. Alternativement, en tant que forme restreinte de diffusion , min et/ou max peuvent être un scalaire de type T .

Exemple avec min et max scalaires :

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

Effondrement

Voir aussi XlaBuilder::Collapse et l'opération tf.reshape .

Réduit les dimensions d'un tableau en une seule dimension.

Collapse(operand, dimensions)

Arguments Taper Sémantique
operand XlaOp tableau de type T
dimensions vecteur int64 Sous-ensemble consécutif et dans l'ordre des dimensions de T.

Collapse remplace le sous-ensemble donné des dimensions de l'opérande par une seule dimension. Les arguments d'entrée sont un tableau arbitraire de type T et un vecteur d'indices de dimension constant au moment de la compilation. Les indices de dimension doivent être un sous-ensemble consécutif (numéros de dimensions faibles à élevés) des dimensions de T. Ainsi, {0, 1, 2}, {0, 1} ou {1, 2} sont tous des ensembles de dimensions valides, mais {1, 0} ou {0, 2} ne le sont pas. Elles sont remplacées par une nouvelle dimension unique, située à la même position dans la séquence de dimensions que celles qu'elles remplacent, la nouvelle taille de dimension étant égale au produit des tailles de dimension d'origine. Le numéro de dimension le plus bas dans dimensions est la dimension qui varie le plus lentement (la plus majeure) dans le nid de boucle qui réduit ces dimensions, et le numéro de dimension le plus élevé varie le plus rapidement (le plus mineur). Consultez l'opérateur tf.reshape si un ordre de réduction plus général est nécessaire.

Par exemple, soit v un tableau de 24 éléments :

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

CollectivePermute

Voir aussi XlaBuilder::CollectivePermute .

CollectivePermute est une opération collective qui envoie et reçoit des réplicas croisés de données.

CollectivePermute(operand, source_target_pairs)

Arguments Taper Sémantique
operand XlaOp tableau d'entrée à n dimensions
source_target_pairs <int64, int64> vecteur Une liste de paires (source_replica_id, target_replica_id). Pour chaque paire, l’opérande est envoyé du réplica source au réplica cible.

Notez qu'il existe les restrictions suivantes sur source_target_pair :

  • Deux paires ne doivent pas avoir le même identifiant de réplica cible, ni le même identifiant de réplica source.
  • Si un identifiant de réplique n'est une cible dans aucune paire, alors la sortie sur cette réplique est un tenseur composé de 0(s) avec la même forme que l'entrée.

Enchaîner

Voir aussi XlaBuilder::ConcatInDim .

Concatenate compose un tableau à partir de plusieurs opérandes de tableau. Le tableau est du même rang que chacun des opérandes du tableau d'entrée (qui doivent être du même rang les uns que les autres) et contient les arguments dans l'ordre dans lequel ils ont été spécifiés.

Concatenate(operands..., dimension)

Arguments Taper Sémantique
operands séquence de N XlaOp N tableaux de type T de dimensions [L0, L1, ...]. Nécessite N >= 1.
dimension int64 Une valeur dans l'intervalle [0, N) qui nomme la dimension à concaténer entre les operands .

À l'exception de dimension toutes les dimensions doivent être les mêmes. En effet, XLA ne prend pas en charge les tableaux « irréguliers ». Notez également que les valeurs de rang 0 ne peuvent pas être concaténées (car il est impossible de nommer la dimension le long de laquelle la concaténation a lieu).

Exemple unidimensionnel :

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

Exemple en 2 dimensions :

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

Diagramme:

Conditionnel

Voir aussi XlaBuilder::Conditional .

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

Arguments Taper Sémantique
pred XlaOp Scalaire de type PRED
true_operand XlaOp Argument de type \(T_0\)
true_computation XlaComputation XlaComputation de type \(T_0 \to S\)
false_operand XlaOp Argument de type \(T_1\)
false_computation XlaComputation XlaComputation de type \(T_1 \to S\)

Exécute true_computation si pred est true , false_computation si pred est false et renvoie le résultat.

Le true_computation doit prendre un seul argument de type \(T_0\) et sera invoqué avec true_operand qui doit être du même type. Le false_computation doit prendre un seul argument de type \(T_1\) et sera invoqué avec false_operand qui doit être du même type. Le type de la valeur renvoyée de true_computation et false_computation doit être le même.

Notez qu'un seul parmi true_computation et false_computation sera exécuté en fonction de la valeur de pred .

Conditional(branch_index, branch_computations, branch_operands)

Arguments Taper Sémantique
branch_index XlaOp Scalaire de type S32
branch_computations séquence de N XlaComputation XlaComputations de type \( T_0 \to S , T_1 \to S , ..., T_{N-1} \to S \)
branch_operands séquence de N XlaOp Arguments de type \( T_0 , T_1 , ..., T_{N-1} \)

Exécute branch_computations[branch_index] et renvoie le résultat. Si branch_index est un S32 qui est < 0 ou >= N, alors branch_computations[N-1] est exécuté comme branche par défaut.

Chaque branch_computations[b] doit prendre un seul argument de type T_b et sera invoqué avec branch_operands[b] qui doit être du même type. Le type de la valeur renvoyée de chaque branch_computations[b] doit être le même.

Notez qu'un seul des branch_computations sera exécuté en fonction de la valeur de branch_index .

Conv (convolution)

Voir aussi XlaBuilder::Conv .

Comme ConvWithGeneralPadding, mais le remplissage est spécifié de manière abrégée comme SAME ou VALID. SAME padding remplit l'entrée ( lhs ) avec des zéros afin que la sortie ait la même forme que l'entrée sans tenir compte de la foulée. Un remplissage VALIDE signifie simplement aucun remplissage.

ConvWithGeneralPadding (convolution)

Voir aussi XlaBuilder::ConvWithGeneralPadding .

Calcule une convolution du type utilisé dans les réseaux de neurones. Ici, une convolution peut être considérée comme une fenêtre à n dimensions se déplaçant sur une zone de base à n dimensions et un calcul est effectué pour chaque position possible de la fenêtre.

Arguments Taper Sémantique
lhs XlaOp tableau d'entrées de rang n+2
rhs XlaOp tableau de rang n+2 de poids de noyau
window_strides ArraySlice<int64> ème tableau de foulées du noyau
padding ArraySlice< pair<int64, int64>> ème tableau de rembourrage (faible, élevé)
lhs_dilation ArraySlice<int64> nd tableau de facteurs de dilatation à gauche
rhs_dilation ArraySlice<int64> nd tableau de facteurs de dilatation rhs
feature_group_count int64 le nombre de groupes de fonctionnalités
batch_group_count int64 le nombre de groupes de lots

Soit n le nombre de dimensions spatiales. L'argument lhs est un tableau de rang n+2 décrivant la zone de base. C'est ce qu'on appelle l'entrée, même si bien sûr le rhs est aussi une entrée. Dans un réseau de neurones, ce sont les activations d'entrée. Les dimensions n+2 sont, dans cet ordre :

  • batch : Chaque coordonnée dans cette dimension représente une entrée indépendante pour laquelle une convolution est effectuée.
  • z/depth/features : Chaque position (y,x) dans la zone de base est associée à un vecteur, qui va dans cette dimension.
  • spatial_dims : décrit les n dimensions spatiales qui définissent la zone de base sur laquelle la fenêtre se déplace.

L'argument rhs est un tableau de rang n+2 décrivant le filtre/noyau/fenêtre convolutif. Les dimensions sont, dans cet ordre :

  • output-z : La dimension z de la sortie.
  • input-z : La taille de cette dimension multipliée feature_group_count doit être égale à la taille de la dimension z en gauche.
  • spatial_dims : décrit les n dimensions spatiales qui définissent la ème fenêtre qui se déplace à travers la zone de base.

L'argument window_strides spécifie la foulée de la fenêtre convolutive dans les dimensions spatiales. Par exemple, si la foulée dans la première dimension spatiale est de 3, alors la fenêtre ne peut être placée qu'aux coordonnées où le premier index spatial est divisible par 3.

L'argument padding spécifie la quantité de remplissage nul à appliquer à la zone de base. La quantité de remplissage peut être négative : la valeur absolue du remplissage négatif indique le nombre d'éléments à supprimer de la dimension spécifiée avant d'effectuer la convolution. padding[0] spécifie le remplissage pour la dimension y et padding[1] spécifie le remplissage pour la dimension x . Chaque paire a le rembourrage faible comme premier élément et le rembourrage élevé comme deuxième élément. Le rembourrage faible est appliqué dans la direction des indices inférieurs tandis que le rembourrage élevé est appliqué dans la direction des indices plus élevés. Par exemple, si padding[1] vaut (2,3) alors il y aura un remplissage de 2 zéros à gauche et de 3 zéros à droite dans la deuxième dimension spatiale. Utiliser le remplissage équivaut à insérer ces mêmes valeurs nulles dans l'entrée ( lhs ) avant d'effectuer la convolution.

Les arguments lhs_dilation et rhs_dilation spécifient le facteur de dilatation à appliquer respectivement aux lhs et rhs dans chaque dimension spatiale. Si le facteur de dilatation dans une dimension spatiale est d, alors d-1 trous sont implicitement placés entre chacune des entrées de cette dimension, augmentant ainsi la taille du tableau. Les trous sont remplis avec une valeur no-op, ce qui pour la convolution signifie des zéros.

La dilatation du rhs est également appelée circonvolution atreuse. Pour plus de détails, voir tf.nn.atrous_conv2d . La dilatation du côté gauche est également appelée convolution transposée. Pour plus de détails, consultez tf.nn.conv2d_transpose .

L'argument feature_group_count (valeur par défaut 1) peut être utilisé pour les convolutions groupées. feature_group_count doit être un diviseur à la fois de la dimension de la fonctionnalité d'entrée et de la dimension de sortie. Si feature_group_count est supérieur à 1, cela signifie que conceptuellement, la dimension des caractéristiques d'entrée et de sortie et la dimension des caractéristiques de sortie rhs sont divisées uniformément en plusieurs groupes feature_group_count , chaque groupe étant constitué d'une sous-séquence consécutive de caractéristiques. La dimension de l'entité en entrée de rhs doit être égale à la dimension de l'entité en entrée lhs divisée par feature_group_count (elle a donc déjà la taille d'un groupe d'entités en entrée). Les i-èmes groupes sont utilisés ensemble pour calculer feature_group_count de nombreuses convolutions distinctes. Les résultats de ces convolutions sont concaténés dans la dimension de l’entité en sortie.

Pour la convolution en profondeur, l'argument feature_group_count serait défini sur la dimension de la fonctionnalité d'entrée et le filtre serait remodelé de [filter_height, filter_width, in_channels, channel_multiplier] à [filter_height, filter_width, 1, in_channels * channel_multiplier] . Pour plus de détails, consultez tf.nn.depthwise_conv2d .

L'argument batch_group_count (valeur par défaut 1) peut être utilisé pour les filtres groupés lors de la rétropropagation. batch_group_count doit être un diviseur de la taille de la dimension du lot lhs (entrée). Si batch_group_count est supérieur à 1, cela signifie que la dimension du lot de sortie doit être de taille input batch / batch_group_count . batch_group_count doit être un diviseur de la taille de l'entité en sortie.

La forme de sortie a ces dimensions, dans cet ordre :

  • batch : La taille de cette dimension multipliée batch_group_count doit être égale à la taille de la dimension batch en gauche.
  • z : Même taille que output-z sur le noyau ( rhs ).
  • spatial_dims : une valeur pour chaque emplacement valide de la fenêtre convolutive.

La figure ci-dessus montre comment fonctionne le champ batch_group_count . En effet, nous découpons chaque lot lhs en groupes batch_group_count et faisons de même pour les fonctionnalités de sortie. Ensuite, pour chacun de ces groupes, nous effectuons des convolutions par paires et concaténons la sortie le long de la dimension de l'entité de sortie. La sémantique opérationnelle de toutes les autres dimensions (caractéristique et spatiale) reste la même.

Les emplacements valides de la fenêtre convolutive sont déterminés par les foulées et la taille de la zone de base après remplissage.

Pour décrire ce que fait une convolution, considérons une convolution 2D et choisissez des coordonnées batch fixes, z , y , x dans la sortie. Alors (y,x) est la position d'un coin de la fenêtre dans la zone de base (par exemple le coin supérieur gauche, selon la façon dont vous interprétez les dimensions spatiales). Nous avons maintenant une fenêtre 2D, extraite de la zone de base, où chaque point 2D est associé à un vecteur 1D, nous obtenons donc une boîte 3D. À partir du noyau convolutif, puisque nous avons fixé la coordonnée de sortie z , nous avons également une boîte 3D. Les deux cases ont les mêmes dimensions, nous pouvons donc prendre la somme des produits élément par élément entre les deux cases (semblable à un produit scalaire). C'est la valeur de sortie.

Notez que si output-z vaut par exemple 5, alors chaque position de la fenêtre produit 5 valeurs dans la sortie dans la dimension z de la sortie. Ces valeurs diffèrent selon la partie du noyau convolutif utilisée - il existe une boîte de valeurs 3D distincte utilisée pour chaque coordonnée output-z . Vous pourriez donc le considérer comme 5 convolutions distinctes avec un filtre différent pour chacune d’elles.

Voici le pseudo-code pour une convolution 2D avec rembourrage et foulée :

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

ConvertElementType

Voir aussi XlaBuilder::ConvertElementType .

Semblable à un static_cast élément par élément en C++, effectue une opération de conversion par élément d’une forme de données vers une forme cible. Les dimensions doivent correspondre et la conversion se fait au niveau des éléments ; Par exemple, les éléments s32 deviennent des éléments f32 via une routine de conversion s32 en f32 .

ConvertElementType(operand, new_element_type)

Arguments Taper Sémantique
operand XlaOp tableau de type T avec dims D
new_element_type PrimitiveType tapez U

Les dimensions de l'opérande et de la forme cible doivent correspondre. Les types d'éléments source et destination ne doivent pas être des tuples.

Une conversion telle que T=s32 en U=f32 effectuera une routine de conversion de normalisation d'entier en flottant telle que l'arrondi au plus proche.

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

SommeRépliqueCross

Exécute AllReduce avec un calcul de sommation.

Appel personnalisé

Voir aussi XlaBuilder::CustomCall .

Appelez une fonction fournie par l'utilisateur dans un calcul.

CustomCall(target_name, args..., shape)

Arguments Taper Sémantique
target_name string Nom de la fonction. Une instruction d'appel sera émise qui ciblera ce nom de symbole.
args séquence de N XlaOp s N arguments de type arbitraire, qui seront passés à la fonction.
shape Shape Forme de sortie de la fonction

La signature de la fonction est la même, quel que soit l'arité ou le type des arguments :

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

Par exemple, si CustomCall est utilisé comme suit :

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

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

Voici un exemple d'implémentation de myfunc :

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

La fonction fournie par l'utilisateur ne doit pas avoir d'effets secondaires et son exécution doit être idempotente.

Point

Voir aussi XlaBuilder::Dot .

Dot(lhs, rhs)

Arguments Taper Sémantique
lhs XlaOp tableau de type T
rhs XlaOp tableau de type T

La sémantique exacte de cette opération dépend des rangs des opérandes :

Saisir Sortir Sémantique
vecteur [n] vecteur dot [n] scalaire produit scalaire vectoriel
matrice [mxk] vecteur dot [k] vecteur [m] multiplication matrice-vecteur
matrice [mxk] matrice dot [kxn] matrice [mxn] multiplication matrice-matrice

L'opération effectue la somme des produits sur la deuxième dimension de lhs (ou la première si elle est de rang 1) et la première dimension de rhs . Ce sont les dimensions « contractées ». Les dimensions contractées de lhs et rhs doivent être de la même taille. En pratique, il peut être utilisé pour réaliser des produits scalaires entre vecteurs, des multiplications vecteur/matrice ou des multiplications matrice/matrice.

DotGénéral

Voir aussi XlaBuilder::DotGeneral .

DotGeneral(lhs, rhs, dimension_numbers)

Arguments Taper Sémantique
lhs XlaOp tableau de type T
rhs XlaOp tableau de type T
dimension_numbers DotDimensionNumbers numéros de dimension de contrat et de lot

Comme Dot, mais permet de spécifier les numéros de dimension de contrat et de lot pour les deux "lhs" et "rhs".

Champs DotDimensionNumbers Taper Sémantique
'lhs_contracting_dimensions' répété int64 Numéros de dimension de contraction 'lhs'
'rhs_contracting_dimensions' répété int64 Numéros de dimension de contraction 'rhs'
'lhs_batch_dimensions' répété int64 Numéros de dimension du lot 'lhs'
'rhs_batch_dimensions' répété int64 Numéros de dimension du lot « rhs »

DotGeneral effectue la somme des produits sur les dimensions contractuelles spécifiées dans « dimension_numbers ».

Les numéros de dimensions de contraction associés de « lhs » et « rhs » ne doivent pas nécessairement être identiques, mais doivent avoir les mêmes dimensions.

Exemple avec des numéros de dimension contractuels :

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

Les numéros de dimension de lot associés de « lhs » et « rhs » doivent avoir les mêmes dimensions.

Exemple avec des numéros de dimension de lot (taille de lot 2, matrices 2x2) :

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

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

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

DotGeneral(lhs, rhs, dnums) -> { { {1.0, 2.0},
{3.0, 4.0} },
{ {5.0, 6.0},
{7.0, 8.0} } }
Saisir Sortir Sémantique
[b0, m, k] dot [b0, k, n] [b0,m,n] lot matmul
[b0, b1, m, k] dot [b0, b1, k, n] [b0, b1, m, n] lot matmul

Il s'ensuit que le numéro de dimension résultant commence par la dimension du lot, puis la dimension « lhs » non contractante/non-batch, et enfin la dimension « rhs » non contractuelle/non-batch.

TrancheDynamique

Voir aussi XlaBuilder::DynamicSlice .

DynamicSlice extrait un sous-tableau du tableau d'entrée à Dynamic start_indices . La taille de la tranche dans chaque dimension est transmise dans size_indices , qui spécifie le point final des intervalles de tranche exclusifs dans chaque dimension : [début, début + taille). La forme des start_indices doit être de rang == 1, avec une taille de dimension égale au rang de operand .

DynamicSlice(operand, start_indices, size_indices)

Arguments Taper Sémantique
operand XlaOp Tableau à N dimensions de type T
start_indices séquence de N XlaOp Liste de N entiers scalaires contenant les indices de départ de la tranche pour chaque dimension. La valeur doit être supérieure ou égale à zéro.
size_indices ArraySlice<int64> List of N integers containing the slice size for each dimension. Each value must be strictly greater than zero, and start + size must be less than or equal to the size of the dimension to avoid wrapping modulo dimension size.

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] - size_indices[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}) produces:
{2.0, 3.0}

2-dimensional example:

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

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

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 rank == 1, with dimension size equal to the rank of operand .

DynamicUpdateSlice(operand, update, start_indices)

Arguments Taper Semantics
operand XlaOp N dimensional array of type T
update XlaOp N dimensional array of type T containing the slice update. Each dimension of update shape must be strictly greater than zero, and start + update must be less than or equal to the operand size for each dimension to avoid generating out-of-bounds update indices.
start_indices sequence of N XlaOp List of N scalar integers containing the starting indices of the slice for each dimension. Value must be greater than or equal to zero.

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) produces:
{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) produces:
{ {0.0,  1.0,  2.0},
{3.0, 12.0, 13.0},
{6.0, 14.0, 15.0},
{9.0, 16.0, 17.0} }

Element-wise binary arithmetic operations

See also XlaBuilder::Add .

A set of element-wise binary arithmetic operations is supported.

Op(lhs, rhs)

Where Op is one of Add (addition), Sub (subtraction), Mul (multiplication), Div (division), Rem (remainder), Max (maximum), Min (minimum), Atan2 (arctangent of y/x), LogicalAnd (logical AND), LogicalOr (logical OR), or LogicalXor (logical XOR).

Arguments Taper Semantics
lhs XlaOp left-hand-side operand: array of type T
rhs XlaOp right-hand-side operand: array of type T

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.

When Op is Rem , the sign of the result is taken from the dividend, and the absolute value of the result is always less than the divisor's absolute value.

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

An alternative variant with different-rank broadcasting support exists for these operations:

Op(lhs, rhs, broadcast_dimensions)

Where Op is the same as above. 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 used to expand the rank of the lower-rank operand up to the rank of the higher-rank operand. broadcast_dimensions maps the dimensions of the lower-rank shape to the dimensions of the higher-rank shape. The unmapped dimensions of the expanded shape are filled with dimensions of size one. Degenerate-dimension broadcasting then broadcasts the shapes along these degenerate dimensions to equalize the shapes of both operands. The semantics are described in detail on the broadcasting page .

Element-wise comparison operations

See also XlaBuilder::Eq .

A set of standard element-wise binary comparison operations is supported. Note that standard IEEE 754 floating-point comparison semantics apply when comparing floating-point types.

Op(lhs, rhs)

Where Op is one of Eq (equal-to), Ne (not equal-to), Ge (greater-or-equal-than), Gt (greater-than), Le (less-or-equal-than), Lt (less-than). Another set of operators, EqTotalOrder, NeTotalOrder, GeTotalOrder, GtTotalOrder, LeTotalOrder, and LtTotalOrder, provide the same functionalities, except that they additionally support a total order over the floating point numbers, by enforcing -NaN < -Inf < -Finite < -0 < +0 < +Finite < +Inf < +NaN.

Arguments Taper Semantics
lhs XlaOp left-hand-side operand: array of type T
rhs XlaOp right-hand-side operand: array of type T

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 with the element type PRED . 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-rank broadcasting support exists for these operations:

Op(lhs, rhs, broadcast_dimensions)

Where Op is the same as above. This variant of the operation should be used for comparison 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 .

Element-wise unary functions

XlaBuilder supports these element-wise unary functions:

Abs(operand) Element-wise abs x -> |x| .

Ceil(operand) Element-wise ceil x -> ⌈x⌉ .

Clz(operand) Element-wise counting of the number of leading zeros x -> clz(x) .

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

Exp(operand) Element-wise natural exponential x -> e^x .

Floor(operand) Element-wise floor x -> ⌊x⌋ .

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

IsFinite(operand) 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.

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

Log1p(operand) Element-wise natural logarithm of a number plus one x -> ln(x + 1)

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

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

PopulationCount(operand) Computes the number of bits set in each element of operand .

Neg(operand) Element-wise negation x -> -x .

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

Rsqrt(operand) Element-wise reciprocal of square root operation x -> 1.0 / sqrt(x) .

Sign(operand) Element-wise sign operation x -> sgn(x) where

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

using the comparison operator of the element type of operand .

Sqrt(operand) Element-wise square root operation x -> sqrt(x) .

Cbrt(operand) Element-wise cubic root operation x -> cbrt(x) .

Tan(operand) Element-wise tangent x -> tan(x) .

Tanh(operand) Element-wise hyperbolic tangent x -> tanh(x) .

Round(operand) Element-wise rounding, ties away from zero.

RoundNearestEven(operand) Element-wise rounding, ties to nearest even.

Arguments Taper Semantics
operand XlaOp The operand to the function

The function is applied to each element in the operand array, resulting in an array with the same shape. It is allowed for operand to be a scalar (rank 0).

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.

See also XlaBuilder::Fft .

Arguments Taper Semantics
operand XlaOp The array we are Fourier transforming.
fft_type FftType See the table below.
fft_length ArraySlice<int64> The time-domain lengths of the axes being transformed. This is needed in particular for IRFFT to right-size the innermost axis, since RFFT(fft_length=[16]) has the same output shape as RFFT(fft_length=[17]) .
FftType Semantics
FFT Forward complex-to-complex FFT. Shape is unchanged.
IFFT Inverse complex-to-complex FFT. Shape is unchanged.
RFFT Forward real-to-complex FFT. Shape of the innermost axis is reduced to fft_length[-1] // 2 + 1 if fft_length[-1] is a non-zero value, omitting the reversed conjugate part of the transformed signal beyond the Nyquist frequency.
IRFFT Inverse real-to-complex FFT (ie takes complex, returns real). Shape of the innermost axis is expanded to fft_length[-1] if fft_length[-1] is a non-zero value, inferring the part of the transformed signal beyond the Nyquist frequency from the reverse conjugate of the 1 to fft_length[-1] // 2 + 1 entries.

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.

Implementation details

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

Gather

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

General Semantics

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

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

Arguments Taper Semantics
operand XlaOp The array we're gathering from.
start_indices XlaOp Array containing the starting indices of the slices we gather.
index_vector_dim int64 The dimension in start_indices that "contains" the starting indices. See below for a detailed description.
offset_dims ArraySlice<int64> The set of dimensions in the output shape that offset into an array sliced from operand.
slice_sizes ArraySlice<int64> slice_sizes[i] is the bounds for the slice on dimension i .
collapsed_slice_dims ArraySlice<int64> The set of dimensions in each slice that are collapsed away. These dimensions must have size 1.
start_index_map ArraySlice<int64> A map that describes how to map indices in start_indices to legal indices into operand.
indices_are_sorted bool Whether the indices are guaranteed to be sorted by the caller.
unique_indices bool Whether the indices are guaranteed to be unique by the caller.

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

The output is an array of rank batch_dims.size + offset_dims.size .

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 start_index_map order) by the user. If they are not then the semantics is implementation defined.

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

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 0 and O 1 , 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 rank. 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 rank, and an explicit mapping dictates how the index should be expanded to have the same rank 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)

Arguments Taper Semantics
operand XlaOp n dimensional input array
dimension int64 A value in the interval [0, n) that specifies the dimension

SetDimensionSize

See also XlaBuilder::SetDimensionSize .

Sets the dynamic size of XlaOp's given dimension. The operand must be array shaped.

SetDimensionSize(operand, size, dimension)

Arguments Taper Semantics
operand XlaOp n dimensional input array.
size XlaOp int32 representing the runtime dynamic size.
dimension int64 A value in the interval [0, n) that specifies the dimension.

Pass through the operand as result, with dynamic dimension tracked by the compiler.

Padded values will be ignored by downstream reduction ops.

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

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

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

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

GetTupleElement

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 .

Infeed

See also XlaBuilder::Infeed .

Infeed(shape)

Argument Taper Semantics
shape Shape Shape of the data read from the Infeed interface. The layout field of the shape must be set to match the layout of the data sent to the device; otherwise its behavior is undefined.

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 Infeeds 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.

Iota

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.

Arguments Taper Semantics
shape Shape Shape of the array created by Iota()
iota_dimension int64 The dimension to increment along.

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

Map

See also XlaBuilder::Map .

Map(operands..., computation)

Arguments Taper Semantics
operands sequence of N XlaOp s N arrays of types T 0..T {N-1}
computation XlaComputation computation of type T_0, T_1, ..., T_{N + M -1} -> S with N parameters of type T and M of arbitrary type
dimensions int64 array array of map 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.

OptimizationBarrier

Blocks any optimization pass from moving computations across the barrier.

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

Pad

See also XlaBuilder::Pad .

Pad(operand, padding_value, padding_config)

Arguments Taper Semantics
operand XlaOp array of type T
padding_value XlaOp scalar of type T to fill in the added padding
padding_config PaddingConfig padding amount on both edges (low, high) and between the elements of each dimension

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.

Recv

See also XlaBuilder::Recv .

Recv(shape, channel_handle)

Arguments Taper Semantics
shape Shape shape of the data to receive
channel_handle ChannelHandle unique identifier for each send/recv pair

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.

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. See also HloInstruction::CreateRecv and HloInstruction::CreateRecvDone .

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.

RecvDone(HloInstruction context)

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

Reduce

See also XlaBuilder::Reduce .

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

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

Arguments Taper Semantics
operands Sequence of N XlaOp N arrays of types T_0, ..., T_{N-1} .
init_values Sequence of N XlaOp N scalars of types T_0, ..., T_{N-1} .
computation XlaComputation computation of type T_0, ..., T_{N-1}, T_0, ..., T_{N-1} -> Collate(T_0, ..., T_{N-1}) .
dimensions int64 array unordered array of dimensions to reduce.

Where:

  • 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 rank of each returned array is rank(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 being associative for most practical uses.

Examples

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 rank of the result
for r0 in range(result_shape[0]), r1 in range(result_shape[1]), ...:
  # Initialize this result element
  result[r0, r1...] <- 0

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

Here's an example of reducing a 2D array (matrix). The shape has rank 2, 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 rank 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 rank-2 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 rank-2 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 rank 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, mantissa_bits, exponent_bits)

Arguments Taper Semantics
operand XlaOp array of floating-point type T .
exponent_bits int32 number of exponent bits in lower-precision format
mantissa_bits int32 number of mantissa bits in lower-precision format

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.

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_dim, shard_count, replica_group_ids, channel_id)

Arguments Taper Semantics
operand XlaOp Array or a non-empty tuple of arrays to reduce across replicas.
computation XlaComputation Reduction computation
scatter_dimension int64 Dimension to scatter.
shard_count int64 Number of blocks to split scatter_dimension
replica_groups vector of vectors of int64 Groups between which the reductions are performed
channel_id optional int64 Optional channel ID for cross-module communication
  • 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.

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.

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)

Arguments Taper Semantics
operands N XlaOps A sequence of N multi-dimensional arrays of types T_0,..., T_{N-1} , each representing the base area on which the window is placed.
init_values N XlaOps The N starting values for the reduction, one for each of the N operands. See Reduce for details.
computation XlaComputation Reduction function of type T_0, ..., T_{N-1}, T_0, ..., T_{N-1} -> Collate(T_0, ..., T_{N-1}) , to apply to elements in each window of all the input operands.
window_dimensions ArraySlice<int64> array of integers for window dimension values
window_strides ArraySlice<int64> array of integers for window stride values
base_dilations ArraySlice<int64> array of integers for base dilation values
window_dilations ArraySlice<int64> array of integers for window dilation values
padding Padding padding type for window (Padding::kSame, which pads so as to have the same output shape as input if the stride is 1, or Padding::kValid, which uses no padding and "stops" the window once it no longer fits)

Where:

  • 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}) .

Below code and figure shows an example of using ReduceWindow . 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);

Stride of 1 in a dimension specifies that the position of a window in the dimension is 1 element away from its adjacent window. In order to specify that no windows overlap with each other, window_stride_dimensions should be equal to window_dimensions. The figure below illustrates the use of two different stride values. Padding is applied to each dimension of the input and the calculations are the same as though the input came in with the dimensions it has after padding.

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

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

ReplicaId

See also XlaBuilder::ReplicaId .

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

ReplicaId()

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

Reshape

See also XlaBuilder::Reshape and the Collapse operation.

Reshapes the dimensions of an array into a new configuration.

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

Arguments Taper Semantics
operand XlaOp array of type T
dimensions int64 vector order in which dimensions are collapsed
new_sizes int64 vector vector of sizes of new dimensions

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

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

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

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

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

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

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


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

As a special case, reshape can transform a single-element array to a scalar and vice versa. For example,

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

Rev (reverse)

See also XlaBuilder::Rev .

Rev(operand, dimensions)

Arguments Taper Semantics
operand XlaOp array of type T
dimensions ArraySlice<int64> dimensions to reverse

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

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

RngNormal

See also XlaBuilder::RngNormal .

Constructs an output of a given shape with random numbers generated following the \(N(\mu, \sigma)\) normal distribution. The parameters \(\mu\) and\(\sigma\), and output shape have to have a floating point elemental type. The parameters furthermore have to be scalar valued.

RngNormal(mu, sigma, shape)

Arguments Taper Semantics
mu XlaOp Scalar of type T specifying mean of generated numbers
sigma XlaOp Scalar of type T specifying standard deviation of generated numbers
shape Shape Output shape of type T

RngUniform

See also XlaBuilder::RngUniform .

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

RngUniform(a, b, shape)

Arguments Taper Semantics
a XlaOp Scalar of type T specifying lower limit of interval
b XlaOp Scalar of type T specifying upper limit of interval
shape Shape Output shape of type T

RngBitGenerator

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

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

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

RngBitGenerator(algorithm, key, shape)

Arguments Taper Semantics
algorithm RandomAlgorithm PRNG algorithm to be used.
initial_state XlaOp Initial state for the PRNG algorithm.
shape Shape Output shape for generated data.

Available values for algorithm :

Scatter

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

See also XlaBuilder::Scatter .

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

Arguments Taper Semantics
operands Sequence of N XlaOp N arrays of types T_0, ..., T_N to be scattered into.
scatter_indices XlaOp Array containing the starting indices of the slices that must be scattered to.
updates Sequence of N XlaOp N arrays of types T_0, ..., T_N . updates[i] contains the values that must be used for scattering operands[i] .
update_computation XlaComputation Computation to be used for combining the existing values in the input array and the updates during scatter. This computation should be of type T_0, ..., T_N, T_0, ..., T_N -> Collate(T_0, ..., T_N) .
index_vector_dim int64 The dimension in scatter_indices that contains the starting indices.
update_window_dims ArraySlice<int64> The set of dimensions in updates shape that are window dimensions .
inserted_window_dims ArraySlice<int64> The set of window dimensions that must be inserted into updates shape.
scatter_dims_to_operand_dims ArraySlice<int64> A dimensions map from the scatter indices to the operand index space. This array is interpreted as mapping i to scatter_dims_to_operand_dims[i] . It has to be one-to-one and total.
indices_are_sorted bool Whether the indices are guaranteed to be sorted by the caller.

Where:

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

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

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

The arguments of scatter should follow these constraints:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Select

See also XlaBuilder::Select .

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

Select(pred, on_true, on_false)

Arguments Taper Semantics
pred XlaOp array of type PRED
on_true XlaOp array of type T
on_false XlaOp array of type T

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

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

Example with non-scalar pred :

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

Example with scalar pred :

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

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

SelectAndScatter

See also XlaBuilder::SelectAndScatter .

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

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

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

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

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

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

Arguments Taper Semantics
operand XlaOp array of type T over which the windows slide
select XlaComputation binary computation of type T, T -> PRED , to apply to all elements in each window; returns true if the first parameter is selected and returns false if the second parameter is selected
window_dimensions ArraySlice<int64> array of integers for window dimension values
window_strides ArraySlice<int64> array of integers for window stride values
padding Padding padding type for window (Padding::kSame or Padding::kValid)
source XlaOp array of type T with the values to scatter
init_value XlaOp scalar value of type T for the initial value of the output array
scatter XlaComputation binary computation of type T, T -> T , to apply each scatter source element with its destination element

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

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

Send

See also XlaBuilder::Send .

Send(operand, channel_handle)

Arguments Taper Semantics
operand XlaOp data to send (array of type T)
channel_handle ChannelHandle unique identifier for each send/recv pair

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

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

Send(HloInstruction operand, int64 channel_id)

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

SendDone(HloInstruction context)

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

Scheduling of channel instructions

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

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

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

Slice

See also XlaBuilder::Slice .

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

Slice(operand, start_indices, limit_indices, strides)

Arguments Taper Semantics
operand XlaOp N dimensional array of type T
start_indices ArraySlice<int64> List of N integers containing the starting indices of the slice for each dimension. Values must be greater than or equal to zero.
limit_indices ArraySlice<int64> List of N integers containing the ending indices (exclusive) for the slice for each dimension. Each value must be greater than or equal to the respective start_indices value for the dimension and less than or equal to the size of the dimension.
strides ArraySlice<int64> List of N integers that decides the input stride of the slice. The slice picks every strides[d] element in dimension d .

1-dimensional example:

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

2-dimensional example:

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

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

Sort

See also XlaBuilder::Sort .

Sort(operands, comparator, dimension, is_stable)

Arguments Taper Semantics
operands ArraySlice<XlaOp> The operands to sort.
comparator XlaComputation The comparator computation to use.
dimension int64 The dimension along which to sort.
is_stable bool Whether stable sorting should be used.

If only one operand is provided:

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

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

If n > 1 operands are provided:

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

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

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

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

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

Top-K

See also the jax.lax.top_k operation.

TopK(operand)

Arguments Taper Semantics
operand XlaOp N-dimensional array
k int64 Integer specifying the number of top entries.
comparator XlaComputation The comparator computation to use.

Returns top k values and their indices as a tuple, along the last dimension of the operand using the given comparator (for usual topk behavior, it should be strict-greater-than operation).

For example, given strict > operator, k=1 and the following operand of shape f32[2,3] :

[[0.1, 0.3, 0.1], [0.7, 0.2, -0.1]]

The TopK application returns the following tuple of shape (f32[2,1], s32[2,1]) :

([[0.3], [0.7]], [[1], [0]])

Transpose

See also the tf.reshape operation.

Transpose(operand)

Arguments Taper Semantics
operand XlaOp The operand to transpose.
permutation ArraySlice<int64> How to permute the dimensions.

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

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

TriangularSolve

See also XlaBuilder::TriangularSolve .

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

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

Arguments Taper Semantics
a XlaOp a rank > 2 array of a complex or floating-point type with shape [..., M, M] .
b XlaOp a rank > 2 array of the same type with shape [..., M, K] if left_side is true, [..., K, M] otherwise.
left_side bool indicates whether to solve a system of the form op(a) * x = b ( true ) or x * op(a) = b ( false ).
lower bool whether to use the upper or lower triangle of a .
unit_diagonal bool if true , the diagonal elements of a are assumed to be 1 and not accessed.
transpose_a Transpose whether to use a as is, transpose it or take its conjugate transpose.

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

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

Tuple

See also XlaBuilder::Tuple .

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

This is analogous to std::tuple in C++. 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);

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

While

See also XlaBuilder::While .

While(condition, body, init)

Arguments Taper Semantics
condition XlaComputation XlaComputation of type T -> PRED which defines the termination condition of the loop.
body XlaComputation XlaComputation of type T -> T which defines the body of the loop.
init T Initial value for the parameter of condition and body .

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

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

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

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

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