Operationssemantik

Im Folgenden wird die Semantik von Operationen in dem definierten XlaBuilder Schnittstelle. Typischerweise Karte diese Operationen einer Eins-zu-eins - Operationen in der RPC - Schnittstelle in definierten xla_data.proto .

Ein Hinweis zur Nomenklatur: Der verallgemeinerte Datentyp XLA ist ein N-dimensionales Array, das Elemente eines einheitlichen Typs (wie 32-Bit-Float) enthält. In der gesamten Dokumentation, Array verwendet , um eine beliebige zweidimensionale Anordnung zu bezeichnen. Der Einfachheit halber haben Spezialfälle spezifischere und bekanntere Namen; zum Beispiel ist ein Vektor , ein 1-dimensionales Feld und eine Matrix ist ein 2-dimensionales Array.

Letztendlich

Siehe auch XlaBuilder::AfterAll .

AfterAll nimmt eine variadische Anzahl von Token und erzeugt ein einzelnes Token. Tokens sind primitive Typen, die zwischen Nebenwirkungsoperationen eingefädelt werden können, um die Reihenfolge zu erzwingen. AfterAll kann als eine von Token verbinden verwendet werden für eine Operation nach einer festgelegten Operationen der Einrichtung.

AfterAll(operands)

Argumente Typ Semantik
operands XlaOp variadische Anzahl von Token

AllGather

Siehe auch XlaBuilder::AllGather .

Führt eine Verkettung über Replikate hinweg aus.

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

Argumente Typ Semantik
operand XlaOp Array zum Verketten über Replikate hinweg.
all_gather_dim int64 Verkettungsdimension.
replica_groups Vektor der Vektoren int64 Gruppen, zwischen denen die Verkettung durchgeführt wird.
channel_id optional int64 Optionale Kanal-ID für modulübergreifende Kommunikation.
  • replica_groups ist eine Liste der Replika - Gruppen , zwischen denen die Verkettung (Replika - ID für den aktuellen Replik kann mit abgerufen werden ausgeführt ReplicaId ). Die Reihenfolge der Replikate in jeder Gruppe bestimmt die Reihenfolge, in der sich ihre Eingaben im Ergebnis befinden. replica_groups muss entweder leer sein (in diesem Fall alle Repliken gehören zu einer einzigen Gruppe von geordneten 0 bis N - 1 ), oder die gleiche Anzahl von Elementen wie die Anzahl der Replikate enthalten. Zum Beispiel replica_groups = {0, 2}, {1, 3} führt eine Verkettung zwischen den Replikaten 0 und 2 und 1 und 3 .
  • shard_count ist die Größe jeder Replikat - Gruppe. Wir müssen dies in Fällen , in denen replica_groups leer sind.
  • channel_id zur modulübergreifende Kommunikation verwendet: Es wird nur all-gather - Operationen mit der gleichen channel_id miteinander kommunizieren können.

Die Ausgangsform ist die Form mit dem Eingang all_gather_dim gemacht shard_count mal größer. Wenn es beispielsweise zwei Repliken sind und die Operanden den Wert [1.0, 2.5] und [3.0, 5.25] jeweils auf den zwei Repliken, dann wird der Ausgangswert von diesem op wo all_gather_dim ist 0 wird [1.0, 2.5, 3.0, 5.25] auf beiden Repliken.

AlleReduzieren

Siehe auch XlaBuilder::AllReduce .

Führt eine benutzerdefinierte Berechnung über Replikate hinweg aus.

AllReduce(operand, computation, replica_group_ids, channel_id)

Argumente Typ Semantik
operand XlaOp Array oder ein nicht leeres Tupel von Arrays, um über Replikate hinweg zu reduzieren.
computation XlaComputation Reduktionsberechnung
replica_groups Vektor der Vektoren int64 Gruppen, zwischen denen die Reduktionen durchgeführt werden
channel_id optional int64 Optionale Kanal-ID für modulübergreifende Kommunikation
  • Wenn operand ein Tupel von Arrays ist, wird das all-reduce auf jedem Element des Tupels durchgeführt.
  • replica_groups ist eine Liste der Replika - Gruppen , zwischen denen die Reduktion (Replikat - ID für den aktuellen Replik kann mit abgerufen werden ausgeführt ReplicaId ). replica_groups muss entweder leer sein (in diesem Fall alle Repliken gehören zu einer einzigen Gruppe), oder die gleiche Anzahl von Elementen wie die Anzahl der Replikate enthält. Zum Beispiel replica_groups = {0, 2}, {1, 3} führt eine Reduktion zwischen den Replikaten 0 und 2 und 1 und 3 .
  • channel_id zur modulübergreifende Kommunikation verwendet: Es werden nur all-reduce Operationen mit dem gleichen channel_id können miteinander kommunizieren.

Die Ausgabeform ist dieselbe wie die Eingabeform. Wenn es zum Beispiel sind zwei Repliken und die Operanden den Wert [1.0, 2.5] und [3.0, 5.25] jeweils auf den beiden Replikaten, so wird der Ausgangswert von diesem op und Summation Berechnung wird [4.0, 7.75] sowohl Repliken. Wenn die Eingabe ein Tupel ist, ist auch die Ausgabe ein Tupel.

Berechnen des Ergebnisses der AllReduce erfordert von jedem Replikat einen Eingang aufweist, so dass , wenn ein Replikat führt einen AllReduce Knoten öfter als eine andere, dann wird das erstere Replik ewig warten. Da die Replikate alle dasselbe Programm ausführen, gibt es nicht viele Möglichkeiten, dies zu erreichen, aber es ist möglich, wenn der Zustand einer while-Schleife von Daten aus der Einspeisung abhängt und die eingespeisten Daten dazu führen, dass die while-Schleife mehrmals wiederholt wird auf einer Replik als auf einer anderen.

