তারিখটা মনে রেখো! গুগল I / O মে 18-20 মে এখনই রেজিস্টার করুন
This page was translated by the Cloud Translation API.
Switch to English

অপারেশন শব্দার্থক

নীচে XlaBuilder ইন্টারফেসে সংজ্ঞায়িত অপারেশনগুলির শব্দার্থবিজ্ঞানের বর্ণনা দেয় XlaBuilder সাধারণত, এই অপারেশনগুলি xla_data.proto এ RPC ইন্টারফেসে সংজ্ঞায়িত অপারেশনগুলিতে একের পর এক মানচিত্র করে।

নামকরণের উপর একটি নোট: এক্সপ্লোর পরিচালনা সংক্রান্ত তথ্য টাইপ এক্সএলএর সাথে কিছু ইউনিফর্মের জাতীয় এন-ডাইমেনশনাল অ্যারে হোল্ড উপাদান রয়েছে (যেমন 32-বিট ফ্লোট)। ডকুমেন্টেশন জুড়ে, অ্যারেটি একটি স্বেচ্ছাকৃতির-মাত্রিক অ্যারে বোঝাতে ব্যবহৃত হয়। সুবিধার জন্য, বিশেষ ক্ষেত্রে আরও নির্দিষ্ট এবং পরিচিত নাম রয়েছে; উদাহরণস্বরূপ ভেক্টরটি 1-মাত্রিক অ্যারে এবং ম্যাট্রিক্স 2-মাত্রিক অ্যারে।

সর্বোপরি

XlaBuilder::AfterAll আরও দেখুন:

আফটারএল টোকেনগুলির একটি বৈচিত্র্যযুক্ত সংখ্যা নেয় এবং একটি একক টোকেন উত্পাদন করে। টোকেনগুলি আদিম ধরণের যা ক্রম প্রয়োগের জন্য পার্শ্ব-প্রতিক্রিয়াশীল ক্রিয়াকলাপগুলির মধ্যে থ্রেড করা যেতে পারে। AfterAll একটি সেট ক্রিয়াকলাপের পরে কোনও ক্রিয়াকলাপ অর্ডার করার জন্য টোকেনগুলির যোগদান হিসাবে ব্যবহার করা যেতে পারে।

AfterAll(operands)

যুক্তি প্রকার শব্দার্থবিজ্ঞান
operands XlaOp টোকেনের বিচিত্র সংখ্যা number

অলগারদার

XlaBuilder::AllGather

প্রতিরূপ জুড়ে একযোগে সঞ্চালন।

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

যুক্তি প্রকার শব্দার্থবিজ্ঞান
operand XlaOp প্রতিরূপ জুড়ে একত্রিত করতে অ্যারে।
all_gather_dim int64 সংযোগের মাত্রা।
replica_groups int64 এর ভেক্টরগুলির ভেক্টর যে দলগুলির মধ্যে সংক্ষিপ্তসার সম্পাদন করা হয়।
channel_id int64 ক্রস-মডিউল যোগাযোগের জন্য channelচ্ছিক চ্যানেল আইডি।
  • replica_groups প্রতিরূপ দলের তালিকা যার মধ্যে সংযুক্তকরণের (বর্তমান প্রতিরূপ ব্যবহার উদ্ধার করা যেতে পারে প্রতিরূপ আইডি সঞ্চালিত হয় ReplicaId )। প্রতিটি গ্রুপে প্রতিরূপের ক্রম ফলাফলটি যাতে তাদের ইনপুটগুলি অবস্থিত হয় তা নির্ধারণ করে। replica_groups হয় ফাঁকা থাকতে হবে ( replica_groups সমস্ত প্রতিলিপিগুলি একক গোষ্ঠীর অন্তর্ভুক্ত, 0 থেকে N - 1 পর্যন্ত অর্ডার করা হয়েছে), বা প্রতিরূপের সংখ্যার মতো একই সংখ্যক উপাদান থাকতে পারে। উদাহরণস্বরূপ, replica_groups = {0, 2}, {1, 3} the প্রতিলিপি 0 এবং 2 , এবং 1 এবং 3 মধ্যে একযোগে সম্পাদন করে।
  • shard_count প্রতিটি প্রতিলিপি গ্রুপের আকার। replica_groups খালি replica_groups ক্ষেত্রে আমাদের এটি দরকার replica_groups
  • channel_id ক্রস-মডিউল যোগাযোগের জন্য ব্যবহৃত হয়: কেবল একই channel_id সাথে all-gather ক্রিয়াকলাপ একে অপরের সাথে যোগাযোগ করতে পারে।

আউটপুট শেপটি all_gather_dim সাথে shard_count বারের চেয়ে বড় ইনপুট আকার shape উদাহরণস্বরূপ, যদি দুটি প্রতিরূপ থাকে এবং দুটি প্রতিরূপের তুলনায় অপারেন্ডের মান যথাক্রমে [1.0, 2.5] এবং [3.0, 5.25] তবে এই all_gather_dim থেকে যেখানে all_gather_dim 0 হবে তার আউটপুট মান হবে [1.0, 2.5, 3.0, 5.25] উভয় প্রতিরূপে।

অলরেডুস

XlaBuilder::AllReduce

প্রতিরূপ জুড়ে একটি কাস্টম গণনা সম্পাদন করে।

AllReduce(operand, computation, replica_group_ids, channel_id)

যুক্তি প্রকার শব্দার্থবিজ্ঞান
operand XlaOp রেপ্লিক্স জুড়ে হ্রাস করতে অ্যারে বা অ্যারেগুলির একটি খালি খালি টিপল।
computation XlaComputation হ্রাস গণনা
replica_groups int64 এর ভেক্টরগুলির ভেক্টর গ্রুপগুলি যার মধ্যে হ্রাসগুলি সম্পন্ন করা হয়
channel_id int64 ক্রস-মডিউল যোগাযোগের জন্য channelচ্ছিক চ্যানেল আইডি
  • যখন operand অ্যারেগুলির একটি টিপল হয়, সমস্ত-হ্রাস টিপলের প্রতিটি উপাদানগুলিতে সঞ্চালিত হয়।
  • replica_groups প্রতিরূপ দলের তালিকা যার মধ্যে রিডাকশন (বর্তমান প্রতিরূপ ব্যবহার উদ্ধার করা যেতে পারে প্রতিরূপ আইডি সঞ্চালিত হয় ReplicaId )। replica_groups অবশ্যই ফাঁকা থাকতে হবে ( replica_groups সমস্ত প্রতিলিপি একক গোষ্ঠীর অন্তর্গত), অথবা প্রতিরূপের সংখ্যার মতো একই সংখ্যক উপাদান থাকতে পারে। উদাহরণস্বরূপ, replica_groups = {0, 2}, {1, 3} the প্রতিলিপি 0 এবং 2 এবং 1 এবং 3 মধ্যে হ্রাস সম্পাদন করে।
  • channel_id ক্রস-মডিউল যোগাযোগের জন্য ব্যবহৃত হয়: কেবল একই channel_id সহ all-reduce অপারেশন একে অপরের সাথে যোগাযোগ করতে পারে।

