clarifai 10.0.0__py3-none-any.whl → 10.1.0__py3-none-any.whl

clarifai/models/model_serving/model_config/model_types_config/text-to-image.yaml

@@ -1,18 +1,19 @@
-triton:
-  input:
-    - name: text
-      data_type: TYPE_STRING
-      dims: [1]
-  output:
-    - name: image
-      data_type: TYPE_UINT8
-      dims: [-1, -1, 3]
-      labels: false
-inference:
-  wrap_func: text_to_image
-  return_type: ImageOutput
-field_maps:
-  input_fields_map:
-    text: text
-  output_fields_map:
-    image: image
+serving_backend:
+  triton:
+    input:
+      - name: text
+        data_type: TYPE_STRING
+        dims: [1]
+    output:
+      - name: image
+        data_type: TYPE_UINT8
+        dims: [-1, -1, 3]
+        label_filename: null
+clarifai_model:
+  type: text-to-image
+  output_type: ImageOutput
+  field_maps:
+    input_fields_map:
+      text: text
+    output_fields_map:
+      image: image

clarifai/models/model_serving/model_config/model_types_config/text-to-text.yaml

@@ -1,18 +1,19 @@
-triton:
-  input:
-    - name: text
-      data_type: TYPE_STRING
-      dims: [1]
-  output:
-    - name: text
-      data_type: TYPE_STRING
-      dims: [1]
-      labels: false
-inference:
-  wrap_func: text_to_text
-  return_type: TextOutput
-field_maps:
-  input_fields_map:
-    text: text
-  output_fields_map:
-    text: text
+serving_backend:
+  triton:
+    input:
+      - name: text
+        data_type: TYPE_STRING
+        dims: [1]
+    output:
+      - name: text
+        data_type: TYPE_STRING
+        dims: [1]
+        label_filename: null
+clarifai_model:
+  type: text-to-text
+  output_type: TextOutput
+  field_maps:
+    input_fields_map:
+      text: text
+    output_fields_map:
+      text: text

clarifai/models/model_serving/model_config/model_types_config/visual-classifier.yaml

@@ -1,18 +1,22 @@
-triton:
-  input:
-    - name: image
-      data_type: TYPE_UINT8
-      dims: [-1, -1, 3]
-  output:
-    - name: softmax_predictions
-      data_type: TYPE_FP32
-      dims: [-1]
-      labels: true
-inference:
-  wrap_func: visual_classifier
-  return_type: ClassifierOutput
-field_maps:
-  input_fields_map:
-    image: image
-  output_fields_map:
-    concepts: softmax_predictions
+serving_backend:
+  triton:
+    input:
+      - name: image
+        data_type: TYPE_UINT8
+        dims: [-1, -1, 3]
+    output:
+      - name: softmax_predictions
+        data_type: TYPE_FP32
+        dims: [-1]
+        label_filename: "labels.txt"
+
+clarifai_model:
+  field_maps:
+    input_fields_map:
+      image: image
+    output_fields_map:
+      concepts: softmax_predictions
+  output_type: ClassifierOutput
+  type: visual-classifier
+  labels:
+  inference_parameters:

clarifai/models/model_serving/model_config/model_types_config/visual-detector.yaml

@@ -1,28 +1,32 @@
-triton:
-  input:
-    - name: image
-      data_type: TYPE_UINT8
-      dims: [-1, -1, 3]
-  output:
-    - name: predicted_bboxes
-      data_type: TYPE_FP32
-      dims: [-1, 4]
-      labels: false
-    - name: predicted_labels
-      data_type: TYPE_INT32
-      dims: [-1, 1]
-      labels: true
-    - name: predicted_scores
-      data_type: TYPE_FP32
-      dims: [-1, 1]
-      labels: false
-inference:
-  wrap_func: visual_detector
-  return_type: VisualDetectorOutput
-field_maps:
-  input_fields_map:
-    image: image
-  output_fields_map:
-    "regions[...].region_info.bounding_box": "predicted_bboxes"
-    "regions[...].data.concepts[...].id": "predicted_labels"
-    "regions[...].data.concepts[...].value": "predicted_scores"
+serving_backend:
+  triton:
+    input:
+      - name: image
+        data_type: TYPE_UINT8
+        dims: [-1, -1, 3]
+    output:
+      - name: predicted_bboxes
+        data_type: TYPE_FP32
+        dims: [-1, 4]
+        label_filename: null
+      - name: predicted_labels
+        data_type: TYPE_INT32
+        dims: [-1, 1]
+        label_filename: "labels.txt"
+      - name: predicted_scores
+        data_type: TYPE_FP32
+        dims: [-1, 1]
+        label_filename: null
+
+clarifai_model:
+  field_maps:
+    input_fields_map:
+      image: image
+    output_fields_map:
+      "regions[...].region_info.bounding_box": "predicted_bboxes"
+      "regions[...].data.concepts[...].id": "predicted_labels"
+      "regions[...].data.concepts[...].value": "predicted_scores"
+  output_type: VisualDetectorOutput
+  type: visual-detector
+  labels:
+  inference_parameters:

