Merge pull request #362 from Necross/coremltools3.0b

Consolidating changes for coremltools3.0 beta release

Author: DawerG

CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.0.0)
+cmake_minimum_required(VERSION 3.12.0)
 
 set(CMAKE_OSX_ARCHITECTURES x86_64)
 
@@ -13,34 +13,12 @@ endif()
 add_subdirectory(deps)
 add_subdirectory(mlmodel)
 
-if("${PYTHON}" STREQUAL "")
-  find_program(PYTHON NAMES python3 python)
-endif()
-if("${PYTHON_MAJOR_VERSION}" STREQUAL "")
-  exec_program(${PYTHON}
-    ARGS "-c 'import sys; print(sys.version_info.major)'"
-    OUTPUT_VARIABLE PYTHON_MAJOR_VERSION)
-endif()
-if("${PYTHON_MINOR_VERSION}" STREQUAL "")
-  exec_program(${PYTHON}
-    ARGS "-c 'import sys; print(sys.version_info.minor)'"
-    OUTPUT_VARIABLE PYTHON_MINOR_VERSION)
-endif()
-if("${PYTHON_VERSION}" STREQUAL "")
-  set(PYTHON_VERSION "${PYTHON_MAJOR_VERSION}.${PYTHON_MINOR_VERSION}")
-endif()
-
-if("${PYTHON_CONFIG}" STREQUAL "")
-  find_program(PYTHON_CONFIG NAMES python3-config python-config)
-endif()
-exec_program(${PYTHON_CONFIG}
-  ARGS "--includes"
-  OUTPUT_VARIABLE PYTHON_CFLAGS)
+find_package(PythonInterp)
+find_package(PythonLibs)
 
