Use Namex for API generation (#1995)

* Structure for Namex export

* Switch to programmatic API generation with Namex

* Fix missing import

* Fix preset class names

Author: ianstenbit

.github/workflows/release.yml

@@ -102,7 +102,7 @@ jobs:
         pip install tensorflow==2.13.0
         python -m pip install --upgrade pip setuptools wheel twine
         export BUILD_WITH_CUSTOM_OPS=false
-        python setup.py sdist bdist_wheel
+        python pip_build.py
     - name: Upload wheels
       env:
         TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}

keras_cv/api_export.py

@@ -0,0 +1,48 @@
+# Copyright 2023 The KerasCV Authors
+#
+# Licensed 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
+#
+#     https://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.
+
+import types
+
+from keras_cv.backend import keras
+
+try:
+    import namex
+except ImportError:
+    namex = None
+
+
+def maybe_register_serializable(symbol):
+    if isinstance(symbol, types.FunctionType) or hasattr(symbol, "get_config"):
+        keras.saving.register_keras_serializable(package="keras_cv")(symbol)
+
+
+if namex:
+
+    class keras_cv_export(namex.export):
+        def __init__(self, path):
+            super().__init__(package="keras_cv", path=path)
+
+        def __call__(self, symbol):
+            maybe_register_serializable(symbol)
+            return super().__call__(symbol)
+
+else:
+
+    class keras_cv_export:
+        def __init__(self, path):
+            pass
+
+        def __call__(self, symbol):
+            maybe_register_serializable(symbol)
+            return symbol

keras_cv/bounding_box/converters.py

@@ -16,6 +16,7 @@
 
 import tensorflow as tf
 
+from keras_cv.api_export import keras_cv_export
 from keras_cv.backend import keras
 from keras_cv.backend import ops
 from keras_cv.backend.scope import tf_data
@@ -298,6 +299,7 @@ def _xyxy_to_rel_yxyx(boxes, images=None, image_shape=None):
 }
 
 
