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"""Utilities for reduce operations.""" 16 17from __future__ import absolute_import 18from __future__ import division 19from __future__ import print_function 20 21import enum 22 23from tensorflow.python.ops import variable_scope 24from tensorflow.python.util.tf_export import tf_export 25 26 27@tf_export("distribute.ReduceOp") 28class ReduceOp(enum.Enum): 29 """Indicates how a set of values should be reduced. 30 31 * `SUM`: Add all the values. 32 * `MEAN`: Take the arithmetic mean ("average") of the values. 33 """ 34 # TODO(priyag): Add the following types: 35 # `MIN`: Return the minimum of all values. 36 # `MAX`: Return the maximum of all values. 37 SUM = "SUM" 38 MEAN = "MEAN" 39 40 @staticmethod 41 def from_variable_aggregation(aggregation): 42 mapping = { 43 variable_scope.VariableAggregation.SUM: ReduceOp.SUM, 44 variable_scope.VariableAggregation.MEAN: ReduceOp.MEAN, 45 } 46 47 reduce_op = mapping.get(aggregation) 48 if not reduce_op: 49 raise ValueError("Could not convert from `tf.VariableAggregation` %s to" 50 "`tf.distribute.ReduceOp` type" % aggregation) 51 return reduce_op 52