24 #ifndef MXNET_ENGINE_H_ 25 #define MXNET_ENGINE_H_ 47 virtual ~Var() =
default;
76 inline void operator()(
const dmlc::Error* error =
nullptr)
const {
77 (*callback_)(engine_, param_, error);
82 friend class ::mxnet::Engine;
84 void (*callback_)(
Engine *,
void *,
const dmlc::Error *);
121 typedef std::function<void(RunContext)>
SyncFn;
123 typedef std::function<void(RunContext, CallbackOnComplete)>
AsyncFn;
135 virtual void NotifyShutdown() = 0;
140 LOG(FATAL) <<
"Engine cannot be stopped";
146 LOG(FATAL) <<
"Engine cannot be restarted";
154 virtual VarHandle NewVariable() = 0;
167 virtual OprHandle NewOperator(AsyncFn fn,
168 std::vector<VarHandle>
const& const_vars,
169 std::vector<VarHandle>
const& mutable_vars,
171 const char* opr_name =
nullptr,
172 bool wait =
false) = 0;
180 virtual void DeleteOperator(OprHandle op) = 0;
188 virtual void Push(OprHandle op,
Context exec_ctx,
int priority = 0,
bool profiling =
false) = 0;
203 virtual void PushAsync(AsyncFn exec_fun,
Context exec_ctx,
204 std::vector<VarHandle>
const& const_vars,
205 std::vector<VarHandle>
const& mutable_vars,
208 const char* opr_name =
nullptr,
209 bool wait =
false) = 0;
221 virtual void DeleteVariable(SyncFn delete_fn,
229 virtual void WaitForVar(VarHandle var) = 0;
233 virtual void WaitForAll() = 0;
235 virtual void Throw(VarHandle var) = 0;
250 static std::shared_ptr<Engine> _GetSharedRef();
264 std::vector<VarHandle>
const& const_vars,
265 std::vector<VarHandle>
const& mutable_vars,
268 const char* opr_name =
nullptr) {
269 this->PushAsync([exec_fn](
RunContext ctx, CallbackOnComplete on_complete) {
272 }, exec_ctx, const_vars, mutable_vars, prop, priority, opr_name);
281 void (*callback)(
Engine *,
void *,
const dmlc::Error *),
void *param) {
282 CallbackOnComplete ret;
283 ret.callback_ = callback;
291 std::vector<engine::VarHandle> *write_vars) {
292 std::sort(write_vars->begin(), write_vars->end());
293 write_vars->resize(std::unique(write_vars->begin(), write_vars->end()) -
294 write_vars->begin());
295 std::sort(read_vars->begin(), read_vars->end());
296 read_vars->resize(std::unique(read_vars->begin(), read_vars->end()) -
298 auto wit = write_vars->begin();
299 auto rtop = read_vars->begin();
300 for (
auto rit = read_vars->begin(); rit != read_vars->end(); ++rit) {
301 while (wit != write_vars->end() && *wit < *rit) ++wit;
302 if (wit == write_vars->end() || *wit != *rit) {
307 read_vars->resize(rtop - read_vars->begin());
318 #endif // DMLC_USE_CXX11 320 #endif // MXNET_ENGINE_H_ void DeduplicateVarHandle(std::vector< engine::VarHandle > *read_vars, std::vector< engine::VarHandle > *write_vars)
Definition: engine.h:290
FnProperty
Function property, used to hint what action is pushed to engine.
Definition: engine.h:94
virtual void Stop()
Stop all workers in the engine.
Definition: engine.h:139
std::function< void(RunContext)> SyncFn
Synchronous operation to pass to engine.
Definition: engine.h:121
virtual int bulk_size() const
query current limit for bulk size
Definition: engine.h:310
std::function< void(RunContext, CallbackOnComplete)> AsyncFn
Asynchronous operation to pass to engine.
Definition: engine.h:123
Operation not to be skipped even with associated exception.
size_t version_
version number of the var. Every time the object it is associated with is modified, the version number is incremented by 1.
Definition: engine.h:59
namespace of mxnet
Definition: api_registry.h:33
Asynchronous function call.
execution time context. The information needed in runtime for actual execution.
Definition: base.h:349
base class of engine variables.
Definition: engine.h:43
virtual ~Engine() noexcept(false)
virtual destructor
Definition: engine.h:237
CallbackOnComplete CreateCallback(void(*callback)(Engine *, void *, const dmlc::Error *), void *param)
factory function to create OnComplete callback.
Definition: engine.h:280
Prioritized sync operation on GPU.
virtual void Start()
Restart all workers in the engine.
Definition: engine.h:145
Copy operation from GPU to other devices.
virtual int set_bulk_size(int)
set maximum limit for bulk size
Definition: engine.h:314
engine::OprHandle OprHandle
Operator pointer.
Definition: engine.h:127
engine::VarHandle VarHandle
Variable pointer.
Definition: engine.h:125
Var * VarHandle
Variable pointer type, usually hold by user used to specify dependencies.
Definition: engine.h:63
Prioritized sync operation on CPU.
engine::CallbackOnComplete CallbackOnComplete
callback on complete
Definition: engine.h:119
virtual void PushSync(SyncFn exec_fn, Context exec_ctx, std::vector< VarHandle > const &const_vars, std::vector< VarHandle > const &mutable_vars, FnProperty prop=FnProperty::kNormal, int priority=0, const char *opr_name=nullptr)
Push an synchronous operation to the engine.
Definition: engine.h:263
Dependency engine that schedules operations.
Definition: engine.h:116
void operator()(const dmlc::Error *error=nullptr) const
involve the callback
Definition: engine.h:76
OnComplete Callback to the engine, called by AsyncFn when action completes.
Definition: engine.h:72
T * Cast()
cast variable to derived type T
Context information about the execution environment.
Definition: base.h:101
#define MXNET_API
define compatible keywords in g++ Used to support g++-4.6 and g++4.7
Definition: base.h:62
Copy operation from CPU to other devices.
Opr * OprHandle
Operator pointer type, usually hold by user.
Definition: engine.h:67
virtual size_t version()
Definition: engine.h:44