আউটপুট আকারটি ইনপুট আকারের মতো। উদাহরণস্বরূপ, যদি দুটি প্রতিরূপ থাকে এবং দুটি প্রতিরূপের তুলনায় অপারেন্ডের মান যথাক্রমে [1.0, 2.5] এবং [3.0, 5.25] তবে এই অপশন এবং সমষ্টি গণনা থেকে আউটপুট মান উভয়ই [4.0, 7.75] হবে প্রতিলিপি। যদি ইনপুটটি টিপল হয় তবে আউটপুটটিও একটি টিপল।

AllReduce ফলাফল AllReduce জন্য প্রতিটি প্রতিরূপ থেকে একটি ইনপুট AllReduce দরকার, সুতরাং যদি AllReduce প্রতিলিপি একটি AllReduce নোডকে অন্যের চেয়ে বেশি বার কার্যকর করে, তবে পূর্বের প্রতিলিপিটি চিরতরে অপেক্ষা করবে। যেহেতু প্রতিলিপিগুলি একই প্রোগ্রাম চালাচ্ছে, তাই হওয়ার অনেকগুলি উপায় নেই, তবে এটি সম্ভব যখন লুপের অবস্থাটি ইনফিড থেকে প্রাপ্ত ডেটার উপর নির্ভর করে এবং যে ডেটা সংক্রামিত হয় সেই সময় লুপটি আরও বারবার পুনরুক্তির কারণ হয় অন্য তুলনায় এক প্রতিরূপে।

AllToAll

XlaBuilder::AllToAll

AllToAll একটি সম্মিলিত ক্রিয়াকলাপ যা সমস্ত কোর থেকে সমস্ত কোরে ডেটা প্রেরণ করে। এটির দুটি পর্যায় রয়েছে:

  1. বিক্ষিপ্ত পর্ব। প্রতিটি কোরে অপারেন্ডটি split_count বরাবর ব্লকগুলির split_count সংখ্যায় বিভক্ত হয় এবং ব্লকগুলি সমস্ত কোরগুলিতে ছড়িয়ে ছিটিয়ে থাকে, যেমন, split_dimensions ব্লকে split_dimensions প্রেরণ করা হয়।
  2. জমায়েত পর্ব। প্রতিটি কোর সংক্ষিপ্ত concat_dimension সাথে প্রাপ্ত প্রাপ্ত ব্লকগুলিকে concat_dimension

অংশগ্রহণকারী কোরগুলি এর দ্বারা কনফিগার করা যায়:

  • replica_groups : প্রতিটি ReplicaGroup একটি গুনতি অংশগ্রহণ (বর্তমান প্রতিরূপ ব্যবহার উদ্ধার করা যেতে পারে প্রতিরূপ আইডি প্রতিরূপ আইডি তালিকা রয়েছে ReplicaId )। AllToAll নির্দিষ্ট ক্রমে সাবগ্রুপগুলির মধ্যে প্রয়োগ করা হবে। উদাহরণস্বরূপ, replica_groups = { {1,2,3}, {4,5,0} } অর্থ একটি প্রতিলিপি T {1, 2, 3} within এর মধ্যে এবং সমস্ত সংগ্রহের পর্যায়ে একটি AllToAll প্রয়োগ করা হবে এবং প্রাপ্ত ব্লকগুলি 1, 2, 3 এর একই ক্রমে সংক্ষিপ্ত করা হবে। তারপরে, অন্য অলটোও সবগুলি প্রতিলিপি 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 ভেক্টর প্রতিটি গ্রুপে প্রতিরূপ আইডির একটি তালিকা রয়েছে।

নীচে অল্টোলের একটি উদাহরণ দেখানো হয়েছে।

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

এই উদাহরণে, অলটোলে অংশ নেওয়া 4 টি কোর রয়েছে। প্রতিটি কোরে অপারেন্ডটি 0 মাত্রার সাথে 4 টি ভাগে বিভক্ত হয়, সুতরাং প্রতিটি অংশের আকার f32 [4,4] থাকে। 4 টি অংশ সমস্ত কোরগুলিতে ছড়িয়ে ছিটিয়ে রয়েছে। তারপরে প্রতিটি কোর অর্ডার 1 বা 1- টি অর্ডার সহ প্রাপ্ত অংশগুলিকে সম্মতি দেয়। সুতরাং প্রতিটি কোরের আউটপুট এর আকার f32 [16,4] রয়েছে।

ব্যাচনর্মগ্র্যাড

অ্যালগরিদমের বিশদ বিবরণের জন্য XlaBuilder::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\))
feature_index int64 operand বৈশিষ্ট্য মাত্রার সূচক

বৈশিষ্ট্য মাত্রা (প্রতিটি বৈশিষ্ট্যের জন্য feature_index ইন বৈশিষ্ট্যটি মাত্রা জন্য সূচি operand ), অপারেশন থেকে সম্মান সঙ্গে গ্রেডিয়েন্ট হিসাব operand , offset এবং scale সব অন্যান্য মাত্রা জুড়ে। feature_index ইন বৈশিষ্ট্যটি মাত্রা জন্য একটি বৈধ সূচক হওয়া আবশ্যক operand

তিনটি গ্রেডিয়েন্ট নিম্নলিখিত সূত্রগুলি দ্বারা সংজ্ঞায়িত করা হয়েছে (4-মাত্রিক অ্যারেটিকে operand হিসাবে এবং বৈশিষ্ট্য মাত্রা সূচক l , ব্যাচের আকারের m এবং স্থানিক আকারের w এবং h ) ধরে h :

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

ইনপুটগুলির mean এবং variance ব্যাচ এবং স্থানিক মাত্রার জুড়ে মুহুর্তের মানকে উপস্থাপন করে।

আউটপুট ধরণটি তিনটি হ্যান্ডেলের একটি টিপল:

