ऑपरेशन शब्दार्थ

निम्नलिखित XlaBuilder इंटरफ़ेस में परिभाषित संचालन के शब्दों का वर्णन करता है। आमतौर पर, ये ऑपरेशन xla_data.proto में RPC इंटरफ़ेस में परिभाषित ऑपरेशन के लिए वन-टू-वन मैप करते हैं।

नामकरण पर एक नोट: सामान्यीकृत डेटा प्रकार XLA कुछ समान प्रकार (जैसे 32-बिट फ्लोट) के तत्वों को धारण करने वाला एक एन-आयामी सरणी है। दस्तावेज़ीकरण के दौरान, सरणी का उपयोग मनमानी-आयामी सरणी को इंगित करने के लिए किया जाता है। सुविधा के लिए, विशेष मामलों में अधिक विशिष्ट और परिचित नाम होते हैं; उदाहरण के लिए एक सदिश एक 1-आयामी सरणी है और एक मैट्रिक्स एक 2-आयामी सरणी है।

आख़िरकार

XlaBuilder::AfterAll भी देखें।

आफ्टरऑल कई प्रकार के टोकन लेता है और एक टोकन बनाता है। टोकन आदिम प्रकार हैं जिन्हें ऑर्डरिंग लागू करने के लिए साइड-इफ़ेक्टिंग ऑपरेशंस के बीच पिरोया जा सकता है। AfterAll उपयोग सेट ऑपरेशंस के बाद ऑपरेशन ऑर्डर करने के लिए टोकन में शामिल होने के रूप में किया जा सकता है।

AfterAll(operands)

सभी इकट्ठा

XlaBuilder::AllGather भी देखें।

प्रतिकृतियों में संयोजन करता है।

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

• replica_groups रेप्लिका ग्रुप्स की एक सूची है जिसके बीच संयोजन किया जाता है (वर्तमान रेप्लिका के लिए रेप्लिका आईडी को ReplicaId उपयोग करके प्राप्त किया जा सकता है)। प्रत्येक समूह में प्रतिकृतियों का क्रम उस क्रम को निर्धारित करता है जिसमें परिणाम में उनके इनपुट स्थित होते हैं। replica_groups या तो खाली होना चाहिए (जिस स्थिति में सभी प्रतिकृतियां एक ही समूह से संबंधित हैं, 0 से N - 1 तक क्रमबद्ध हैं), या प्रतिकृतियों की संख्या के समान तत्वों की संख्या शामिल है। उदाहरण के लिए, replica_groups = {0, 2}, {1, 3} प्रतिकृति 0 और 2 और 1 और 3 के बीच संयोजन करता है।
• shard_count प्रत्येक प्रतिकृति समूह का आकार है। हमें इसकी आवश्यकता उन मामलों में होती है जहां replica_groups खाली होते हैं।
• channel_id का उपयोग क्रॉस-मॉड्यूल संचार के लिए किया जाता है: केवल एक ही channel_id के साथ all-gather संचालन एक दूसरे से संवाद कर सकते हैं।

आउटपुट आकार इनपुट आकार है जिसमें all_gather_dim shard_count गुना बड़ा बनाया गया है। उदाहरण के लिए, यदि दो प्रतिकृतियां हैं और दो प्रतिकृतियों पर ऑपरेंड का मूल्य क्रमशः [1.0, 2.5] और [3.0, 5.25] है, तो इस ऑप से आउटपुट मूल्य जहां all_gather_dim 0 है [1.0, 2.5, 3.0, 5.25] दोनों प्रतिकृतियों पर।

AllReduce

XlaBuilder::AllReduce भी देखें।

प्रतिकृतियों में एक कस्टम संगणना करता है।

AllReduce(operand, computation, replica_group_ids, channel_id)

• जब operand सरणियों का एक टपल होता है, तो टपल के प्रत्येक तत्व पर ऑल-रिड्यूस किया जाता है।
• replica_groups रेप्लिका ग्रुप्स की एक सूची है जिसके बीच रिडक्शन किया जाता है (वर्तमान रेप्लिका के लिए रेप्लिका आईडी को ReplicaId उपयोग करके प्राप्त किया जा सकता है)। replica_groups या तो खाली होना चाहिए (जिस स्थिति में सभी रेप्लिका एक ही समूह से संबंधित हैं), या रेप्लिका की संख्या के समान तत्वों की संख्या होनी चाहिए। उदाहरण के लिए, replica_groups = {0, 2}, {1, 3} प्रतिकृति 0 और 2 और 1 और 3 के बीच कमी करता है।
• channel_id का उपयोग क्रॉस-मॉड्यूल संचार के लिए किया जाता है: केवल एक ही channel_id के साथ all-reduce संचालन एक दूसरे से संवाद कर सकते हैं।

आउटपुट आकार इनपुट आकार के समान है। उदाहरण के लिए, यदि दो प्रतिकृतियां हैं और दो प्रतिकृतियों पर ऑपरेंड का मूल्य क्रमशः [1.0, 2.5] और [3.0, 5.25] है, तो इस ऑप से आउटपुट मूल्य और दोनों पर योग गणना [4.0, 7.75] होगी। प्रतिकृतियां। यदि इनपुट टपल है, तो आउटपुट भी टपल है।