clarifai/models/model_serving/model_config/model_types_config/visual-embedder.yaml

@@ -1,18 +1,19 @@
-triton:
-  input:
-    - name: image
-      data_type: TYPE_UINT8
-      dims: [-1, -1, 3]
-  output:
-    - name: embeddings
-      data_type: TYPE_FP32
-      dims: [-1]
-      labels: false
-inference:
-  wrap_func: visual_embedder
-  return_type: EmbeddingOutput
-field_maps:
-  input_fields_map:
-    image: image
-  output_fields_map:
-    embeddings: embeddings
+serving_backend:
+  triton:
+    input:
+      - name: image
+        data_type: TYPE_UINT8
+        dims: [-1, -1, 3]
+    output:
+      - name: embeddings
+        data_type: TYPE_FP32
+        dims: [-1]
+        label_filename: null
+clarifai_model:
+  type: visual-embedder
+  output_type: EmbeddingOutput
+  field_maps:
+    input_fields_map:
+      image: image
+    output_fields_map:
+      embeddings: embeddings

clarifai/models/model_serving/model_config/model_types_config/visual-segmenter.yaml

@@ -1,18 +1,19 @@
-triton:
-  input:
-    - name: image
-      data_type: TYPE_UINT8
-      dims: [-1, -1, 3]
-  output:
-    - name: predicted_mask
-      data_type: TYPE_INT64
-      dims: [-1, -1]
-      labels: true
-inference:
-  wrap_func: visual_segmenter
-  return_type: MasksOutput
-field_maps:
-  input_fields_map:
-    image: image
-  output_fields_map:
-    "regions[...].region_info.mask,regions[...].data.concepts": "predicted_mask"
+serving_backend:
+  triton:
+    input:
+      - name: image
+        data_type: TYPE_UINT8
+        dims: [-1, -1, 3]
+    output:
+      - name: predicted_mask
+        data_type: TYPE_INT64
+        dims: [-1, -1]
+        label_filename: "labels.txt"
+clarifai_model:
+  type: visual-segmenter
+  output_type: MasksOutput
+  field_maps:
+    input_fields_map:
+      image: image
+    output_fields_map:
+      "regions[...].region_info.mask,regions[...].data.concepts": "predicted_mask"

clarifai/models/model_serving/{models → model_config}/output.py

@@ -28,6 +28,10 @@ class VisualDetectorOutput:
     """
     Validate input upon initialization.
     """
+    assert isinstance(self.predicted_scores, np.ndarray), "`predicted_scores` must be numpy array"
+    assert isinstance(self.predicted_labels, np.ndarray), "`predicted_labels` must be numpy array"
+    assert isinstance(self.predicted_scores, np.ndarray), "`predicted_scores` must be numpy array"
+
     assert self.predicted_bboxes.ndim == self.predicted_labels.ndim == \
       self.predicted_scores.ndim==2, f"All predictions must be 2-dimensional, \
         Got bbox-dims: {self.predicted_bboxes.ndim}, label-dims: {self.predicted_labels.ndim}, \
@@ -58,6 +62,7 @@ class ClassifierOutput:
     """
     Validate input upon initialization.
     """
+    assert isinstance(self.predicted_scores, np.ndarray), "`predicted_scores` must be numpy array"
     assert self.predicted_scores.ndim == 1, \
       f"All predictions must be 1-dimensional, Got scores-dims: {self.predicted_scores.ndim} instead."
 
@@ -89,6 +94,7 @@ class EmbeddingOutput:
     """
     Validate input upon initialization.
     """
