net_op.h 3.0 KB
Newer Older
S
Superjom 已提交
1 2
/* Copyright (c) 2016 PaddlePaddle Authors. All Rights Reserve.

Q
Qiao Longfei 已提交
3 4 5
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
S
Superjom 已提交
6

Q
Qiao Longfei 已提交
7
    http://www.apache.org/licenses/LICENSE-2.0
S
Superjom 已提交
8

Q
Qiao Longfei 已提交
9 10 11 12 13
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. */
S
Superjom 已提交
14 15 16

#pragma once

Y
Yan Chunwei 已提交
17
#include "paddle/framework/op_desc.pb.h"
D
dongzhihong 已提交
18
#include "paddle/framework/op_proto.pb.h"
Q
Qiao Longfei 已提交
19
#include "paddle/framework/op_registry.h"
Y
Yan Chunwei 已提交
20
#include "paddle/framework/operator.h"
S
Superjom 已提交
21
#include "paddle/framework/scope.h"
Y
Yan Chunwei 已提交
22
#include "paddle/operators/type_alias.h"
D
dongzhihong 已提交
23
#include "paddle/platform/device_context.h"
S
Superjom 已提交
24 25

namespace paddle {
Y
Yan Chunwei 已提交
26 27
namespace operators {

S
Superjom 已提交
28
/**
Q
Qiao Longfei 已提交
29 30 31
 * @brief Network is also a type of Operator
 *
 * It will manage the operators it has.
S
Superjom 已提交
32
 *
Q
Qiao Longfei 已提交
33
 * Network is the container and controller of a set of operators.
S
Superjom 已提交
34 35 36 37 38

 * A network object knows all Operators belonging to this network. Variables,
 * which are inputs and outputs of these operators, are created and managed by a
 * hierarchy of Scope objects.
 *
Q
Qiao Longfei 已提交
39
 * This is the base class of network, all the networks should implement the APIs
S
Superjom 已提交
40 41
 * it defines.
 */
Y
Yan Chunwei 已提交
42
class NetOp : public framework::OperatorBase {
43
 public:
S
Superjom 已提交
44
  /**
Q
Qiao Longfei 已提交
45
   * Infer all the operators' input and output variables' shapes, will be called
S
Superjom 已提交
46 47
   * before every mini-batch
   */
Y
Yan Chunwei 已提交
48
  void InferShape(const framework::Scope& scope) const override {
Q
Qiao Longfei 已提交
49 50 51 52
    for (auto& op : ops_) {
      op->InferShape(scope);
    }
  }
S
Superjom 已提交
53 54 55 56 57 58 59 60

  /**
   * @brief Run the network.
   *
   * Run all the operators with the `scope`, if no scope is provided, default
   * scope will be used instead. If no OpContext is provicded, default context
   * will be used.
   */
Y
Yan Chunwei 已提交
61
  void Run(const framework::Scope& scope,
Q
Qiao Longfei 已提交
62 63 64 65 66
           const platform::DeviceContext& dev_ctx) const override {
    for (auto& op : ops_) {
      op->Run(scope, dev_ctx);
    }
  }
S
Superjom 已提交
67 68

  /**
Q
Qiao Longfei 已提交
69
   * @brief Add an operator by ptr
S
Superjom 已提交
70
   */
Y
Yu Yang 已提交
71
  void AddOp(const std::shared_ptr<OperatorBase>& op) {
Q
Qiao Longfei 已提交
72
    PADDLE_ENFORCE(!add_op_done_, "Cannot AddOp when this network is sealed");
Y
Yan Chunwei 已提交
73
    PADDLE_ENFORCE_NOT_NULL(op, "Cannot Insert Null op");
Q
Qiao Longfei 已提交
74 75
    ops_.push_back(op);
  }
S
Superjom 已提交
76

Y
Yu Yang 已提交
77 78 79
  void InsertOp(size_t pos, const std::shared_ptr<OperatorBase>& op) {
    PADDLE_ENFORCE(!add_op_done_,
                   "Cannot InsertOp when this network is sealed");
Y
Yan Chunwei 已提交
80 81
    PADDLE_ENFORCE_NOT_NULL(op, "Cannot Insert Null op");
    PADDLE_ENFORCE_LE(pos, ops_.size(), "Out of range");
Y
Yu Yang 已提交
82 83 84
    ops_.insert(ops_.begin() + pos, op);
  }

Y
Yu Yang 已提交
85
  void CompleteAddOp(bool calculate = true);
S
Superjom 已提交
86

87 88
  std::string DebugString() const override;

Y
Yu Yang 已提交
89 90
  bool IsNetOp() const override;

Y
Yu Yang 已提交
91
  std::vector<std::shared_ptr<OperatorBase>> ops_;
S
Superjom 已提交
92

93
 private:
Q
Qiao Longfei 已提交
94 95 96 97 98 99
  bool add_op_done_{false};

  template <typename T, typename KeyType>
  static bool Contains(T container, KeyType key) {
    return container.find(key) != container.end();
  }
S
Superjom 已提交
100 101
};

Y
Yan Chunwei 已提交
102
}  // namespace operators
S
Superjom 已提交
103
}  // namespace paddle