날짜를 저장하십시오! Google I / O가 5 월 18 일부터 20 일까지 반환됩니다. 지금 등록
이 페이지는 Cloud Translation API를 통해 번역되었습니다.
Switch to English

작동 의미

다음은 XlaBuilder 인터페이스에 정의 된 연산의 의미를 설명합니다. 일반적으로 이러한 작업은 xla_data.proto 의 RPC 인터페이스에 정의 된 작업에 xla_data.proto 됩니다.

명명법에 대한 참고 사항 : XLA가 다루는 일반화 된 데이터 유형은 일부 균일 한 유형 (예 : 32 비트 부동 소수점)의 요소를 보유하는 N 차원 배열입니다. 설명서 전체에서 배열 은 임의 차원 배열을 나타내는 데 사용됩니다. 편의상 특수한 경우에는보다 구체적이고 친숙한 이름이 있습니다. 예를 들어 벡터 는 1 차원 배열이고 행렬 은 2 차원 배열입니다.

결국

XlaBuilder::AfterAll 도 참조하십시오.

AfterAll은 가변적 인 수의 토큰을 가져와 단일 토큰을 생성합니다. 토큰은 순서를 적용하기 위해 부작용 작업간에 스레드 될 수있는 기본 유형입니다. AfterAll 은 집합 작업 후 작업을 주문하기위한 토큰 조인으로 사용할 수 있습니다.

AfterAll(operands)

인수 유형 의미론
operands XlaOp 가변 토큰 수

AllGather

XlaBuilder::AllGather 도 참조하십시오.

복제본에서 연결을 수행합니다.

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

인수 유형 의미론
operand XlaOp 복제본을 연결하는 배열입니다.
all_gather_dim int64 연결 차원.
replica_groups int64 의 벡터로 int64 벡터 연결이 수행되는 그룹입니다.
channel_id 선택적 int64 모듈 간 통신을위한 선택적 채널 ID입니다.
  • replica_groups 는 연결이 수행되는 복제본 그룹 목록입니다 (현재 복제본의 복제본 ID는 ReplicaId 사용하여 검색 할 수 있음). 각 그룹의 복제본 순서는 입력이 결과에있는 순서를 결정합니다. replica_groups 는 비어 있거나 (이 경우 모든 복제본이 단일 그룹에 속하고 0 에서 N - 1 로 정렬 됨) 복제본 수와 동일한 수의 요소를 포함해야합니다. 예를 들어 replica_groups = {0, 2}, {1, 3} 은 복제본 02 , 13 사이의 연결을 수행합니다.
  • shard_count 는 각 복제본 그룹의 크기입니다. replica_groups 가 비어있는 경우에 필요합니다.
  • channel_id 는 모듈 간 통신에 사용됩니다. 동일한 channel_id 사용하는 all-gather 작업 만 서로 통신 할 수 있습니다.

출력 모양은 all_gather_dimshard_count 배 더 큰 입력 모양입니다. 예를 들어 두 개의 복제본이 있고 피연산자가 두 복제본에서 각각 [1.0, 2.5][3.0, 5.25] 값을 all_gather_dim 경우 all_gather_dim0 이 연산의 출력 값은 [1.0, 2.5, 3.0, 5.25] 두 복제본에 모두 적용됩니다.

AllReduce

XlaBuilder::AllReduce 도 참조하십시오.

복제본에서 사용자 지정 계산을 수행합니다.

AllReduce(operand, computation, replica_group_ids, channel_id)

인수 유형 의미론
operand XlaOp 복제본을 줄이기위한 어레이 또는 비어 있지 않은 어레이 튜플입니다.
computation XlaComputation 감소 계산
replica_groups int64 의 벡터로 int64 벡터 감축이 수행되는 그룹
channel_id 선택적 int64 모듈 간 통신을위한 선택적 채널 ID
  • operand 가 배열의 튜플이면 튜플의 각 요소에 대해 all-reduce가 수행됩니다.
  • replica_groups 는 축소가 수행되는 복제본 그룹 목록입니다 (현재 복제본의 복제본 ID는 ReplicaId 사용하여 검색 할 수 있음). replica_groups 는 비어 있거나 (이 경우 모든 복제본이 단일 그룹에 속함) 복제본 수와 동일한 수의 요소를 포함해야합니다. 예를 들어 replica_groups = {0, 2}, {1, 3} 은 복제본 02 , 13 간에 축소를 수행합니다.
  • channel_id 는 모듈 간 통신에 사용됩니다. 동일한 channel_id 가진 all-reduce 작업 만 서로 통신 할 수 있습니다.

출력 모양은 입력 모양과 동일합니다. 예를 들어 두 개의 복제본이 있고 피연산자가 두 복제본에서 각각 [1.0, 2.5][3.0, 5.25] 값을 갖는 경우이 연산 및 합계 계산의 출력 값은 둘 다에서 [4.0, 7.75] 가됩니다. 복제품. 입력이 튜플이면 출력도 튜플입니다.