+@keras_cv_export("keras_cv.bounding_box.convert_format")
 @tf_data
 def convert_format(
     boxes, source, target, images=None, image_shape=None, dtype="float32"

keras_cv/bounding_box/ensure_tensor.py

@@ -12,9 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from keras_cv.api_export import keras_cv_export
 from keras_cv.utils import preprocessing
 
 
+@keras_cv_export("keras_cv.bounding_box.ensure_tensor")
 def ensure_tensor(boxes, dtype=None):
     boxes = boxes.copy()
     for key in ["boxes", "classes", "confidence"]:

keras_cv/bounding_box/formats.py

@@ -15,7 +15,10 @@
 formats.py contains axis information for each supported format.
 """
 
+from keras_cv.api_export import keras_cv_export
 
+
+@keras_cv_export("keras_cv.bounding_box.XYXY")
 class XYXY:
     """XYXY contains axis indices for the XYXY format.
 
@@ -35,6 +38,7 @@ class XYXY:
     BOTTOM = 3
 
 
+@keras_cv_export("keras_cv.bounding_box.REL_XYXY")
 class REL_XYXY:
     """REL_XYXY contains axis indices for the REL_XYXY format.
 
@@ -56,6 +60,7 @@ class REL_XYXY:
     BOTTOM = 3
 
 
+@keras_cv_export("keras_cv.bounding_box.CENTER_XYWH")
 class CENTER_XYWH:
     """CENTER_XYWH contains axis indices for the CENTER_XYWH format.
 
@@ -75,6 +80,7 @@ class CENTER_XYWH:
     HEIGHT = 3
 
 
+@keras_cv_export("keras_cv.bounding_box.XYWH")
 class XYWH:
     """XYWH contains axis indices for the XYWH format.
 
@@ -94,6 +100,7 @@ class XYWH:
     HEIGHT = 3
 
 
+@keras_cv_export("keras_cv.bounding_box.REL_XYWH")
 class REL_XYWH:
     """REL_XYWH contains axis indices for the XYWH format.
 
@@ -113,6 +120,7 @@ class REL_XYWH:
     HEIGHT = 3
 
 
+@keras_cv_export("keras_cv.bounding_box.YXYX")
 class YXYX:
     """YXYX contains axis indices for the YXYX format.
 
@@ -132,6 +140,7 @@ class YXYX:
     RIGHT = 3
 
 
+@keras_cv_export("keras_cv.bounding_box.REL_YXYX")
 class REL_YXYX:
     """REL_YXYX contains axis indices for the REL_YXYX format.
 

keras_cv/bounding_box/iou.py

@@ -15,6 +15,7 @@
 import math
 
 from keras_cv import bounding_box
+from keras_cv.api_export import keras_cv_export
 from keras_cv.backend import keras
 from keras_cv.backend import ops
 
@@ -60,6 +61,7 @@ def _compute_intersection(boxes1, boxes2):
     return intersect_height * intersect_width
 
 
+@keras_cv_export("keras_cv.bounding_box.compute_iou")
 def compute_iou(
     boxes1,
     boxes2,
@@ -170,6 +172,7 @@ def compute_iou(
     return iou_lookup_table
 
 
+@keras_cv_export("keras_cv.bounding_box.compute_ciou")
 def compute_ciou(box1, box2, bounding_box_format, eps=1e-7):
     """
     Computes the Complete IoU (CIoU) between two bounding boxes or between

keras_cv/bounding_box/mask_invalid_detections.py

@@ -13,11 +13,13 @@
 # limitations under the License.
 
 from keras_cv import backend
+from keras_cv.api_export import keras_cv_export
 from keras_cv.backend import ops
 from keras_cv.bounding_box.to_ragged import to_ragged
 from keras_cv.bounding_box.validate_format import validate_format
 
 
+@keras_cv_export("keras_cv.bounding_box.mask_invalid_detections")
 def mask_invalid_detections(bounding_boxes, output_ragged=False):
     """masks out invalid detections with -1s.
 

keras_cv/bounding_box/to_dense.py

@@ -14,6 +14,7 @@
 import tensorflow as tf
 
 import keras_cv.bounding_box.validate_format as validate_format
+from keras_cv.api_export import keras_cv_export
 from keras_cv.backend.scope import tf_data
 
 
@@ -36,6 +37,7 @@ def _classes_shape(batched, classes_shape, max_boxes):
     return [max_boxes] + classes_shape[2:]
 
 
+@keras_cv_export("keras_cv.bounding_box.to_dense")
 @tf_data
 def to_dense(bounding_boxes, max_boxes=None, default_value=-1):
     """to_dense converts bounding boxes to Dense tensors

keras_cv/bounding_box/to_ragged.py

@@ -15,9 +15,11 @@
 
 import keras_cv.bounding_box.validate_format as validate_format
 from keras_cv import backend
+from keras_cv.api_export import keras_cv_export
 from keras_cv.backend import keras
 
 
+@keras_cv_export("keras_cv.bounding_box.to_ragged")
 def to_ragged(bounding_boxes, sentinel=-1, dtype=tf.float32):
     """converts a Dense padded bounding box `tf.Tensor` to a `tf.RaggedTensor`.
 

keras_cv/bounding_box/utils.py

@@ -14,10 +14,12 @@
 """Utility functions for working with bounding boxes."""
 
 from keras_cv import bounding_box
+from keras_cv.api_export import keras_cv_export
 from keras_cv.backend import ops
 from keras_cv.bounding_box.formats import XYWH
 
 
+@keras_cv_export("keras_cv.bounding_box.is_relative")
 def is_relative(bounding_box_format):
     """A util to check if a bounding box format uses relative coordinates"""
     if (
@@ -34,6 +36,7 @@ def is_relative(bounding_box_format):
     return bounding_box_format.startswith("rel")
 
 
+@keras_cv_export("keras_cv.bounding_box.as_relative")
 def as_relative(bounding_box_format):
     """A util to get the relative equivalent of a provided bounding box format.
 
@@ -61,8 +64,7 @@ def _relative_area(boxes, bounding_box_format):
     )
 
 
-# bounding_boxes is a dictionary with shape:
-# {"boxes": [None, None, 4], "mask": [None, None]}
+@keras_cv_export("keras_cv.bounding_box.clip_to_image")
 def clip_to_image(
     bounding_boxes, bounding_box_format, images=None, image_shape=None
 ):