AllReduce के परिणाम की गणना करने के लिए प्रत्येक प्रतिकृति से एक इनपुट की आवश्यकता होती है, इसलिए यदि एक प्रतिकृति किसी अन्य की तुलना में AllReduce नोड को अधिक बार निष्पादित करती है, तो पूर्व प्रतिकृति हमेशा के लिए प्रतीक्षा करेगी। चूंकि प्रतिकृतियां सभी एक ही कार्यक्रम चला रही हैं, ऐसा होने के लिए बहुत सारे तरीके नहीं हैं, लेकिन यह संभव है जब थोड़ी देर के लूप की स्थिति इनफीड के डेटा पर निर्भर करती है और जो डेटा संक्रमित होता है, वह लूप को अधिक बार पुनरावृत्त करने का कारण बनता है। एक से दूसरी प्रतिकृति पर।

सभी के लिए

XlaBuilder::AllToAll भी देखें।

AllToAll एक सामूहिक ऑपरेशन है जो सभी कोर से सभी कोर में डेटा भेजता है। इसके दो चरण हैं:

1. बिखराव चरण। प्रत्येक कोर पर, ऑपरेंड को split_dimensions के साथ split_count नंबर ब्लॉक में विभाजित किया जाता है, और ब्लॉक सभी कोर में बिखरे हुए होते हैं, उदाहरण के लिए, ith ब्लॉक ith कोर को भेजा जाता है।
2. इकट्ठा चरण। प्रत्येक कोर concat_dimension के साथ प्राप्त ब्लॉक को जोड़ता है।

भाग लेने वाले कोर को इसके द्वारा कॉन्फ़िगर किया जा सकता है:

• replica_groups : प्रत्येक प्रतिकृति समूह में गणना में भाग लेने वाले प्रतिकृति आईडी की एक सूची होती है (वर्तमान प्रतिकृति के लिए प्रतिकृति आईडी को ReplicaId का उपयोग करके पुनर्प्राप्त किया जा सकता है)। AllToAll निर्दिष्ट क्रम में उपसमूहों के भीतर लागू किया जाएगा। उदाहरण के लिए, replica_groups = { {1,2,3}, {4,5,0} } अर्थ है कि AllToAll को प्रतिकृतियों {1, 2, 3} के भीतर और एकत्रित चरण में लागू किया जाएगा, और प्राप्त ब्लॉक 1, 2, 3 के समान क्रम में श्रेणीबद्ध किया जाना चाहिए। फिर, 4, 5, 0 प्रतिकृतियों के भीतर एक और AllToAll लागू किया जाएगा, और संयोजन क्रम भी 4, 5, 0 है। यदि replica_groups खाली है, तो सभी प्रतिकृतियां एक से संबंधित हैं समूह, उनकी उपस्थिति के संयोजन क्रम में।

पूर्वापेक्षाएँ:

• split_dimension पर ऑपरेंड का आयाम आकार split_count से विभाज्य है।
• ऑपरेंड का आकार टपल नहीं है।

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

नीचे Alltoall का एक उदाहरण दिखाया गया है।

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

इस उदाहरण में, Alltoall में 4 कोर भाग ले रहे हैं। प्रत्येक कोर पर, ऑपरेंड आयाम 1 के साथ 4 भागों में विभाजित होता है, इसलिए प्रत्येक भाग का आकार f32 [4,4] होता है। 4 भाग सभी कोरों में बिखरे हुए हैं। फिर प्रत्येक कोर क्रम या कोर 0-4 में आयाम 0 के साथ प्राप्त भागों को जोड़ता है। तो प्रत्येक कोर पर आउटपुट का आकार f32 [16,4] है।

बैचनॉर्मग्रैड

एल्गोरिदम के विस्तृत विवरण के लिए XlaBuilder::BatchNormGrad और मूल बैच सामान्यीकरण पेपर भी देखें।

बैच मानक के ग्रेडिएंट्स की गणना करता है।

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

फीचर डायमेंशन में प्रत्येक फीचर के लिए ( feature_index operand में फीचर डायमेंशन के लिए इंडेक्स है), ऑपरेशन अन्य सभी आयामों में operand , offset और scale के संबंध में ग्रेडिएंट की गणना करता है। operand में फीचर आयाम के लिए feature_index एक मान्य इंडेक्स होना चाहिए।

तीन ग्रेडिएंट्स को निम्नलिखित सूत्रों द्वारा परिभाषित किया गया है ( operand के रूप में एक 4-आयामी सरणी मानते हुए और फीचर डायमेंशन इंडेक्स l , बैच आकार m और स्थानिक आकार w और h के साथ):

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

इनपुट mean और variance बैच और स्थानिक आयामों में क्षणों के मूल्य का प्रतिनिधित्व करते हैं।

आउटपुट प्रकार तीन हैंडल का एक टपल है:

बैच नॉर्म अनुमान

एल्गोरिदम के विस्तृत विवरण के लिए XlaBuilder::BatchNormInference और मूल बैच सामान्यीकरण पेपर भी देखें।

बैच और स्थानिक आयामों में एक सरणी को सामान्यीकृत करता है।

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

फीचर डायमेंशन में प्रत्येक फीचर के लिए ( feature_index operand में फीचर डायमेंशन के लिए इंडेक्स है), ऑपरेशन अन्य सभी आयामों में माध्य और विचरण की गणना करता है और operand में प्रत्येक तत्व को सामान्य करने के लिए माध्य और विचरण का उपयोग करता है। operand में फीचर आयाम के लिए feature_index एक मान्य इंडेक्स होना चाहिए।