-message("Found python at ${PYTHON}")
-message("Found python version ${PYTHON_VERSION}")
-message("Found python-config at ${PYTHON_CONFIG}")
-message("Found python includes ${PYTHON_CFLAGS}")
+message("Found python at ${PYTHON_EXECUTABLE}")
+message("Found python version ${PYTHON_VERSION_STRING}")
+message("Found python includes ${PYTHON_INCLUDE_DIRS}")
 
 include_directories(
   .
@@ -49,11 +27,11 @@ include_directories(
   deps/protobuf/src
   deps/pybind11/include
   mlmodel/src
+  ${PYTHON_INCLUDE_DIRS}
 )
 
 set(CMAKE_CXX_FLAGS " \
   ${CMAKE_CXX_FLAGS} \
-  ${PYTHON_CFLAGS} \
   --std=c++14 \
 ")
 
@@ -127,6 +105,16 @@ if (APPLE)
   set_target_properties(caffeconverter PROPERTIES LINK_FLAGS "-undefined dynamic_lookup")
 endif()
 
+file(COPY ${CMAKE_SOURCE_DIR}/README.rst DESTINATION ${CMAKE_BINARY_DIR})
+file(COPY ${CMAKE_SOURCE_DIR}/coremltools/__init__.py
+     DESTINATION ${CMAKE_BINARY_DIR}/coremltools)
+file(COPY ${CMAKE_SOURCE_DIR}/coremltools/__main__.py
+     DESTINATION ${CMAKE_BINARY_DIR}/coremltools)
+set(copy_dirs _deps _scripts converters graph_visualization models proto)
+foreach(cdir IN ITEMS ${copy_dirs})
+  file(COPY ${CMAKE_SOURCE_DIR}/coremltools/${cdir}
+       DESTINATION ${CMAKE_BINARY_DIR}/coremltools)
+endforeach()
 if(APPLE)
   add_custom_command(
     TARGET caffeconverter
@@ -147,14 +135,14 @@ find_library(FOUNDATION Foundation)
 
 if (APPLE AND CORE_VIDEO AND CORE_ML AND FOUNDATION)
   execute_process(
-      COMMAND ${PYTHON} -c "import numpy; print(numpy.get_include())"
+      COMMAND ${PYTHON_EXECUTABLE} -c "import numpy; print(numpy.get_include())"
       RESULT_VARIABLE NUMPY_INCLUDE_STATUS
-      OUTPUT_VARIABLE NUMPY_INCLUDE)
+      OUTPUT_VARIABLE NUMPY_INCLUDE
+  )
 
   if("${NUMPY_INCLUDE}" STREQUAL "" OR NOT NUMPY_INCLUDE_STATUS EQUAL 0)
       message(FATAL_ERROR "Could not find numpy include path. Exit code: ${NUMPY_INCLUDE_STATUS}")
   endif()
-
   message("Found numpy include path at ${NUMPY_INCLUDE}")
 
   include_directories(
@@ -175,6 +163,7 @@ if (APPLE AND CORE_VIDEO AND CORE_ML AND FOUNDATION)
     ${CORE_VIDEO}
     ${CORE_ML}
     ${FOUNDATION}
+    ${PYTHON_LIBRARIES}
   )
 
   if (APPLE)
@@ -193,22 +182,33 @@ else()
   message(STATUS "CoreML.framework and dependent frameworks not found. Skipping libcoremlpython build.")
 endif()
 
-set(PYTHON_TAG "cp${PYTHON_MAJOR_VERSION}${PYTHON_MINOR_VERSION}")
+set(PYTHON_TAG "cp${PYTHON_VERSION_MAJOR}${PYTHON_VERSION_MINOR}")
 if(APPLE)
-  set(PLAT_NAME "macosx_10_14_intel;macosx_10_13_intel;macosx_10_12_intel")
+  set(PLAT_NAME "macosx_10_15_intel;macosx_10_14_intel;macosx_10_13_intel;macosx_10_12_intel")
 elseif("${CMAKE_SYSTEM_NAME}" MATCHES "Linux")
   set(PLAT_NAME "manylinux1_x86_64")
 else()
   message(FATAL_ERROR "Unsupported build platform. Supported platforms are Linux and macOS.")
 endif()
 
-add_custom_target(dist
-  # Workaround for building multiple platform versions since python setuptools only take in one platform via '--plat-name' argument
-  # and cmake 'foreach' does not seem to work inside add_custom_target
-  COMMAND for SUPP_PLATFORM in ${PLAT_NAME}$<SEMICOLON> do ${PYTHON} setup.py bdist_wheel --plat-name=$$SUPP_PLATFORM --python-tag=${PYTHON_TAG}$<SEMICOLON> done$<SEMICOLON>
-  DEPENDS caffeconverter coremlpython
-  COMMENT "Building Python wheel for coremltools under dist/"
-)
+# Add a target for each platform, and then a 'dist' that will build all of them.
+# Parallel invocations of setup.py is not safe, so we serialize them.
+set(plat_targets "")
+foreach(platform IN ITEMS ${PLAT_NAME})
+  add_custom_target(dist_${platform}
+    COMMENT "Building dist for platform ${platform}..."
+    COMMAND ${PYTHON_EXECUTABLE}
+      ${CMAKE_SOURCE_DIR}/setup.py
+      bdist_wheel
+      --plat-name=${platform}
+      --python-tag=${PYTHON_TAG}
+    DEPENDS "caffeconverter;coremlpython;${plat_targets}"
+    WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+  )
+  set(plat_targets "${plat_targets};dist_${platform}")
+endforeach()
+# Add a 'dist' target that will build wheels for all possible platforms.
+add_custom_target(dist DEPENDS ${plat_targets})
 
 add_custom_target(pytest
   COMMAND pytest coremltools/test/

README.md

@@ -70,15 +70,20 @@ Building from source
 To build the project, you need [CMake](https://cmake.org) to configure the project
 
 ```shell
-cmake .
+mkdir build
+cd build
+cmake ../
 ```
 
 When several python virtual environments are installed, 
 it may be useful to use the following command instead, 
 to point to the correct intended version of python:
 
 ```shell
-cmake . -DPYTHON=$(which python) -DPYTHON_CONFIG=$(which python-config)
+cmake \
+  -DPYTHON_EXECUTABLE:FILEPATH=/Library/Frameworks/Python.framework/Versions/3.7/bin/python \
+  -DPYTHON_INCLUDE_DIR=/Library/Frameworks/Python.framework/Versions/3.7/include/python3.7m \
+  ../
 ``` 
 
 after which you can use make to build the project
@@ -135,7 +140,10 @@ To install xgboost
 
 ```shell
 git clone --recursive https://github.com/dmlc/xgboost
-cd xgboost; cp make/minimum.mk ./config.mk; make
+cd xgboost
+git checkout v0.90
+git submodule update
+make config=make/config.mk -j8
 cd python-package; python setup.py develop
 ```
 

caffeconverter/Caffe/LSTM.cpp

@@ -90,7 +90,7 @@ void CoreMLConverter::convertCaffeLSTM(CoreMLConverter::ConvertLayerParameters l
     //Copy weights
     //Input Weight Matrices
     int blobSize = caffeLayerWeights.blobs(0).data_size();
-    int64_t expectedSize = 4*hidden_size*input_size;
+    int64_t expectedSize = 4*((int64_t)hidden_size)*input_size;
     if (blobSize != expectedSize) {
         CoreMLConverter::errorInCaffeProto("Expected blob size = "+std::to_string(expectedSize)+" but found blob of size = "+std::to_string(blobSize)+" in caffe"
                           , caffeLayer.name(), "Recurrent");
@@ -119,7 +119,7 @@ void CoreMLConverter::convertCaffeLSTM(CoreMLConverter::ConvertLayerParameters l
 
     //biases
     blobSize = caffeLayerWeights.blobs(1).data_size();
-    expectedSize = 4*hidden_size;
+    expectedSize = 4*((int64_t)hidden_size);
     if (blobSize != expectedSize) {
         CoreMLConverter::errorInCaffeProto("Expected blob size = "+std::to_string(expectedSize)+" but found blob of size = "+std::to_string(blobSize)+" in caffe"
                           , caffeLayer.name(), "Recurrent");
@@ -148,7 +148,7 @@ void CoreMLConverter::convertCaffeLSTM(CoreMLConverter::ConvertLayerParameters l
 
     //Recursion matrices
     blobSize = caffeLayerWeights.blobs(2).data_size();
-    expectedSize = 4*hidden_size*hidden_size;
+    expectedSize = 4*((int64_t)hidden_size)*((int64_t)hidden_size);
     if (blobSize != expectedSize) {
         CoreMLConverter::errorInCaffeProto("Expected blob size = "+std::to_string(expectedSize)+" but found blob of size = "+std::to_string(blobSize)+" in caffe"
                           , caffeLayer.name(), "Recurrent");

caffeconverter/Caffe/caffe_pb_wrapper.hpp

@@ -4,7 +4,9 @@
 #pragma clang diagnostic ignored "-Wunused-parameter"
 #pragma clang diagnostic ignored "-Wshorten-64-to-32"
 #pragma clang diagnostic ignored "-Wshadow"
+#if __apple_build_version__ < 10010028
 #pragma clang diagnostic ignored "-Wextended-offsetof"
+#endif
 #pragma clang diagnostic ignored "-Wdeprecated-declarations"
 
 #include "caffe.pb.h"

caffeconverter/CaffeConverterLib.cpp

@@ -53,7 +53,7 @@ void convertCaffe(const std::string& srcPath,
     caffe::NetParameter caffeWeightsNetwork;
     std::map<std::string, caffe::BlobProto> caffeMeanImageBlob;
 
-    // TODO: We need to use only one caffe network proto variable (rdar://problem/30400140)
+    // TODO: We need to use only one caffe network proto variable
     // This is a workaround for that.
     if (caffeProtoTxtPath != "") {
         CoreMLConverter::loadCaffeNetwork(srcPath, caffeWeightsNetwork, caffeProtoTxtPath, caffeNetwork, meanImageProtoPath, caffeMeanImageBlob);

coremlpython/CoreMLPython.h

@@ -6,7 +6,7 @@
 #pragma clang diagnostic pop
 
 #import <CoreML/CoreML.h>
-#import "NeuralNetworkShapes.hpp"
+#import "NeuralNetwork/NeuralNetworkShapes.hpp"
 
 namespace py = pybind11;
 
@@ -21,7 +21,7 @@ namespace CoreML {
             Model(const Model&) = delete;
             Model& operator=(const Model&) = delete;
             ~Model();
-            explicit Model(const std::string& urlStr);
+            explicit Model(const std::string& urlStr, bool useCPUOnly);
             py::dict predict(const py::dict& input, bool useCPUOnly);
             static int32_t maximumSupportedSpecificationVersion();
             std::string toString() const;

coremlpython/CoreMLPython.mm

@@ -3,7 +3,7 @@
 #import "CoreMLPython.h"
 #import "CoreMLPythonUtils.h"
 #import "Globals.hpp"
-#import "NeuralNetworkShapes.hpp"
+#import "NeuralNetwork/NeuralNetworkShapes.hpp"
 #import "Utils.hpp"
 
 #pragma clang diagnostic push
@@ -25,7 +25,7 @@
     }
 }
 
-Model::Model(const std::string& urlStr) {
+Model::Model(const std::string& urlStr, bool useCPUOnly) {
     @autoreleasepool {
 
         // Compile the model
@@ -53,8 +53,16 @@
             errmsg << "\".";
             throw std::runtime_error(errmsg.str());
         }
-        
-        m_model = [MLModel modelWithContentsOfURL:compiledUrl error:&error];
+
+        if (@available(macOS 10.14, *)) {
+            MLModelConfiguration *configuration = [MLModelConfiguration new];
+            if (useCPUOnly){
+                configuration.computeUnits = MLComputeUnitsCPUOnly;
+            }
+            m_model = [MLModel modelWithContentsOfURL:compiledUrl configuration:configuration error:&error];
+        } else {
+            m_model = [MLModel modelWithContentsOfURL:compiledUrl error:&error];
+        }
         Utils::handleError(error);
     }
 }
@@ -109,7 +117,7 @@
     py::module m("libcoremlpython", "CoreML.Framework Python bindings");
 
     py::class_<Model>(m, "_MLModelProxy")
-        .def(py::init<const std::string&>())
+        .def(py::init<const std::string&, bool>())
         .def("predict", &Model::predict)
         .def_static("maximum_supported_specification_version", &Model::maximumSupportedSpecificationVersion);
 

coremlpython/CoreMLPythonUtils.h

@@ -34,7 +34,8 @@ namespace CoreML {
             py::object convertArrayValueToPython(MLMultiArray *value);
             py::object convertDictionaryValueToPython(NSDictionary<NSObject *,NSNumber *> * value);
             py::object convertImageValueToPython(CVPixelBufferRef value);
-
+            API_AVAILABLE(macos(10.14))
+            py::object convertSequenceValueToPython(MLSequence *seq);
             py::dict shapeConstraintToPyDict(const ShapeConstraint& constraint);
 
         }