xref: /aosp_15_r20/external/tensorflow/tensorflow/compiler/xla/service/all_reduce_folder.h (revision b6fb3261f9314811a0f4371741dbb8839866f948)
1 /* Copyright 2021 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_REDUCE_FOLDER_H_
17 #define TENSORFLOW_COMPILER_XLA_SERVICE_ALL_REDUCE_FOLDER_H_
18 
19 #include "tensorflow/compiler/xla/service/hlo_module.h"
20 #include "tensorflow/compiler/xla/service/hlo_pass_interface.h"
21 #include "tensorflow/compiler/xla/statusor.h"
22 
23 namespace xla {
24 
25 // A pass that folds an all-reduce feeding into another all-reduce by expanding
26 // the replica groups. As an example:
27 //
28 //   ar0 = all-reduce(x) replica_groups={{0,1},{2,3},{4,5},{6,7}}
29 //   ar1 = all-reduce(all-reduce0) replica_groups={{0,2},{1,3},{4,6},{5,7}}
30 //
31 //  Can be combined into a single all-reduce:
32 //
33 //   ar1 = all-reduce(x) replica_groups={{0,1,2,3},{4,5,6,7}}
34 //
35 
36 class AllReduceFolder : public HloModulePass {
37  public:
name()38   absl::string_view name() const override { return "all-reduce-folder"; }
39 
40   using HloPassInterface::Run;
41   StatusOr<bool> Run(
42       HloModule* module,
43       const absl::flat_hash_set<absl::string_view>& execution_threads) override;
44 };
45 
46 }  // namespace xla
47 
48 #endif  // TENSORFLOW_COMPILER_XLA_SERVICE_ALL_REDUCE_FOLDER_H_
49