BatchNormInference प्रत्येक बैच के mean और variance गणना किए बिना BatchNormTraining कॉल करने के बराबर है। यह अनुमानित मूल्यों के बजाय इनपुट mean और variance का उपयोग करता है। इस ऑप का उद्देश्य अनुमान में विलंबता को कम करना है, इसलिए इसका नाम BatchNormInference है।

आउटपुट एक एन-आयामी, सामान्यीकृत सरणी है जिसमें इनपुट operand के समान आकार होता है।

बैच नॉर्म ट्रेनिंग

एल्गोरिदम के विस्तृत विवरण के लिए XlaBuilder::BatchNormTraining और the original batch normalization paper भी देखें।

बैच और स्थानिक आयामों में एक सरणी को सामान्यीकृत करता है।

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

फीचर डायमेंशन में प्रत्येक फीचर के लिए ( feature_index operand में फीचर डायमेंशन के लिए इंडेक्स है), ऑपरेशन अन्य सभी आयामों में माध्य और विचरण की गणना करता है और operand में प्रत्येक तत्व को सामान्य करने के लिए माध्य और विचरण का उपयोग करता है। operand में फीचर आयाम के लिए feature_index एक मान्य इंडेक्स होना चाहिए।

operand \(x\) में प्रत्येक बैच के लिए एल्गोरिथम इस प्रकार होता है जिसमें स्थानिक आयामों के आकार के रूप में w और h के साथ m तत्व होते हैं (यह मानते हुए कि 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\)

डिवाइड-बाय-जीरो एरर से बचने के लिए एप्सिलॉन वैल्यू, आमतौर पर एक छोटी संख्या, जोड़ी जाती है।

आउटपुट प्रकार तीन XlaOp s का टपल है:

batch_mean और batch_var उपरोक्त सूत्रों का उपयोग करके बैच और स्थानिक आयामों में गणना किए गए क्षण हैं।

बिटकास्ट कन्वर्ट टाइप

XlaBuilder::BitcastConvertType भी देखें।

TensorFlow में tf.bitcast के समान, डेटा आकार से लक्ष्य आकार तक तत्व-वार बिटकास्ट ऑपरेशन करता है। इनपुट और आउटपुट आकार मेल खाना चाहिए: उदाहरण के लिए s32 तत्व बिटकास्ट रूटीन के माध्यम से f32 तत्व बन जाते हैं, और एक s32 तत्व चार s8 तत्व बन जाते हैं। बिटकास्ट को निम्न-स्तरीय कास्ट के रूप में कार्यान्वित किया जाता है, इसलिए अलग-अलग फ़्लोटिंग-पॉइंट प्रस्तुतियों वाली मशीनें अलग-अलग परिणाम देंगी।

BitcastConvertType(operand, new_element_type)

ऑपरेंड के आयाम और लक्ष्य आकार का मिलान होना चाहिए, अंतिम आयाम के अलावा जो रूपांतरण से पहले और बाद में आदिम आकार के अनुपात से बदल जाएगा।

स्रोत और गंतव्य तत्व प्रकार टुपल्स नहीं होने चाहिए।

बिटकास्ट-विभिन्न चौड़ाई के आदिम प्रकार में परिवर्तित करना