AllReduce 의 결과를 AllReduce 하려면 각 복제본에서 하나의 입력이 필요하므로 한 복제본이 다른 복제본보다 AllReduce 노드를 더 많이 실행하면 이전 복제본은 영원히 기다립니다. 복제본이 모두 동일한 프로그램을 실행하기 때문에 발생하는 방법은 많지 않지만 while 루프의 조건이 인피 드의 데이터에 의존하고 주입 된 데이터로 인해 while 루프가 더 많이 반복 될 수 있습니다. 한 복제본에서 다른 복제본보다.

AllToAll

XlaBuilder::AllToAll 도 참조하십시오.

AllToAll은 모든 코어에서 모든 코어로 데이터를 보내는 집합 적 작업입니다. 두 단계가 있습니다.

  1. 산란 단계. 각 코어에서 피연산자는 split_count 따라 split_dimensions 블록 수로 분할되고 블록은 모든 코어로 분산됩니다. 예를 들어 i 번째 블록은 i 번째 코어로 전송됩니다.
  2. 수집 단계. 각 코어는 concat_dimension 따라 수신 된 블록을 연결합니다.

참여 코어는 다음과 같이 구성 할 수 있습니다.

  • replica_groups : 각 ReplicaGroup은 계산에 참여하는 복제본 ID 목록을 포함합니다 (현재 복제본의 복제본 ID는 ReplicaId 사용하여 검색 할 수 있음). AllToAll은 지정된 순서로 하위 그룹 내에서 적용됩니다. 예를 들어 replica_groups = { {1,2,3}, {4,5,0} } 은 AllToAll이 복제본 {1, 2, 3} 및 수집 단계에 적용되고 수신 된 블록이 1, 2, 3의 동일한 순서로 연결되어야합니다. 그런 다음 다른 AllToAll이 복제본 4, 5, 0 내에 적용되고 연결 순서도 4, 5, 0입니다. replica_groups 가 비어 있으면 모든 복제본이 하나에 속합니다. 그룹, 모양의 연결 순서로.

전제 조건 :

  • 온 피연산자의 치수 사이즈 split_dimension 로 나누어 split_count .
  • 피연산자의 모양은 튜플이 아닙니다.

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

인수 유형 의미론
operand XlaOp n 차원 입력 배열
split_dimension int64 피연산자가 분할되는 차원의 이름을 지정하는 간격 [0, n) 의 값
concat_dimension int64 분할 블록이 연결되는 차원의 이름을 지정하는 간격 [0, n) 의 값
split_count int64 이 작업에 참여하는 코어 수입니다. replica_groups 가 비어 있으면 이것은 복제본의 수 여야합니다. 그렇지 않으면 각 그룹의 복제본 수와 같아야합니다.
replica_groups ReplicaGroup 벡터 각 그룹에는 복제본 ID 목록이 있습니다.

아래는 Alltoall의 예입니다.

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

이 예에서는 Alltoall에 참여하는 4 개의 코어가 있습니다. 각 코어에서 피연산자는 치수 0을 따라 4 개 부분으로 분할되므로 각 부분의 모양은 f32 [4,4]입니다. 4 개의 부품이 모든 코어에 흩어져 있습니다. 그런 다음 각 코어는 수신 된 부품을 차원 1을 따라 순서 또는 코어 0-4로 연결합니다. 따라서 각 코어의 출력은 f32 [16,4] 모양을 갖습니다.

BatchNormGrad

알고리즘에 대한 자세한 설명은 XlaBuilder::BatchNormGrad원본 배치 정규화 문서 를 참조하십시오.

배치 표준의 기울기를 계산합니다.

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

인수 유형 의미론
operand XlaOp 정규화 할 n 차원 배열 (x)
scale XlaOp 1 차원 배열 (\(\gamma\))
mean XlaOp 1 차원 배열 (\(\mu\))
variance XlaOp 1 차원 배열 (\(\sigma^2\))
grad_output XlaOp BatchNormTraining 전달 된 그라디언트 (\( \nabla y\))
epsilon float Epsilon 값 (\(\epsilon\))
feature_index int64 operand 특성 차원에 대한 인덱스

특성 차원의 각 특성에 대해 ( feature_indexoperand 의 특성 차원에 대한 인덱스 임) 연산은 다른 모든 차원의 operand , offsetscale 대한 기울기를 계산합니다. feature_indexoperand 의 기능 차원에 대한 유효한 인덱스 여야합니다.

세 가지 그라디언트는 다음 공식으로 정의됩니다 (4 차원 배열을 operand 로 가정하고 특성 차원 인덱스 l , 배치 크기 m 및 공간 크기 wh ).

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

입력 meanvariance 은 배치 및 공간 차원에서 모멘트 값을 나타냅니다.

출력 유형은 세 개의 핸들로 구성된 튜플입니다.

출력 유형 의미론
grad_operand XlaOp 입력 operand (\( \nabla x\))에 대한 기울기
grad_scale XlaOp 입력 scale 대한 기울기 (\( \nabla \gamma\))
grad_offset XlaOp 입력 offset (\( \nabla \beta\))에 대한 기울기

BatchNormInference

알고리즘에 대한 자세한 설명은 XlaBuilder::BatchNormInference원래 배치 정규화 문서 를 참조하십시오.