+    assert isinstance(self.embedding_vector, np.ndarray), "`embedding_vector` must be numpy array"
     assert self.embedding_vector.ndim == 1, \
       f"Embeddings must be 1-dimensional, Got embedding-dims: {self.embedding_vector.ndim} instead."
 
@@ -104,6 +110,7 @@ class MasksOutput:
     """
     Validate input upon initialization.
     """
+    assert isinstance(self.predicted_mask, np.ndarray), "`predicted_mask` must be numpy array"
     assert self.predicted_mask.ndim == 2, \
       f"predicted_mask must be 2-dimensional, Got mask dims: {self.predicted_mask.ndim} instead."
 
@@ -119,6 +126,7 @@ class ImageOutput:
     """
     Validate input upon initialization.
     """
+    assert isinstance(self.image, np.ndarray), "`image` must be numpy array"
     assert self.image.ndim == 3, \
       f"Generated image must be 3-dimensional, Got image-dims: {self.image.ndim} instead."
     assert self.image.shape[2] == 3, \

clarifai/models/model_serving/model_config/triton/__init__.py

@@ -0,0 +1,14 @@
+# Copyright 2023 Clarifai, Inc.
+# 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
+#
+#    http://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.
+from .serializer import Serializer  # noqa # pylint: disable=unused-import
+from .triton_config import *  # noqa # pylint: disable=unused-import

clarifai/models/model_serving/model_config/{serializer.py → triton/serializer.py}

@@ -21,7 +21,7 @@ from typing import Type
 from google.protobuf.text_format import MessageToString
 from tritonclient.grpc import model_config_pb2
 
-from .config import TritonModelConfig
+from .triton_config import TritonModelConfig
 
 
 class Serializer:
@@ -61,6 +61,8 @@ class Serializer:
       output_config = self.config_proto.output.add()
       for key, value in out_field.__dict__.items():
         try:
+          if not value:
+            continue
           setattr(output_config, key, value)
         except AttributeError:  #Proto Repeated Field assignment not allowed
           field = getattr(output_config, key)

clarifai/models/model_serving/model_config/triton/triton_config.py

