MXNet external operators

CMakeLists.txt

@@ -700,18 +700,21 @@ endif()
 target_compile_definitions(mxnet PUBLIC DMLC_LOG_FATAL_THROW=$<BOOL:${LOG_FATAL_THROW}>)
 
 # extension libraries (custom operators, custom subgraphs) are built by default
-add_library(customop_lib SHARED ${CMAKE_CURRENT_SOURCE_DIR}/example/extensions/lib_custom_op/gemm_lib.cc)
-add_library(transposecsr_lib SHARED ${CMAKE_CURRENT_SOURCE_DIR}/example/extensions/lib_custom_op/transposecsr_lib.cc)
-add_library(transposerowsp_lib SHARED ${CMAKE_CURRENT_SOURCE_DIR}/example/extensions/lib_custom_op/transposerowsp_lib.cc)
-add_library(subgraph_lib SHARED ${CMAKE_CURRENT_SOURCE_DIR}/example/extensions/lib_subgraph/subgraph_lib.cc)
-add_library(pass_lib SHARED ${CMAKE_CURRENT_SOURCE_DIR}/example/extensions/lib_pass/pass_lib.cc)
+add_library(customop_lib SHARED ${CMAKE_CURRENT_SOURCE_DIR}/example/extensions/lib_custom_op/gemm_lib.cc ${CMAKE_CURRENT_SOURCE_DIR}/src/lib_api.cc)
+add_library(transposecsr_lib SHARED ${CMAKE_CURRENT_SOURCE_DIR}/example/extensions/lib_custom_op/transposecsr_lib.cc ${CMAKE_CURRENT_SOURCE_DIR}/src/lib_api.cc)
+add_library(transposerowsp_lib SHARED ${CMAKE_CURRENT_SOURCE_DIR}/example/extensions/lib_custom_op/transposerowsp_lib.cc ${CMAKE_CURRENT_SOURCE_DIR}/src/lib_api.cc)
+add_library(subgraph_lib SHARED ${CMAKE_CURRENT_SOURCE_DIR}/example/extensions/lib_subgraph/subgraph_lib.cc ${CMAKE_CURRENT_SOURCE_DIR}/src/lib_api.cc)
+add_library(pass_lib SHARED ${CMAKE_CURRENT_SOURCE_DIR}/example/extensions/lib_pass/pass_lib.cc ${CMAKE_CURRENT_SOURCE_DIR}/src/lib_api.cc)
+
+add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/example/extensions/lib_external_ops ${CMAKE_CURRENT_SOURCE_DIR}/example/extensions/lib_external_ops/build)
+
 target_include_directories(customop_lib PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include/mxnet)
 target_include_directories(transposecsr_lib PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include/mxnet)
 target_include_directories(transposerowsp_lib PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include/mxnet)
 target_include_directories(subgraph_lib PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include/mxnet)
 target_include_directories(pass_lib PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include/mxnet)
 if(USE_CUDA)
-  add_library(customop_gpu_lib SHARED ${CMAKE_CURRENT_SOURCE_DIR}/example/extensions/lib_custom_op/relu_lib.cu)
+  add_library(customop_gpu_lib SHARED ${CMAKE_CURRENT_SOURCE_DIR}/example/extensions/lib_custom_op/relu_lib.cu ${CMAKE_CURRENT_SOURCE_DIR}/src/lib_api.cc)
   target_include_directories(customop_gpu_lib PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include/mxnet)
 endif()
 if(UNIX)
@@ -730,7 +733,9 @@ elseif(MSVC)
   set_target_properties(subgraph_lib PROPERTIES PREFIX "lib")
   set_target_properties(pass_lib PROPERTIES PREFIX "lib")
   if(USE_CUDA)
-    target_compile_options(customop_gpu_lib PUBLIC "$<$<COMPILE_LANGUAGE:CUDA>:-Xcompiler=-fPIC>")
+    target_compile_options(customop_gpu_lib PRIVATE "$<$<COMPILE_LANGUAGE:CUDA>:-Xcompiler=-LD -MT>")
+    target_compile_options(customop_gpu_lib PRIVATE "$<$<COMPILE_LANGUAGE:CXX>:/LD>")
+    target_compile_options(customop_gpu_lib PRIVATE "$<$<COMPILE_LANGUAGE:CXX>:/MT>")
     set_target_properties(customop_gpu_lib PROPERTIES PREFIX "lib")
   endif()
 endif()

