xref: /aosp_15_r20/external/tensorflow/tensorflow/compiler/xla/service/all_gather_combiner.h (revision b6fb3261f9314811a0f4371741dbb8839866f948)
1 /* Copyright 2020 The TensorFlow Authors. All Rights Reserved.
2 
3 Licensed under the Apache License, Version 2.0 (the "License");
4 you may not use this file except in compliance with the License.
5 You may obtain a copy of the License at
6 
7     http://www.apache.org/licenses/LICENSE-2.0
8 
9 Unless required by applicable law or agreed to in writing, software
10 distributed under the License is distributed on an "AS IS" BASIS,
11 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 See the License for the specific language governing permissions and
13 limitations under the License.
14 ==============================================================================*/
15 
16 #ifndef TENSORFLOW_COMPILER_XLA_SERVICE_ALL_GATHER_COMBINER_H_
17 #define TENSORFLOW_COMPILER_XLA_SERVICE_ALL_GATHER_COMBINER_H_
18 
19 #include "absl/strings/string_view.h"
20 #include "tensorflow/compiler/xla/array2d.h"
21 #include "tensorflow/compiler/xla/service/hlo_module.h"
22 #include "tensorflow/compiler/xla/service/hlo_pass_interface.h"
23 #include "tensorflow/compiler/xla/statusor.h"
24 #include "tensorflow/compiler/xla/xla_data.pb.h"
25 
26 namespace xla {
27 
28 // Combines small non-dependent AllGather ops into larger combined
29 // AllGather ops. A typical AllGather implementation has a minimum
30 // latency-induced time for a AllGather op so a single combined op can be
31 // more efficient than many small ones.
32 class AllGatherCombiner : public HloModulePass {
33  public:
34   AllGatherCombiner(int64_t combine_threshold_in_bytes,
35                     int64_t combine_threshold_count);
36 
name()37   absl::string_view name() const override { return "all-gather-combiner"; }
38 
39   using HloPassInterface::Run;
40   StatusOr<bool> Run(
41       HloModule* module,
42       const absl::flat_hash_set<absl::string_view>& execution_threads) override;
43 
44  private:
45   // Combine all gather ops up to this threshold.
46   int64_t combine_threshold_in_bytes_;
47 
48   // Combine all gather ops up to this threshold (number of operands).
49   int64_t combine_threshold_count_;
50 };
51 
52 }  // namespace xla
53 
54 #endif  // TENSORFLOW_COMPILER_XLA_SERVICE_ALL_GATHER_COMBINER_H_
55