আউটপুটস প্রকার শব্দার্থবিজ্ঞান
grad_operand XlaOp ইনপুট থেকে সম্মান সঙ্গে গ্রেডিয়েন্ট operand (\( \nabla x\))
grad_scale XlaOp ইনপুট scale (\( \nabla \gamma\)) এর সাথে সম্মানের সাথে গ্রেডিয়েন্ট
grad_offset XlaOp ইনপুট offset (\( \nabla \beta\)) এর সাথে সম্মতি সহ গ্রেডিয়েন্ট

ব্যাচনর্মআইনফারেন্স

অ্যালগরিদমের বিশদ বিবরণের জন্য XlaBuilder::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 এপসিলনের মান
feature_index int64 operand বৈশিষ্ট্যযুক্ত সূচক

বৈশিষ্ট্য মাত্রা প্রতিটি বৈশিষ্ট্যের জন্য (বৈশিষ্ট্য_আন্দেক্স operand বৈশিষ্ট্য মাত্রার সূচক), অপারেশনটি অন্যান্য সমস্ত মাত্রার feature_index গড় এবং feature_index গণনা করে এবং operand প্রতিটি উপাদানকে স্বাভাবিক করার জন্য গড় এবং বৈকল্পিক ব্যবহার করে। feature_index ইন বৈশিষ্ট্যটি মাত্রা জন্য একটি বৈধ সূচক হওয়া আবশ্যক operand

BatchNormInference কলিং সমতূল্য BatchNormTraining কম্পিউটিং ছাড়া mean এবং variance প্রতিটি ব্যাচ জন্য। এটি আনুমানিক মান হিসাবে পরিবর্তে ইনপুট mean এবং variance ব্যবহার করে। এই অপের উদ্দেশ্য হ'ল অনুমানের ক্ষেত্রে BatchNormInference হ্রাস করা, তাই নামটি BatchNormInference

আউটপুটটি একটি এন-ডাইমেনশনাল, ইনপুট operand মতো একই আকৃতির সাধারণ অ্যারে।

ব্যাচনার্মট্রেইন

অ্যালগরিদমের বিশদ বিবরণের জন্য XlaBuilder::BatchNormTraining এবং the original batch normalization paper XlaBuilder::BatchNormTraining দেখুন।

ব্যাচ এবং স্থানিক মাত্রাগুলি জুড়ে একটি অ্যারেরকে সাধারণ করে তোলে।

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

যুক্তি প্রকার শব্দার্থবিজ্ঞান
operand XlaOp n মাত্রিক অ্যারেটি স্বাভাবিক করা হবে (x)
scale XlaOp 1 টি মাত্রিক অ্যারে (\(\gamma\))
offset XlaOp 1 মাত্রিক অ্যারে (\(\beta\))
epsilon float অ্যাপসিলনের মান (\(\epsilon\))
feature_index int64 operand বৈশিষ্ট্যযুক্ত সূচক

বৈশিষ্ট্য মাত্রা প্রতিটি বৈশিষ্ট্যের জন্য (বৈশিষ্ট্য_আন্দেক্স operand বৈশিষ্ট্য মাত্রার সূচক), অপারেশনটি অন্যান্য সমস্ত মাত্রার feature_index গড় এবং feature_index গণনা করে এবং operand প্রতিটি উপাদানকে স্বাভাবিক করার জন্য গড় এবং বৈকল্পিক ব্যবহার করে। feature_index ইন বৈশিষ্ট্যটি মাত্রা জন্য একটি বৈধ সূচক হওয়া আবশ্যক operand

অ্যালগরিদম যেমন প্রতিটি ব্যাচ জন্য নিম্নরূপ যায় operand \(x\) যে রয়েছে m উপাদানের w এবং h স্থানিক মাত্রা আকার হিসাবে (অভিমানী 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\) ব্যাচের ভেরিয়েন্স গণনা করে

  • সাধারণকরণ, স্কেল এবং শিফটগুলি: 04 স্যাব 121250

অ্যাপসিলন মান, সাধারণত একটি ছোট সংখ্যা, যোগ-শূন্যের ত্রুটিগুলি এড়ানোর জন্য যুক্ত করা হয়।

আউটপুট টাইপ তিনটি XlaOp গুলি এর একটি:

আউটপুটস প্রকার শব্দার্থবিজ্ঞান
output XlaOp ইনপুট operand (y) এর মতো একই আকৃতির n টি মাত্রিক অ্যারে
batch_mean XlaOp 1 মাত্রিক অ্যারে (\(\mu\))
batch_var XlaOp 1 মাত্রিক অ্যারে (\(\sigma^2\))

batch_mean এবং batch_var উপরের সূত্রগুলি ব্যবহার করে ব্যাচ এবং স্থানিক মাত্রাগুলি জুড়ে গণনা করা মুহুর্ত হয়।

বিটকাস্ট কনভার্টটাইপ

XlaBuilder::BitcastConvertType

tf.bitcast তে একটি tf.bitcast অনুরূপ, একটি ডেটা আকার থেকে একটি লক্ষ্য আকারে একটি এলিমেন্ট-ভিত্তিক বিটকাস্ট অপারেশন করে। মাত্রাগুলি অবশ্যই মেলতে হবে এবং রূপান্তরটি উপাদান অনুসারে এক; যেমন s32 উপাদানগুলি বিটকাস্ট রুটিনের মাধ্যমে s32 উপাদান হয়ে f32 । বিটকাস্টটি নিম্ন-স্তরের castালাই হিসাবে প্রয়োগ করা হয়েছে, তাই বিভিন্ন ভাসমান-পয়েন্ট উপস্থাপনা সহ মেশিনগুলি বিভিন্ন ফলাফল দেয়।

BitcastConvertType(operand, new_element_type)

যুক্তি প্রকার শব্দার্থবিজ্ঞান
operand XlaOp ডি টাইম ডি সহ টি টাইপের অ্যারে
new_element_type PrimitiveType টাইপ ইউ

অপারেন্ডের মাত্রাগুলি এবং লক্ষ্য আকারটি অবশ্যই মিলবে। উত্স এবং গন্তব্য উপাদান ধরণের বিট প্রস্থ অবশ্যই সমান হতে হবে। উত্স এবং গন্তব্য উপাদান ধরণেরগুলি অবশ্যই টিউপলস নয়।

সম্প্রচার

XlaBuilder::Broadcast

অ্যারেতে ডেটা নকল করে একটি অ্যারেতে মাত্রা যুক্ত করে।

Broadcast(operand, broadcast_sizes)

যুক্তি প্রকার শব্দার্থবিজ্ঞান
operand XlaOp সদৃশ করার জন্য অ্যারে
broadcast_sizes ArraySlice<int64> নতুন মাত্রা আকার