AllToAll

Siehe auch XlaBuilder::AllToAll .

AllToAll ist eine kollektive Operation, die Daten von allen Kernen an alle Kerne sendet. Es hat zwei Phasen:

  1. Die Streuphase. Auf jedem Kern wird der Operand aufgeteilt in split_count Anzahl von Blöcken entlang der split_dimensions , und die Blöcke werden an alle Kerne gestreut, zum Beispiel der i - te Block des i - ten Kern senden.
  2. Die Sammelphase. Jeder Kern verkettet die empfangenen Blöcke entlang der concat_dimension .

Die teilnehmenden Cores können konfiguriert werden durch:

  • replica_groups : jede ReplicaGroup enthält eine Liste der Replikat - ID in der Berechnung (Replik - ID der aktuellen Replik kann mit Hilfe abgerufen werden teilnehmenden ReplicaId ). AllToAll wird innerhalb von Untergruppen in der angegebenen Reihenfolge angewendet. Zum Beispiel replica_groups = { {1,2,3}, {4,5,0} } bedeutet , dass ein AllToAll innerhalb Repliken angewendet werden {1, 2, 3} , und in der Phase zu sammeln, und die empfangenen Blöcke in der gleichen Reihenfolge von 1, 2, 3. Dann verkettet wird, wird ein anderer AllToAll innerhalb Repliken 4, 5, 0, und die Verkettungs Reihenfolge 4, 5 auch angewandt werden , 0. Wenn replica_groups leer ist, alle Replikate gehören zu einem Gruppe, in der Verkettungsreihenfolge ihres Erscheinens.

Voraussetzungen:

  • Die Dimension Größe des Operanden auf dem split_dimension ist durch teilbar split_count .
  • Die Form des Operanden ist kein Tupel.

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

Argumente Typ Semantik
operand XlaOp n-dimensionales Eingabearray
split_dimension int64 Ein Wert in dem Intervall [0, n) , dass Namen , entlang dem die Dimension der Operand ist Split
concat_dimension int64 ein Wert in dem Intervall [0, n) , dass Namen , entlang dem die Dimension die geteilten Blöcke verkettet sind ,
split_count int64 die Anzahl der Kerne, die an diesem Vorgang teilnehmen. Wenn replica_groups leer ist, sollte dies die Anzahl der Replikate sein; andernfalls sollte dies der Anzahl der Replikate in jeder Gruppe entsprechen.
replica_groups ReplicaGroup Vektor Jede Gruppe enthält eine Liste mit Replikat-IDs.

Unten sehen Sie ein Beispiel für 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);

In diesem Beispiel nehmen 4 Kerne am Alltoall teil. Auf jedem Kern wird der Operand entlang der Dimension 0 in 4 Teile geteilt, sodass jeder Teil die Form f32[4,4] hat. Die 4 Teile sind auf alle Kerne verstreut. Dann verkettet jeder Kern die empfangenen Teile entlang der Dimension 1 in der Reihenfolge oder Kern 0-4. Die Ausgabe auf jedem Kern hat also die Form f32[16,4].

BatchNormGrad

Siehe auch XlaBuilder::BatchNormGrad und die ursprüngliche Charge Normalisierung Papier für eine detaillierte Beschreibung des Algorithmus.

Berechnet Gradienten der Chargennorm.

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

Argumente Typ Semantik
operand XlaOp n-dimensionales zu normalisierendes Array (x)
scale XlaOp 1 - dimensionales Array (\(\gamma\))
mean XlaOp 1 - dimensionales Array (\(\mu\))
variance XlaOp 1 - dimensionales Array (\(\sigma^2\))
grad_output XlaOp Gradients bestanden BatchNormTraining (\( \nabla y\))
epsilon float Epsilon - Wert (\(\epsilon\))
feature_index int64 Index - Funktion Dimension in operand

Für jedes Merkmal in der Merkmalsabmessung ( feature_index ist der Index für die Dimension Merkmal in operand ), der Betrieb die Gradienten bezüglich berechnet operand , offset und scale über all anderen Dimensionen. Die feature_index muss ein gültiger Index für das Merkmal Dimension in seinem operand .

Die drei Gradienten werden durch die folgenden Formeln (unter der Annahme eines 4-dimensionalen Array definierten operand und mit Feature Dimension Index l , Chargengröße m und räumliche Größen w und 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) \\\\ \nabla x_{ijkl} &= \frac{\gamma_{l} }{\sqrt{\sigma^2_{l}+\epsilon} } \left( \nabla y_{ijkl} - \mathrm{mean}(\nabla y) - 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} \]

Die Eingänge mean und variance repräsentieren Momente Wert über Batch- und räumliche Dimensionen.

Der Ausgabetyp ist ein Tupel aus drei Handles:

Ausgänge Typ Semantik
grad_operand XlaOp Gradienten mit Bezug auf die operand (\( \nabla x\))
grad_scale XlaOp Gradienten in Bezug auf scale (\( \nabla \gamma\))
grad_offset XlaOp Gradienten in Bezug auf offset (\( \nabla \beta\))

BatchNormInference

Siehe auch XlaBuilder::BatchNormInference und das ursprüngliche Charge Normalisierung Papier für eine detaillierte Beschreibung des Algorithmus.

Normalisiert ein Array über Batch- und räumliche Dimensionen hinweg.

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

Argumente Typ Semantik
operand XlaOp n-dimensionales Array, das normalisiert werden soll
scale XlaOp 1 dimensionales Array
offset XlaOp 1 dimensionales Array
mean XlaOp 1 dimensionales Array
variance XlaOp 1 dimensionales Array
epsilon float Epsilon-Wert
feature_index int64 Index - Funktion Dimension in operand

