executor.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */

#ifndef MXNET_EXECUTOR_H_
#define MXNET_EXECUTOR_H_

#include <dmlc/base.h>
#include <vector>
#include <memory>
#include <map>
#include <string>
#include <utility>
#include "./base.h"
#include "./c_api.h"
#include "./ndarray.h"
#include "./operator.h"

// check c++11
#if DMLC_USE_CXX11 == 0
#error "CXX11 was required for symbolic module"
#endif

namespace mxnet {
using nnvm::Symbol;

class Executor {
 public:
  virtual ~Executor() {}
  virtual void Forward(bool is_train) = 0;
  virtual void PartialForward(bool is_train, int step, int *step_left) = 0;
  virtual void Backward(const std::vector<NDArray> &head_grads, bool is_train = true) = 0;
  virtual void Print(std::ostream &os) const {} // NOLINT(*)
 virtual const std::vector<NDArray> &outputs() const = 0;
  virtual const std::unordered_map<std::string, NDArray>& in_arg_map() const = 0;
  virtual const std::unordered_map<std::string, NDArray>& arg_grad_map() const = 0;
  virtual const std::unordered_map<std::string, NDArray>& aux_state_map() const = 0;
  virtual Executor* Reshape(const bool partial_shaping,
                            const bool allow_up_sizing,
                            const Context& default_ctx,
                            const std::map<std::string, Context>& ctx_map,
                            const std::unordered_map<std::string, TShape>&
                              provided_arg_shapes,
                            std::vector<NDArray>* in_args,
                            std::vector<NDArray>* arg_grads,
                            std::vector<NDArray>* aux_states) = 0;
  static Executor *Bind(nnvm::Symbol symbol,
                        const Context& default_ctx,
                        const std::map<std::string, Context>& group2ctx,
                        const std::vector<NDArray> &in_args,
                        const std::vector<NDArray> &arg_grad_store,
                        const std::vector<OpReqType> &grad_req_type,
                        const std::vector<NDArray> &aux_states,
                        Executor* shared_exec = NULL);

  static Executor* SimpleBind(nnvm::Symbol symbol,
                              const Context& default_ctx,
                              const std::map<std::string, Context>& group2ctx,
                              const std::vector<Context>& in_arg_ctxes,
                              const std::vector<Context>& arg_grad_ctxes,
                              const std::vector<Context>& aux_state_ctxes,
                              const std::unordered_map<std::string, TShape>& arg_shape_map,
                              const std::unordered_map<std::string, int>& arg_dtype_map,
                              const std::unordered_map<std::string, int>& arg_stype_map,
                              const std::vector<OpReqType>& grad_req_types,
                              const std::unordered_set<std::string>& param_names,
                              std::vector<NDArray>* in_args,
                              std::vector<NDArray>* arg_grads,
                              std::vector<NDArray>* aux_states,
                              std::unordered_map<std::string, NDArray>*
                                shared_data_arrays = nullptr,
                              Executor* shared_exec = nullptr);

  typedef std::function<void(const char*, void*)> MonitorCallback;
  virtual void SetMonitorCallback(const MonitorCallback& callback) {}
};  // class executor
}  // namespace mxnet
#endif  // MXNET_EXECUTOR_H_