dynamic custom operator support

Makefile

@@ -660,7 +660,7 @@ pylint:
 	python3 -m pylint --rcfile=$(ROOTDIR)/ci/other/pylintrc --ignore-patterns=".*\.so$$,.*\.dll$$,.*\.dylib$$" python/mxnet tools/caffe_converter/*.py
 
 sample_lib:
-	$(CXX) -shared -fPIC example/lib_api/mylib.cc -o libsample_lib.so -I include/mxnet
+	$(CXX) -shared -fPIC -std=c++11 example/lib_ops/mylib.cc -o libsample_lib.so -I include/mxnet
 
 doc: docs
 

example/lib_api/test.py

@@ -26,6 +26,8 @@
 import os
 
 if (os.name=='posix'):
-    mx.library.load('mylib.so')
+    path = os.path.abspath('mylib.so')
+    mx.library.load(path)
 elif (os.name=='nt'):
-    mx.library.load('mylib.dll')
+    path = os.path.abspath('mylib.so')
+    mx.library.load(path)

example/lib_ops/Makefile

@@ -0,0 +1,31 @@
+# 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.
+
+all:
+	g++ -shared -fPIC -std=gnu++0x mylib.cc -o mylib.so -I ../../include/mxnet
+
+test:
+	g++ -std=c++11 -O3 -o libtest libtest.cc -ldl -I ../../include/mxnet
+
+windows:
+	cl /LD mylib.cc
+
+win_test:
+	cl libtest.cc
+
+clean:
+	rm -rf mylib.so libtest

example/lib_ops/libtest.cc

@@ -0,0 +1,78 @@
+/*
+ * 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.
+ */
+
+/*!
+ * Copyright (c) 2019 by Contributors
+ * \file libtest.cc
+ * \brief This test checks if the library is implemented correctly
+ * and does not involve dynamic loading of library into MXNet
+ * This test is supposed to be run before test.py
+ */
+
+#if defined(_WIN32) || defined(_WIN64) || defined(__WINDOWS__)
+#include <windows.h>
+#else
+#include <dlfcn.h>
+#endif
+
+#include <iostream>
+#include "lib_api.h"
+
+#define MXNET_VERSION 10500
+
+int main(void) {
+  // Get a handle to the library.
+#if defined(_WIN32) || defined(_WIN64) || defined(__WINDOWS__)
+  HINSTANCE handle;
+  handle = LoadLibrary(TEXT("mylib.dll"));
+#else
+  void *handle;
+  handle = dlopen("mylib.so", RTLD_LAZY);
+#endif
+
+  if (!handle) {
+    std::cerr << "Unable to load library" << std::endl;
+    return 1;
+  }
+
+  // get initialize function address from the library
+  initialize_t init_lib;
+#if defined(_WIN32) || defined(_WIN64) || defined(__WINDOWS__)
+  init_lib = (initialize_t) GetProcAddress(handle, MXLIB_INITIALIZE_STR);
+#else
+  init_lib = (initialize_t) dlsym(handle, MXLIB_INITIALIZE_STR);
+#endif
+
+  if (!init_lib) {
+    std::cerr << "Unable to get function 'intialize' from library" << std::endl;
+    return 1;
+  }
+
+  // Call the function.
+  (init_lib)(MXNET_VERSION);
+
+  // Deallocate memory.
+#if defined(_WIN32) || defined(_WIN64) || defined(__WINDOWS__)
+  FreeLibrary(handle);
+#else
+  dlclose(handle);
+#endif
+
+  return 0;
+}

example/lib_ops/mylib.cc