Für jedes Merkmal in der Merkmalsabmessung ( feature_index ist der Index für die Dimension Merkmal in operand ), berechnet der Betrieb den Mittelwert und die Varianz über all anderen Dimensionen und verwendet den Mittelwert und die Varianz jedes Element zu normalisieren operand . Die feature_index muss ein gültiger Index für das Merkmal Dimension in seinem operand .

BatchNormInference entspricht Aufruf BatchNormTraining ohne Berechnung mean und variance für jede Charge. Es nutzt den Eingang mean und variance stattdessen als Schätzwert. Der Zweck dieses op ist in Inferenz Latenz zu reduzieren, daher der Name BatchNormInference .

Der Ausgang ist ein n-dimensionale, normalisiert Array mit der gleichen Form als operand .

BatchNormTraining

Siehe auch XlaBuilder::BatchNormTraining und the original batch normalization paper für eine detaillierte Beschreibung des Algorithmus.

Normalisiert ein Array über Batch- und räumliche Dimensionen hinweg.

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

Argumente Typ Semantik
operand XlaOp n-dimensionales zu normalisierendes Array (x)
scale XlaOp 1 - dimensionales Array (\(\gamma\))
offset XlaOp 1 - dimensionales Array (\(\beta\))
epsilon float Epsilon - Wert (\(\epsilon\))
feature_index int64 Index - Funktion Dimension in operand

Für jedes Merkmal in der Merkmalsabmessung ( feature_index ist der Index für die Dimension Merkmal in operand ), berechnet der Betrieb den Mittelwert und die Varianz über all anderen Dimensionen und verwendet den Mittelwert und die Varianz jedes Element zu normalisieren operand . Die feature_index muss ein gültiger Index für das Merkmal Dimension in seinem operand .

Der Algorithmus geht wie folgt für jede Charge in operand \(x\) das enthält m Elemente mit w und h wie der Größe der räumlichen Abmessungen (unter der Annahme , operand ist ein 4 - dimensionales Array):

  • Errechnet Batch mittlerer \(\mu_l\) für jedes Merkmal l in Feature - Dimension:\(\mu_l=\frac{1}{mwh}\sum_{i=1}^m\sum_{j=1}^w\sum_{k=1}^h x_{ijkl}\)

  • Errechnet Batch - Varianz \(\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\)

  • Normalisiert, Skalen und Verschiebungen:\(y_{ijkl}=\frac{\gamma_l(x_{ijkl}-\mu_l)}{\sqrt[2]{\sigma^2_l+\epsilon} }+\beta_l\)

Der Epsilon-Wert, normalerweise eine kleine Zahl, wird addiert, um Fehler bei der Division durch Null zu vermeiden.

Der Ausgabetyp ist ein Tupel von drei XlaOp s:

Ausgänge Typ Semantik
output XlaOp n - dimensionales Array mit der gleichen Form als operand (y)
batch_mean XlaOp 1 - dimensionales Array (\(\mu\))
batch_var XlaOp 1 - dimensionales Array (\(\sigma^2\))

Die batch_mean und batch_var gibt Momente , über die Charge und räumlichen Dimensionen berechnet die obigen Formeln.

BitcastConvertType

Siehe auch XlaBuilder::BitcastConvertType .

Ähnlich wie bei einem tf.bitcast in TensorFlow führt eine elementweise Bitcast Operation aus einer Datenform in eine Zielform. Die Dimensionen müssen übereinstimmen, und die Konvertierung erfolgt elementweise. zB s32 Elemente werden f32 Elemente über Bitcast Routine. Bitcast wird als Low-Level-Cast implementiert, sodass Maschinen mit unterschiedlichen Gleitkommadarstellungen unterschiedliche Ergebnisse liefern.

BitcastConvertType(operand, new_element_type)

Argumente Typ Semantik
operand XlaOp Array vom Typ T mit Dims D
new_element_type PrimitiveType Typ U

Die Abmessungen des Operanden und der Zielform müssen übereinstimmen. Die Bitbreite der Quell- und Zielelementtypen muss gleich sein. Die Quell- und Zielelementtypen dürfen keine Tupel sein.

Übertragen

Siehe auch XlaBuilder::Broadcast .

Fügt einem Array Dimensionen hinzu, indem die Daten im Array dupliziert werden.

Broadcast(operand, broadcast_sizes)

Argumente Typ Semantik
operand XlaOp Das zu duplizierende Array
broadcast_sizes ArraySlice<int64> Die Größen der neuen Dimensionen

Die neuen Dimensionen sind auf der linken Seite eingesetzt wird , das heißt , wenn broadcast_sizes Werte hat {a0, ..., aN} und die Operanden - Form hat Abmessungen {b0, ..., bM} dann die Form des Ausgangs hat Abmessungen {a0, ..., aN, b0, ..., bM} .

Der neue Dimensionsindex in Kopien des Operanden, dh

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

Wenn beispielsweise operand ein Skalar f32 mit Wert 2.0f und broadcast_sizes ist {2, 3} , dann wird das Ergebnis mit der Form ein Array f32[2, 3] und allen Werten im Ergebnis wird sein , 2.0f .

BroadcastInDim

Siehe auch XlaBuilder::BroadcastInDim .

Erweitert die Größe und den Rang eines Arrays durch Duplizieren der Daten im Array.

BroadcastInDim(operand, out_dim_size, broadcast_dimensions)

Argumente Typ Semantik
operand XlaOp Das zu duplizierende Array
out_dim_size ArraySlice<int64> Die Größen der Abmessungen der Zielform
broadcast_dimensions ArraySlice<int64> Welcher Dimension in der Zielform entspricht jede Dimension der Operandenform

