tico 0.1.0.dev250603__py3-none-any.whl → 0.1.0.dev250604__py3-none-any.whl

tico/__init__.py

@@ -21,7 +21,7 @@ from tico.config import CompileConfigV1, get_default_config
 from tico.utils.convert import convert, convert_from_exported_program, convert_from_pt2
 
 # THIS LINE IS AUTOMATICALLY GENERATED BY setup.py
-__version__ = "0.1.0.dev250603"
+__version__ = "0.1.0.dev250604"
 
 MINIMUM_SUPPORTED_VERSION = "2.5.0"
 SECURE_TORCH_VERSION = "2.6.0"

tico/passes/legalize_predefined_layout_operators.py

@@ -316,12 +316,6 @@ class LegalizePreDefinedLayoutOperators(PassBase):
         ceil_mode = args.ceil_mode
         if ceil_mode:
             raise NotYetSupportedError("Only support non-ceil model.")
-        count_include_pad = args.count_include_pad
-        if not count_include_pad:
-            # NOTE count_include_pad = False can be partially supported with SAME padding in circle.
-            raise NotYetSupportedError(
-                "For the case that the count_include_pad is False is not yet supported."
-            )
         divisor_override = args.divisor_override
         if divisor_override is not None:
             raise NotYetSupportedError(

tico/serialize/operators/op_avg_pool2d.py

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import math
 from typing import Dict, List, TYPE_CHECKING
 
 if TYPE_CHECKING:
@@ -26,25 +27,101 @@ from tico.serialize.operators.hashable_opcode import OpCode
 from tico.serialize.operators.node_visitor import NodeVisitor, register_node_visitor
 from tico.serialize.operators.utils import create_builtin_operator, get_op_index
 from tico.utils.define import define_pad_node
+from tico.utils.errors import NotYetSupportedError
 from tico.utils.validate_args_kwargs import AvgPool2dArgs
 
 
 @register_node_visitor
 class AvgPool2DVisitor(NodeVisitor):
+    """
+    This class defines how to serialize AvgPool2D operation into Circle IR.
+
+    Torch                                           | Circle
+
+    count_include_pad: True/False                   | (count_include_pad): Always False
+    padding: number (could be valid, same, or etc)  | padding: "valid"/"same"
+
+    * Circle's avgpool2d has no option for count_include_pad, so we always set it as False.
+    """
+
     target: List[torch._ops.OpOverload] = [torch.ops.circle_custom.avgpool2d]
 
     def __init__(self, op_codes: Dict[OpCode, int], graph: CircleSubgraph):
         super().__init__(op_codes, graph)
 
+    def has_padding(self, args: AvgPool2dArgs) -> bool:
+        padding = args.padding
+        if padding[0] == 0 and padding[1] == 0:
+            return False
+        else:
+            return True
+
+    def has_same_padding(self, args: AvgPool2dArgs) -> bool:
+        input_shape = list(extract_shape(args.input))
+        kernel_size = args.kernel_size
+        stride = args.stride
+        padding = args.padding
+        # TODO Update this function when supporting ceil_mode = True
+        assert args.ceil_mode is False
+        output_height = math.floor(
+            (input_shape[1] + padding[0] * 2 - kernel_size[0]) / stride[0] + 1
+        )
+        output_width = math.floor(
+            (input_shape[2] + padding[1] * 2 - kernel_size[1]) / stride[1] + 1
+        )
+
+        return input_shape[1] == output_height and input_shape[2] == output_width
+
+    def define_avgpool_node(self, inputs, outputs, padding, stride, kernel_size):
+        op_index = get_op_index(
+            circle.BuiltinOperator.BuiltinOperator.AVERAGE_POOL_2D,
+            self._op_codes,
+        )
+        operator = create_builtin_operator(self.graph, op_index, inputs, outputs)
+
+        # Op-specific option
+        operator.builtinOptionsType = circle.BuiltinOptions.BuiltinOptions.Pool2DOptions
+        option = circle.Pool2DOptions.Pool2DOptionsT()
+
+        assert padding in {"SAME": 0, "VALID": 1}
+
+        option.padding = {"SAME": 0, "VALID": 1}[padding]
+        option.strideH = stride[0]
+        option.strideW = stride[1]
+        option.filterHeight = kernel_size[0]
+        option.filterWidth = kernel_size[1]
+        option.fusedActivationFunction = (
+            circle.ActivationFunctionType.ActivationFunctionType.NONE
+        )
+
+        operator.builtinOptions = option
+        return operator
+
     def define_node(
         self,
         node: torch.fx.Node,
     ) -> circle.Operator.OperatorT:
+        """
+        PSEUDO CODE
+
+        if count_include_pad == True:
+            (Circle cannot represent count_include_pad=True in AvgPool2D. Therefore we manually add zero padding node.)
+            DEFINE zero padding node
+            DEFINE avgpool node with no padding (valid)
+        if count_include_pad == False:
+            (Lucky! Circle can represent count_include_pad=False)
+            DEFINE avgpool node with same/valid padding.
+
+            (However, it cannot represent all paddings. So, if the padding is not same or valid, we throw an error.)
+            if the paddding is neither same nor valid:
+                THROW an error.
+        """
         args = AvgPool2dArgs(*node.args, **node.kwargs)  # type: ignore[arg-type]
         input = args.input
         kernel_size = args.kernel_size
         stride = args.stride
         padding = args.padding
+        count_include_pad = args.count_include_pad
 
         avgpool_input: torch.fx.Node | circle.Tensor.TensorT = input
 
@@ -81,32 +158,33 @@ class AvgPool2DVisitor(NodeVisitor):
             self.graph.add_operator(pad_operator)
             return padded_input_tensor
 
-        if padding is not None:
-            avgpool_input = define_padding_node()
+        if count_include_pad is True:
+            # Add padding before avgpool2d
+            # Circle's avgpool2d does not support count_include_pad=True, so we need to add padding manually
+            if self.has_padding(args):
+                avgpool_input = define_padding_node()
 
-        inputs = [avgpool_input]
-        outputs = [node]
-
-        op_index = get_op_index(
-            circle.BuiltinOperator.BuiltinOperator.AVERAGE_POOL_2D,
-            self._op_codes,
-        )
-        operator = create_builtin_operator(self.graph, op_index, inputs, outputs)
-
-        # Op-specific option
-        operator.builtinOptionsType = circle.BuiltinOptions.BuiltinOptions.Pool2DOptions
-        option = circle.Pool2DOptions.Pool2DOptionsT()
-
-        SAME, VALID = 0, 1
-        option.padding = VALID
-        option.strideH = stride[0]
-        option.strideW = stride[1]
-        option.filterHeight = kernel_size[0]
-        option.filterWidth = kernel_size[1]
-        option.fusedActivationFunction = (
-            circle.ActivationFunctionType.ActivationFunctionType.NONE
-        )
-
-        operator.builtinOptions = option
-
-        return operator
+            result = self.define_avgpool_node(
+                [avgpool_input], [node], "VALID", stride, kernel_size
+            )
+        elif count_include_pad is False:
+            if not self.has_padding(args):  # valid padding
+                result = self.define_avgpool_node(
+                    [avgpool_input], [node], "VALID", stride, kernel_size
+                )
+            elif self.has_same_padding(args):
+                result = self.define_avgpool_node(
+                    [avgpool_input], [node], "SAME", stride, kernel_size
+                )
+            else:
+                # CASE: count_include_pad is False and not VALID/SAME padding
+                #
+                # Implement this when it's needed.
+                # If needed, may it help: the idea of ratio masking in https://github.com/Samsung/TICO/pull/119
+                raise NotYetSupportedError(
+                    f"Padding({padding}) with count_include_pad({count_include_pad}) is not supported yet."
+                )
+        else:
+            raise RuntimeError("Cannot reach here")
+
+        return result

{tico-0.1.0.dev250603.dist-info → tico-0.1.0.dev250604.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tico
-Version: 0.1.0.dev250603
+Version: 0.1.0.dev250604
 Summary: Convert exported Torch module to circle
 Home-page: UNKNOWN
 License: UNKNOWN

{tico-0.1.0.dev250603.dist-info → tico-0.1.0.dev250604.dist-info}/RECORD

@@ -1,4 +1,4 @@
-tico/__init__.py,sha256=b-iBFbe5L_XPwZaSnmweHVjabHVJPCZBqZOh5P1nUZU,1743
+tico/__init__.py,sha256=X2eazANf-Y9gV1fcug-QytZyLbNFnJqqW658DamD_wI,1743
 tico/pt2_to_circle.py,sha256=PPmFNw20jw2Z2VyM3ln9pX__jTzBOAZiv0gT5a-p-Y8,2666
 tico/config/__init__.py,sha256=xZzCXjZ84qE-CsBi-dfaL05bqpQ3stKKfTXhnrJRyVs,142
 tico/config/base.py,sha256=anwOiJFkUxUi7Cef573JgQcjk6S-FSi6O_TLjYASW-g,1244
@@ -77,7 +77,7 @@ tico/passes/extract_dtype_kwargs.py,sha256=hfGJ_GfZULbBmLif2AJkhPHVifhucxBiLoQI8
 tico/passes/fill_meta_val.py,sha256=Xbam6Aq90ZfWItZw1dgLIwH_q8RCiU5JodKNqkj-ink,1797
 tico/passes/fuse_redundant_reshape_to_mean.py,sha256=SzHLLL2Yfj4k1c2L5i4PVI9EFUilHRfIS6S-hahKFCM,3702
 tico/passes/legalize_causal_mask_value.py,sha256=KZc_UPk7CGPXO35JOu6dVrOzRJx-ZpJoVvuzz-GvQek,4080
-tico/passes/legalize_predefined_layout_operators.py,sha256=OKVKxw039Bl9df7YCt17mWOHaGhQLWkJeSIPQpWdNBM,16224
+tico/passes/legalize_predefined_layout_operators.py,sha256=N2TtJInjSTk-E5afnkDXXbo9v4zTM7yzsjna3VoihMw,15895
 tico/passes/lower_pow2_to_mul.py,sha256=imx9CoKG4bLyNqv4F-Z203s_P0-0SdRH-y4_Q0PTZVo,2304
 tico/passes/lower_to_resize_nearest_neighbor.py,sha256=4bIxPSyNEzznTw8f8D9hMNXbZ0KmMPPPfRvITXonEz0,8881
 tico/passes/lower_to_slice.py,sha256=6xK7A2hdqdBdN2XRyt2rFGnqJGcaXxmgndis4kn2q2w,7112
@@ -107,7 +107,7 @@ tico/serialize/operators/op_alias_copy.py,sha256=Xu9OiILbGf8oddh8yTqovvLfgVs8XYV
 tico/serialize/operators/op_any.py,sha256=WMsHLq7WIcl6rD2G3QqpWRSCR-a6UYX6y5AjB6BDS3U,5049
 tico/serialize/operators/op_arange_start_step.py,sha256=0T5lWwh3TfsFStmVv0v5qG03KENRDBmMix08RXQ4D-U,2132
 tico/serialize/operators/op_argmax.py,sha256=ARyGHlmWVmzwCct93V5x1-VyKqhxMOvV8GuM8yQWXdo,2290
-tico/serialize/operators/op_avg_pool2d.py,sha256=kLtbB1VmGC8H51rF4OmQIZxpUkpK1ZlqYXNkJdvABYc,4068
+tico/serialize/operators/op_avg_pool2d.py,sha256=ABxhfowDz7SXlWnW2iQuSA5X52xm0PGLs-N1l9vGXbo,7488
 tico/serialize/operators/op_bmm.py,sha256=AELjHC9ISFPIzEEl5Kr1s4GSNLZElwZmVZJWkEyCEoA,2189
 tico/serialize/operators/op_cat.py,sha256=XDYOh0XAyrM0TlxVm6Sa0OFFGrKk7aSDcGXC-hYX4gs,2204
 tico/serialize/operators/op_clamp.py,sha256=V3rncHvUAuJ2nXOyywTnOGCvNBeCQGqQIW1_zxKlSsA,4231
@@ -194,9 +194,9 @@ tico/utils/mx/__init__.py,sha256=IO6FP_xYbGy0dW0HL26GXD3ouxARaxCK7bz9dn4blPQ,26
 tico/utils/mx/elemwise_ops.py,sha256=V6glyAHsVR1joqpsgnNytatCD_ew92xNWZ19UFDoMTA,10281
 tico/utils/mx/formats.py,sha256=uzNWyu-1onUlwQfX5cZ6fZSUfHMRqorper7_T1k3jfk,3404
 tico/utils/mx/mx_ops.py,sha256=RcfUTYVi-wilGB2sC35OeARdwDqnixv7dG5iyZ-fQT8,8555
-tico-0.1.0.dev250603.dist-info/LICENSE,sha256=kp4JLII7bzRhPb0CPD5XTDZMh22BQ7h3k3B7t8TiSbw,12644
-tico-0.1.0.dev250603.dist-info/METADATA,sha256=CcrcTSCD543XA0KQHdiYENeTXpcbw4p7OwkJtHOXtiY,8633
-tico-0.1.0.dev250603.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
-tico-0.1.0.dev250603.dist-info/entry_points.txt,sha256=kBKYSS_IYrSXmUYevmmepqIVPScq5vF8ulQRu3I_Zf0,59
-tico-0.1.0.dev250603.dist-info/top_level.txt,sha256=oqs7UPoNSKZEwqsX8B-KAWdQwfAa7i60pbxW_Jk7P3w,5
-tico-0.1.0.dev250603.dist-info/RECORD,,
+tico-0.1.0.dev250604.dist-info/LICENSE,sha256=kp4JLII7bzRhPb0CPD5XTDZMh22BQ7h3k3B7t8TiSbw,12644
+tico-0.1.0.dev250604.dist-info/METADATA,sha256=gN7iYzRhOodrWqExhbNBTMQ5S_6iOpb-vte13nECcak,8633
+tico-0.1.0.dev250604.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
+tico-0.1.0.dev250604.dist-info/entry_points.txt,sha256=kBKYSS_IYrSXmUYevmmepqIVPScq5vF8ulQRu3I_Zf0,59
+tico-0.1.0.dev250604.dist-info/top_level.txt,sha256=oqs7UPoNSKZEwqsX8B-KAWdQwfAa7i60pbxW_Jk7P3w,5
+tico-0.1.0.dev250604.dist-info/RECORD,,