배치 및 공간 차원에서 배열을 정규화합니다.

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

인수 유형 의미론
operand XlaOp 정규화 할 n 차원 배열
scale XlaOp 1 차원 배열
offset XlaOp 1 차원 배열
mean XlaOp 1 차원 배열
variance XlaOp 1 차원 배열
epsilon float Epsilon 가치
feature_index int64 operand 특성 차원에 대한 인덱스

특성 차원의 각 특성에 대해 ( feature_indexoperand 의 특성 차원에 대한 인덱스 임) 연산은 다른 모든 차원의 평균과 분산을 계산하고 평균과 분산을 사용하여 operand 각 요소를 정규화합니다. feature_indexoperand 의 기능 차원에 대한 유효한 인덱스 여야합니다.

BatchNormInference 는 각 배치의 meanvariance 을 계산하지 않고 BatchNormTraining 을 호출하는 것과 같습니다. 대신 입력 meanvariance 을 추정값으로 사용합니다. 이 작업의 목적은 추론의 지연 시간을 줄이는 것이므로 이름은 BatchNormInference 입니다.

출력은 입력 operand 와 모양이 같은 정규화 된 n 차원 배열입니다.

BatchNormTraining

알고리즘에 대한 자세한 설명은 XlaBuilder::BatchNormTrainingthe original batch normalization paper 를 참조하십시오.

배치 및 공간 차원에서 배열을 정규화합니다.

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

인수 유형 의미론
operand XlaOp 정규화 할 n 차원 배열 (x)
scale XlaOp 1 차원 배열 (\(\gamma\))
offset XlaOp 1 차원 배열 (\(\beta\))
epsilon float Epsilon 값 (\(\epsilon\))
feature_index int64 operand 특성 차원에 대한 인덱스

특성 차원의 각 특성에 대해 ( feature_indexoperand 의 특성 차원에 대한 인덱스 임) 연산은 다른 모든 차원의 평균과 분산을 계산하고 평균과 분산을 사용하여 operand 각 요소를 정규화합니다. feature_indexoperand 의 기능 차원에 대한 유효한 인덱스 여야합니다.

알고리즘은 공간 차원의 크기가 wh m 요소를 포함하는 operand \(x\)의 각 배치에 대해 다음과 같이 진행됩니다 ( operand 가 4 차원 배열이라고 가정).

  • 기능 차원의 각 기능 l 에 대한 배치 평균 \(\mu_l\)을 계산합니다. \(\mu_l=\frac{1}{mwh}\sum_{i=1}^m\sum_{j=1}^w\sum_{k=1}^h x_{ijkl}\)

  • 배치 분산 계산 \(\sigma^2_l\) : \(\sigma^2_l=\frac{1}{mwh}\sum_{i=1}^m\sum_{j=1}^w\sum_{k=1}^h (x_{ijkl} - \mu_l)^2\)

  • 정규화, 확장 및 이동 : \(y_{ijkl}=\frac{\gamma_l(x_{ijkl}-\mu_l)}{\sqrt[2]{\sigma^2_l+\epsilon} }+\beta_l\)

0으로 나누기 오류를 피하기 위해 일반적으로 작은 숫자 인 엡실론 값이 추가됩니다.

출력 유형은 세 개의 XlaOp 튜플입니다.

출력 유형 의미론
output XlaOp 입력 operand 와 모양이 같은 n 차원 배열 (y)
batch_mean XlaOp 1 차원 배열 (\(\mu\))
batch_var XlaOp 1 차원 배열 (\(\sigma^2\))

batch_meanbatch_var 는 위의 공식을 사용하여 배치 및 공간 차원에서 계산 된 모멘트입니다.

BitcastConvertType

XlaBuilder::BitcastConvertType 도 참조하십시오.

TensorFlow의 tf.bitcast 와 유사하게 데이터 셰이프에서 대상 셰이프로 요소 별 비트 캐스트 작업을 수행합니다. 차원은 일치해야하며 변환은 요소별로 이루어집니다. 예를 들어 s32 요소는 비트 캐스트 루틴을 통해 f32 요소가됩니다. 비트 캐스트는 저수준 캐스트로 구현되므로 부동 소수점 표현이 다른 시스템은 다른 결과를 제공합니다.

BitcastConvertType(operand, new_element_type)

인수 유형 의미론
operand XlaOp dims D가있는 T 유형의 배열
new_element_type PrimitiveType 유형 U

피연산자와 대상 모양의 치수가 일치해야합니다. 소스 및 대상 요소 유형의 비트 너비는 동일해야합니다. 소스 및 대상 요소 유형은 튜플이 아니어야합니다.

방송

XlaBuilder::Broadcast 도 참조하십시오.

배열의 데이터를 복제하여 배열에 차원을 추가합니다.

Broadcast(operand, broadcast_sizes)

인수 유형 의미론
operand XlaOp 복제 할 배열
broadcast_sizes ArraySlice<int64> 새로운 차원의 크기