Ähnlich wie Broadcast, ermöglicht jedoch das Hinzufügen von Dimensionen überall und das Erweitern vorhandener Dimensionen mit Größe 1.

Der operand wird auf die beschriebene Form von Broadcast out_dim_size . broadcast_dimensions ordnet die Abmessungen von operand an die Abmessungen der Zielform, dh die i - te Dimension des Operanden an die broadcast_dimension abgebildet wird [i] -te Dimension der Ausgangsform. Die Abmessungen des operand müssen der Größe 1 oder die gleiche Größe wie die Abmessung in der Ausgangsform sie abgebildet werden. Die verbleibenden Dimensionen werden mit Dimensionen der Größe 1 gefüllt. Eine Sendung mit entarteter Dimension sendet dann entlang dieser entarteten Dimensionen, um die Ausgabeform zu erreichen. Die Semantik ist ausführlich auf der beschriebene Sendeseite .

Anruf

Siehe auch XlaBuilder::Call .

Ruft eine Berechnung mit den angegebenen Argumenten auf.

Call(computation, args...)

Argumente Typ Semantik
computation XlaComputation Berechnung vom Typ T_0, T_1, ..., T_{N-1} -> S mit N Parametern eines beliebigen Typs
args Sequenz von N XlaOp s N Argumente beliebigen Typs

Die arity und Typen der args müssen die Parameter der Match computation . Es ist erlaubt , keine haben args .

Cholesky

Siehe auch XlaBuilder::Cholesky .

Berechnet die Cholesky - Zerlegung einer Charge von symmetrischen (Hermitesche) positiv definite Matrizen.

Cholesky(a, lower)

Argumente Typ Semantik
a XlaOp ein Array mit Rang > 2 eines komplexen oder Gleitkommatyps.
lower bool ob die oberen oder unteren Dreieck verwenden a .

Wenn lower ist true berechnet unteren Dreiecksmatrizen l , so dass

$$ a = l . l^T $$

. Wenn lower ist false berechnet oberen Dreiecksmatrizen u derart , dass

$$ a = u^T . u $$

.

Eingangsdaten werden nur von dem unteren / oberen Dreieck der lesen a , abhängig von dem Wert der lower . Werte aus dem anderen Dreieck werden ignoriert. Ausgabedaten werden im gleichen Dreieck zurückgegeben; die Werte im anderen Dreieck sind implementierungsdefiniert und können beliebig sein.

Wenn der Rang a größer als 2 ist, a als Batch von Matrizen behandelt, wobei alle außer den kleinen 2 Dimensionen Chargenabmessungen sind.

Wenn a nicht symmetrisch (Hermitesche) positiv definit ist, ist das Ergebnis der Implementierung definiert.

Klemme

Siehe auch XlaBuilder::Clamp .

Klemmt einen Operanden auf den Bereich zwischen einem minimalen und einem maximalen Wert.

Clamp(min, operand, max)

Argumente Typ Semantik
min XlaOp Array vom Typ T
operand XlaOp Array vom Typ T
max XlaOp Array vom Typ T

Bei gegebenem Operanden und Minimal- und Maximalwerten wird der Operand zurückgegeben, wenn er im Bereich zwischen Minimal- und Maximalwert liegt, ansonsten den Minimalwert, wenn der Operand unterhalb dieses Bereichs liegt, oder den Maximalwert, wenn der Operand oberhalb dieses Bereichs liegt. Das heißt, clamp(a, x, b) = min(max(a, x), b) .

Alle drei Arrays müssen die gleiche Form haben. Alternativ kann , wie eine eingeschränkte Form von Rundfunk , min und / oder max kann ein Skalar des Typ sein T .

Beispiel mit skalaren min und max :

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

Zusammenbruch

Siehe auch XlaBuilder::Collapse und den tf.reshape Betrieb.

Reduziert Dimensionen eines Arrays in eine Dimension.

Collapse(operand, dimensions)

Argumente Typ Semantik
operand XlaOp Array vom Typ T
dimensions int64 Vektor geordnete, aufeinanderfolgende Teilmenge der T-Dimensionen.

Collapse ersetzt die angegebene Teilmenge der Dimensionen des Operanden durch eine einzelne Dimension. Die Eingabeargumente sind ein beliebiges Array vom Typ T und ein Vektor von Dimensionsindizes mit konstanter Kompilierungszeit. Die Dimensionsindizes müssen eine fortlaufende Teilmenge der Dimensionen von T sein (niedrige bis hohe Dimensionszahlen). Somit sind {0, 1, 2}, {0, 1} oder {1, 2} alle gültige Dimensionssätze, aber {1, 0} oder {0, 2} sind es nicht. Sie werden durch eine einzelne neue Bemaßung an derselben Position in der Bemaßungsreihenfolge wie die ersetzten ersetzt, wobei die neue Bemaßungsgröße dem Produkt der ursprünglichen Bemaßungsgrößen entspricht. Die niedrigste Dimensionszahl in dimensions ist die langsamste Variierende Dimension (am wichtigsten) in der Schleife Nest , das diese Dimension zusammenbricht, und die höchste Dimensionszahl ist am schnellsten Variieren (kleinste). Siehe den tf.reshape Operator , wenn allgemeiner Zusammenbruch Ordnung erforderlich ist.

Sei beispielsweise v ein Array mit 24 Elementen:

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

KollektivPermute

Siehe auch XlaBuilder::CollectivePermute .

CollectivePermute ist ein kollektiver Vorgang, der datenübergreifende Replikate sendet und empfängt.

CollectivePermute(operand, source_target_pairs)

Argumente Typ Semantik
operand XlaOp n-dimensionales Eingabearray
source_target_pairs <int64, int64> Vektor Eine Liste von (source_replica_id, target_replica_id)-Paaren. Für jedes Paar wird der Operand vom Quellreplikat zum Zielreplikat gesendet.