@@ -0,0 +1,140 @@
+/*
+ * 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.
+ */
+
+/*!
+ * Copyright (c) 2019 by Contributors
+ * \file mylib.cc
+ * \brief Sample custom operator implementation
+ * library file
+ */
+
+#include <iostream>
+#include "lib_api.h"
+
+/*
+ * main matrix multiplication routine
+ */
+void gemm(float* A, float* B, float* C, unsigned n, unsigned k, unsigned m) {
+  unsigned i,j,kk;
+  for (i=0;i<n;i++) {
+    for (j=0;j<m;j++) {
+      C[i*m+j] = 0;
+      for (kk=0;kk<k;kk++) {
+        C[i*m+j] += A[i*k+kk] * B[kk*m+j];
+      }
+    }
+  }
+}
+
+
+int myFCompute(std::map<std::string,std::string> attrs,
+               std::vector<MXTensor> inputs, std::vector<MXTensor> outputs) {
+  //validate inputs
+  for(int i=0; i<inputs.size(); i++) {
+    if(inputs[i].dtype != kFloat32) {
+      std::cout << "Expected input " << i << " to have float32 type" << std::endl;
+      return 0;
+    }
+  }
+
+  //extract data pointers from tensors
+  float* input1 = inputs[0].getData<float>();
+  float* input2 = inputs[1].getData<float>();
+  float* output = outputs[0].getData<float>();
+  //set tensor shapes
+  unsigned n = inputs[0].shape[0];
+  unsigned k = inputs[0].shape[1];
+  unsigned m = inputs[1].shape[1];
+
+  gemm(input1, input2, output, n, k, m);
+
+  return 1; //no error
+}
+
+int parseAttrs(std::map<std::string,std::string> attrs,
+               int* num_in, int* num_out) {
+  /*
+  if(attrs.find("myParam") == attrs.end()) {
+    std::cout << "Missing param 'myParam'" << std::endl;
+    return 0;
+  }
+  */
+  *num_in = 2;
+  *num_out = 1;
+
+  return 1; //no error
+}
+
+int inferType(std::map<std::string,std::string> attrs, std::vector<int> &intypes,
+              std::vector<int> &outtypes) {
+  outtypes[0] = intypes[0];
+
+  return 1; //no error
+}
+
+int inferShape(std::map<std::string,std::string> attrs, std::vector<std::vector<unsigned int>> &inshapes,
+               std::vector<std::vector<unsigned int>> &outshapes) {
+  //validate inputs
+  if(inshapes.size() != 2) {
+    std::cout << "Expected 2 inputs to inferShape" << std::endl;
+    return 0;
+  }
+
+  if(inshapes[0].size() != 2) {
+    std::cout << "Expected 2D for first input to inferShape" << std::endl;
+    return 0;
+  }
+
+  if(inshapes[1].size() != 2) {
+    std::cout << "Expected 2D for second input to inferShape" << std::endl;
+    return 0;
+  }
+
+  unsigned n = inshapes[0][0];
+  unsigned k = inshapes[0][1];
+  unsigned kk = inshapes[1][0];
+  unsigned m = inshapes[1][1];
+
+  std::cout << "inshapes[0][0]=" << n << "  inshapes[0][1]=" << k << std::endl;
+  std::cout << "inshapes[1][0]=" << kk << "  inshapes[1][1]=" << m << std::endl;
+
+  if(k != kk) return 0;
+
+  outshapes[0].push_back(n);
+  outshapes[0].push_back(m);
+
+  return 1; //no error
+}
+
+REGISTER_OP(sam)
+.setFCompute(myFCompute)
+.setParseAttrs(parseAttrs)
+.setInferType(inferType)
+.setInferShape(inferShape);
+
+int initialize(int version) {
+  if (version >= 10400) {
+    std::cout << "MXNet version " << version << " supported" << std::endl;
+    return 1;
+  } else {
+    std::cout << "MXNet version " << version << " not supported" << std::endl;
+    return 0;
+  }
+}
+

example/lib_ops/test.py

@@ -0,0 +1,46 @@
+#!/usr/bin/env python3
+
+# 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.
+
+# coding: utf-8
+# pylint: disable=arguments-differ
+
+# This test checks if dynamic loading of library into MXNet is successful
+# and checks the end of end computation of custom operator
+
+import mxnet as mx
+import os
+
+#load library
+if (os.name=='posix'):
+    path = os.path.abspath('mylib.so')
+    mx.library.load(path)
+elif (os.name=='nt'):
+    path = os.path.abspath('mylib.so')
+    mx.library.load(path)
+
+#setup inputs to call test operator
+a = mx.nd.array([[1,2],[3,4]])
+b = mx.nd.array([[5,6],[7,8]])
+
+#print inputs
+print(a)
+print(b)
+
+#compute and print output
+print(mx.nd.sam(a,b))