새 차원이 왼쪽에 삽입됩니다. 즉, broadcast_sizes{a0, ..., aN} 값이 있고 피연산자 모양에 {b0, ..., bM} 크기가 있으면 출력의 모양에 {a0, ..., aN, b0, ..., bM}

새로운 차원은 피연산자의 복사본으로 색인됩니다.

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

예를 들어, operand 가 값이 2.0ff32 스칼라이고 broadcast_sizes{2, 3} 이면 결과는 f32[2, 3] 모양의 배열이되고 결과의 모든 값은 2.0f 됩니다.

BroadcastInDim

XlaBuilder::BroadcastInDim 도 참조하십시오.

배열의 데이터를 복제하여 배열의 크기와 순위를 확장합니다.

BroadcastInDim(operand, out_dim_size, broadcast_dimensions)

인수 유형 의미론
operand XlaOp 복제 할 배열
out_dim_size ArraySlice<int64> 대상 모양의 치수 크기
broadcast_dimensions ArraySlice<int64> 피연산자 모양의 각 차원에 해당하는 대상 모양의 차원

브로드 캐스트와 유사하지만 크기를 어디에서나 추가하고 크기 1로 기존 크기를 확장 할 수 있습니다.

operandout_dim_size 설명하는 모양으로 브로드 캐스트됩니다. broadcast_dimensionsoperand 의 차원을 대상 모양의 차원에 매핑합니다. 즉, 피연산자의 i 차원이 출력 모양의 broadcast_dimension [i] 차원에 매핑됩니다. operand 의 차원은 크기가 1이거나 매핑되는 출력 셰이프의 차원과 같은 크기 여야합니다. 나머지 차원은 크기 1의 차원으로 채워집니다. 퇴화 차원 방송은 출력 형태에 도달하기 위해 퇴화 차원을 따라 방송합니다. 의미론은 방송 페이지 에 자세히 설명되어 있습니다.

요구

XlaBuilder::Call 도 참조하십시오.

주어진 인수로 계산을 호출합니다.

Call(computation, args...)

인수 유형 의미론
computation XlaComputation 임의 유형의 N 개의 매개 변수를 사용하여 T_0, T_1, ..., T_{N-1} -> S 유형 계산
args N XlaOp 의 시퀀스 임의 유형의 N 인수

인수에 대응하고, 유형의 args 의 매개 변수와 일치해야 computation . args 가 허용되지 않습니다.

Cholesky

XlaBuilder::Cholesky 도 참조하십시오.

대칭 (Hermitian) 양의 정부 호 행렬 배치의 촐레 스키 분해 를 계산합니다.

Cholesky(a, lower)

인수 유형 의미론
a XlaOp 복합 또는 부동 소수점 유형의 랭크> 2 배열.
lower bool 여부는 상부 또는 하부 삼각형 사용 a .

lowertrue 과 같은 하위 삼각 행렬 l 계산합니다.

$$ a = l . l^T $$

. lowerfalse 이면 다음과 같은 상위 삼각 행렬 u 계산합니다.

$$ a = u^T . u $$

.

입력 데이터는 하부 / 상부 삼각형로부터 판독 의 값에 따라, a lower . 다른 삼각형의 값은 무시됩니다. 출력 데이터는 동일한 삼각형으로 반환됩니다. 다른 삼각형의 값은 구현에 따라 정의되며 무엇이든 될 수 있습니다.

의 계급 경우 a 2보다 큰, a 모든 미성년자를 제외하고 2 차원 배치 차원이다 행렬의 배치로 처리됩니다.

a 가 대칭 (헤르 미트 식) 양의 정부 호가 아닌 경우 결과는 구현에 따라 정의됩니다.

집게

XlaBuilder::Clamp 도 참조하십시오.

최소값과 최대 값 사이의 범위 내로 피연산자를 고정합니다.

Clamp(min, operand, max)

인수 유형 의미론
min XlaOp 유형 T의 배열
operand XlaOp 유형 T의 배열
max XlaOp 유형 T의 배열

피연산자와 최소값 및 최대 값이 주어지면 최소값과 최대 값 사이의 범위에 있으면 피연산자를 반환하고, 피연산자가이 범위보다 작 으면 최소값을 반환하고, 피연산자가이 범위보다 높으면 최대 값을 반환합니다. 즉, clamp(a, x, b) = min(max(a, x), b) 입니다.

세 배열은 모두 같은 모양이어야합니다. 또는 제한된 형태의 브로드 캐스팅 으로 min 및 / 또는 maxT 유형의 스칼라 일 수 있습니다.

스칼라 minmax 예 :

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

무너짐

XlaBuilder::Collapsetf.reshape 작업도 참조하세요.

배열의 차원을 한 차원으로 축소합니다.

Collapse(operand, dimensions)

인수 유형 의미론
operand XlaOp 유형 T의 배열
dimensions int64 벡터 순서대로 T 차원의 연속 하위 집합입니다.

