mxnet
op_attr_types.h
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements. See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership. The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the
7  * "License"); you may not use this file except in compliance
8  * with the License. You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing,
13  * software distributed under the License is distributed on an
14  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15  * KIND, either express or implied. See the License for the
16  * specific language governing permissions and limitations
17  * under the License.
18  */
19 
26 #ifndef MXNET_OP_ATTR_TYPES_H_
27 #define MXNET_OP_ATTR_TYPES_H_
28 
29 #include <mshadow/tensor.h>
30 #include <nnvm/op_attr_types.h>
31 
32 #include <vector>
33 #include <functional>
34 
35 #include "./base.h"
36 #include "./ndarray.h"
37 #include "./engine.h"
38 #include "./resource.h"
39 
40 namespace mxnet {
41 
42 using nnvm::NodeAttrs;
43 
45 enum OpReqType {
58 };
59 
66 struct OpContext {
68  bool need_grad;
70  bool is_train;
76  std::vector<Resource> requested;
82  template<typename xpu>
83  inline mshadow::Stream<xpu>* get_stream() const {
84  return run_ctx.get_stream<xpu>();
85  }
86 };
87 
89 enum class ExecType {
91  kSync,
96  kAsync,
110 };
111 
113 enum class DispatchMode {
114  kUndefined = -1,
115  // dispatch on FCompute or FStatefulCompute
116  kFCompute,
117  // dispatch on FComputeEx or FStatefulComputeEx, if available
118  kFComputeEx,
119  // dispatch on FCompute or FStatefulCompute, and performs storage fallback
121  // special dispatch mode for variables
122  kVariable,
123 };
124 
129 class OpStatePtr {
130  public:
131  /* \brief Create a OpStatePtr with state of type T.
132  * \param args Arguments passed to T's constructor.
133  */
134  template<typename T, typename... Args>
135  static OpStatePtr Create(Args&&... args) {
136  OpStatePtr ret;
137  auto state = new T(std::forward<Args>(args)...);
138  auto var = Engine::Get()->NewVariable();
139  ret.ptr_.reset(
140  new OpState(var, state),
141  [](OpState* p) {
142  Engine::Get()->DeleteVariable([](RunContext s) {}, Context::CPU(), p->var);
143  delete reinterpret_cast<T*>(p->state);
144  delete p;
145  });
146 
147  return ret;
148  }
149  /* \brief Get engine variable associated with this state */
151  return ptr_->var;
152  }
153  /* \brief Get state of type T */
154  template<typename T>
155  T& get_state() const {
156  return *reinterpret_cast<T*>(ptr_->state);
157  }
158  /* \brief clear state */
159  void reset() {
160  ptr_.reset();
161  }
162  /* \brief checks whether the managed object is managed only by the current
163  OpStatePtr instance */
164  bool unique() const {
165  return ptr_.unique();
166  }
167  /* \brief Whether state is empty */
168  explicit operator bool() const {
169  return ptr_ ? true : false;
170  }
171 
172  private:
173  /* \brief state structure */
174  struct OpState {
175  engine::VarHandle var;
176  void* state;
177 
178  OpState(engine::VarHandle var_, void* state_) : var(var_), state(state_) {}
179  OpState(const OpState& other) = delete;
180  OpState& operator=(const OpState& other) = delete;
181  };
182  /* \brief shared pointer to state */
183  std::shared_ptr<OpState> ptr_;
184 };
185 
198 using FCreateOpState = std::function<OpStatePtr (const NodeAttrs& attrs,
199  Context ctx,
200  const std::vector<TShape>& in_shape,
201  const std::vector<int>& in_type)>;
205 using FExecType = std::function<ExecType (const NodeAttrs& attrs)>;
213 using FStatefulCompute = std::function<void (const OpStatePtr& state,
214  const OpContext& ctx,
215  const std::vector<TBlob>& inputs,
216  const std::vector<OpReqType>& req,
217  const std::vector<TBlob>& outputs)>;
225 using FStatefulComputeEx = std::function<void (const OpStatePtr& state,
226  const OpContext& ctx,
227  const std::vector<NDArray>& inputs,
228  const std::vector<OpReqType>& req,
229  const std::vector<NDArray>& outputs)>;
236 using FResourceRequest = std::function<
237  std::vector<ResourceRequest> (const NodeAttrs& n)>;
244 using FResourceRequestEx = std::function<
245  std::vector<ResourceRequest> (const NodeAttrs& n,
246  const int dev_mask,
247  const DispatchMode dispatch_mode)>;
253 using FNDArrayFunction = std::function<void (const nnvm::NodeAttrs& attrs,
254  const std::vector<NDArray>& inputs,
255  std::vector<NDArray>* outputs)>;
261 using FCompute = std::function<void (const nnvm::NodeAttrs& attrs,
262  const OpContext& ctx,
263  const std::vector<TBlob>& inputs,
264  const std::vector<OpReqType>& req,
265  const std::vector<TBlob>& outputs)>;
271 using FComputeEx = std::function<void (const nnvm::NodeAttrs& attrs,
272  const OpContext& ctx,
273  const std::vector<NDArray>& inputs,
274  const std::vector<OpReqType>& req,
275  const std::vector<NDArray>& outputs)>;
276 
283 using FInferStorageType = std::function<bool (const NodeAttrs& attrs,
284  const int dev_mask,
285  DispatchMode* dispatch_mode,
286  std::vector<int>* in_attrs,
287  std::vector<int>* out_attrs)>;
288 
293 using FQuantizedOp = std::function<nnvm::NodePtr (const NodeAttrs& attrs)>;
294 
301 using FNeedRequantize = std::function<bool (const NodeAttrs& attrs)>;
302 
308 using FAvoidQuantizeInput = std::function<bool (const NodeAttrs& attrs,
309  size_t index)>;
310 
311 } // namespace mxnet
312 
313 #endif // MXNET_OP_ATTR_TYPES_H_
std::function< void(const OpStatePtr &state, const OpContext &ctx, const std::vector< TBlob > &inputs, const std::vector< OpReqType > &req, const std::vector< TBlob > &outputs)> FStatefulCompute
Resiger a compute function for stateful operator. OpStatePtr is a pointer type, it&#39;s content is mutab...
Definition: op_attr_types.h:217
void reset()
Definition: op_attr_types.h:159
Forward/Backward are synchronous calls.
Engine that schedules all the operations according to dependency.
no operation, do not write anything
Definition: op_attr_types.h:47
write gradient to provided space
Definition: op_attr_types.h:49
namespace of mxnet
Definition: base.h:118
std::function< std::vector< ResourceRequest >(const NodeAttrs &n)> FResourceRequest
The resource request from the operator. An operator could register ResourceRequestEx, or ResourceRequest, or neither.
Definition: op_attr_types.h:237
std::function< void(const OpStatePtr &state, const OpContext &ctx, const std::vector< NDArray > &inputs, const std::vector< OpReqType > &req, const std::vector< NDArray > &outputs)> FStatefulComputeEx
Resiger a compute function for stateful operator using NDArray interface. OpStatePtr is a pointer typ...
Definition: op_attr_types.h:229
mshadow::Stream< xpu > * get_stream() const
get mshadow stream from Context
Definition: base.h:270
std::function< bool(const NodeAttrs &attrs)> FNeedRequantize
Register a function to determine if the output of a quantized operator needs to be requantized...
Definition: op_attr_types.h:301
Asynchronous function call.
bool is_train
whether it is training phase
Definition: op_attr_types.h:70
engine::VarHandle get_var() const
Definition: op_attr_types.h:150
Cross device copy operation, this is a special operator that indicates it will copy across devices...
execution time context. The information needed in runtime for actual execution.
Definition: base.h:257
DispatchMode
the dispatch mode of the operator
Definition: op_attr_types.h:113
base class of engine variables.
Definition: engine.h:45
T & get_state() const
Definition: op_attr_types.h:155
engine::CallbackOnComplete async_on_complete
the callback when operation completes, used by asynchronize ops
Definition: op_attr_types.h:74
std::function< OpStatePtr(const NodeAttrs &attrs, Context ctx, const std::vector< TShape > &in_shape, const std::vector< int > &in_type)> FCreateOpState
Create a Layer style, forward/backward operator. This is easy to write code that contains state...
Definition: op_attr_types.h:201
All the possible information needed by Operator.Forward and Backward This is the superset of RunConte...
Definition: op_attr_types.h:66
NDArray interface that handles array arithematics.
std::function< ExecType(const NodeAttrs &attrs)> FExecType
Execution mode of this operator.
Definition: op_attr_types.h:205
virtual VarHandle NewVariable()=0
Allocate a new variable, the variable can then be used to schedule the operation concurrently via dep...
static OpStatePtr Create(Args &&...args)
Definition: op_attr_types.h:135
std::function< nnvm::NodePtr(const NodeAttrs &attrs)> FQuantizedOp
Register a quantized node creation function based on the attrs of the node.
Definition: op_attr_types.h:293
bool need_grad
whether there is a backward phase to compute gradients.
Definition: op_attr_types.h:68
std::function< void(const nnvm::NodeAttrs &attrs, const std::vector< NDArray > &inputs, std::vector< NDArray > *outputs)> FNDArrayFunction
Register an operator called as a NDArray function.
Definition: op_attr_types.h:255
Global resource allocation handling.
virtual void DeleteVariable(SyncFn delete_fn, Context exec_ctx, VarHandle var)=0
Schedule the deletion of a variable.
perform an inplace write, This option only happen when Target shares memory with one of input argumen...
Definition: op_attr_types.h:55
A subgraph execution should happen in the main thread, instead of in the execution engine...
bool unique() const
Definition: op_attr_types.h:164
OpReqType
operation request type to Forward and Backward
Definition: op_attr_types.h:45
std::function< void(const nnvm::NodeAttrs &attrs, const OpContext &ctx, const std::vector< NDArray > &inputs, const std::vector< OpReqType > &req, const std::vector< NDArray > &outputs)> FComputeEx
Resiger an NDArray compute function for simple stateless forward only operator.
Definition: op_attr_types.h:275
std::vector< Resource > requested
Resources requested by the operator.
Definition: op_attr_types.h:76
RunContext run_ctx
RunContext related resources.
Definition: op_attr_types.h:72
static Context CPU(int32_t dev_id=0)
std::function< void(const nnvm::NodeAttrs &attrs, const OpContext &ctx, const std::vector< TBlob > &inputs, const std::vector< OpReqType > &req, const std::vector< TBlob > &outputs)> FCompute
Resiger a compute function for simple stateless forward only operator.
Definition: op_attr_types.h:265
OnComplete Callback to the engine, called by AsyncFn when action completes.
Definition: engine.h:74
configuration of MXNet as well as basic data structure.
static Engine * Get()
std::function< bool(const NodeAttrs &attrs, const int dev_mask, DispatchMode *dispatch_mode, std::vector< int > *in_attrs, std::vector< int > *out_attrs)> FInferStorageType
Resiger a storage and dispatch mode inference function based on storage types of the inputs and outpu...
Definition: op_attr_types.h:287
std::function< std::vector< ResourceRequest >(const NodeAttrs &n, const int dev_mask, const DispatchMode dispatch_mode)> FResourceRequestEx
The resource request from the operator. An operator could register ResourceRequestEx, or ResourceRequest, or neither.
Definition: op_attr_types.h:247
add to the provided space
Definition: op_attr_types.h:57
std::function< bool(const NodeAttrs &attrs, size_t index)> FAvoidQuantizeInput
Register a function to determine if the input of a quantized operator needs to be quantized...
Definition: op_attr_types.h:309
ExecType
the execution type of the operator
Definition: op_attr_types.h:89
Context information about the execution environment.
Definition: base.h:133
mshadow::Stream< xpu > * get_stream() const
get mshadow stream from Context
Definition: op_attr_types.h:83
Operator state. This is a pointer type, its content is mutable even if OpStatePtr is const...
Definition: op_attr_types.h:129