BitcastConvert HLO निर्देश उस मामले का समर्थन करता है जहां आउटपुट तत्व प्रकार T' का आकार इनपुट तत्व T के आकार के बराबर नहीं है। जैसा कि संपूर्ण ऑपरेशन वैचारिक रूप से एक बिटकास्ट है और अंतर्निहित बाइट्स को नहीं बदलता है, आउटपुट तत्व का आकार बदलना पड़ता है। B = sizeof(T), B' = sizeof(T') के लिए, दो संभावित मामले हैं।

सबसे पहले, जब B > B' , आउटपुट आकार को आकार B/B' का एक नया मामूली-सबसे आयाम मिलता है। उदाहरण के लिए:

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

प्रभावी अदिश राशियों के लिए नियम समान रहता है:

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

वैकल्पिक रूप से, B' > B निर्देश के लिए आवश्यक है कि इनपुट आकार का अंतिम तार्किक आयाम B'/B के बराबर हो, और रूपांतरण के दौरान यह आयाम हटा दिया जाता है:

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

ध्यान दें कि विभिन्न बिटविड्थ के बीच रूपांतरण तत्ववार नहीं होते हैं।

प्रसारण

XlaBuilder::Broadcast भी देखें।

सरणी में डेटा को डुप्लिकेट करके सरणी में आयाम जोड़ता है।

Broadcast(operand, broadcast_sizes)

नए आयाम बाईं ओर डाले गए हैं, यानी यदि broadcast_sizes में मान {a0, ..., aN} हैं और ऑपरेंड आकार में आयाम {b0, ..., bM} हैं तो आउटपुट के आकार में आयाम {a0, ..., aN, b0, ..., bM} ।

ऑपरेंड की प्रतियों में नए आयाम सूचकांक, यानी

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

उदाहरण के लिए, यदि operand 2.0f मान के साथ एक स्केलर f32 है, और broadcast_sizes {2, 3} है, तो परिणाम आकार f32[2, 3] के साथ एक सरणी होगी और परिणाम में सभी मान 2.0f होंगे।

ब्रॉडकास्ट इनडिम

XlaBuilder::BroadcastInDim भी देखें।

सरणी में डेटा को डुप्लिकेट करके सरणी के आकार और रैंक का विस्तार करता है।

BroadcastInDim(operand, out_dim_size, broadcast_dimensions)

प्रसारण के समान, लेकिन आयामों को कहीं भी जोड़ने और आकार 1 के साथ मौजूदा आयामों का विस्तार करने की अनुमति देता है।

operand out_dim_size द्वारा वर्णित आकार में प्रसारित किया जाता है। broadcast_dimensions operand के आयामों को लक्ष्य आकार के आयामों में मैप करता है, यानी ऑपरेंड के i'वें आयाम को ब्रॉडकास्ट_डाइमेंशन [i]' आउटपुट आकार के आयाम में मैप किया जाता है। operand के आयामों का आकार 1 होना चाहिए या उसी आकार का होना चाहिए, जिस आकार के आउटपुट आकार में वे मैप किए गए हैं। शेष आयाम आकार 1 के आयामों से भरे हुए हैं। डीजेनरेट-आयाम प्रसारण फिर आउटपुट आकार तक पहुंचने के लिए इन पतित आयामों के साथ प्रसारण करता है। शब्दार्थ का प्रसारण पृष्ठ पर विस्तार से वर्णन किया गया है।

पुकारना

XlaBuilder::Call भी देखें।

दिए गए तर्कों के साथ एक संगणना को आमंत्रित करता है।

Call(computation, args...)

Arity और प्रकार के args computation के पैरामीटर से मेल खाना चाहिए। इसे कोई args नहीं होने दिया जाता है।

चोल्स्की

XlaBuilder::Cholesky भी देखें।

सममित (हर्मिटियन) सकारात्मक निश्चित आव्यूहों के एक बैच के चोल्स्की अपघटन की गणना करता है।

Cholesky(a, lower)

यदि lower true है, तो निम्न-त्रिकोणीय मैट्रिसेस l की गणना करता है जैसे कि \( a = l . l^T \)। यदि lower false है, तो ऊपरी-त्रिकोणीय आव्यूह u गणना करता है जैसे कि \( a = u^T . u \)।

इनपुट डेटा केवल a के निचले/ऊपरी त्रिकोण से पढ़ा जाता है, जो lower के मान पर निर्भर करता है। दूसरे त्रिभुज के मानों की उपेक्षा की जाती है। आउटपुट डेटा उसी त्रिकोण में लौटाया जाता है; अन्य त्रिकोण में मान कार्यान्वयन-परिभाषित हैं और कुछ भी हो सकते हैं।

यदि a की रैंक 2 से अधिक है, a मैट्रिसेस के एक बैच के रूप में माना जाता है, जहां छोटे 2 आयामों को छोड़कर सभी बैच आयाम हैं।

यदि a सममित (हर्मिटियन) सकारात्मक निश्चित नहीं है, तो परिणाम कार्यान्वयन-परिभाषित है।

क्लैंप

XlaBuilder::Clamp भी देखें।

किसी ऑपरेंड को न्यूनतम और अधिकतम मान के बीच की सीमा के भीतर क्लैम्प करता है।

Clamp(min, operand, max)

एक ऑपरेंड और न्यूनतम और अधिकतम मान दिए जाने पर, ऑपरेंड लौटाता है यदि यह न्यूनतम और अधिकतम के बीच की सीमा में है, अन्यथा न्यूनतम मान लौटाता है यदि ऑपरेंड इस सीमा से नीचे है या अधिकतम मान यदि ऑपरेंड इस सीमा से ऊपर है। यही है, clamp(a, x, b) = min(max(a, x), b)

तीनों सरणियों का आकार एक जैसा होना चाहिए। वैकल्पिक रूप से, प्रसारण के एक प्रतिबंधित रूप के रूप में, min और/या max टाइप T का एक स्केलर हो सकता है।

अदिश min और max के साथ उदाहरण:

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

गिर जाना

XlaBuilder::Collapse और tf.reshape ऑपरेशन भी देखें।

किसी सरणी के आयामों को एक आयाम में संक्षिप्त करता है.

Collapse(operand, dimensions)

संक्षिप्त करें ऑपरेंड के आयामों के दिए गए सबसेट को एक आयाम से बदल देता है। इनपुट तर्क प्रकार टी की एक मनमाना सरणी और आयाम सूचकांकों का एक संकलन-समय-स्थिर वेक्टर है। आयाम सूचकांक एक इन-ऑर्डर (निम्न से उच्च आयाम संख्या), T के आयामों का लगातार सबसेट होना चाहिए। इस प्रकार, {0, 1, 2}, {0, 1}, या {1, 2} सभी मान्य आयाम सेट हैं, लेकिन {1, 0} या {0, 2} नहीं हैं। वे मूल आयाम आकार के उत्पाद के बराबर नए आयाम आकार के साथ, आयाम अनुक्रम में उसी स्थिति में एक नए आयाम द्वारा प्रतिस्थापित किए जाते हैं, जैसा कि वे प्रतिस्थापित करते हैं। लूप नेस्ट में dimensions में सबसे कम डाइमेंशन नंबर सबसे धीमा डायमेंशन (सबसे बड़ा) होता है जो इन डायमेंशन को ढहा देता है, और सबसे तेज़ डाइमेंशन नंबर सबसे तेज़ (सबसे माइनर) होता है। tf.reshape ऑपरेटर देखें यदि अधिक सामान्य पतन आदेश की आवश्यकता है।

उदाहरण के लिए, v को 24 तत्वों की एक सरणी होने दें:

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

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

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

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

कलेक्टिवपरम्यूट

XlaBuilder::CollectivePermute भी देखें।

कलेक्टिवप्रम्यूट एक सामूहिक ऑपरेशन है जो डेटा क्रॉस प्रतिकृतियां भेजता और प्राप्त करता है।

CollectivePermute(operand, source_target_pairs)

ध्यान दें कि source_target_pair पर निम्नलिखित प्रतिबंध हैं:

• किसी भी दो जोड़ियों में समान लक्ष्य प्रतिकृति आईडी नहीं होनी चाहिए, और उनके पास समान स्रोत प्रतिकृति आईडी नहीं होनी चाहिए।
• यदि एक प्रतिकृति आईडी किसी भी जोड़ी में एक लक्ष्य नहीं है, तो उस प्रतिकृति पर आउटपुट एक टेंसर होता है जिसमें इनपुट के समान आकार के साथ 0 (s) होते हैं।

CONCATENATE

XlaBuilder::ConcatInDim भी देखें।

कॉन्टेनेट एकाधिक सरणी ऑपरेंड से एक सरणी बनाता है। सरणी प्रत्येक इनपुट सरणी ऑपरेंड के समान रैंक की होती है (जो एक दूसरे के समान रैंक की होनी चाहिए) और इसमें निर्दिष्ट क्रम में तर्क शामिल होते हैं।

Concatenate(operands..., dimension)

dimension के अपवाद के साथ सभी आयाम समान होने चाहिए। ऐसा इसलिए है क्योंकि XLA "रैग्ड" सरणियों का समर्थन नहीं करता है। यह भी ध्यान रखें कि रैंक-0 मानों को श्रेणीबद्ध नहीं किया जा सकता है (क्योंकि उस आयाम को नाम देना असंभव है जिसके साथ संयोजन होता है)।

1-आयामी उदाहरण:

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

द्वि-आयामी उदाहरण:

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 true है तो true_computation निष्पादित करता है, यदि pred false है, तो false_computation निष्पादित करता है, और परिणाम देता है।

true_computation \(T_0\) प्रकार के एक तर्क में लेना चाहिए और इसे true_operand के साथ लागू किया जाएगा जो एक ही प्रकार का होना चाहिए। false_computation \(T_1\) प्रकार के एक तर्क में लेना चाहिए और इसे false_operand के साथ लागू किया जाएगा जो एक ही प्रकार का होना चाहिए। true_computation और false_computation के दिए गए मान का प्रकार समान होना चाहिए।

ध्यान दें कि pred के मान के आधार पर केवल एक true_computation और false_computation निष्पादित किया जाएगा।

Conditional(branch_index, branch_computations, branch_operands)

branch_computations[branch_index] निष्पादित करता है, और परिणाम देता है। यदि branch_index एक S32 है जो <0 या >= N है, तो branch_computations[N-1] डिफ़ॉल्ट शाखा के रूप में निष्पादित किया जाता है।

प्रत्येक branch_computations[b] T_b प्रकार के एक तर्क में लेना चाहिए और branch_operands[b] के साथ बुलाया जाएगा जो एक ही प्रकार का होना चाहिए। प्रत्येक branch_computations[b] के लौटाए गए मूल्य का प्रकार समान होना चाहिए।

ध्यान दें कि branch_index के मान के आधार पर केवल एक branch_computations निष्पादित किया जाएगा।

रूपा (कनवल्शन)

XlaBuilder::Conv भी देखें।

ConvWithGeneralPadding के रूप में, लेकिन पैडिंग को SAME या VALID के रूप में शॉर्ट-हैंड तरीके से निर्दिष्ट किया गया है। समान पैडिंग इनपुट ( lhs ) को शून्य से पैड करती है ताकि स्ट्राइडिंग को ध्यान में न रखते हुए आउटपुट का आकार इनपुट के समान हो। वैलिड पैडिंग का मतलब नो पैडिंग है।

कनविथ जनरल पैडिंग (कनवल्शन)

XlaBuilder::ConvWithGeneralPadding भी देखें।

तंत्रिका नेटवर्क में उपयोग किए जाने वाले प्रकार के कनवल्शन की गणना करता है। यहां, एक कनवल्शन को एक एन-डायमेंशनल विंडो के रूप में माना जा सकता है जो एक एन-डायमेंशनल बेस एरिया में चलती है और विंडो की प्रत्येक संभावित स्थिति के लिए एक गणना की जाती है।

चलो n स्थानिक आयामों की संख्या हो। lhs तर्क एक रैंक एन + 2 सरणी है जो आधार क्षेत्र का वर्णन करता है। इसे इनपुट कहा जाता है, बेशक rhs भी एक इनपुट है। एक तंत्रिका नेटवर्क में, ये इनपुट सक्रियण हैं। n+2 आयाम इस क्रम में हैं:

• batch : इस आयाम में प्रत्येक निर्देशांक एक स्वतंत्र इनपुट का प्रतिनिधित्व करता है जिसके लिए कनवल्शन किया जाता है।
• z/depth/features : आधार क्षेत्र में प्रत्येक (y,x) स्थिति में इससे जुड़ा एक सदिश होता है, जो इस आयाम में जाता है।
• spatial_dims : n स्थानिक आयामों का वर्णन करता है जो उस आधार क्षेत्र को परिभाषित करता है जिस पर विंडो चलती है।

rhs तर्क एक रैंक n+2 सरणी है जो दृढ़ फ़िल्टर/कर्नेल/विंडो का वर्णन करता है। इस क्रम में आयाम हैं:

• output-z : आउटपुट का z आयाम।
• input-z : इस आयाम समय का आकार feature_group_count lhs में z आयाम के आकार के बराबर होना चाहिए।
• spatial_dims : n स्थानिक आयामों का वर्णन करता है जो दूसरी विंडो को परिभाषित करता है जो आधार क्षेत्र में चलती है।

window_strides तर्क स्थानिक आयामों में कनवल्शनल विंडो के स्ट्राइड को निर्दिष्ट करता है। उदाहरण के लिए, यदि पहले स्थानिक आयाम में छलाँग 3 है, तो खिड़की को केवल निर्देशांक पर रखा जा सकता है जहाँ पहला स्थानिक सूचकांक 3 से विभाज्य है।

padding तर्क आधार क्षेत्र पर लागू होने वाली शून्य पैडिंग की मात्रा को निर्दिष्ट करता है। गद्दी की मात्रा ऋणात्मक हो सकती है -- ऋणात्मक गद्दी का निरपेक्ष मान कनवल्शन करने से पहले निर्दिष्ट आयाम से निकाले जाने वाले तत्वों की संख्या को इंगित करता है। padding[0] आयाम y के लिए पैडिंग निर्दिष्ट करता है और padding[1] आयाम x के लिए पैडिंग निर्दिष्ट करता है। प्रत्येक जोड़ी में पहले तत्व के रूप में कम गद्दी होती है और दूसरे तत्व के रूप में उच्च गद्दी होती है। कम पैडिंग को निचले सूचकांकों की दिशा में लगाया जाता है जबकि उच्च पैडिंग को उच्च सूचकांकों की दिशा में लगाया जाता है। उदाहरण के लिए, यदि padding[1] (2,3) है, तो दूसरे स्थानिक आयाम में बाईं ओर 2 शून्य और दाईं ओर 3 शून्य द्वारा पैडिंग होगी। पैडिंग का उपयोग कनवल्शन करने से पहले उन्हीं शून्य मानों को इनपुट ( lhs ) में डालने के बराबर है।

lhs_dilation और rhs_dilation तर्क प्रत्येक स्थानिक आयाम में क्रमशः lhs और rhs पर लागू होने वाले फैलाव कारक को निर्दिष्ट करते हैं। यदि एक स्थानिक आयाम में फैलाव कारक d है, तो उस आयाम में प्रत्येक प्रविष्टि के बीच d-1 छेद अंतर्निहित रूप से रखे जाते हैं, जिससे सरणी का आकार बढ़ जाता है। छेद नो-ऑप वैल्यू से भरे हुए हैं, जो कनवल्शन के लिए शून्य का मतलब है।

Rhs के फैलाव को एट्रस कनवल्शन भी कहा जाता है। अधिक विवरण के लिए, 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-th समूहों का उपयोग एक साथ कई अलग-अलग दृढ़ feature_group_count गणना करने के लिए किया जाता है। इन संकल्पों के परिणाम आउटपुट फीचर आयाम में एक साथ जुड़े हुए हैं।

गहराई से कनवल्शन के लिए feature_group_count तर्क इनपुट सुविधा आयाम पर सेट किया जाएगा, और फ़िल्टर [filter_height, filter_width, in_channels, channel_multiplier] से [filter_height, filter_width, 1, in_channels * channel_multiplier] फिर से आकार दिया जाएगा। अधिक विवरण के लिए, tf.nn.depthwise_conv2d देखें।

batch_group_count (डिफ़ॉल्ट मान 1) तर्क का उपयोग बैकप्रोपैजेशन के दौरान समूहीकृत फ़िल्टर के लिए किया जा सकता है। batch_group_count lhs (इनपुट) बैच आयाम के आकार का विभाजक होना चाहिए। यदि batch_group_count 1 से अधिक है, तो इसका मतलब है कि आउटपुट बैच आयाम आकार input batch / batch_group_count का होना चाहिए। batch_group_count आउटपुट फीचर साइज का विभाजक होना चाहिए।

इस क्रम में आउटपुट आकार में ये आयाम हैं:

• batch : इस आयाम गुणा batch_group_count का आकार lhs में batch आयाम के आकार के बराबर होना चाहिए।
• z : कर्नेल पर output-z के समान आकार ( rhs )।
• spatial_dims : कनवल्शनल विंडो के प्रत्येक मान्य प्लेसमेंट के लिए एक मान।

ऊपर दिया गया चित्र दिखाता है कि batch_group_count फ़ील्ड कैसे काम करता है। प्रभावी रूप से, हम प्रत्येक lhs बैच को batch_group_count समूहों में विभाजित करते हैं, और आउटपुट सुविधाओं के लिए भी ऐसा ही करते हैं। फिर, इनमें से प्रत्येक समूह के लिए हम जोड़ीदार कनवल्शन करते हैं और आउटपुट फीचर डायमेंशन के साथ आउटपुट को जोड़ते हैं। अन्य सभी आयामों (विशेषता और स्थानिक) के परिचालन शब्दार्थ समान रहते हैं।

कनवल्शनल विंडो के वैध प्लेसमेंट को पैडिंग के बाद स्ट्राइड्स और बेस एरिया के आकार द्वारा निर्धारित किया जाता है।

कनवल्शन क्या करता है इसका वर्णन करने के लिए, एक 2d कनवल्शन पर विचार करें, और आउटपुट में कुछ निश्चित batch , z , y , x निर्देशांक चुनें। तब (y,x) आधार क्षेत्र के भीतर खिड़की के एक कोने की स्थिति है (उदाहरण के लिए ऊपरी बाएँ कोने, आप स्थानिक आयामों की व्याख्या कैसे करते हैं) पर निर्भर करता है। अब हमारे पास एक 2डी विंडो है, जो आधार क्षेत्र से ली गई है, जहां प्रत्येक 2डी बिंदु 1डी वेक्टर से जुड़ा है, इसलिए हमें एक 3डी बॉक्स मिलता है। कन्वेन्शनल कर्नेल से, चूँकि हमने आउटपुट कोऑर्डिनेट z तय किया है, हमारे पास एक 3डी बॉक्स भी है। दो बक्सों के आयाम समान हैं, इसलिए हम दो बक्सों के बीच तत्व-वार उत्पादों का योग ले सकते हैं (डॉट उत्पाद के समान)। वह आउटपुट वैल्यू है।

ध्यान दें कि यदि output-z उदाहरण के लिए, 5 है, तो विंडो की प्रत्येक स्थिति आउटपुट के z आयाम में आउटपुट में 5 मान उत्पन्न करती है। कनवल्शन कर्नेल के किस भाग में ये मान भिन्न होते हैं - प्रत्येक output-z समन्वय के लिए उपयोग किए जाने वाले मानों का एक अलग 3D बॉक्स होता है। तो आप इसे उनमें से प्रत्येक के लिए एक अलग फिल्टर के साथ 5 अलग-अलग कनवल्शन के रूप में सोच सकते हैं।

पैडिंग और स्ट्राइडिंग के साथ 2डी कनवल्शन के लिए छद्म कोड यहां दिया गया है:

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

कन्वर्ट एलिमेंट टाइप

XlaBuilder::ConvertElementType भी देखें।

सी ++ में तत्व-वार static_cast के समान, डेटा आकार से लक्ष्य आकार में तत्व-वार रूपांतरण ऑपरेशन करता है। आयामों का मिलान होना चाहिए, और रूपांतरण एक तत्व-वार है; उदाहरण के लिए s32 तत्व एक s32 -to- f32 रूपांतरण दिनचर्या के माध्यम से f32 तत्व बन जाते हैं।

ConvertElementType(operand, new_element_type)

ऑपरेंड के आयाम और लक्ष्य आकार का मिलान होना चाहिए। स्रोत और गंतव्य तत्व प्रकार टुपल्स नहीं होने चाहिए।

एक रूपांतरण जैसे T=s32 से U=f32 राउंड-टू-निकटतम-ईवन जैसे सामान्य इंट-टू-फ्लोट रूपांतरण रूटीन का प्रदर्शन करेगा।

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

क्रॉसरेप्लिकासम

योग संगणना के साथ AllReduce करता है।

कस्टम कॉल

XlaBuilder::CustomCall भी देखें।

गणना के भीतर उपयोगकर्ता द्वारा प्रदान किए गए फ़ंक्शन को कॉल करें।

CustomCall(target_name, args..., shape)

फ़ंक्शन हस्ताक्षर समान है, भले ही तर्क या तर्क के प्रकार के बावजूद:

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

उदाहरण के लिए, यदि CustomCall का उपयोग निम्नानुसार किया जाता है:

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

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

यहाँ myfunc के कार्यान्वयन का एक उदाहरण दिया गया है:

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

उपयोगकर्ता द्वारा प्रदान किए गए फ़ंक्शन के दुष्प्रभाव नहीं होने चाहिए और इसका निष्पादन निष्प्रभावी होना चाहिए।

डॉट

XlaBuilder::Dot भी देखें।

Dot(lhs, rhs)

इस ऑपरेशन का सटीक शब्दार्थ ऑपरेंड के रैंक पर निर्भर करता है:

ऑपरेशन lhs के दूसरे आयाम (या पहला अगर इसकी रैंक 1 है) और rhs के पहले आयाम पर उत्पादों का योग करता है। ये "अनुबंधित" आयाम हैं। lhs और rhs के अनुबंधित आयाम समान आकार के होने चाहिए। व्यवहार में, इसका उपयोग वैक्टर, वेक्टर/मैट्रिक्स गुणन या मैट्रिक्स/मैट्रिक्स गुणन के बीच डॉट उत्पादों को करने के लिए किया जा सकता है।

डॉट जनरल

XlaBuilder::DotGeneral भी देखें।

DotGeneral(lhs, rhs, dimension_numbers)

डॉट के रूप में, लेकिन अनुबंध और बैच आयाम संख्याओं को 'एलएचएस' और 'आरएचएस' दोनों के लिए निर्दिष्ट करने की अनुमति देता है।

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

यह इस प्रकार है कि परिणामी आयाम संख्या बैच आयाम से शुरू होती है, फिर 'एलएचएस' गैर-अनुबंध/गैर-बैच आयाम, और अंत में 'आरएचएस' गैर-अनुबंध/गैर-बैच आयाम।

डायनामिकस्लाइस

XlaBuilder::DynamicSlice भी देखें।

डायनेमिकस्लाइस डायनेमिक start_indices पर इनपुट सरणी से एक उप-सरणी निकालता है। प्रत्येक आयाम में स्लाइस का आकार size_indices में पारित किया जाता है, जो प्रत्येक आयाम में अनन्य स्लाइस अंतराल के अंत बिंदु को निर्दिष्ट करता है: [प्रारंभ, प्रारंभ + आकार)। start_indices का आकार रैंक == 1 होना चाहिए, आयाम आकार operand के रैंक के बराबर होना चाहिए।

DynamicSlice(operand, start_indices, size_indices)

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

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

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

1-dimensional example:

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

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

2-dimensional example:

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

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

DynamicUpdateSlice

See also XlaBuilder::DynamicUpdateSlice .

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

DynamicUpdateSlice(operand, update, start_indices)

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

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.

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

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

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

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

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

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 .

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)

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

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

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

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

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

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

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

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

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

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

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

   2. S in [ _ ] = 0 otherwise.

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

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

   2. O in [ _ ] = 0 otherwise.

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

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

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

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