config/linux_gpu.cmake

@@ -24,7 +24,8 @@
 #
 #  $ cp config/linux_gpu.cmake config.cmake
 #
-#  Next modify the according entries, and then compile by
+#  Next modify the entries in the config.cmake like MXNET_CUDA_ARCH to set the specific
+#  GPU architecture, and then compile by
 #
 #  $ mkdir build; cd build
 #  $ cmake ..
@@ -42,15 +43,18 @@ set(USE_CUDA ON CACHE BOOL "Build with CUDA support")
 set(USE_CUDNN ON CACHE BOOL "Build with cudnn support, if found")
 
 # Target NVIDIA GPU achitecture.
-# Valid options are "Auto" for autodetection, "All" for all available
-# architectures or a list of architectures by compute capability number, such as
-# "7.0" or "7.0;7.5" as well as name, such as "Volta" or "Volta;Turing".
+# Valid options are:
+#   - "Auto" for autodetection, will try and discover which GPU architecture to use by
+#            looking at the available GPUs on the machine that you're building on
+#   - "All" for all available GPU architectures supported by the version of CUDA installed
+#   - "specific GPU architectures" by giving the compute capability number such as
+#            "7.0" or "7.0;7.5" (ie. sm_70 or sm_75) or you can specify the name like:
+#            "Volta" or "Volta;Turing".
 # The value specified here is passed to cmake's CUDA_SELECT_NVCC_ARCH_FLAGS to
 # obtain the compilation flags for nvcc.
 #
 # When compiling on a machine without GPU, autodetection will fail and you
-# should instead specify the target architecture manually to avoid excessive
-# compilation times.
+# should instead specify the target architecture manually.
 set(MXNET_CUDA_ARCH "Auto" CACHE STRING "Target NVIDIA GPU achitecture")
 
 #---------------------------------------------

example/extensions/lib_api/Makefile

@@ -16,7 +16,7 @@
 # under the License.
 
 all:
-	g++ -std=c++11 -shared -fPIC init_lib.cc -o libinit_lib.so -I ../../../include/mxnet
+	g++ -std=c++11 -shared -fPIC init_lib.cc ../../../src/lib_api.cc -o libinit_lib.so -I ../../../include
 
 test:
 	g++ -std=c++11 -O3 -o libtest libtest.cc -ldl -I ../../../include/mxnet

example/extensions/lib_api/init_lib.cc

@@ -24,7 +24,7 @@
  */
 
 #include <iostream>
-#include "lib_api.h"
+#include "mxnet/lib_api.h"
 
 using namespace mxnet::ext;
 

example/extensions/lib_custom_op/Makefile

@@ -18,16 +18,16 @@
 all: gemm_lib relu_lib transposecsr_lib transposerowsp_lib
 
 gemm_lib:
-	g++ -shared -fPIC -std=c++11 gemm_lib.cc -o libgemm_lib.so -I ../../../include/mxnet
+	g++ -shared -fPIC -std=c++11 gemm_lib.cc ../../../src/lib_api.cc -o libgemm_lib.so -I ../../../include
 
 relu_lib:
-	nvcc -shared -std=c++11 -Xcompiler -fPIC relu_lib.cu -o librelu_lib.so -I ../../../include/mxnet
+	nvcc -shared -std=c++11 -Xcompiler -fPIC relu_lib.cu ../../../src/lib_api.cc -o librelu_lib.so -I ../../../include
 
 transposecsr_lib:
-	g++ -shared -fPIC -std=c++11 transposecsr_lib.cc -o libtransposecsr_lib.so -I ../../../include/mxnet
+	g++ -shared -fPIC -std=c++11 transposecsr_lib.cc ../../../src/lib_api.cc -o libtransposecsr_lib.so -I ../../../include
 
 transposerowsp_lib:
-	g++ -shared -fPIC -std=c++11 transposerowsp_lib.cc -o libtransposerowsp_lib.so -I ../../../include/mxnet
+	g++ -shared -fPIC -std=c++11 transposerowsp_lib.cc ../../../src/lib_api.cc -o libtransposerowsp_lib.so -I ../../../include
 
 clean:
 	rm -rf libgemm_lib.so librelu_lib.so libtransposecsr_lib.so libtransposerowsp_lib.so

example/extensions/lib_custom_op/gemm_lib.cc

@@ -25,7 +25,7 @@
 
 #include <iostream>
 #include <utility>
-#include "lib_api.h"
+#include "mxnet/lib_api.h"
 
 using namespace mxnet::ext;
 

example/extensions/lib_custom_op/relu_lib.cu

@@ -24,7 +24,7 @@
  */
 
 #include <iostream>
-#include "lib_api.h"
+#include "mxnet/lib_api.h"
 
 using namespace mxnet::ext;
 

example/extensions/lib_custom_op/test_transposecsr.py

@@ -54,25 +54,25 @@
 print("indices:", c.indices.asnumpy())
 print("indptr:", c.indptr.asnumpy())
 
-print("--------start symbolic compute--------")
+print("--------start Gluon compute--------")
 d = mx.sym.Variable('d')
 e = mx.sym.my_transposecsr(d)
 f = mx.sym.my_state_transposecsr(d, test_kw=200)
 
-exe = e.bind(ctx=mx.cpu(),args={'d':a})
-exe2 = f.bind(ctx=mx.cpu(),args={'d':a})
-out = exe.forward()
+block = mx.gluon.nn.SymbolBlock(e, [d])
+out = block(a)
 print("Compute Results:")
-print("data:", out[0].data.asnumpy())
-print("indices:", out[0].indices.asnumpy())
-print("indptr:", out[0].indptr.asnumpy())
+print("data:", out.data.asnumpy())
+print("indices:", out.indices.asnumpy())
+print("indptr:", out.indptr.asnumpy())
 
-out2 = exe2.forward()
-out2 = exe2.forward()
+block2 = mx.gluon.nn.SymbolBlock(f,[d])
+out2 = block2(a)
+out2 = block2(a)
 print("Stateful Compute Result:")
-print("data:", out2[0].data.asnumpy())
-print("indices:", out2[0].indices.asnumpy())
-print("indptr:", out2[0].indptr.asnumpy())
+print("data:", out2.data.asnumpy())
+print("indices:", out2.indices.asnumpy())
+print("indptr:", out2.indptr.asnumpy())
 
 print("--------Baseline(dense)--------")
 print(mx.nd.transpose(a.tostype('default')))

example/extensions/lib_custom_op/test_transposerowsp.py

@@ -51,23 +51,29 @@
 print("data:", c.data.asnumpy())
 print("indices:", c.indices.asnumpy())
 
-print("--------start symbolic compute--------")
+print("--------start Gluon compute--------")
 d = mx.sym.Variable('d')
 e = mx.sym.my_transposerowsp(d)
 f = mx.sym.my_state_transposerowsp(d, test_kw=200)
 
-exe = e.bind(ctx=mx.cpu(),args={'d':a})
-exe2 = f.bind(ctx=mx.cpu(),args={'d':a})
-out = exe.forward()
+#exe = e.bind(ctx=mx.cpu(),args={'d':a})
+block = mx.gluon.nn.SymbolBlock(e,[d])
+#out = exe.forward()
+out = block(a)
 print("Compute Results:")
-print("data:", out[0].data.asnumpy())
-print("indices:", out[0].indices.asnumpy())
+print(out)
+print("data:", out.data.asnumpy())
+print("indices:", out.indices.asnumpy())
 
-out2 = exe2.forward()
-out2 = exe2.forward()
+#exe2 = f.bind(ctx=mx.cpu(),args={'d':a})
+block2 = mx.gluon.nn.SymbolBlock(f,[d])
+#out2 = exe2.forward()
+out2 = block2(a)
+#out2 = exe2.forward()
+out2 = block2(a)
 print("Stateful Compute Result:")
-print("data:", out2[0].data.asnumpy())
-print("indices:", out2[0].indices.asnumpy())
+print("data:", out2.data.asnumpy())
+print("indices:", out2.indices.asnumpy())
 
 print("--------Baseline(dense)--------")
 print(mx.nd.transpose(a.tostype('default')))

