releasing 1.0b3 (#471)

* Changing disable_coreml_rank5_mapping option to target_ios
Introducing SupportedVersion class to control and manager version and feature support log

* Updating readme and comments

* test cases using SupportedVersion for version and feature checking

* Updating comments and adding specification version

* changes in README

Author: bhushan23

README.md

@@ -10,22 +10,23 @@ There's a comprehensive [Tutorial](https://github.com/onnx/tutorials/tree/master
 ## [New] Beta onnx-coreml converter with Core ML 3
 
 To try out the new beta converter with CoreML 3 (>= iOS 13, >= macOS 15), 
-install coremltools 3.0b3 and coremltools 1.0b2
+install coremltools 3.0b3 and coremltools 1.0b3
 
 ```shell
-pip install coremltools==3.0b3
-pip install onnx-coreml==1.0b2
+pip install coremltools==3.0b6
+pip install onnx-coreml==1.0b3
 ```
 
-There is a new flag `disable_coreml_rank5_mapping` which should be set to true to utilize 
-the Core ML 3 specification.
+With beta 3, flag `disable_coreml_rank5_mapping` which should be set to true to utilize 
+the Core ML 3 specification is removed and replace by target iOS specific flag, taking default value of '12'
 
+target_ios takes a string specifying target deployment iOS version e.g. '11.2', '12' and '13'
 
 For example:
 ```python
 from onnx_coreml import convert
 
-ml_model = convert(model='my_model.onnx', disable_coreml_rank5_mapping=True)
+ml_model = convert(model='my_model.onnx', target_ios='13')
 ```
 
 ## Installation
@@ -80,7 +81,7 @@ def convert(model,
             predicted_feature_name='classLabel',
             add_custom_layers = False,
             custom_conversion_functions = {},
-	      disable_coreml_rank5_mapping=False)
+	      target_ios='12')
 ```
 
 The function returns a coreml model instance that can be saved to a .mlmodel file, e.g.: 
@@ -164,13 +165,18 @@ __onnx_coreml_input_shape_map__: dict (str: List[int])
     0: Sequence, 1: Batch, 2: channel, 3: height, 4: width.  
     For example, an input of rank 2 could be mapped as [3,4] (i.e. H,W) or [1,2] (i.e. B,C) etc.  
 
-__disable_coreml_rank5_mapping__: bool  
-	  If True, then it disables the "RANK5_ARRAY_MAPPING" or enables the "EXACT_ARRAY_MAPPING"
-        option in CoreML (https://github.com/apple/coremltools/blob/655b3be5cc0d42c3c4fa49f0f0e4a93a26b3e492/mlmodel/format/NeuralNetwork.proto#L67)
-        Thus, no longer, onnx tensors are forced to map to rank 5 CoreML tensors.
-        With this flag on, a rank r ONNX tensor, (1<=r<=5), will map to a rank r tensor in CoreML as well.
-        This flag must be on to utilize any of the new layers added in CoreML 3 (i.e. specification version 4, iOS13)
-
+__target_ios__: str
+      Target Deployment iOS Version (default: '12')
+      Supported iOS version options: '11.2', '12', '13'        
+      CoreML model produced by the converter will be compatible with the iOS version specified in this argument.
+      e.g. if target_ios = '12', the converter would only utilize CoreML features released till iOS12 (equivalently macOS 10.14, watchOS 5 etc).
+
+      - (Supported features: https://github.com/apple/coremltools/releases/tag/v0.8)
+      iOS 12 (CoreML 2.0)
+      - (Supported features: https://github.com/apple/coremltools/releases/tag/v2.0)
+      iSO 13 (CoreML 3.0)
+      - (Supported features: https://github.com/apple/coremltools/releases/tag/3.0-beta6)
+      
 ### Returns
 __model__: A coreml model.
 
@@ -235,4 +241,4 @@ See the testing script `tests/custom_layers_test.py` on how to produce CoreML mo
 ## License
 Copyright © 2018 by Apple Inc., Facebook Inc., and Prisma Labs Inc.
 
-Use of this source code is governed by the [MIT License](https://opensource.org/licenses/MIT) that can be found in the LICENSE.txt file.
+Use of this source code is governed by the [MIT License](https://opensource.org/licenses/MIT) that can be found in the LICENSE.txt file.

onnx_coreml/_backend.py

@@ -36,7 +36,7 @@ class CoreMLBackend(Backend):
     def prepare(cls,
                 model,  # type: ModelProto
                 device='CPU',  # type: Text
-                disable_rank5_mapping=False, # type: Bool
+                target_ios='12', # type: str
                 **kwargs  # type: Any
                 ):
         # type: (...) -> CoreMLRep
@@ -45,11 +45,11 @@ def prepare(cls,
             with open('/tmp/node_model.onnx', 'wb') as f:
                 s = model.SerializeToString()
                 f.write(s)
-        coreml_model = convert(model, disable_coreml_rank5_mapping=disable_rank5_mapping)
+        coreml_model = convert(model, target_ios=target_ios)
         if DEBUG:
             coreml_model.save('/tmp/node_model.mlmodel')
         onnx_outputs_info = _get_onnx_outputs_info(model)
-        return CoreMLRep(coreml_model, onnx_outputs_info, device == 'CPU', disable_rank5_mapping=disable_rank5_mapping)
+        return CoreMLRep(coreml_model, onnx_outputs_info, device == 'CPU', target_ios=target_ios)
 
     @classmethod
     def is_compatible(cls,
@@ -114,7 +114,7 @@ class CoreMLBackendND(Backend):
     def prepare(cls,
                 model,  # type: ModelProto
                 device='CPU',  # type: Text
-                disable_rank5_mapping=True, # type: Bool
+                target_ios='13', # type: str
                 **kwargs  # type: Any
                 ):
         # type: (...) -> CoreMLRep
@@ -123,11 +123,11 @@ def prepare(cls,
             with open('/tmp/node_model.onnx', 'wb') as f:
                 s = model.SerializeToString()
                 f.write(s)
-        coreml_model = convert(model, disable_coreml_rank5_mapping=disable_rank5_mapping)
+        coreml_model = convert(model, target_ios=target_ios)
         if DEBUG:
             coreml_model.save('/tmp/node_model.mlmodel')
         onnx_outputs_info = _get_onnx_outputs_info(model)
-        return CoreMLRep(coreml_model, onnx_outputs_info, device == 'CPU', disable_rank5_mapping=disable_rank5_mapping)
+        return CoreMLRep(coreml_model, onnx_outputs_info, device == 'CPU', target_ios=target_ios)
 
     @classmethod
     def is_compatible(cls,

onnx_coreml/_backend_rep.py

@@ -12,6 +12,7 @@
 from typing import Dict, Any, Text, Tuple
 from onnx import TensorProto
 from ._graph import EdgeInfo
+from .converter import SupportedVersion
 
 
 def _set_dtypes(input_dict, #type: Dict[Text, np._ArrayLike[Any]]
@@ -34,13 +35,13 @@ def __init__(self,
                  coreml_model,  # type: MLModel
                  onnx_outputs_info,  # type: Dict[Text, EdgeInfo]
                  useCPUOnly=False,  # type: bool
-                 disable_rank5_mapping=False # type: bool
+                 target_ios='12' # type: str
                  ):
         # type: (...) -> None
         super(CoreMLRep, self).__init__()
         self.model = coreml_model
         self.useCPUOnly = useCPUOnly
-        self.disable_rank5_mapping = disable_rank5_mapping
+        self.target_ios = target_ios
 
         spec = coreml_model.get_spec()
         self.input_names = [str(i.name) for i in spec.description.input]
@@ -55,7 +56,7 @@ def run(self,
         super(CoreMLRep, self).run(inputs, **kwargs)
         inputs_ = inputs
         _reshaped = False
-        if not self.disable_rank5_mapping:
+        if not SupportedVersion.is_nd_array_supported(self.target_ios):
             for i, input_ in enumerate(inputs_):
                 shape = input_.shape
                 if len(shape) == 4 or len(shape) == 2:
@@ -79,7 +80,7 @@ def run(self,
         prediction = self.model.predict(input_dict, self.useCPUOnly)
         output_values = [prediction[name] for name in self.output_names]
 
-        if not self.disable_rank5_mapping:
+        if not SupportedVersion.is_nd_array_supported(self.target_ios):
             for i, output_ in enumerate(output_values):
                 shape = output_.shape
                 #reshape the CoreML output to match Onnx's output shape

onnx_coreml/_error_utils.py

@@ -15,18 +15,14 @@ def __init__(self,
                add_custom_layers = False, # type: bool
                custom_conversion_functions = dict(), # type: Dict[Text, Any]
                custom_layer_nodes = [], # type : List[Node]
-               disable_coreml_rank5_mapping = False
                ):
       # type: (...) -> None
       self.add_custom_layers = add_custom_layers
       self.custom_conversion_functions = custom_conversion_functions
       self.custom_layer_nodes = custom_layer_nodes
-      self.disable_coreml_rank5_mapping = disable_coreml_rank5_mapping
-      # TODO: Remove following error message once, disable_coreml_rank5_mapping is default to True
-      self.coreml_3_rerun_message = ''
-      if not disable_coreml_rank5_mapping:
-        self.coreml_3_rerun_message = '\nPlease try converting again with disable_coreml_rank5_mapping=True' \
-                                                        ' and coremltools 3.0 latest beta'
+
+      self.rerun_suggestion = '\n Please try converting with higher target_ios.\n' \
+                              'You can also provide custom function/layer to convert the model.'
 
 
   def unsupported_op(self,
@@ -41,7 +37,7 @@ def unsupported_op(self,
         return _convert_custom
       else:
         raise TypeError(
-          "ONNX node of type {} is not supported. {}\n".format(node.op_type, self.coreml_3_rerun_message)
+          "ONNX node of type {} is not supported. {}\n".format(node.op_type, self.rerun_suggestion)
         )
 
 
@@ -61,7 +57,7 @@ def unsupported_op_configuration(self,
       else:
         raise TypeError(
           "Error while converting op of type: {}. Error message: {} {}\n".format(node.op_type, err_message,
-                                                                                  self.coreml_3_rerun_message)
+                                                                                  self.rerun_suggestion)
         )
 
 
@@ -76,7 +72,7 @@ def missing_initializer(self,
       raise ValueError(
         "Missing initializer error in op of type {}, with input name = {}, "
         "output name = {}. Error message: {} {}\n".
-        format(node.op_type, node.inputs[0], node.outputs[0], err_message, self.coreml_3_rerun_message)
+        format(node.op_type, node.inputs[0], node.outputs[0], err_message, self.rerun_suggestion)
       )
 
   def unsupported_feature_warning(self,
@@ -89,8 +85,8 @@ def unsupported_feature_warning(self,
       '''
       print(
         "Warning: Unsupported Feature in op of type {}, with input name = {}, "
-        "output name = {}. Warning message: {} {}\n".
-        format(node.op_type, node.inputs[0], node.outputs[0], err_message, self.coreml_3_rerun_message)
+        "output name = {}. Warning message: {}\n".
+        format(node.op_type, node.inputs[0], node.outputs[0], err_message)
       )
 
 

onnx_coreml/_operators_nd.py

@@ -1759,7 +1759,6 @@ def add_softmax(output_name, rank=-1, axis=-3):
             transpose_axes = list(range(rank))
             transpose_axes[-3], transpose_axes[axis] = transpose_axes[axis], transpose_axes[-3]
 
-            print(transpose_axes)
             builder.add_transpose(
                 name=node.name + '_transpose',
                 axes=transpose_axes,

onnx_coreml/converter.py

@@ -13,6 +13,9 @@
 from coremltools.models.neural_network import NeuralNetworkBuilder  #type: ignore
 from coremltools.models import datatypes, MLModel  #type: ignore
 from coremltools.proto import FeatureTypes_pb2 as ft  #type: ignore
+from coremltools import _MINIMUM_CUSTOM_LAYER_SPEC_VERSION as IOS_11_2_SPEC_VERSION # iOS 11.2
+from coremltools import _MINIMUM_CUSTOM_MODEL_SPEC_VERSION as IOS_12_SPEC_VERSION # iOS 12.0
+from coremltools import _MINIMUM_NDARRAY_SPEC_VERSION as IOS_13_SPEC_VERSION # iOS 13.0
 
 from typing import Tuple
 
@@ -34,6 +37,41 @@
 
 DEBUG = False
 
+class SupportedVersion():
+    # Supported iOS Version
+    # New OS Version must be added at the end to maintain backward version index
+    supported_ios_version = ['11.2', '12', '13']
+    IOS_13_VERSION = supported_ios_version.index('13')
+    ND_ARRARY_SUPPORT = IOS_13_VERSION
+
+    @staticmethod
+    def ios_support_check(target_ios):
+        return target_ios in SupportedVersion.supported_ios_version
+
+    @staticmethod
+    def is_nd_array_supported(target_ios):
+        if not SupportedVersion.ios_support_check(target_ios):
+            raise TypeError('{} not supported. Please provide one of target iOS: {}', target_ios, SupportedVersion.supported_ios_version)
+        
+        target_ios_index = SupportedVersion.supported_ios_version.index(target_ios)
+        return SupportedVersion.ND_ARRARY_SUPPORT <= target_ios_index
+
+    @staticmethod
+    def get_supported_ios():
+        return SupportedVersion.supported_ios_version
+
+    @staticmethod
+    def get_specification_version(target_ios):
+        if not SupportedVersion.ios_support_check(target_ios):
+            raise TypeError('{} not supported. Please provide one of target iOS: {}', target_ios, SupportedVersion.supported_ios_version)
+
+        if target_ios == '11.2':
+            return IOS_11_2_SPEC_VERSION
+        elif target_ios == '12':
+            return IOS_12_SPEC_VERSION
+        else:
+            return IOS_13_SPEC_VERSION            
+
 '''
 inputs: list of tuples.
       [Tuple]: [(name, type, shape)]
@@ -177,7 +215,7 @@ def _check_unsupported_ops(nodes, disable_coreml_rank5_mapping=False): # type: (
 
     coreml_3_rerun_message = ''
     if not disable_coreml_rank5_mapping:
-        coreml_3_rerun_message = '\nPlease try converting again with disable_coreml_rank5_mapping=True' \
+        coreml_3_rerun_message = '\nPlease try converting again with target_ios=13' \
                                  ' and coremltools 3.0 latest beta'
     if len(unsupported_op_types) > 0:
         raise NotImplementedError("Unsupported ONNX ops of type: %s %s" % (
@@ -343,7 +381,7 @@ def convert(model,  # type: Union[onnx.ModelProto, Text]
             add_custom_layers = False,  # type: bool
             custom_conversion_functions = {}, #type: Dict[Text, Any]
             onnx_coreml_input_shape_map = {}, # type: Dict[Text, List[int,...]]
-            disable_coreml_rank5_mapping = False):
+            target_ios = '12'):
     # type: (...) -> MLModel
     """
     Convert ONNX model to CoreML.
@@ -384,13 +422,19 @@ def convert(model,  # type: Union[onnx.ModelProto, Text]
         how the shape of the input is mapped to CoreML. Convention used for CoreML shapes is
         0: Sequence, 1: Batch, 2: channel, 3: height, 4: width.
         For example, an input of rank 2 could be mapped as [3,4] (i.e. H,W) or [1,2] (i.e. B,C) etc.
-        This is ignored if "disable_coreml_rank5_mapping" is set to True.
-    disable_coreml_rank5_mapping: bool
-        If True, then it disables the "RANK5_ARRAY_MAPPING" or enables the "EXACT_ARRAY_MAPPING"
-        option in CoreML (https://github.com/apple/coremltools/blob/655b3be5cc0d42c3c4fa49f0f0e4a93a26b3e492/mlmodel/format/NeuralNetwork.proto#L67)
-        Thus, no longer, onnx tensors are forced to map to rank 5 CoreML tensors.
-        With this flag on, a rank r ONNX tensor, (1<=r<=5), will map to a rank r tensor in CoreML as well.
-        This flag must be on to utilize any of the new layers added in CoreML 3 (i.e. specification version 4, iOS13)
+        This is ignored if "target_ios" is set to 13.
+    target_ios: str
+        Target Deployment iOS Version (default: '12')
+        Supported iOS version options: '11.2', '12', '13'        
+        CoreML model produced by the converter will be compatible with the iOS version specified in this argument.
+        e.g. if target_ios = '12', the converter would only utilize CoreML features released till iOS12 (equivalently macOS 10.14, watchOS 5 etc).
+
+        iOS 11.2 (CoreML 0.8) does not support resize_bilinear, crop_resize layers 
+         - (Supported features: https://github.com/apple/coremltools/releases/tag/v0.8)
+        iOS 12 (CoreML 2.0)
+         - (Supported features: https://github.com/apple/coremltools/releases/tag/v2.0)
+        iSO 13 (CoreML 3.0)
+         - (Supported features: https://github.com/apple/coremltools/releases/tag/3.0-beta6)
 
     Returns
     -------
@@ -405,13 +449,20 @@ def convert(model,  # type: Union[onnx.ModelProto, Text]
             "Model must be file path to .onnx file or onnx loaded model"
         )
 
+    if not SupportedVersion.ios_support_check(target_ios):
+        raise TypeError('{} not supported. Please provide one of target iOS: {}', target_ios, SupportedVersion.get_supported_ios())
+        
+
     global USE_SHAPE_MAPPING
+    disable_coreml_rank5_mapping = False
+    if SupportedVersion.is_nd_array_supported(target_ios):
+        disable_coreml_rank5_mapping = True
+    
     if disable_coreml_rank5_mapping:
         USE_SHAPE_MAPPING = False
     else:
         USE_SHAPE_MAPPING = True
 
-
     '''
     First, apply a few optimizations to the ONNX graph,
     in preparation for conversion to CoreML. 
@@ -495,6 +546,9 @@ def __call__(self, graph):
 
     builder = NeuralNetworkBuilder(input_features, output_features, mode=mode, disable_rank5_shape_mapping=disable_coreml_rank5_mapping)
 
+    # TODO: To be removed once, auto-downgrading of spec version is enabled
+    builder.spec.specificationVersion = SupportedVersion.get_specification_version(target_ios)
+
     '''
     Set CoreML input,output types (float, double, int) same as onnx types, if supported
     '''
@@ -559,9 +613,7 @@ def __call__(self, graph):
     ErrorHandling is a generic class, useful to store a variety of parameters during the conversion process  
     '''
     err = ErrorHandling(add_custom_layers,
-                        custom_conversion_functions,
-                        disable_coreml_rank5_mapping=disable_coreml_rank5_mapping)
-
+                        custom_conversion_functions)
 
     for i, node in enumerate(graph.nodes):
         print("%d/%d: Converting Node Type %s" %(i+1, len(graph.nodes), node.op_type))
@@ -658,6 +710,13 @@ def _add_informative_description(feature, raise_error=True):
     if len(graph.optional_inputs) > 0 or len(graph.optional_outputs):
         builder.add_optionals(graph.optional_inputs, graph.optional_outputs)
 
+    # Check for specification version and target ios compatibility
+    if target_ios == '11.2' and builder.spec.WhichOneof('Type') == 'neuralNetwork':
+        nn_spec = builder.spec.neuralNetwork
+        for layer in nn_spec.layers:
+            if layer.WhichOneof('layer') == 'resizeBilinear' or layer.WhichOneof('layer') == 'cropResize':
+                raise TypeError('{} not supported with target iOS 11.2 please provide higher target iOS'.format(layer.WhichOneof('layer')))
+
     print("Translation to CoreML spec completed. Now compiling the CoreML model.")
     try:
         if DEBUG:

setup.py

@@ -3,7 +3,7 @@
 import sys
 
 
-VERSION = '1.0b2'
+VERSION = '1.0b3'
 
 here = path.abspath(path.dirname(__file__))