Home | History | Annotate | Download | only in util
      1 /* Copyright 2015 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_UTIL_PADDING_H_
     17 #define TENSORFLOW_UTIL_PADDING_H_
     18 
     19 // This file contains helper routines to deal with padding in various ops and
     20 // kernels.
     21 
     22 #include <string>
     23 
     24 #include "tensorflow/core/lib/core/status.h"
     25 
     26 namespace tensorflow {
     27 
     28 class NodeDef;
     29 
     30 // Padding: the padding we apply to the input tensor along the rows and columns
     31 // dimensions. This is usually used to make sure that the spatial dimensions do
     32 // not shrink when we progress with convolutions. Two types of padding are
     33 // supported:
     34 //   VALID: No padding is carried out.
     35 //   SAME: The pad value is computed so that the output will have the same
     36 //         dimensions as the input.
     37 // The padded area is zero-filled.
     38 enum Padding {
     39   VALID = 1,  // No padding.
     40   SAME = 2,   // Input and output layers have the same size.
     41 };
     42 
     43 // Return the string containing the list of valid padding types, that can be
     44 // used as an Attr() in REGISTER_OP.
     45 string GetPaddingAttrString();
     46 
     47 // Specialization to parse an attribute directly into a Padding enum.
     48 Status GetNodeAttr(const NodeDef& node_def, StringPiece attr_name,
     49                    Padding* value);
     50 
     51 }  // end namespace tensorflow
     52 
     53 #endif  // TENSORFLOW_UTIL_PADDING_H_
     54