নতুন মাত্রাগুলি বাম দিকে সন্নিবেশ করা হয়েছে, অর্থাত্ যদি broadcast_sizes আকারের মানগুলি {a0, ..., aN} has থাকে এবং অপারেন্ড আকারের মাত্রা থাকে {b0, ..., bM} তবে আউটপুটটির আকারের আকার থাকে {a0, ..., aN, b0, ..., bM}

অপারেন্ডের অনুলিপিগুলিতে নতুন মাত্রা সূচক, যেমন

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

উদাহরণস্বরূপ, যদি operand স্কেলের হয় f32 মান 2.0f এবং broadcast_sizes হয় {2, 3} , তারপর ফলাফলের আকৃতি সহ একটি বিন্যাস হতে হবে f32[2, 3] এবং ফলাফলে সব মান হতে হবে 2.0f

ব্রডকাস্টিনডিম

XlaBuilder::BroadcastInDim

অ্যারেতে ডাটা নকল করে একটি অ্যারের আকার এবং র‌্যাঙ্ক প্রসারিত করে।

BroadcastInDim(operand, out_dim_size, broadcast_dimensions)

যুক্তি প্রকার শব্দার্থবিজ্ঞান
operand XlaOp সদৃশ করার জন্য অ্যারে
out_dim_size ArraySlice<int64> লক্ষ্য আকারের মাত্রাগুলির আকার
broadcast_dimensions ArraySlice<int64> লক্ষ্য আকারের কোন মাত্রা অপারেন্ড আকারের প্রতিটি মাত্রার সাথে মিলে যায়

সম্প্রচারের অনুরূপ, তবে যে কোনও জায়গায় মাত্রা যুক্ত করতে এবং 1 টি আকারের সাথে বিদ্যমান মাত্রাগুলি প্রসারিত করতে দেয়।

operand out_dim_size দ্বারা বর্ণিত আকারে সম্প্রচারিত হয়। broadcast_dimensions operand মাত্রাগুলিকে লক্ষ্য আকৃতির মাত্রা ম্যাপ করে, অর্থাত অপারেন্ডের প্রথম মাপকে ব্রডকাস্ট_ডিমাইশন [i] এর আউটপুট আকারের ম্যাপ করা হয়। operand মাত্রাগুলির আকার 1 হতে হবে বা তারা ম্যাপ করা হয় আউটপুট আকারের মাত্রা হিসাবে একই আকার হতে হবে। বাকি মাত্রাগুলি আকারের মাত্রা 1 দিয়ে পূর্ণ হয় 1. মাত্রা সম্প্রচারিত হ্রাস করুন তারপর আউটপুট আকারে পৌঁছানোর জন্য এই অধঃপতন মাত্রা বরাবর সম্প্রচার করে। শব্দার্থক সম্প্রচারের পৃষ্ঠায় বিশদে বর্ণনা করা হয়েছে।

ফোন করুন

XlaBuilder::Call দেখুন।

প্রদত্ত যুক্তিগুলির সাথে একটি গণনা প্রার্থনা করে।

Call(computation, args...)

যুক্তি প্রকার শব্দার্থবিজ্ঞান
computation XlaComputation T_0, T_1, ..., T_{N-1} -> S নির্বিচারে টাইপের N পরামিতি সহ টাইপের গণনা
args এন XlaOp এর ক্রম স্বেচ্ছাচারী টাইপের এন আর্গুমেন্ট

Arity এবং ধরনের args পরামিতি মেলানো computationargs কোনও args থাকার অনুমতি নেই।

কোলেস্কি

XlaBuilder::Cholesky দেখুন।

প্রতিলিপি (হার্মিটিয়ান) ধনাত্মক সুনির্দিষ্ট ম্যাট্রিকগুলির একটি ব্যাচের কোলেস্কি পচনকে গণনা করে।

Cholesky(a, lower)

যুক্তি প্রকার শব্দার্থবিজ্ঞান
a XlaOp একটি জটিল বা ভাসমান-পয়েন্ট ধরণের 2 টি অ্যারে।
lower bool a এর উপরের বা নিম্ন ত্রিভুজটি ব্যবহার করা হবে কিনা।

তাহলে 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)

যুক্তি প্রকার শব্দার্থবিজ্ঞান
min XlaOp টাইপ টি এর অ্যারে
operand XlaOp টাইপ টি এর অ্যারে
max XlaOp টাইপ টি এর অ্যারে

অপারেন্ড এবং ন্যূনতম এবং সর্বাধিক মানগুলি দেওয়া, অপারেন্ডটি ন্যূনতম এবং সর্বাধিকের মধ্যে সীমাতে থাকলে এটি প্রদান করে, অন্যথায় অপারেন্ড যদি এই ব্যাপ্তির নীচে থাকে বা অপারেন্ড এই সীমার উপরে থাকে তবে সর্বাধিক মান প্রদান করে। অর্থাৎ, 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)

যুক্তি প্রকার শব্দার্থবিজ্ঞান
operand XlaOp টাইপ টি এর অ্যারে
dimensions int64 ভেক্টর ক্রমানুসারে টি এর মাত্রাগুলির একটানা উপসেট।