Informal Description and Examples

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

GetDimensionSize

See also XlaBuilder::GetDimensionSize .

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

GetDimensionSize(operand, dimension)

SetDimensionSize

See also XlaBuilder::SetDimensionSize .

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

SetDimensionSize(operand, size, 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)

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

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

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

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

Iota

See also XlaBuilder::Iota .

Iota(shape, iota_dimension)

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

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

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

Iota(s32[4, 8], 1) returns

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

Map

See also XlaBuilder::Map .

Map(operands..., computation)

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

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

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

OptimizationBarrier

Blocks any optimization pass from moving computations across the barrier.

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

Pad

See also XlaBuilder::Pad .

Pad(operand, padding_value, padding_config)

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)

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)

Where:

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

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

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

Examples

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

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

but there are also many other possibilities, eg

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

The following is a rough pseudo-code example of how reduction could be implemented, using summation as the reduction computation with an initial value of 0.

result_shape <- remove all dims in dimensions from operand_shape

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

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

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

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

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

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

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

|  4   8  12 |
| 16  20  24 |

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

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

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

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

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

Variadic Reduce

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

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

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

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

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

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

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

ReducePrecision

See also XlaBuilder::ReducePrecision .

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

ReducePrecision(operand, mantissa_bits, exponent_bits)

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)