Beachten Sie, dass die folgenden Beschränkungen für die sind source_target_pair :

  • Zwei beliebige Paare sollten nicht dieselbe Zielreplikat-ID und nicht dieselbe Quellreplikat-ID haben.
  • Wenn eine Replikat-ID kein Ziel in einem Paar ist, ist die Ausgabe auf dieser Replik ein Tensor, der aus 0(s) mit derselben Form wie die Eingabe besteht.

Verketten

Siehe auch XlaBuilder::ConcatInDim .

Verketten setzt ein Array aus mehreren Array-Operanden zusammen. Das Array hat denselben Rang wie jeder der Eingabe-Array-Operanden (die denselben Rang haben müssen) und enthält die Argumente in der Reihenfolge, in der sie angegeben wurden.

Concatenate(operands..., dimension)

Argumente Typ Semantik
operands Sequenz von N XlaOp N Arrays vom Typ T mit den Dimensionen [L0, L1, ...]. Benötigt N >= 1.
dimension int64 Ein Wert in dem Intervall [0, N) , deren Name die Abmessung zwischen der verketteten werden operands .

Mit Ausnahme der dimension alle Dimensionen gleich sein müssen. Dies liegt daran, dass XLA keine "zerlumpten" Arrays unterstützt. Beachten Sie auch, dass Rang-0-Werte nicht verkettet werden können (da es unmöglich ist, die Dimension zu benennen, entlang derer die Verkettung erfolgt).

1-dimensionales Beispiel:

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

2-dimensionales Beispiel:

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

Diagramm:

Bedingt

Siehe auch XlaBuilder::Conditional .

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

Argumente Typ Semantik
pred XlaOp Scalar vom Typ PRED
true_operand XlaOp Argument vom Typ \(T_0\)
true_computation XlaComputation XlaComputation vom Typ \(T_0 \to S\)
false_operand XlaOp Argument vom Typ \(T_1\)
false_computation XlaComputation XlaComputation vom Typ \(T_1 \to S\)

Führt true_computation wenn pred ist true , false_computation wenn pred ist false , und gibt das Ergebnis.

Die true_computation muss in einem einzigen Argumente vom Typ nehmen \(T_0\) und wird mit aufgerufen werden true_operand , die vom gleichen Typ sein müssen. Die false_computation muss in einem einzigen Argumente vom Typ nehmen \(T_1\) und wird mit aufgerufen werden false_operand , die vom gleichen Typ sein müssen. Der Typ des zurückgegebenen Wert von true_computation und false_computation müssen gleich sein.

Beachten Sie, dass nur einer von true_computation und false_computation wird in Abhängigkeit vom Wert der ausgeführt werden pred .

Conditional(branch_index, branch_computations, branch_operands)

Argumente Typ Semantik
branch_index XlaOp Scalar vom Typ S32
branch_computations Sequenz von N XlaComputation XlaComputations vom Typ \( T_0 \to S , T_1 \to S , ..., T_{N-1} \to S \)
branch_operands Sequenz von N XlaOp Argumente vom Typ \( T_0 , T_1 , ..., T_{N-1} \)

Führt branch_computations[branch_index] , und gibt das Ergebnis zurück. Wenn branch_index eine ist S32 , das ist <0 oder> = N, dann branch_computations[N-1] wird als Standard - Zweig ausgeführt.

Jeder branch_computations[b] muss in einem einzigen Argumente vom Typ nehmen T_b und wird mit aufgerufen werden branch_operands[b] , die vom gleichen Typ sein müssen. Die Art der den zurückgegebenen Wert jedes branch_computations[b] müssen gleich sein.

Beachten Sie, dass nur eine der branch_computations wird in Abhängigkeit vom Wert der ausgeführt werden branch_index .

Conv (Faltung)

Siehe auch XlaBuilder::Conv .

Wie ConvWithGeneralPadding, aber die Auffüllung wird in Kurzform entweder als SAME oder VALID angegeben. SAME padding pads der Eingang ( lhs ) mit Nullen , so dass die Ausgabe die gleiche Form wie der Eingang hat , wenn sie nicht Schreiten zu berücksichtigen. GÜLTIGE Auffüllung bedeutet einfach keine Auffüllung.

ConvWithGeneralPadding (Faltung)

Siehe auch XlaBuilder::ConvWithGeneralPadding .

Berechnet eine Faltung, wie sie in neuronalen Netzen verwendet wird. Hier kann man sich eine Faltung als ein n-dimensionales Fenster vorstellen, das sich über eine n-dimensionale Grundfläche bewegt, und eine Berechnung wird für jede mögliche Position des Fensters durchgeführt.

Argumente Typ Semantik
lhs XlaOp Rang n+2 Array von Eingängen
rhs XlaOp Rang n+2 Array von Kernelgewichten
window_strides ArraySlice<int64> nd Array von Kernel-Schritten
padding ArraySlice< pair<int64, int64>> nd Array von (niedrig, hoch) Padding
lhs_dilation ArraySlice<int64> nd linkes Dilatationsfaktor-Array
rhs_dilation ArraySlice<int64> nd rhs Dilatationsfaktor-Array
feature_group_count int64 die Anzahl der Funktionsgruppen
batch_group_count int64 die Anzahl der Chargengruppen

Sei n die Anzahl der Raumdimensionen. Das lhs Argument ist ein Rang n + 2 - Array beschreibt die Grundfläche. Dies wird als Eingabe bezeichnet, obwohl die rhs natürlich auch eine Eingabe ist. In einem neuronalen Netz sind dies die Eingabeaktivierungen. Die n+2 Dimensionen sind in dieser Reihenfolge:

  • batch : Jede Koordinate in dieser Dimension , für das einen unabhängigen Eingang darstellt Faltung durchgeführt wird.
  • z/depth/features : Jede (y, x) Position im Fußbereich einen Vektor verknüpft ist, der in dieser Dimension geht.
  • spatial_dims : Beschreibt die n räumlichen Dimensionen, die die Grundfläche , dass die Fenster bewegt sich über definieren.