@@ -0,0 +1,182 @@
+# Copyright 2023 Clarifai, Inc.
+# 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
+#
+#    http://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.
+""" Model Config classes."""
+from __future__ import annotations  # isort: skip
+
+from copy import deepcopy
+from dataclasses import dataclass, field
+from typing import Any, List, Union
+
+from ...constants import IMAGE_TENSOR_NAME, MAX_HW_DIM
+
+
+### Triton Model Config classes.###
+@dataclass
+class DType:
+  """
+  Triton Model Config data types.
+  """
+  # https://github.com/triton-inference-server/common/blob/main/protobuf/model_config.proto
+  TYPE_UINT8: int = 2
+  TYPE_INT8: int = 6
+  TYPE_INT16: int = 7
+  TYPE_INT32: int = 8
+  TYPE_INT64: int = 9
+  TYPE_FP16: int = 10
+  TYPE_FP32: int = 11
+  TYPE_STRING: int = 13
+  KIND_GPU: int = 1
+  KIND_CPU: int = 2
+
+
+@dataclass
+class InputConfig:
+  """
+  Triton Input definition.
+  Params:
+  -------
+  name: input name
+  data_type: input data type
+  dims: Pre-defined input data shape(s).
+
+  Returns:
+  --------
+  InputConfig
+  """
+  name: str
+  data_type: int
+  dims: List = field(default_factory=list)
+  optional: bool = False
+
+
+@dataclass
+class OutputConfig:
+  """
+  Triton Output definition.
+  Params:
+  -------
+  name: output name
+  data_type: output data type
+  dims: Pre-defined output data shape(s).
+  labels (bool): If labels file is required for inference.
+
+  Returns:
+  --------
+  OutputConfig
+  """
+  name: str
+  data_type: int
+  dims: List = field(default_factory=list)
+  label_filename: str = ""
+
+
+@dataclass
+class Device:
+  """
+  Triton instance_group.
+  Define the type of inference device and number of devices to use.
+  Params:
+  -------
+  count: number of devices
+  use_gpu: whether to use cpu or gpu.
+
+  Returns:
+  --------
+  Device object
+  """
+  count: int = 1
+  use_gpu: bool = True
+
+  def __post_init__(self):
+    if self.use_gpu:
+      self.kind: str = DType.KIND_GPU
+    else:
+      self.kind: str = DType.KIND_CPU
+
+
+@dataclass
+class DynamicBatching:
+  """
+  Triton dynamic_batching config.
+  Params:
+  -------
+  preferred_batch_size: batch size
+  max_queue_delay_microseconds: max queue delay for a request batch
+
+  Returns:
+  --------
+  DynamicBatching object
+  """
+  #preferred_batch_size: List[int] = [1] # recommended not to set
+  max_queue_delay_microseconds: int = 500
+
+
+@dataclass
+class TritonModelConfig:
+  """
+  Triton Model Config base.
+  Params:
+  -------
+  name: triton inference model name
+  input: a list of an InputConfig field
+  output: a list of OutputConfig fields/dicts
+  instance_group: Device. see Device
+  dynamic_batching: Triton dynamic batching settings.
+  max_batch_size: max request batch size
+  backend: Triton Python Backend. Constant
+  image_shape: List of Height and Width of input image. *
+
+  (*): This attribute won't be serialized in config.pbtxt
+
+  Returns:
+  --------
+  TritonModelConfig
+  """
+  #model_type: str
+  model_name: str = ""
+  model_version: str = "1"
+  input: List[InputConfig] = field(default_factory=list)
+  output: List[OutputConfig] = field(default_factory=list)
+  instance_group: Device = field(default_factory=Device)
+  dynamic_batching: DynamicBatching = field(default_factory=DynamicBatching)
+  max_batch_size: int = 1
+  backend: str = "python"
+  image_shape: tuple[Union[int, float], Union[int, float]] = field(
+      default_factory=lambda: [-1, -1])  #(H, W)
+
+  def __setattr__(self, __name: str, __value: Any) -> None:
+    if __name == "image_shape":
+      __value = self._check_and_assign_image_shape_value(__value)
+
+    super().__setattr__(__name, __value)
+
+  def _check_and_assign_image_shape_value(self, value):
+    _has_image = False
+    for each in self.input:
+      if IMAGE_TENSOR_NAME in each.name:
+        _has_image = True
+        if len(value) != 2:
+          raise ValueError(
+              f"image_shape takes 2 values, Height and Width. Got {len(value)} values instead.")
+        if value[0] > MAX_HW_DIM or value[1] > MAX_HW_DIM:
+          raise ValueError(
+              f"H and W each have a maximum value of {MAX_HW_DIM}. Got H: {value[0]}, W: {value[1]}"
+          )
+        image_dims = deepcopy(value)
+        image_dims.append(3)  # add channel dim
+        each.dims = image_dims
+
+    if not _has_image and self.input:
+      return [-1, -1]
+    else:
+      return value

clarifai/models/model_serving/{models/model_types.py → model_config/triton/wrappers.py}

@@ -41,7 +41,7 @@ def visual_detector(func: Callable):
     out_scores = []
 
     # input_data passed as list of images
-    preds = func(self, input_data[:], *args, **kwargs)
+    preds = func(self, list(input_data[:]), *args, **kwargs)
     for pred in preds:
       out_bboxes.append(pred.predicted_bboxes)
       out_labels.append(pred.predicted_labels)
@@ -79,7 +79,7 @@ def visual_classifier(func: Callable):
     """
     out_scores = []
     # input_data passed as list of images
-    preds = func(self, input_data[:], *args, **kwargs)
+    preds = func(self, list(input_data[:]), *args, **kwargs)
 
     for pred in preds:
       out_scores.append(pred.predicted_scores)
@@ -185,7 +185,7 @@ def visual_embedder(func: Callable):
     """
     out_embeddings = []
     # input_data passed as list of images
-    preds = func(self, input_data[:], *args, **kwargs)
+    preds = func(self, list(input_data[:]), *args, **kwargs)
 
     for pred in preds:
       out_embeddings.append(pred.embedding_vector)
@@ -210,7 +210,7 @@ def visual_segmenter(func: Callable):
     """
     masks = []
     # input_data passed as list of images
-    preds = func(self, input_data[:], *args, **kwargs)
+    preds = func(self, list(input_data[:]), *args, **kwargs)
 
     for pred in preds:
       masks.append(pred.predicted_mask)

clarifai/models/model_serving/{models → repo_build}/__init__.py

@@ -10,3 +10,5 @@
 # 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 .build import RepositoryBuilder  # noqa
+from .static_files.base_test import BaseTest  # noqa