সঙ্কুচিত হওয়া অপারেন্ডের মাত্রাগুলির প্রদত্ত উপসেটটিকে একক মাত্রায় প্রতিস্থাপন করে। ইনপুট আর্গুমেন্টগুলি টাইপ টির একটি স্বেচ্ছাসেবী অ্যারে এবং মাত্রা সূচকগুলির একটি সংকলন-সময়-ধ্রুবক ভেক্টর। ডাইমেনশন সূচকগুলি অবশ্যই একটি ক্রম (কম থেকে উচ্চ মাত্রা সংখ্যার) হতে হবে, টি এর মাত্রাগুলির একটানা উপসেট হতে হবে। সুতরাং, {0, 1, 2}, {0, 1}, বা {1, 2 all সমস্ত বৈধ মাত্রা সেট, তবে {1, 0} বা {0, 2। নয়। মূল মাত্রা আকারের পণ্যের সমান নতুন মাত্রা আকারের সাথে তারা প্রতিস্থাপনের মতো মাত্রা ক্রমের একই অবস্থানে একটি একক নতুন মাত্রা দ্বারা প্রতিস্থাপিত হয়। মধ্যে এটা সর্বনিম্ন মাত্রা সংখ্যা dimensions ধীরতম নানারকম মাত্রা (অধিকাংশ প্রধান) লুপ নীড় যা এই মাত্রা ভেঙে আছে, এবং সর্বোচ্চ মাত্রা সংখ্যা দ্রুততম নানারকম (অধিকাংশ ছোটখাট) হয়। আরও সাধারণ পতনের ক্রম প্রয়োজন হলে tf.reshape অপারেটরটি দেখুন।

উদাহরণস্বরূপ, ভি 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)

যুক্তি প্রকার শব্দার্থবিজ্ঞান
operand XlaOp n মাত্রিক ইনপুট অ্যারে
source_target_pairs <int64, int64> ভেক্টর (উত্স_প্রণালী_আইডি, টার্গেট_প্রিলিকা_আইডি) জোড়াগুলির একটি তালিকা। প্রতিটি জুটির জন্য অপারেন্ডকে উত্স প্রতিরূপ থেকে লক্ষ্য প্রতিরূপে প্রেরণ করা হয়।

মনে রাখবেন যে source_target_pair উপর নিম্নলিখিত বিধিনিষেধ source_target_pair :

  • যে কোনও দুটি জুটির একই টার্গেটের প্রতিলিপি আইডি থাকা উচিত নয় এবং তাদের একই উত্সের প্রতিরূপ আইডি থাকা উচিত নয়।
  • যদি কোনও প্রতিরূপ আইডি কোনও জোড় লক্ষ্য না হয়, তবে সেই প্রতিরূপের আউটপুটটি একটি টেনসর হয় ইনপুট হিসাবে একই আকৃতিযুক্ত 0 (গুলি) নিয়ে।

শ্রেণীবদ্ধভাবে সংযুক্ত করা

XlaBuilder::ConcatInDim

সংযোগকারী একাধিক অ্যারে অপারেশনগুলি থেকে একটি অ্যারে রচনা করে। অ্যারে প্রতিটি ইনপুট অ্যারে অপারেঞ্জের সমান র‌্যাঙ্কের (যা অবশ্যই একে অপরের সমান র‌্যাঙ্কের হওয়া আবশ্যক) এবং সেগুলি নির্দিষ্ট করে দেওয়া ক্রমে আর্গুমেন্টগুলি অন্তর্ভুক্ত করে।

Concatenate(operands..., dimension)

যুক্তি প্রকার শব্দার্থবিজ্ঞান
operands এন XlaOp ক্রম মাত্রার সাথে টি টাইপের এন অ্যারে [L0, L1, ...]। এন> = 1 প্রয়োজন।
dimension int64 ব্যবধানের মধ্যে একটি মান [0, N) যা operands মধ্যে operands হওয়ার মাত্রাটির নাম দেয়।

dimension সমস্ত মাত্রা অবশ্যই এক হতে হবে। এটি কারণ XLA "ragged" অ্যারে সমর্থন করে না। এছাড়াও নোট করুন যে র‌্যাঙ্ক -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 XlaOp প্রকার প্রকারের PRED
true_operand XlaOp \(T_0\) প্রকারের যুক্তি
true_computation XlaComputation \(T_0 \to S\) টাইপের XlaComptation
false_operand XlaOp \(T_1\) প্রকারের যুক্তি
false_computation XlaComputation \(T_1 \to S\) প্রকারের এক্সপ্লোরেশন

Executes true_computation যদি pred হল true , false_computation যদি pred হল false , এবং আয় ফলাফল।

true_computation অবশ্যই true_computation টাইপের একক যুক্তিতে নেবে এবং true_operand দিয়ে true_operand যা অবশ্যই একই ধরণের হতে হবে। false_computation অবশ্যই false_computation টাইপের একক যুক্তিতে নেবে এবং false_operand সাথে false_operand যা অবশ্যই একই ধরণের হতে হবে। true_computation এবং false_computation প্রত্যাবর্তিত মানের true_computation একই হতে হবে।

লক্ষ্য করুন মাত্র এক true_computation এবং false_computation মান উপর নির্ভর করে মৃত্যুদন্ড কার্যকর করা হবে pred

Conditional(branch_index, branch_computations, branch_operands)

যুক্তি প্রকার শব্দার্থবিজ্ঞান
branch_index XlaOp ধরনের স্কালে S32
branch_computations এন XlaComputation ক্রম \( T_0 \to S , T_1 \to S , ..., T_{N-1} \to S \) প্রকারের XlaComutes
branch_operands এন XlaOp ক্রম \( T_0 , T_1 , ..., T_{N-1} \) প্রকারের যুক্তি

branch_computations[branch_index] এবং ফলাফলটি প্রদান করে। তাহলে branch_index একটি হল S32 যা <0 বা> = এন, তারপর branch_computations[N-1] ডিফল্ট শাখা হিসেবে মৃত্যুদন্ড কার্যকর করা হয়।

প্রতিটি branch_computations[b] অবশ্যই T_b টাইপের একক যুক্তি গ্রহণ করতে হবে এবং branch_operands[b] সাথে branch_operands[b] হবে যা অবশ্যই একই ধরণের হতে হবে। প্রতিটি branch_computations[b] এর প্রত্যাবর্তিত মানের ধরণ একই রকম হতে হবে।

লক্ষ্য করুন মাত্র এক branch_computations মান উপর নির্ভর করে মৃত্যুদন্ড কার্যকর করা হবে branch_index

রূপান্তর (সমঝোতা)

XlaBuilder::Conv

কনভউইথজেনারালপ্যাডিং হিসাবে, তবে প্যাডিংটি সংক্ষিপ্ত হাতে স্যাম বা ভ্যালিড হিসাবে নির্দিষ্ট করা হয়েছে। একই প্যাডিং শূন্যগুলির সাথে ইনপুট ( lhs ) প্যাড করে যাতে আউটপুটটিকে অ্যাকাউন্টে স্ট্রাইডিং না নেওয়ার সময় ইনপুটটির মতো একই আকার থাকে। ভ্যালিড প্যাডিংয়ের অর্থ সহজভাবে কোনও প্যাডিং নয়।

কনভউইথ জেনারালপ্যাডিং (কনভোলশন)

XlaBuilder::ConvWithGeneralPadding দেখুন।

নিউরাল নেটওয়ার্কগুলিতে ব্যবহৃত ধরণের একটি কনভোলশন গণনা করে। এখানে, একটি রূপান্তরটি এন-ডাইমেনশনাল উইন্ডোটিকে একটি এন-ডাইমেনশনাল বেস অঞ্চল জুড়ে চলমান হিসাবে ভাবা যেতে পারে এবং উইন্ডোর প্রতিটি সম্ভাব্য অবস্থানের জন্য একটি গণনা করা হয়।

যুক্তি প্রকার শব্দার্থবিজ্ঞান
lhs XlaOp ইনপুটগুলির রেঙ্ক এন + 2 অ্যারে
rhs XlaOp কার্নেল ওজনের র‌্যাঙ্ক এন + 2 অ্যারে
window_strides ArraySlice<int64> কার্নেল পদক্ষেপের এনডি অ্যারে
padding ArraySlice< pair<int64, int64>> (নিম্ন, উচ্চ) প্যাডিংয়ের এনডি অ্যারে
lhs_dilation ArraySlice<int64> nd lhs dilation factor অ্যারে
rhs_dilation ArraySlice<int64> এনডিএইচএস ডিলেশন ফ্যাক্টর অ্যারে
feature_group_count int64 বৈশিষ্ট্য গোষ্ঠীর সংখ্যা
batch_group_count int64 ব্যাচ গ্রুপ সংখ্যা

স্থানিক মাত্রার সংখ্যা এন হোক be lhs আর্গুমেন্টটি বেস অঞ্চলটি বর্ণনা করে এমন একটি র‌্যাঙ্ক n + 2 অ্যারে। এটিকে ইনপুট বলা হয়, যদিও অবশ্যই আরএইচএসও একটি ইনপুট। নিউরাল নেটওয়ার্কে, এটি হ'ল ইনপুট অ্যাক্টিভেশন। N + 2 মাত্রা এই ক্রমে:

  • batch : এই মাত্রায় প্রতিটি সমন্বয় একটি স্বতন্ত্র ইনপুট উপস্থাপন করে যার জন্য বোঝা বাহিত হয়।
  • z/depth/features : বেস অঞ্চলে প্রতিটি (y, x) অবস্থানের সাথে এটির সাথে একটি ভেক্টর যুক্ত থাকে, যা এই মাত্রায় যায় into
  • spatial_dims : বর্ণনা n স্থানিক মাত্রা যে যে উইন্ডো প্যাচসমূহ জুড়ে বেস এলাকায় নির্ধারণ করুন।

rhs আর্গুমেন্টটি একটি র‌্যাঙ্ক এন + ২ অ্যারে যা কনভ্যুশনাল ফিল্টার / কার্নেল / উইন্ডো বর্ণনা করে। মাত্রাগুলি এই ক্রমে:

  • output-z : output-z এর z মাত্রা।
  • input-z : এই মাত্রা সময়ের আকার feature_group_count আকার সমান উচিত z LHS মধ্যে মাত্রা।
  • spatial_dims : বর্ণনা n স্থানিক মাত্রা যে য় উইন্ডোতে সংজ্ঞায়িত যে বেস এলাকায় জুড়ে সরে আসে।

window_strides যুক্তি স্থানিক মাত্রায় window_strides উইন্ডোর window_strides নির্দিষ্ট করে। উদাহরণস্বরূপ, যদি প্রথম স্থানিক মাত্রার স্ট্রাইড 3 হয়, তবে উইন্ডোটি কেবল স্থানাঙ্কগুলিতে স্থাপন করা যেতে পারে যেখানে প্রথম স্থানিক সূচকটি 3 দ্বারা বিভাজ্য হয়।

padding আর্গুমেন্টটি বেস অঞ্চলে প্রয়োগ করার জন্য শূন্য প্যাডিংয়ের পরিমাণ নির্দিষ্ট করে। প্যাডিংয়ের পরিমাণ নেতিবাচক হতে পারে - নেতিবাচক প্যাডিংয়ের নিখুঁত মান বোঝাটি করার আগে নির্দিষ্ট মাত্রা থেকে সরানোর উপাদানগুলির সংখ্যা নির্দেশ করে। padding[0] মাত্রা y জন্য প্যাডিং নির্দিষ্ট করে এবং padding[1] মাত্রা x জন্য প্যাডিং নির্দিষ্ট করে। প্রতিটি জোড়ের প্রথম উপাদান হিসাবে কম প্যাডিং এবং দ্বিতীয় উপাদান হিসাবে উচ্চ প্যাডিং থাকে। নিম্ন প্যাডিং নিম্ন সূচকের দিকে প্রয়োগ করা হয় যখন উচ্চ প্যাডিং উচ্চতর সূচকের দিকে প্রয়োগ করা হয়। উদাহরণস্বরূপ, padding[1] যদি padding[1] হয় (2,3) তবে দ্বিতীয় স্থানিক মাত্রায় ডানদিকে 2 টি শূন্য এবং ডানদিকে 3 টি শূন্য দ্বারা একটি প্যাডিং থাকবে। প্যাডিং ব্যবহার lhs করার আগে ইনপুট ( lhs ) এ একই শূন্য মান সন্নিবেশ করার সমতুল্য।

lhs_dilation এবং rhs_dilation আর্গুমেন্টগুলি প্রতিটি স্থানিক মাত্রায় যথাক্রমে lhs এবং rhs_dilation জন্য প্রয়োগ করার জন্য ডিলেশন ফ্যাক্টর নির্দিষ্ট করে। যদি একটি স্থানিক মাত্রায় ডিলেশন ফ্যাক্টরটি ডি হয়, তবে ডি -1 গর্তগুলি এই মাত্রার প্রতিটি এন্ট্রিগুলির মধ্যে স্পষ্টভাবে স্থাপন করা হয়, অ্যারের আকার বৃদ্ধি করে। গর্তগুলি কোনও অপ-মান দিয়ে পূর্ণ হয়, যা বোঝার জন্য শূন্য হয়।

আরএইচএসের বিসারণকে অ্যাট্রাস কনভলিউশনও বলা হয়। আরও তথ্যের জন্য দেখুন tf.nn.atrous_conv2d । লাহাগুলির অপসারণকে ট্রান্সপোজড কনভলিউশনও বলা হয়। আরও তথ্যের জন্য দেখুন tf.nn.conv2d_transpose

feature_group_count আর্গুমেন্ট (ডিফল্ট মান 1) feature_group_count জন্য ব্যবহার করা যেতে পারে। বৈশিষ্ট্য_গ্রুপ_কাউন্টকে ইনপুট এবং আউটপুট বৈশিষ্ট্যের মাত্রা উভয়ের বিভাজক feature_group_count দরকার। তাহলে feature_group_count 1 তার চেয়ে অনেক বেশী, এটা মানে হল যে ধারণার দিক থেকে ইনপুট এবং আউটপুট বৈশিষ্ট্য মাত্রা এবং rhs আউটপুট বৈশিষ্ট্য মাত্রা মধ্যে সমানভাবে বিভক্ত করা হয় feature_group_count অনেক গোষ্ঠী, বৈশিষ্ট্য পরপর subsequence গঠিত প্রতিটি গ্রুপ। ইনপুট বৈশিষ্ট্য মাত্রা rhs চাহিদা সমান হতে lhs ইনপুট বৈশিষ্ট্য দ্বারা বিভক্ত মাত্রা feature_group_count (তাই এটি ইতিমধ্যেই ইনপুট বৈশিষ্ট্য একটি গ্রুপ আকার আছে)। feature_group_count আলাদা আলাদা feature_group_count গণনা করতে আই-তম গ্রুপগুলি একসাথে ব্যবহৃত হয়। এই কনভোলিউশনের ফলাফলগুলি আউটপুট বৈশিষ্ট্যের মাত্রায় একত্রে একত্রিত হয়।

গভীরতার দিক থেকে 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 দরকার। যদি batch_group_count 1 এর চেয়ে বেশি হয় তবে এর অর্থ হ'ল আউটপুট ব্যাচের মাত্রা আকারের input batch / batch_group_count হওয়া উচিত। batch_group_count অবশ্যই আউটপুট বৈশিষ্ট্য আকারের বিভাজক হতে হবে।

এই ক্রমে আউটপুট আকারের এই মাত্রাগুলি রয়েছে:

  • batch : batch_group_count এই মাত্রা বারের আকারের lhs মধ্যে batch মাত্রার আকার সমান করা উচিত
  • z : কার্নেলের rhs output-z হিসাবে একই আকার ( rhs )।
  • spatial_dims : spatial_dims উইন্ডোর প্রতিটি বৈধ প্লেসমেন্টের জন্য একটি মান।

কনভ্যুশনাল উইন্ডোটির বৈধ প্লেসমেন্টগুলি প্যাডিংয়ের পরে অগ্রভাগ এবং বেস ক্ষেত্রের আকার দ্বারা নির্ধারিত হয়।

কোন কনভোলশনটি কী করে তা বর্ণনা করতে, 2 ডি কনভোলিউশনটি বিবেচনা করুন এবং আউটপুটে কিছু স্থির batch , z , y , x স্থানাঙ্ক বেছে নিন pick তারপরে (y,x) হ'ল বেস ক্ষেত্রের মধ্যে উইন্ডোর একটি কোণের অবস্থান (যেমন উপরের বাম কোণে, আপনি স্থানিক মাত্রাগুলি কীভাবে ব্যাখ্যা করেন তার উপর নির্ভর করে)। আমাদের এখন একটি 2 ডি উইন্ডো রয়েছে, বেস অঞ্চল থেকে নেওয়া, যেখানে প্রতিটি 2 ডি পয়েন্ট 1 ডি ভেক্টরের সাথে সম্পর্কিত, তাই আমরা একটি 3 ডি বাক্স পাই। কনভ্যুশনাল কার্নেল থেকে, যেহেতু আমরা আউটপুট স্থানাঙ্ক z স্থির করেছি তাই আমাদের একটি 3 ডি বাক্সও রয়েছে। দুটি বাক্সের একই মাত্রা রয়েছে, তাই আমরা দুটি বাক্সের মধ্যে উপাদান হিসাবে বুদ্ধিমান পণ্যগুলির যোগফল নিতে পারি (কোনও বিন্দুর সাথে মিল রয়েছে)। এটি আউটপুট মান।

মনে রাখবেন যদি output-z উদাহরণস্বরূপ, 5 হয় তবে উইন্ডোর প্রতিটি অবস্থান আউটপুটের z মাত্রায় আউটপুটে 5 টি মান তৈরি করে। কনভ্যুশনাল কার্নেলের কোন অংশটি ব্যবহৃত হয় তার মধ্যে এই মানগুলি পৃথক হয় - প্রতিটি output-z সমন্বয়ের জন্য পৃথক মানের 3 ডি বাক্স ব্যবহার করা হয় used সুতরাং আপনি তাদের প্রত্যেকের জন্য পৃথক ফিল্টার সহ 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 অনুরূপ, কোনও ডাটা শেপ থেকে লক্ষ্য আকারে একটি উপাদান-ভিত্তিক রূপান্তর static_cast সম্পাদন করে। মাত্রাগুলি অবশ্যই মেলতে হবে এবং রূপান্তরটি উপাদান অনুসারে এক; উদাহরণস্বরূপ s32 উপাদানগুলি একটি s32 থেকে- f32 রূপান্তর রুটিনের মাধ্যমে s32 উপাদান হয়ে f32

ConvertElementType(operand, new_element_type)

যুক্তি প্রকার শব্দার্থবিজ্ঞান
operand XlaOp ডি টাইম ডি সহ টি টাইপের অ্যারে
new_element_type PrimitiveType টাইপ ইউ

অপারেন্ডের মাত্রাগুলি এবং লক্ষ্য আকারটি অবশ্যই মিলবে। উত্স এবং গন্তব্য উপাদান ধরণেরগুলি অবশ্যই টিউপলস নয়।

T=s32 থেকে U=f32 মত রূপান্তরটি রাউন্ড-টু-নিকটতম- U=f32 স্বাভাবিক- 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)