Das rhs - Argument ist ein Rang n + 2 - Array der Beschreibung der Faltungsfilter / kernel / Fenster. Die Maße sind in dieser Reihenfolge:

  • output-z : Die z - Dimension des Ausgangs.
  • input-z : Die Größe dieser Dimension mal feature_group_count die Größe der Equal sollte z Dimension in lhs.
  • spatial_dims : Beschreibt die n räumlichen Dimensionen, die das Fenster nd dass bewegt sich über die Grundfläche definieren.

Das window_strides Argument gibt den Schritt des Faltungsfensters in den räumlichen Dimensionen. Wenn der Schritt in der ersten räumlichen Dimension beispielsweise 3 beträgt, kann das Fenster nur an Koordinaten platziert werden, bei denen der erste räumliche Index durch 3 teilbar ist.

Das padding - Argument gibt die Menge der Null - Auffüllung die Grundfläche angelegt wird. Die Füllmenge kann negativ sein – der absolute Wert der negativen Füllmenge gibt die Anzahl der Elemente an, die aus der angegebenen Dimension entfernt werden müssen, bevor die Faltung durchgeführt wird. padding[0] gibt die Polsterung für Dimension y und padding[1] gibt die Polsterung für Dimension x . Jedes Paar hat die niedrige Auffüllung als erstes Element und die hohe Auffüllung als zweites Element. Das niedrige Padding wird in Richtung niedrigerer Indizes angewendet, während das hohe Padding in Richtung höherer Indizes angewendet wird. Wenn beispielsweise padding[1] ist (2,3) , dann wird es eine Polsterung von 2 Nullen auf der linken Seite und von 3 Nullen auf der rechten Seite in der zweiten Raumdimension. Padding Verwendung entspricht , die gleichen Null - Werte in den Eingang (zum Einfügen lhs ) , bevor die Faltung zu tun.

Die lhs_dilation und rhs_dilation Argumente geben den Dehnungsfaktor auf lhs und rhs die angelegt werden, bzw. in jeder räumlichen Dimension. Wenn der Dilatationsfaktor in einer räumlichen Dimension d ist, werden implizit d-1 Löcher zwischen jedem der Einträge in dieser Dimension platziert, wodurch die Größe des Arrays erhöht wird. Die Löcher werden mit einem No-Op-Wert gefüllt, was für die Faltung Nullen bedeutet.

Die Dilatation der Rs. wird auch als atrous Convolution bezeichnet. Weitere Einzelheiten finden Sie tf.nn.atrous_conv2d . Die Dilatation der linken Seite wird auch transponierte Faltung genannt. Weitere Einzelheiten finden Sie tf.nn.conv2d_transpose .

Das feature_group_count Argument (Standardwert 1) für gruppierte Faltungen verwendet werden. feature_group_count Bedürfnisse ein Teiler von sowohl dem Eingang und der Ausgang Merkmale Dimension sein. Wenn feature_group_count größer als 1 ist, bedeutet dies , dass vom Konzept her die Eingangs- und Ausgangs Merkmal Dimension und die rhs Merkmalsausgabe Dimension gleichmäßig aufgeteilt sind in feature_group_count viele Gruppen, wobei jede Gruppe einer konsekutiven Subsequenz von Merkmalen besteht. Die Eingangsmerkmalsabmessung von rhs Bedürfnisse gleich der sein lhs Eingangsmerkmalsabmessung von geteilten feature_group_count (so dass es bereits die Größe einer Gruppe von Eingangs Merkmale aufweist). Die i-te Gruppen werden zusammen berechnen feature_group_count viele getrennte Faltungen. Die Ergebnisse dieser Faltungen werden in der Ausgabe-Feature-Dimension verkettet.

Für Tiefe Faltung des feature_group_count würde Argument des Eingangsmerkmal Maß eingestellt werden, und die Filter würden aus umgeformt werden [filter_height, filter_width, in_channels, channel_multiplier] bis [filter_height, filter_width, 1, in_channels * channel_multiplier] . Weitere Einzelheiten finden Sie tf.nn.depthwise_conv2d .

Das batch_group_count (Standardwert 1) Argument für gruppierte Filter während Backpropagation verwendet werden. batch_group_count muss ein Teiler von der Größe der sein lhs (Input) Batch - Dimension. Wenn batch_group_count größer als 1 ist, bedeutet dies , dass die Ausgabe Batch Dimension der Größe sein sollte input batch / batch_group_count . Der batch_group_count muss ein Teiler der Ausgabe - Feature - Größe sein.

Das Ausgabe-Shape hat diese Abmessungen in dieser Reihenfolge:

  • batch : Die Größe dieser Dimension mal batch_group_count sollte die Größe der gleich batch Dimension in lhs.
  • z : Die gleiche Größe wie output-z auf dem Kern ( rhs ).
  • spatial_dims : Ein Wert für jede gültige Platzierung des Faltungsfensters.

Die gültigen Platzierungen des Faltungsfensters werden durch die Schritte und die Größe der Grundfläche nach dem Auffüllen bestimmt.