축소는 피연산자 차원의 지정된 하위 집합을 단일 차원으로 바꿉니다. 입력 인수는 T 유형의 임의 배열과 차원 인덱스의 컴파일 시간 상수 벡터입니다. 차원 인덱스는 T 차원의 연속적인 하위 집합 인 순서 (낮은 차원에서 높은 차원 번호) 여야합니다. 따라서 {0, 1, 2}, {0, 1} 또는 {1, 2}는 모두 유효한 측정 기준 집합이지만 {1, 0} 또는 {0, 2}는 그렇지 않습니다. 그것들은 원래 치수 크기의 제품과 동일한 새 치수 크기로 대체되는 치수 순서에서 동일한 위치에있는 단일 새 치수로 대체됩니다. 가장 낮은 차원 번호 dimensions 이러한 치수를 축소 루프 둥지에서 가장 느린 VARYING 치수 (가장 중요한)이며, 가장 높은 차원의 수는 (가장 작은)을 변화 빠른입니다. 더 일반적인 축소 순서가 필요한 경우 tf.reshape 연산자를 참조하세요.

예를 들어 v를 24 개 요소의 배열로 지정합니다.

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

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

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

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

CollectivePermute

XlaBuilder::CollectivePermute 도 참조하십시오.

CollectivePermute는 복제본 간 데이터를 보내고받는 집합 적 작업입니다.

CollectivePermute(operand, source_target_pairs)

인수 유형 의미론
operand XlaOp n 차원 입력 배열
source_target_pairs <int64, int64> 벡터 (source_replica_id, target_replica_id) 쌍의 목록입니다. 각 쌍에 대해 피연산자는 소스 복제본에서 대상 복제본으로 전송됩니다.

source_target_pair 에는 다음과 같은 제한이 있습니다.

  • 두 쌍은 동일한 대상 복제본 ID를 가질 수 없으며 동일한 소스 복제본 ID를 가져서는 안됩니다.
  • 복제본 ID가 어떤 쌍의 대상이 아닌 경우 해당 복제본의 출력은 입력과 동일한 모양을 가진 0으로 구성되는 텐서입니다.

사슬 같이 잇다

XlaBuilder::ConcatInDim 도 참조하십시오.

Concatenate는 여러 배열 피연산자에서 배열을 구성합니다. 배열은 각 입력 배열 피연산자 (서로 동일한 순위 여야 함)와 순위가 같고 지정된 순서대로 인수를 포함합니다.

Concatenate(operands..., dimension)

인수 유형 의미론
operands N XlaOp 시퀀스 차원이 [L0, L1, ...] 인 유형 T의 N 배열. N> = 1이 필요합니다.
dimension int64 operands 간에 연결될 차원의 이름을 지정하는 간격 [0, N) 의 값입니다.

dimension 제외하고 모든 차원은 동일해야합니다. 이는 XLA가 "비정형"배열을 지원하지 않기 때문입니다. 또한 순위 0 값은 연결할 수 없습니다 (연결이 발생하는 차원의 이름을 지정할 수 없으므로).

1 차원 예 :

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

2 차원 예 :

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

도표:

가정 어구

XlaBuilder::Conditional 도 참조하십시오.

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

인수 유형 의미론
pred XlaOp PRED 유형의 스칼라
true_operand XlaOp \(T_0\) 유형의 인수
true_computation XlaComputation \(T_0 \to S\) 유형의 XlaComputation
false_operand XlaOp \(T_1\) 유형의 인수
false_computation XlaComputation \(T_1 \to S\) 유형의 XlaComputation

predtrue 이면 false_computation , predfalse true true_computation 실행하여 결과를 반환합니다.

true_computationtrue_computation 유형의 단일 인수를 가져와야하며 동일한 유형이어야하는 true_operand 로 호출됩니다. false_computationfalse_computation 유형의 단일 인수를 가져와야하며 동일한 유형이어야하는 false_operand 로 호출됩니다. true_computationfalse_computation 의 반환 된 값 유형은 동일해야합니다.

pred 값에 따라 true_computationfalse_computation 중 하나만 실행됩니다.

Conditional(branch_index, branch_computations, branch_operands)

인수 유형 의미론
branch_index XlaOp S32 유형의 스칼라
branch_computations N XlaComputation 순서 \( T_0 \to S , T_1 \to S , ..., T_{N-1} \to S \) 유형의 XlaComputations
branch_operands N XlaOp 시퀀스 \( T_0 , T_1 , ..., T_{N-1} \) 유형의 인수

branch_computations[branch_index] 실행하고 결과를 반환합니다. branch_index 가 <0 또는> = N 인 S32 이면 branch_computations[N-1] 이 기본 분기로 실행됩니다.

branch_computations[b] 형의 인수 취해야 T_b 및 호출한다 branch_operands[b] 같은 형식이어야한다. 각 branch_computations[b] 의 반환 값 유형은 동일해야합니다.

단 하나의 유의 branch_computations 값에 따라 실행된다 branch_index .

Conv (컨볼 루션)

XlaBuilder::Conv 도 참조하십시오.

ConvWithGeneralPadding과 같지만 패딩은 SAME 또는 VALID로 단축 방식으로 지정됩니다. SAME 패딩은 입력 ( lhs )을 0으로 채워서 스트라이드를 고려하지 않을 때 출력이 입력과 동일한 모양을 갖도록합니다. 유효한 패딩은 단순히 패딩이 없음을 의미합니다.