যুক্তি প্রকার শব্দার্থবিজ্ঞান
target_name string ফাংশনের নাম। একটি কল নির্দেশ প্রেরণ করা হবে যা এই চিহ্নের নামটিকে লক্ষ্য করে।
args এন XlaOp গুলি এর ক্রম স্বেচ্ছাসেবী প্রকারের এন আর্গুমেন্ট, যা ফাংশনে পাস হবে।
shape Shape ফাংশনের আউটপুট আকার

বিন্যাস বা ধরণের প্রকার নির্বিশেষে ফাংশনের স্বাক্ষরটি একই রকম:

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

উদাহরণস্বরূপ, কাস্টমকলটি যদি নীচে ব্যবহার করা হয়:

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 টাইপ টি এর অ্যারে
rhs XlaOp টাইপ টি এর অ্যারে

এই ক্রিয়াকলাপের সঠিক শব্দার্থবিজ্ঞান অপারেটরগুলির স্তরের উপর নির্ভর করে:

ইনপুট আউটপুট শব্দার্থবিজ্ঞান
ভেক্টর [এন] dot ভেক্টর [এন] স্কেলার ভেক্টর ডট পণ্য
ম্যাট্রিক্স [এমএক্সকে] dot ভেক্টর [কে] ভেক্টর [মি] ম্যাট্রিক্স-ভেক্টর গুণ
ম্যাট্রিক্স [এমএক্সকে] dot ম্যাট্রিক্স [কেএক্সএন] ম্যাট্রিক্স [এমএক্সএন] ম্যাট্রিক্স-ম্যাট্রিক্সের গুণ

