Export Model APIs (#2389)

* Fix backbone export under models * Namex for API generation * Use Namex API generator * Namex for API generation * Export API namex * Fix typo and export APIs
keras-team · Mar 18, 2024 · fb05c82 · fb05c82
1 parent 707132b
commit fb05c82
Show file tree

Hide file tree

Showing 13 changed files with 55 additions and 6 deletions.
diff --git a/keras_cv/models/backbones/csp_darknet/csp_darknet_aliases.py b/keras_cv/models/backbones/csp_darknet/csp_darknet_aliases.py
@@ -52,7 +52,7 @@
 """  # noqa: E501
 
 
-@keras_cv_export("keras_cv.losses.CSPDarkNetTinyBackbone")
+@keras_cv_export("keras_cv.models.CSPDarkNetTinyBackbone")
 class CSPDarkNetTinyBackbone(CSPDarkNetBackbone):
     def __new__(
         cls,
@@ -87,7 +87,7 @@ def presets_with_weights(cls):
         return cls.presets
 
 
-@keras_cv_export("keras_cv.losses.CSPDarkNetSBackbone")
+@keras_cv_export("keras_cv.models.CSPDarkNetSBackbone")
 class CSPDarkNetSBackbone(CSPDarkNetBackbone):
     def __new__(
         cls,
@@ -118,7 +118,7 @@ def presets_with_weights(cls):
         return {}
 
 
-@keras_cv_export("keras_cv.losses.CSPDarkNetMBackbone")
+@keras_cv_export("keras_cv.models.CSPDarkNetMBackbone")
 class CSPDarkNetMBackbone(CSPDarkNetBackbone):
     def __new__(
         cls,
@@ -149,7 +149,7 @@ def presets_with_weights(cls):
         return {}
 
 
-@keras_cv_export("keras_cv.losses.CSPDarkNetLBackbone")
+@keras_cv_export("keras_cv.models.CSPDarkNetLBackbone")
 class CSPDarkNetLBackbone(CSPDarkNetBackbone):
     def __new__(
         cls,
@@ -184,7 +184,7 @@ def presets_with_weights(cls):
         return cls.presets
 
 
-@keras_cv_export("keras_cv.losses.CSPDarkNetXLBackbone")
+@keras_cv_export("keras_cv.models.CSPDarkNetXLBackbone")
 class CSPDarkNetXLBackbone(CSPDarkNetBackbone):
     def __new__(
         cls,

diff --git a/keras_cv/models/backbones/efficientnet_lite/efficientnet_lite_aliases.py b/keras_cv/models/backbones/efficientnet_lite/efficientnet_lite_aliases.py
@@ -12,6 +12,7 @@
 # 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.models.backbones.efficientnet_lite.efficientnet_lite_backbone import (  # noqa: E501
     EfficientNetLiteBackbone,
 )
@@ -41,6 +42,7 @@
 """  # noqa: E501
 
 
+@keras_cv_export("keras_cv.models.EfficientNetLiteB0Backbone")
 class EfficientNetLiteB0Backbone(EfficientNetLiteBackbone):
     def __new__(
         cls,
@@ -73,6 +75,7 @@ def presets_with_weights(cls):
         return {}
 
 
+@keras_cv_export("keras_cv.models.EfficientNetLiteB1Backbone")
 class EfficientNetLiteB1Backbone(EfficientNetLiteBackbone):
     def __new__(
         cls,
@@ -105,6 +108,7 @@ def presets_with_weights(cls):
         return {}
 
 
+@keras_cv_export("keras_cv.models.EfficientNetLiteB2Backbone")
 class EfficientNetLiteB2Backbone(EfficientNetLiteBackbone):
     def __new__(
         cls,
@@ -137,6 +141,7 @@ def presets_with_weights(cls):
         return {}
 
 
+@keras_cv_export("keras_cv.models.EfficientNetLiteB3Backbone")
 class EfficientNetLiteB3Backbone(EfficientNetLiteBackbone):
     def __new__(
         cls,
@@ -169,6 +174,7 @@ def presets_with_weights(cls):
         return {}
 
 
+@keras_cv_export("keras_cv.models.EfficientNetLiteB4Backbone")
 class EfficientNetLiteB4Backbone(EfficientNetLiteBackbone):
     def __new__(
         cls,

diff --git a/keras_cv/models/backbones/efficientnet_lite/efficientnet_lite_backbone.py b/keras_cv/models/backbones/efficientnet_lite/efficientnet_lite_backbone.py
@@ -24,6 +24,7 @@
 import copy
 import math
 
+from keras_cv.api_export import keras_cv_export
 from keras_cv.backend import keras
 from keras_cv.models import utils
 from keras_cv.models.backbones.backbone import Backbone
@@ -35,6 +36,7 @@
 BN_AXIS = 3
 
 
+@keras_cv_export("keras_cv.models.EfficientNetLiteBackbone")
 @keras.saving.register_keras_serializable(package="keras_cv.models")
 class EfficientNetLiteBackbone(Backbone):
     """Instantiates the EfficientNetLite architecture using given scaling

diff --git a/keras_cv/models/backbones/efficientnet_v1/efficientnet_v1_aliases.py b/keras_cv/models/backbones/efficientnet_v1/efficientnet_v1_aliases.py
@@ -12,6 +12,7 @@
 # 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.models.backbones.efficientnet_v1.efficientnet_v1_backbone import (
     EfficientNetV1Backbone,
 )
@@ -33,6 +34,7 @@
 """  # noqa: E501
 
 
+@keras_cv_export("keras_cv.models.EfficientNetV1B0Backbone")
 class EfficientNetV1B0Backbone(EfficientNetV1Backbone):
     def __new__(
         cls,
@@ -63,6 +65,7 @@ def presets_with_weights(cls):
         return {}
 
 
+@keras_cv_export("keras_cv.models.EfficientNetV1B1Backbone")
 class EfficientNetV1B1Backbone(EfficientNetV1Backbone):
     def __new__(
         cls,
@@ -93,6 +96,7 @@ def presets_with_weights(cls):
         return {}
 
 
+@keras_cv_export("keras_cv.models.EfficientNetV1B2Backbone")
 class EfficientNetV1B2Backbone(EfficientNetV1Backbone):
     def __new__(
         cls,
@@ -123,6 +127,7 @@ def presets_with_weights(cls):
         return {}
 
 
+@keras_cv_export("keras_cv.models.EfficientNetV1B3Backbone")
 class EfficientNetV1B3Backbone(EfficientNetV1Backbone):
     def __new__(
         cls,
@@ -153,6 +158,7 @@ def presets_with_weights(cls):
         return {}
 
 
+@keras_cv_export("keras_cv.models.EfficientNetV1B4Backbone")
 class EfficientNetV1B4Backbone(EfficientNetV1Backbone):
     def __new__(
         cls,
@@ -183,6 +189,7 @@ def presets_with_weights(cls):
         return {}
 
 
+@keras_cv_export("keras_cv.models.EfficientNetV1B5Backbone")
 class EfficientNetV1B5Backbone(EfficientNetV1Backbone):
     def __new__(
         cls,
@@ -213,6 +220,7 @@ def presets_with_weights(cls):
         return {}
 
 
+@keras_cv_export("keras_cv.models.EfficientNetV1B6Backbone")
 class EfficientNetV1B6Backbone(EfficientNetV1Backbone):
     def __new__(
         cls,
@@ -243,6 +251,7 @@ def presets_with_weights(cls):
         return {}
 
 
+@keras_cv_export("keras_cv.models.EfficientNetV1B7Backbone")
 class EfficientNetV1B7Backbone(EfficientNetV1Backbone):
     def __new__(
         cls,

diff --git a/keras_cv/models/backbones/efficientnet_v1/efficientnet_v1_backbone.py b/keras_cv/models/backbones/efficientnet_v1/efficientnet_v1_backbone.py
@@ -14,6 +14,7 @@
 import copy
 import math
 
+from keras_cv.api_export import keras_cv_export
 from keras_cv.backend import keras
 from keras_cv.models import utils
 from keras_cv.models.backbones.backbone import Backbone
@@ -23,6 +24,7 @@
 from keras_cv.utils.python_utils import classproperty
 
 
+@keras_cv_export("keras_cv.models.EfficientNetV1Backbone")
 @keras.saving.register_keras_serializable(package="keras_cv.models")
 class EfficientNetV1Backbone(Backbone):
     """Instantiates the EfficientNetV1 architecture.

diff --git a/keras_cv/models/backbones/mix_transformer/mix_transformer_aliases.py b/keras_cv/models/backbones/mix_transformer/mix_transformer_aliases.py
@@ -14,6 +14,7 @@
 
 import copy
 
+from keras_cv.api_export import keras_cv_export
 from keras_cv.models.backbones.mix_transformer.mix_transformer_backbone import (
     MiTBackbone,
 )
@@ -46,6 +47,7 @@
 """  # noqa: E501
 
 
+@keras_cv_export("keras_cv.models.MiTB0Backbone")
 class MiTB0Backbone(MiTBackbone):
     def __new__(
         cls,
@@ -80,6 +82,7 @@ def presets_with_weights(cls):
         return cls.presets
 
 
+@keras_cv_export("keras_cv.models.MiTB1Backbone")
 class MiTB1Backbone(MiTBackbone):
     def __new__(
         cls,
@@ -109,6 +112,7 @@ def presets_with_weights(cls):
         return {}
 
 
+@keras_cv_export("keras_cv.models.MiTB2Backbone")
 class MiTB2Backbone(MiTBackbone):
     def __new__(
         cls,
@@ -138,6 +142,7 @@ def presets_with_weights(cls):
         return {}
 
 
+@keras_cv_export("keras_cv.models.MiTB3Backbone")
 class MiTB3Backbone(MiTBackbone):
     def __new__(
         cls,
@@ -167,6 +172,7 @@ def presets_with_weights(cls):
         return {}
 
 
+@keras_cv_export("keras_cv.models.MiTB4Backbone")
 class MiTB4Backbone(MiTBackbone):
     def __new__(
         cls,
@@ -196,6 +202,7 @@ def presets_with_weights(cls):
         return {}
 
 
+@keras_cv_export("keras_cv.models.MiTB5Backbone")
 class MiTB5Backbone(MiTBackbone):
     def __new__(
         cls,

diff --git a/keras_cv/models/backbones/vgg16/vgg16_backbone.py b/keras_cv/models/backbones/vgg16/vgg16_backbone.py
@@ -14,10 +14,12 @@
 
 from keras import layers
 
+from keras_cv.api_export import keras_cv_export
 from keras_cv.models import utils
 from keras_cv.models.backbones.backbone import Backbone
 
 
+@keras_cv_export("keras_cv.models.VGG16Backbone")
 class VGG16Backbone(Backbone):
     """
     Reference:

diff --git a/keras_cv/models/backbones/vit_det/vit_det_aliases.py b/keras_cv/models/backbones/vit_det/vit_det_aliases.py
@@ -14,6 +14,7 @@
 
 import copy
 
+from keras_cv.api_export import keras_cv_export
 from keras_cv.models.backbones.vit_det.vit_det_backbone import ViTDetBackbone
 from keras_cv.models.backbones.vit_det.vit_det_backbone_presets import (
     backbone_presets,
@@ -41,6 +42,7 @@
 """  # noqa: E501
 
 
+@keras_cv_export("keras_cv.models.ViTDetBBackbone")
 class ViTDetBBackbone(ViTDetBackbone):
     def __new__(
         cls,
@@ -64,6 +66,7 @@ def presets_with_weights(cls):
         return cls.presets
 
 
+@keras_cv_export("keras_cv.models.ViTDetLBackbone")
 class ViTDetLBackbone(ViTDetBackbone):
     def __new__(
         cls,
@@ -87,6 +90,7 @@ def presets_with_weights(cls):
         return cls.presets
 
 
+@keras_cv_export("keras_cv.models.ViTDetHBackbone")
 class ViTDetHBackbone(ViTDetBackbone):
     def __new__(
         cls,

diff --git a/keras_cv/models/feature_extractor/clip/clip_encoder.py b/keras_cv/models/feature_extractor/clip/clip_encoder.py
@@ -13,6 +13,7 @@
 # limitations under the License.
 import numpy as np
 
+from keras_cv.api_export import keras_cv_export
 from keras_cv.backend import keras
 from keras_cv.backend import ops
 
@@ -31,6 +32,7 @@ def get_initializer(initializer_range=0.02):
     return keras.initializers.TruncatedNormal(stddev=initializer_range)
 
 
+@keras_cv_export("keras_cv.models.feature_extractor.QuickGELU")
 class QuickGELU(keras.layers.Layer):
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
@@ -39,6 +41,7 @@ def call(self, x):
         return x * ops.sigmoid(1.702 * x)
 
 
+@keras_cv_export("keras_cv.models.feature_extractor.ResidualAttention")
 class ResidualAttention(keras.layers.Layer):
     def __init__(
         self,
@@ -136,6 +139,7 @@ def get_config(self):
         return config
 
 
+@keras_cv_export("keras_cv.models.feature_extractor.CLIPEncoder")
 class CLIPEncoder(keras.layers.Layer):
     def __init__(self, width, num_layers, heads, **kwargs):
         super().__init__(**kwargs)
@@ -185,6 +189,7 @@ def get_config(self):
         return config
 
 
+@keras_cv_export("keras_cv.models.feature_extractor.CLIPAttention")
 class CLIPAttention(keras.layers.Layer):
     """
     Adapted from https://github.com/huggingface/transformers/blob/main/src/transformers/models/clip/modeling_clip.py # noqa: E501

diff --git a/keras_cv/models/feature_extractor/clip/clip_image_model.py b/keras_cv/models/feature_extractor/clip/clip_image_model.py
@@ -12,12 +12,14 @@
 # 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.backend import keras
 from keras_cv.backend import ops
 from keras_cv.models.feature_extractor.clip.clip_encoder import CLIPEncoder
 from keras_cv.models.feature_extractor.clip.clip_encoder import get_initializer
 
 
+@keras_cv_export("keras_cv.models.feature_extractor.CLIPPatchingAndEmbedding")
 class CLIPPatchingAndEmbedding(keras.layers.Layer):
     def __init__(
         self, width, patch_size, input_resolution, output_dim, **kwargs
@@ -95,6 +97,7 @@ def get_config(self):
         return config
 
 
+@keras_cv_export("keras_cv.models.feature_extractor.CLIPImageEncoder")
 class CLIPImageEncoder(keras.Model):
     def __init__(
         self,

diff --git a/keras_cv/models/feature_extractor/clip/clip_processor.py b/keras_cv/models/feature_extractor/clip/clip_processor.py
@@ -19,7 +19,7 @@
 from keras_cv.models.feature_extractor.clip.clip_tokenizer import CLIPTokenizer
 
 
-@keras_cv_export("keras_cv.models.feature_extractors.CLIPProcessor")
+@keras_cv_export("keras_cv.models.feature_extractor.CLIPProcessor")
 class CLIPProcessor:
     """
     CLIPProcessor is a utility class that provides functionality for processing

diff --git a/keras_cv/models/feature_extractor/clip/clip_text_model.py b/keras_cv/models/feature_extractor/clip/clip_text_model.py
@@ -11,11 +11,13 @@
 # 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.
+from keras_cv.api_export import keras_cv_export
 from keras_cv.backend import keras
 from keras_cv.backend import ops
 from keras_cv.models.feature_extractor.clip.clip_encoder import CLIPEncoder
 
 
+@keras_cv_export("keras_cv.models.feature_extractor.CLIPTextEncoder")
 class CLIPTextEncoder(keras.Model):
     def __init__(
         self,