ConvWithGeneralPadding (컨볼 루션)

XlaBuilder::ConvWithGeneralPadding 도 참조하십시오.

신경망에서 사용되는 종류의 회선을 계산합니다. 여기서 컨볼 루션은 n 차원 기본 영역을 가로 질러 이동하는 n 차원 창으로 생각할 수 있으며 창의 가능한 각 위치에 대해 계산이 수행됩니다.

인수 유형 의미론
lhs XlaOp n + 2 입력 배열 순위
rhs XlaOp 커널 가중치의 n + 2 배열 순위
window_strides ArraySlice<int64> 커널 보폭의 nd 배열
padding ArraySlice< pair<int64, int64>> (낮음, 높음) 패딩의 nd 배열
lhs_dilation ArraySlice<int64> nd lhs 팽창 인자 배열
rhs_dilation ArraySlice<int64> nd rhs 팽창 인자 배열
feature_group_count int64 기능 그룹의 수
batch_group_count int64 배치 그룹 수

n을 공간 차원의 수라고합니다. lhs 인수는 기본 영역을 설명하는 순위 n + 2 배열입니다. 물론 rhs도 입력이지만 이것을 입력이라고합니다. 신경망에서 이들은 입력 활성화입니다. n + 2 차원은 다음과 같습니다.

  • batch :이 차원의 각 좌표는 컨볼 루션이 수행되는 독립적 인 입력을 나타냅니다.
  • z/depth/features : 기본 영역의 각 (y, x) 위치에는이 차원으로 들어가는 벡터가 연결되어 있습니다.
  • spatial_dims : 창이 이동하는 기본 영역을 정의하는 n 공간 차원을 설명합니다.

rhs 인수는 컨벌루션 필터 / 커널 / 창을 설명하는 랭크 n + 2 배열입니다. 치수는 다음과 같습니다.

  • output-z : output-zz 차원입니다.
  • input-z :이 차원의 크기에 feature_group_count 를 곱한 값은 z 차원의 크기 (lhs)와 같아야합니다.
  • spatial_dims : 기본 영역을 가로 질러 이동하는 창을 정의하는 n 공간 차원을 설명합니다.

window_strides 인수는 공간 차원에서 컨볼 루션 창의 보폭을 지정합니다. 예를 들어 첫 번째 공간 차원의 보폭이 3이면 첫 번째 공간 인덱스가 3으로 나눌 수있는 좌표에만 창을 배치 할 수 있습니다.

padding 인수는 기본 영역에 적용 할 0 채우기 양을 지정합니다. 패딩의 양은 음수 일 수 있습니다. 음수 패딩의 절대 값은 컨볼 루션을 수행하기 전에 지정된 차원에서 제거 할 요소의 수를 나타냅니다. padding[0] 은 차원 y 의 안쪽 여백을 지정하고 padding[1] 은 차원 x 의 안쪽 여백을 지정합니다. 각 쌍에는 첫 번째 요소로 낮은 패딩이 있고 두 번째 요소로 높은 패딩이 있습니다. 낮은 패딩은 낮은 인덱스 방향으로 적용되고 높은 패딩은 높은 인덱스 방향으로 적용됩니다. 예를 들어 padding[1](2,3) 이면 두 번째 공간 차원에서 왼쪽에 0이 2 개, 오른쪽에 0이 3 개씩 채워집니다. 패딩을 사용하는 것은 컨볼 루션을 수행하기 전에 동일한 0 값을 입력 ( lhs )에 삽입하는 것과 같습니다.

lhs_dilationrhs_dilation 인수는 각 공간 차원에서 각각 lhs 및 rhs에 적용 할 확장 계수를 지정합니다. 공간 차원의 확장 계수가 d이면 해당 차원의 각 항목 사이에 d-1 구멍이 암시 적으로 배치되어 배열 크기가 증가합니다. 구멍은 no-op 값으로 채워지며 컨볼 루션의 경우 0을 의미합니다.

rhs의 확장은 atrous convolution이라고도합니다. 자세한 내용은 tf.nn.atrous_conv2d 참조하십시오. lhs의 확장을 전치 회선이라고도합니다. 자세한 내용은 tf.nn.conv2d_transpose 참조하십시오.

feature_group_count 인수 (기본값 1)는 그룹화 된 컨볼 루션에 사용할 수 있습니다. feature_group_count 는 입력 및 출력 특성 차원의 제수 여야합니다. feature_group_count 가 1보다 크면 개념적으로 입력 및 출력 특성 차원과 rhs 출력 특성 차원이 feature_group_count 여러 그룹으로 균등하게 분할되며 각 그룹은 연속적인 특성 하위 시퀀스로 구성됩니다. rhs 의 입력 특성 차원은 lhs 입력 특성 차원을 feature_group_count 로 나눈 값과 같아야합니다 (따라서 이미 입력 특성 그룹의 크기가 있음). i 번째 그룹은 feature_group_count 많은 개별 컨볼 루션을 계산하는 데 함께 사용됩니다. 이러한 컨볼 루션의 결과는 출력 특성 차원에서 함께 연결됩니다.