• When operand is a tuple of arrays, the reduce-scatter is performed on each element of the tuple.
• replica_groups is a list of replica groups between which the reduction is performed (replica id for the current replica can be retrieved using ReplicaId ). The order of replicas in each group determines the order in which the all-reduce result will be scattered. replica_groups must either be empty (in which case all replicas belong to a single group), or contain the same number of elements as the number of replicas. When there are more than one replica groups, they all must be of the same size. For example, replica_groups = {0, 2}, {1, 3} performs reduction between the replicas 0 and 2 , and 1 and 3 and then scatters the result.
• shard_count is the size of each replica group. We need this in cases where replica_groups are empty. If replica_groups is not empty, shard_count must be equal to the size of each replica group.
• channel_id is used for cross-module communication: only reduce-scatter operations with the same channel_id can communicate with each other.

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

ReduceWindow

See also XlaBuilder::ReduceWindow .

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

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

Where:

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

Below code and figure shows an example of using ReduceWindow . Input is a matrix of size [4x6] and both window_dimensions and window_stride_dimensions are [2x3].

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

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

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

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

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

ReplicaId

See also XlaBuilder::ReplicaId .

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

ReplicaId()

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

Reshape

See also XlaBuilder::Reshape and the Collapse operation.

Reshapes the dimensions of an array into a new configuration.

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

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)

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)

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)

RngBitGenerator

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

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

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

RngBitGenerator(algorithm, key, shape)

Available values for algorithm :

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

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

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

Scatter

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

See also XlaBuilder::Scatter .

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

Where:

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

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

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

The arguments of scatter should follow these constraints:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Select

See also XlaBuilder::Select .

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

Select(pred, on_true, on_false)

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)

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)

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

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

Send(HloInstruction operand, int64 channel_id)

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

SendDone(HloInstruction context)

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

Scheduling of channel instructions

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

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

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

Slice

See also XlaBuilder::Slice .

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

Slice(operand, start_indices, limit_indices, strides)

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)

If only one operand is provided:

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

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

If n > 1 operands are provided:

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

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

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

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

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

Top-K

See also the jax.lax.top_k operation.

TopK(operand)

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

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

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

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

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

Transpose

See also the tf.reshape operation.

Transpose(operand)

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

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

TriangularSolve

See also XlaBuilder::TriangularSolve .

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

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

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

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

Tuple

See also XlaBuilder::Tuple .

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

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

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