অপারেশন সঞ্চালিত দ্বিতীয় মাত্রা উপর গুণফলের সমষ্টি lhs (বা প্রথম যদি এটা র্যাঙ্ক 1 আছে) এবং প্রথম মাত্রা rhs । এগুলি হ'ল "চুক্তিবদ্ধ" মাত্রা। lhs এবং rhs এর চুক্তিবদ্ধ মাত্রা অবশ্যই একই আকারের হবে। অনুশীলনে, এটি ভেক্টর, ভেক্টর / ম্যাট্রিক্স গুণ বা ম্যাট্রিক্স / ম্যাট্রিক্স গুণনের মধ্যে ডট পণ্য সম্পাদন করতে ব্যবহৃত হতে পারে।

ডট জেনারাল

XlaBuilder::DotGeneral

DotGeneral(lhs, rhs, dimension_numbers)

যুক্তি প্রকার শব্দার্থবিজ্ঞান
lhs XlaOp টাইপ টি এর অ্যারে
rhs XlaOp টাইপ টি এর অ্যারে
dimension_numbers DotDimensionNumbers চুক্তি এবং ব্যাচের মাত্রা সংখ্যা

ডট হিসাবে, তবে চুক্তিকরণ এবং ব্যাচের মাত্রা সংখ্যাগুলি 'lhs' এবং 'rhs' উভয়ের জন্য নির্দিষ্ট করার অনুমতি দেয়।