깊이 별 컨볼 루션의 경우 feature_group_count 인수는 입력 특성 차원으로 설정되고 필터는 [filter_height, filter_width, in_channels, channel_multiplier] 에서 [filter_height, filter_width, 1, in_channels * channel_multiplier] 됩니다. 자세한 내용은 tf.nn.depthwise_conv2d 참조하십시오.

batch_group_count (기본값 1) 인수는 역 전파 중에 그룹화 된 필터에 사용할 수 있습니다. batch_group_countlhs (입력) 배치 차원 크기의 제수 여야합니다. batch_group_count 가 1보다 크면 출력 배치 차원이 input batch / batch_group_count 크기 여야 함을 의미합니다. batch_group_count 는 출력 피쳐 크기의 제수 여야합니다.

출력 모양은 다음과 같은 순서로 치수를 갖습니다.

  • batch :이 차원의 크기에 batch_group_count 를 곱한 값은 batch 차원의 크기 (lhs)와 같아야합니다.
  • z : 커널의 output-z 와 동일한 크기 ( rhs ).
  • spatial_dims : 컨볼 루션 창의 각 유효한 배치에 대한 하나의 값입니다.

컨볼 루션 창의 유효한 배치는 패딩 후 기본 영역의 보폭과 크기에 의해 결정됩니다.

컨볼 루션의 기능을 설명하려면 2d 컨볼 루션을 고려하고 출력에서 ​​고정 된 batch , z , y , x 좌표를 선택하십시오. 그런 다음 (y,x) 는 기본 영역 내 창 모서리의 위치입니다 (예 : 공간 차원을 해석하는 방법에 따라 왼쪽 위 모서리). 이제 각 2d 점이 1d 벡터에 연결되어있는 기본 영역에서 가져온 2d 창이 있으므로 3d 상자가 생깁니다. 컨벌루션 커널에서 출력 좌표 z 고정했기 때문에 3d 상자도 있습니다. 두 상자의 크기는 같으므로 두 상자 사이의 요소 별 곱의 합계를 구할 수 있습니다 (내적과 유사). 이것이 출력 값입니다.

output-z 가 예를 들어 5 인 경우 창의 각 위치는 출력에서 ​​출력의 z 차원으로 5 개의 값을 생성합니다. 이 값은 컨벌루션 커널의 어떤 부분이 사용되는지에 따라 다릅니다. 각 output-z 좌표에 사용되는 별도의 3d 값 상자가 있습니다. 따라서 각각에 대해 다른 필터를 사용하는 5 개의 개별 컨볼 루션으로 생각할 수 있습니다.

다음은 패딩 및 스트라이드가있는 2D 컨볼 루션의 의사 코드입니다.

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

ConvertElementType

XlaBuilder::ConvertElementType 도 참조하십시오.

C ++의 요소 별 static_cast 와 유사하게 데이터 셰이프에서 대상 셰이프로 요소 별 변환 작업을 수행합니다. 차원은 일치해야하며 변환은 요소별로 이루어집니다. 예를 들어 s32 요소는 s32 에서 f32 로의 변환 루틴을 통해 f32 요소가됩니다.

ConvertElementType(operand, new_element_type)

인수 유형 의미론
operand XlaOp dims D가있는 T 유형의 배열
new_element_type PrimitiveType 유형 U

피연산자와 대상 모양의 치수가 일치해야합니다. 소스 및 대상 요소 유형은 튜플이 아니어야합니다.

T=s32 에서 U=f32 로의 변환은 가장 가까운 짝수로 반올림과 같은 정규화 int에서 부동으로 변환 루틴을 수행합니다.

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

CrossReplicaSum

합계 계산으로 AllReduce 를 수행합니다.

CustomCall

XlaBuilder::CustomCall 도 참조하십시오.

계산 내에서 사용자 제공 함수를 호출합니다.

CustomCall(target_name, args..., shape)

인수 유형 의미론
target_name string 함수의 이름입니다. 이 심볼 이름을 대상으로하는 호출 명령이 방출됩니다.
args N XlaOp 의 시퀀스 함수에 전달되는 임의 유형의 N 개의 인수.
shape Shape 함수의 출력 모양

함수 시그니처는 인수의 arity 또는 유형에 관계없이 동일합니다.

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

예를 들어 CustomCall이 다음과 같이 사용되는 경우 :

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

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

다음은 myfunc 구현의 예입니다.

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

사용자가 제공 한 함수에는 부작용이 없어야하며 실행은 멱등 적이어야합니다.

XlaBuilder::Dot 도 참조하십시오.

Dot(lhs, rhs)

인수 유형 의미론
lhs XlaOp 유형 T의 배열
rhs XlaOp T 형 배열

이 연산의 정확한 의미는 피연산자의 순위에 따라 다릅니다.

입력 산출 의미론
벡터 [n] dot 벡터 [n] 스칼라 벡터 내적
행렬 [mxk] dot 벡터 [k] 벡터 [m] 행렬-벡터 곱셈
행렬 [mxk] dot 행렬 [kxn] 행렬 [mxn] 행렬-행렬 곱셈