example/extensions/lib_custom_op/transposecsr_lib.cc

@@ -25,7 +25,7 @@
 
 #include <iostream>
 #include <utility>
-#include "lib_api.h"
+#include "mxnet/lib_api.h"
 
 using namespace mxnet::ext;
 

example/extensions/lib_custom_op/transposerowsp_lib.cc

@@ -25,7 +25,7 @@
 
 #include <iostream>
 #include <utility>
-#include "lib_api.h"
+#include "mxnet/lib_api.h"
 
 using namespace mxnet::ext;
 

example/extensions/lib_external_ops/CMakeLists.txt

@@ -0,0 +1,36 @@
+# specify CXX sources
+FILE(GLOB CXX_SRCS
+  # Required files
+  ${CMAKE_CURRENT_SOURCE_DIR}/init_lib.cc
+  ${CMAKE_CURRENT_SOURCE_DIR}/../../../src/lib_api.cc
+  # Your custom files
+  ${CMAKE_CURRENT_SOURCE_DIR}/min_ex.cc
+  )
+
+# create library & set libraries
+add_library(external_lib SHARED $<TARGET_OBJECTS:nnvm> ${CXX_SRCS})
+target_link_libraries(external_lib PUBLIC mshadow mxnet dmlc)
+
+# generic GPU stuff
+if(USE_CUDA)
+  # specify GPU sources (optional)
+  FILE(GLOB CU_SRCS "*.cu")
+  target_sources(external_lib PUBLIC ${CU_SRCS})
+endif(USE_CUDA)
+
+if(UNIX)
+  # unix-specific stuff
+  if(USE_CUDA)
+    # unix+GPU-specific stuff
+    target_compile_options(external_lib PUBLIC -shared)
+  endif(USE_CUDA)
+elseif(MSVC)
+  # windows-specific stuff
+  target_compile_options(external_lib PRIVATE "$<$<COMPILE_LANGUAGE:CXX>:/LD>")
+  target_compile_options(external_lib PRIVATE "$<$<COMPILE_LANGUAGE:CXX>:/MT>")
+  set_target_properties(external_lib PROPERTIES PREFIX "lib")
+  if(USE_CUDA)
+    # windows+GPU-specific stuff
+    target_compile_options(external_lib PRIVATE "$<$<COMPILE_LANGUAGE:CUDA>:-Xcompiler=-LD -MT>")
+  endif(USE_CUDA)
+endif()

example/extensions/lib_external_ops/README.md

@@ -0,0 +1,38 @@
+<!--- 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. -->
+
+External Operators Example and Tutorial
+=======================================
+
+## Introduction
+
+Extending MXNet with custom components used to mean distributing a custom fork. This feature allows adding custom components to MXNet by dynamically loading external libraries at runtime.
+
+## Getting Started
+
+### Have MXNet Ready
+
+For this tutorial, clone MXNet from source and build it.
+
+### Run An Example
+
+This example shows compiling a custom backend operator and then dynamically loading it into MXNet at runtime. Go to the **lib_external_ops** directory and follow these steps:
+
+1. Touch or modify the **min_ex.cc** and/or **min_ex-inl.h** file(s)
+2. Go into the **build** directory that was created when building MXNet.
+3. Run `make external_lib`. Notice that **libexternal_lib.so** has been rebuilt
+4. Go to the **example/extensions/lib_external_ops** directory again and run `python test_loading.py`.

example/extensions/lib_external_ops/init_lib.cc

@@ -0,0 +1,39 @@
+/*
+ * 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) 2015 by Contributors
+ * \file init_lib.cc
+ * \brief Sample library file
+ */
+
+#include <iostream>
+#include "mxnet/lib_api.h"
+
+using namespace mxnet::ext;
+
+MXReturnValue initialize(int version) {
+  if (version >= 10700) {
+    std::cout << "MXNet version " << version << " supported" << std::endl;
+    return MX_SUCCESS;
+  } else {
+    MX_ERROR_MSG << "MXNet version " << version << " not supported";
+    return MX_FAIL;
+  }
+}