ডটডাইমেনশন নাম্বার ক্ষেত্র প্রকার শব্দার্থবিজ্ঞান
'lhs_contracting_ आयाম' পুনরাবৃত্তি int64 'lhs' চুক্তি আকারের সংখ্যা
'আরএইচএস_কন্ট্র্যাক্টিং_ডাইমেনশনস' পুনরাবৃত্তি int64 'আরএইচএস' চুক্তি আকারের সংখ্যা
'এলএইচএস_বাচ_ডিমেন্টস' পুনরাবৃত্তি int64 'lhs' ব্যাচের মাত্রা সংখ্যা
'আরএইচএস_বাচ_ডিমেন্টস' পুনরাবৃত্তি int64 'আরএইচএস' ব্যাচের মাত্রা সংখ্যা

ডটজেনারাল 'মাত্রা_সংখ্যায়' নির্দিষ্ট করে দেওয়া চুক্তির মাত্রাগুলির উপরে পণ্যের যোগফল সম্পাদন করে।

'Lhs' এবং 'আরএইচএস' এর সাথে যুক্ত চুক্তিভিত্তিক সংখ্যার সংখ্যাগুলি একই হওয়ার দরকার নেই তবে একই মাত্রার আকার থাকতে হবে।

মাত্রা সংখ্যার চুক্তি সহ উদাহরণ:

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' এবং 'আরএইচএস' থেকে যুক্ত ব্যাচের মাত্রা সংখ্যার একই মাত্রা আকার থাকতে হবে।

ব্যাচের মাত্রা সংখ্যার উদাহরণ (ব্যাচের আকার 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} } }
ইনপুট আউটপুট শব্দার্থবিজ্ঞান
[বি0, এম, কে] dot [বি0, কে, এন] [বি0, মি, এন] ব্যাচ ম্যাটমুল
[বি0, বি 1, এম, কে] dot [বি0, বি 1, কে, এন] [বি0, বি 1, মি, এন] ব্যাচ ম্যাটমুল

এটি অনুসরণ করে যে ফলাফলের মাত্রা সংখ্যাটি ব্যাচের মাত্রা দিয়ে শুরু হয়, তারপরে 'lhs' নন-কন্ট্রাক্টিং / নন-ব্যাচ মাত্রা এবং অবশেষে 'আরএইচএস' নন-কন্ট্রাক্টিং / নন-ব্যাচের মাত্রা।

ডায়নামিকস্লাইস

XlaBuilder::DynamicSlice আরও দেখুন।

ডায়নামিকস্লাইস গতিশীল start_indices ইনপুট অ্যারে থেকে একটি উপ-অ্যারে বের করে। প্রতিটি মাত্রায় size_indices আকার size_indices পাস হয়, যা প্রতিটি মাত্রায় একচেটিয়া স্লাইস অন্তরগুলির শেষ বিন্দু নির্দিষ্ট করে: [শুরু, প্রারম্ভ + আকার)। start_indices অবশ্যই operand র‌্যাঙ্কের সমান মাত্রা আকারের সাথে == 1 হতে হবে।

DynamicSlice(operand, start_indices, size_indices)

যুক্তি প্রকার শব্দার্থবিজ্ঞান
operand XlaOp টাইপ টি এর N মাত্রিক অ্যারে
start_indices এন XlaOp ক্রম প্রতিটি মাত্রার জন্য স্লাইসের প্রারম্ভিক সূচকগুলি সমেত এন স্কেলারের পূর্ণসংখ্যার তালিকা। মানটি শূন্যের চেয়ে বড় বা সমান হতে হবে।
size_indices ArraySlice<int64> প্রতিটি মাত্রার জন্য স্লাইস আকারযুক্ত এন পূর্ণসংখ্যার তালিকা। প্রতিটি মান অবশ্যই শূন্যের চেয়ে কঠোরতর হতে হবে এবং মডুলোর মাত্রা আকার মোড়ানো এড়াতে শুরু + আকার মাত্রার আকারের চেয়ে কম বা সমান হতে হবে।

কার্যকর ফালি সূচকের প্রতিটি সূচক জন্য নিম্নলিখিত রূপান্তর প্রয়োগের দ্বারা নির্ণিত হয় i[1, N) ফালি করণ আগে:

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}

দ্বিমাত্রিক উদাহরণ:

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

ডায়নামিকআপডেটস্লাইস

XlaBuilder::DynamicUpdateSlice

DynamicUpdateSlice ফলে যা ইনপুট অ্যারের মান উত্পন্ন operand , একটি ফালি সঙ্গে update এ ওভাররাইট start_indicesupdate আকারটি update ফলাফলের সাব-অ্যারের আকার নির্ধারণ করে। start_indices অবশ্যই operand র‌্যাঙ্কের সমান মাত্রা আকারের সাথে == 1 হতে হবে।

DynamicUpdateSlice(operand, update, start_indices)

যুক্তি প্রকার শব্দার্থবিজ্ঞান
operand XlaOp টাইপ টি এর N মাত্রিক অ্যারে
update XlaOp স্লাইস আপডেটযুক্ত টি টাইপ টি এর টি মাত্রিক অ্যারে। 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};
}