이 연산은 lhs 의 두 번째 차원 (또는 순위가 1 인 경우 첫 번째 차원)과 rhs 의 첫 번째 차원에 대한 곱의 합계를 수행합니다. 이것이 "계약 된"차원입니다. lhsrhs 의 축소 치수는 동일한 크기 여야합니다. 실제로 벡터, 벡터 / 행렬 곱셈 또는 행렬 / 행렬 곱셈 간의 내적을 수행하는 데 사용할 수 있습니다.

DotGeneral

XlaBuilder::DotGeneral 도 참조하십시오.

DotGeneral(lhs, rhs, dimension_numbers)

인수 유형 의미론
lhs XlaOp 유형 T의 배열
rhs XlaOp 유형 T의 배열
dimension_numbers DotDimensionNumbers 계약 및 배치 차원 번호

Dot으로하지만 'lhs'및 'rhs'모두에 대해 계약 및 배치 차원 번호를 지정할 수 있습니다.

DotDimensionNumbers 필드 유형 의미론
'lhs_contracting_dimensions' 반복 된 int64 'lhs'계약 치수 번호
'rhs_contracting_dimensions' 반복 된 int64 'rhs'수축 차원 번호
'lhs_batch_dimensions' 반복 된 int64 'lhs'배치 차원 번호
'rhs_batch_dimensions' 반복 된 int64 'rhs'배치 차원 번호

DotGeneral은 'dimension_numbers'에 지정된 축소 차원에 대해 제품 합계를 수행합니다.

'lhs'및 'rhs'의 관련 축소 치수 번호는 동일 할 필요는 없지만 동일한 치수 크기를 가져야합니다.

축소 차원 번호의 예 :

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

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

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

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

'lhs'및 'rhs'의 연결된 배치 차원 번호는 차원 크기가 동일해야합니다.

배치 차원 번호의 예 (배치 크기 2, 2x2 행렬) :

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

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

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

DotGeneral(lhs, rhs, dnums) -> { { {1.0, 2.0},
{3.0, 4.0} },
{ {5.0, 6.0},
{7.0, 8.0} } }
입력 산출 의미론
[b0, m, k] dot [b0, k, n] [b0, m, n] 배치 매트 물
[b0, b1, m, k] dot [b0, b1, k, n] [b0, b1, m, n] 배치 매트 물

결과 차원 번호는 배치 차원에서 시작하여 'lhs'비 계약 / 비 배치 차원, 마지막으로 'rhs'비 계약 / 비 배치 차원으로 시작됩니다.

DynamicSlice

XlaBuilder::DynamicSlice 도 참조하십시오.

DynamicSlice는 dynamic start_indices 의 입력 배열에서 하위 배열을 추출합니다. 각 차원의 슬라이스 크기는 size_indices 로 전달되며 각 차원에서 독점 슬라이스 간격의 끝점을 지정합니다 : [시작, 시작 + 크기). start_indices 의 모양은 rank == 1이어야하며 차원 크기는 operand 의 순위와 동일해야합니다.

DynamicSlice(operand, start_indices, size_indices)

인수 유형 의미론
operand XlaOp T 형의 N 차원 배열
start_indices N XlaOp 시퀀스 각 차원에 대한 슬라이스의 시작 인덱스를 포함하는 N 개의 정수 스칼라 목록입니다. 값은 0보다 크거나 같아야합니다.
size_indices ArraySlice<int64> 각 차원의 슬라이스 크기를 포함하는 N 개의 정수 목록입니다. 모듈로 차원 크기를 래핑하지 않도록 각 값은 0보다 엄격하게 커야하며 시작 + 크기는 차원 크기보다 작거나 같아야합니다.

유효 슬라이스 인덱스는 슬라이스를 수행하기 전에 [1, N) 각 인덱스 i 에 대해 다음 변환을 적용하여 계산됩니다.

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

이렇게하면 추출 된 슬라이스가 항상 피연산자 배열에 대해 인바운드됩니다. 변형이 적용되기 전에 조각이 인바운드이면 변형이 적용되지 않습니다.

1 차원 예 :

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

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

2 차원 예 :

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

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

DynamicUpdateSlice

XlaBuilder::DynamicUpdateSlice 도 참조하십시오.

DynamicUpdateSlice는 start_indices 에서 슬라이스 update 덮어 쓴 입력 배열 operand 의 값인 결과를 생성합니다. update 의 모양은 update 되는 결과의 하위 배열 모양을 결정합니다. start_indices 의 모양은 rank == 1이어야하며 차원 크기는 operand 의 순위와 동일해야합니다.

DynamicUpdateSlice(operand, update, start_indices)

인수 유형 의미론
operand XlaOp T 형의 N 차원 배열
update XlaOp 슬라이스 업데이트를 포함하는 T 유형의 N 차원 배열입니다. 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.

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.

Some reduction functions like addition are not strictly 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. It is possible to conceive of some completely non-associative reductions, however, and these will produce incorrect or unpredictable results in XLA.

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.

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