Um zu beschreiben , was eine Faltung der Fall ist, zu prüfen , eine 2D - Faltung, und wählen einige feste batch , z , y , x - Koordinaten in der Ausgabe. Dann (y,x) eine Position einer Ecke des Fensters innerhalb der Grundfläche (zB der oberen linken Ecke, je nachdem , wie die räumlichen Dimensionen interpretieren). Wir haben jetzt ein 2D-Fenster aus der Grundfläche, in dem jeder 2D-Punkt einem 1D-Vektor zugeordnet ist, sodass wir eine 3D-Box erhalten. Aus dem Faltungskern, da wir die Ausgänge festen Koordinaten z , haben wir auch eine 3D - Box. Die beiden Boxen haben die gleichen Abmessungen, so dass wir die Summe der elementweisen Produkte zwischen den beiden Boxen nehmen können (ähnlich einem Punktprodukt). Das ist der Ausgabewert.

Man beachte , daß , wenn output-z ist , beispielsweise 5, dann wird jede Position des Fensters erzeugt 5 Werte in der Ausgabe in die z Dimension des Ausgangs. Diese Werte unterscheiden , in welchem Teil des Faltungskern verwendet wird - es gibt ein separates 3D - Feld von Werten für jeden verwendeten output-z - Koordinate. Sie können es sich also als 5 separate Windungen mit einem anderen Filter für jede von ihnen vorstellen.

Hier ist Pseudocode für eine 2D-Faltung mit Padding und Striding:

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

ConvertElementType

Siehe auch XlaBuilder::ConvertElementType .

Ähnlich wie ein elementweise static_cast in C ++, führt eine elementweise Umwandlungsoperation aus einer Datenform in eine Zielform. Die Dimensionen müssen übereinstimmen, und die Konvertierung erfolgt elementweise. zB s32 Elemente werden f32 Elemente über eine s32 -zu- f32 Umwandlungsroutine.

ConvertElementType(operand, new_element_type)

Argumente Typ Semantik
operand XlaOp Array vom Typ T mit Dims D
new_element_type PrimitiveType Typ U

Die Abmessungen des Operanden und der Zielform müssen übereinstimmen. Die Quell- und Zielelementtypen dürfen keine Tupel sein.

Eine Umwandlung , wie beispielsweise T=s32 bis U=f32 wird eine normalisierende int-to-float Umwandlungsroutine wie Rund-to-nearest-even zuführen.

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

CrossReplicaSumme

Führe AllReduce mit einer Summenberechnung.

Benutzerdefinierter Anruf

Siehe auch XlaBuilder::CustomCall .

Rufen Sie eine vom Benutzer bereitgestellte Funktion innerhalb einer Berechnung auf.

CustomCall(target_name, args..., shape)

Argumente Typ Semantik
target_name string Name der Funktion. Es wird eine Aufrufanweisung ausgegeben, die auf diesen Symbolnamen abzielt.
args Sequenz von N XlaOp s N Argumente beliebigen Typs, die an die Funktion übergeben werden.
shape Shape Ausgabeform der Funktion

Die Funktionssignatur ist unabhängig von der Arität oder Art der Argumente gleich:

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

Wenn CustomCall beispielsweise wie folgt verwendet wird:

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

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

Hier ist ein Beispiel für eine Implementierung von 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];
  // ...
}

Die vom Benutzer bereitgestellte Funktion darf keine Nebenwirkungen haben und ihre Ausführung muss idempotent sein.

Punkt

Siehe auch XlaBuilder::Dot .

Dot(lhs, rhs)

Argumente Typ Semantik
lhs XlaOp Array vom Typ T
rhs XlaOp Array vom Typ T

Die genaue Semantik dieser Operation hängt von den Rängen der Operanden ab:

Eingang Ausgabe Semantik
Vektor [n] dot [n] Skalar Vektorpunktprodukt
Matrix [mxk] dot [k] Vektor [m] Matrix-Vektor-Multiplikation
Matrix [mxk] dot [KXN] Matrix [mxn] Matrix-Matrix-Multiplikation

Die Operation durchführt , von Produkten Summe über die zweite Dimension der lhs (oder die ersten , wenn sie mit Rang 1 hat) und die erste Dimension der rhs . Dies sind die "kontrahierten" Dimensionen. Die vertraglich vereinbarten Abmessungen von lhs und rhs müssen gleich groß sein. In der Praxis kann es verwendet werden, um Punktprodukte zwischen Vektoren, Vektor/Matrix-Multiplikationen oder Matrix/Matrix-Multiplikationen durchzuführen.

PunktAllgemein

Siehe auch XlaBuilder::DotGeneral .

DotGeneral(lhs, rhs, dimension_numbers)

Argumente Typ Semantik
lhs XlaOp Array vom Typ T
rhs XlaOp Array vom Typ T
dimension_numbers DotDimensionNumbers Kontrahierungs- und Chargendimensionsnummern

Wie Dot, ermöglicht jedoch die Angabe von Kontrahierungs- und Chargendimensionsnummern sowohl für „links“ als auch für „rechts“.

DotDimensionNumbers-Felder Typ Semantik
'lhs_contracting_dimensions' wiederholt int64 'links' Kontraktionsmaßzahlen
'rhs_contracting_dimensions' wiederholt int64 'rhs'-Kontrahierungsdimensionsnummern
'lhs_batch_dimensions' wiederholt int64 'links' Chargendimensionsnummern
'rhs_batch_dimensions' wiederholt int64 'rhs'-Batch-Dimensionsnummern

DotGeneral führt die Summe der Produkte über die in 'dimension_numbers' angegebenen Kontrahierungsdimensionen aus.

Zugehörige kontrahierende Dimensionsnummern von 'links' und 'rechts' müssen nicht gleich sein, müssen aber die gleichen Dimensionsgrößen haben.

Beispiel mit Kontrahierungsmaßzahlen:

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

Zugehörige Chargenbemaßungsnummern aus 'links' und 'rechts' müssen die gleichen Bemaßungsgrößen haben.

