AverageLayer.h 1.7 KB
Newer Older
1
/* Copyright (c) 2016 PaddlePaddle Authors. All Rights Reserve.
Z
zhangjinchao01 已提交
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License. */

#pragma once

17
#include "SequencePoolLayer.h"
Z
zhangjinchao01 已提交
18 19 20 21 22 23 24
#include "paddle/math/Matrix.h"

namespace paddle {

/**
 * A layer for "internal average" for sequence input.
 * Input: one or more sequences. Each sequence contains some instances.
25
 * If SequenceLevel = kNonSeq:
Z
zhangjinchao01 已提交
26 27
 *    Output: output size is the number of input sequences (NOT input instances)
 *    output[i] = average_{for each instance in this sequence}{input[i]}
28
 * If SequenceLevel = kSeq:
Z
zhangjinchao01 已提交
29 30 31
 *    Check input sequence must has sub-sequence
 *    Output: output size is the number of input sub-sequences
 *    output[i] = average_{for each instance in this sub-sequence}{input[i]}
32 33
 *
 * The config file api is pooling_layer.
Z
zhangjinchao01 已提交
34
 */
35
class AverageLayer : public SequencePoolLayer {
Z
zhangjinchao01 已提交
36 37
public:
  enum AverageStrategy { kAverage = 0, kSum = 1, kAverageSquareRootN = 2 };
38 39
  explicit AverageLayer(const LayerConfig& config)
      : SequencePoolLayer(config) {}
Z
zhangjinchao01 已提交
40 41 42 43 44 45 46 47 48 49 50 51 52 53

  ~AverageLayer() {}

  bool init(const LayerMap& layerMap, const ParameterMap& parameterMap);

  void forward(PassType passType);
  void backward(const UpdateCallback& callback = nullptr);

protected:
  MatrixPtr outMtx_;
  MatrixPtr dataMtx_;
  int mode_;
};
}  // namespace paddle