xref: /aosp_15_r20/external/tensorflow/tensorflow/compiler/xla/service/convolution_group_converter.h (revision b6fb3261f9314811a0f4371741dbb8839866f948)
1 /* Copyright 2018 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_CONVOLUTION_GROUP_CONVERTER_H_
17 #define TENSORFLOW_COMPILER_XLA_SERVICE_CONVOLUTION_GROUP_CONVERTER_H_
18 
19 #include <functional>
20 
21 #include "absl/strings/string_view.h"
22 #include "tensorflow/compiler/xla/service/hlo_module.h"
23 #include "tensorflow/compiler/xla/service/hlo_pass_interface.h"
24 #include "tensorflow/compiler/xla/status_macros.h"
25 
26 namespace xla {
27 
28 // A pass which rewrites convolutions with feature_group_count > 1 into
29 // convolutions with feature_group_count = 1.
30 class ConvolutionGroupConverter : public HloModulePass {
31  public:
32   ConvolutionGroupConverter(std::function<bool(HloInstruction*)> should_expand,
33                             std::function<bool(HloInstruction*)> is_cost_viable,
34                             bool convert_batch_groups_only,
35                             bool filter_expansion = true)
should_expand_(should_expand)36       : should_expand_(should_expand),
37         is_cost_viable_(is_cost_viable),
38         convert_batch_groups_only_(convert_batch_groups_only),
39         filter_expansion_(filter_expansion) {}
40 
name()41   absl::string_view name() const override {
42     return "convolution-group-converter";
43   }
44 
45   // Run convolution rewriting on the given computation. Returns whether the
46   // computation was changed.
47   using HloPassInterface::Run;
48   StatusOr<bool> Run(
49       HloModule* module,
50       const absl::flat_hash_set<absl::string_view>& execution_threads) override;
51 
52   // Predicate that determines whether this pass should rewrite a given
53   // convolution.
54   std::function<bool(HloInstruction*)> should_expand_;
55 
56   // Lambda containing cost model that decides whether to expand
57   // batch_group_count.
58   std::function<bool(HloInstruction*)> is_cost_viable_;
59 
60   // Decides whether to convert batch groups or feature groups.
61   bool convert_batch_groups_only_;
62 
63   // Tells whether filter expansion is required.
64   bool filter_expansion_;
65 };
66 
67 }  // namespace xla
68 
69 #endif  // TENSORFLOW_COMPILER_XLA_SERVICE_CONVOLUTION_GROUP_CONVERTER_H_
70