Beispiel mit Chargendimensionsnummern (Chargengröße 2, 2x2 Matrizen):

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} } }
Eingang Ausgabe Semantik
[b0, m, k] dot [b0, k, n] [b0, m, n] Batch matmul
[b0, b1, m, k] dot [b0, b1, k, n] [b0, b1, m, n] Batch matmul

Daraus folgt, dass die resultierende Dimensionsnummer mit der Batch-Dimension beginnt, dann die 'lhs'-Dimension ohne Kontrakt/Nicht-Batch und schließlich die 'Rechts'-Dimension ohne Kontrakt/Nicht-Batch.

DynamicSlice

Siehe auch XlaBuilder::DynamicSlice .

DynamicSlice extrahiert ein Unterarray von dem Eingangsarray bei dynamischen start_indices . Die Größe der Scheibe in jeder Dimension wird in vergangen size_indices , die den Endpunkt des exklusiven slice Intervalle in jeder Dimension angeben: [Starts, start + size). Die Form des start_indices muss rank sein == 1 mit Dimensionsgröße , um den Rang der operand .

DynamicSlice(operand, start_indices, size_indices)

Argumente Typ Semantik
operand XlaOp N-dimensionales Array vom Typ T
start_indices Sequenz von N XlaOp Liste von N skalaren ganzen Zahlen, die die Startindizes des Slice für jede Dimension enthalten. Der Wert muss größer oder gleich Null sein.
size_indices ArraySlice<int64> Liste von N ganzen Zahlen, die die Slice-Größe für jede Dimension enthalten. Jeder Wert muss unbedingt größer als Null sein, und start + size muss kleiner oder gleich der Größe der Dimension sein, um zu vermeiden, dass die Modulo-Dimension-Größe umbrochen wird.

Die effektive Schichtindizes werden durch Anwendung der folgenden Transformation für jeden Index berechnet i in [1, N) vor der Durchführung der Scheibe:

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

Dadurch wird sichergestellt, dass die extrahierte Scheibe immer innerhalb des Operanden-Arrays liegt. Wenn das Slice vor dem Anwenden der Transformation in-bounds ist, hat die Transformation keine Auswirkung.

1-dimensionales Beispiel:

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-dimensionales Beispiel:

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

Siehe auch XlaBuilder::DynamicUpdateSlice .

DynamicUpdateSlice erzeugt ein Ergebnis , das der Wert des Eingangsfeldes ist operand , mit einer Scheibe update bei überschrieben start_indices . Die Form der update bestimmt die Form des Sub-Array des Ergebnisses , das aktualisiert wird. Die Form des start_indices muss rank sein == 1 mit Dimensionsgröße , um den Rang der operand .

DynamicUpdateSlice(operand, update, start_indices)

Argumente Typ Semantik
operand XlaOp N-dimensionales Array vom Typ T
update XlaOp N-dimensionales Array vom Typ T, das die Slice-Aktualisierung enthält. 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), LogicalAnd (logical AND), or LogicalOr (logical OR).

Arguments Type 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 Type 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⌉ .

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

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

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

Arguments Type 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 Type 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 Type 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 . 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.size ) and range [ 0 , operand.rank ) \ collapsed_slice_dims . So if, eg, offset.size is 4 , operand.rank is 6 and collapsed_slice_dims is { 0 , 2 } then remapped_offset_dims is { 01 , 13 , 24 , 35 }.

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 ], X ] 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 Type 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 Type 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 Type 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

Iota()

Builds a constant literal on device rather than a potentially large host transfer. Creates a rank 1 array of values starting at zero and incrementing by one. 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 Type Semantics
type PrimitiveType type U
size int64 The number of elements in the array.
iota_dimension int64 The dimension to increment along.

Map

See also XlaBuilder::Map .

Map(operands..., computation)

Arguments Type 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.

Pad

See also XlaBuilder::Pad .

Pad(operand, padding_value, padding_config)

Arguments Type 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 Type 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 Type 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.
  • 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 T .

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.

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 initial value used for every reduction is init_value , and it may be inserted anywhere during computation by the back-end. It is required that init_value is an identity of the reduction function (for example, 0 for addition) or undefined behavior will occur. The applied computation is always passed the init_value on the left-hand side.

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.

As an example, 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 Type 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 Type Semantics
operand XlaOp Array or a non-empty tuple of arrays to reduce across replicas.
computation XlaComputation Reduction computation
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_dim 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 Type 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().ConsumeValueOrDie();
}

// 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 Type 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 Type 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 Type 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 Type 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 Type 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 result which is the value of the input array operand , with several slices (at indices specified by scatter_indices ) updated with the values in updates using update_computation .

See also XlaBuilder::Scatter .

scatter(operand, scatter_indices, updates, update_computation, index_vector_dim, update_window_dims, inserted_window_dims, scatter_dims_to_operand_dims)

Arguments Type Semantics
operand XlaOp Array to be scattered into.
scatter_indices XlaOp Array containing the starting indices of the slices that must be scattered to.
updates XlaOp Array containing the values that must be used for scattering.
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, T) -> T .
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.

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:

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

  • Bounds of dimension i in updates 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 [ index_vector_dim ], and its values must be in the range [0, operand.rank) .

For a given index U in the updates array, the corresponding index I in the operand 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 operand 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 { 01 , 13 , 24 , 35 }).
    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 operand , ie for all indices O in the operand array:
    output [ O ] = operand [ O ]
  • For every index U in the updates array and the corresponding index O in the operand array, if O is a valid index for output :
    output [ O ] = update_computation ( output [ O ], updates [ U ])

The order in which updates are applied is non-deterministic. So, when multiple indices in updates refer to the same index in operand , 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 Type 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 Type 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 Type 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)

Arguments Type 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 Type 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. By default, is_stable is set to false.

Transpose

See also the tf.reshape operation.

Transpose(operand)

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