clarifai 11.3.0rc2__py3-none-any.whl → 11.4.0__py3-none-any.whl

clarifai/runners/utils/code_script.py

@@ -1,217 +1,255 @@
 import json
 from typing import List
+
 from clarifai_grpc.grpc.api import resources_pb2
+
 from clarifai.runners.utils import data_types
 
 
-def generate_client_script(method_signatures: List[resources_pb2.MethodSignature], user_id, app_id,
-                           model_id) -> str:
-  _CLIENT_TEMPLATE = """\
-from clarifai.runners.utils import data_types
+def generate_client_script(
+    method_signatures: List[resources_pb2.MethodSignature],
+    user_id,
+    app_id,
+    model_id,
+    base_url: str = None,
+    deployment_id: str = None,
+    use_ctx: bool = False,
+) -> str:
+    _CLIENT_TEMPLATE = """\
 import os
-from clarifai.client import Model
 
-model = Model("www.clarifai.com/{user_id}/{app_id}/{model_id}",
-    deployment_id = os.environ['CLARIFAI_DEPLOYMENT_ID'], # Only needed for dedicated deployed models
-)
+from clarifai.client import Model
+from clarifai.runners.utils import data_types
+{model_section}
     """
-  # Generate client template
-  client_template = _CLIENT_TEMPLATE.format(user_id=user_id, app_id=app_id, model_id=model_id)
-
-  # Generate method signatures
-  method_signatures_str = []
-  for method_signature in method_signatures:
-    method_name = method_signature.name
-    if method_signature.method_type in [
-        resources_pb2.RunnerMethodType.UNARY_UNARY,
-        resources_pb2.RunnerMethodType.UNARY_STREAMING,
-    ]:
-
-      client_script_str = f'response = model.{method_name}('
-      annotations = _get_annotations_source(method_signature)
-      for param_name, (param_type, default_value) in annotations.items():
-        if param_name == "return":
-          continue
-        if default_value is None:
-          default_value = _set_default_value(param_type)
-          if param_type == "str":
-            default_value = repr(default_value)
-
-        client_script_str += f"{param_name}={default_value}, "
-      client_script_str = client_script_str.rstrip(", ") + ")"
-      if method_signature.method_type == resources_pb2.RunnerMethodType.UNARY_UNARY:
-        client_script_str += "\nprint(response)"
-      elif method_signature.method_type == resources_pb2.RunnerMethodType.UNARY_STREAMING:
-        client_script_str += "\nfor res in response:\n    print(res)"
-      client_script_str += "\n"
-      method_signatures_str.append(client_script_str)
-
-  method_signatures_str = "\n".join(method_signatures_str)
-  # Combine all parts
-  script_lines = []
-  script_lines.append("\n# Clarifai Model Client Script")
-  script_lines.append(
-      "# Set the environment variables `CLARIFAI_DEPLOYMENT_ID` and `CLARIFAI_PAT` to run this script."
-  )
-  script_lines.append("# Example usage:")
-  script_lines.append(client_template)
-  script_lines.append("# Example model prediction from different model methods: \n")
-  script_lines.append(method_signatures_str)
-  script_lines.append("")
-  script = "\n".join(script_lines)
-  return script
+
+    deployment_id = (
+        "os.environ['CLARIFAI_DEPLOYMENT_ID']" if deployment_id is None else deployment_id
+    )
+
+    base_url_str = ""
+    if base_url is not None:
+        base_url_str = f"base_url={base_url},"
+
+    if use_ctx:
+        model_section = """
+model = Model.from_current_context()"""
+    else:
+        model_section = """
+ model = Model("https://clarifai.com/{user_id}/{app_id}/{model_id}",
+               deployment_id = {deployment_id}, # Only needed for dedicated deployed models
+               {base_url_str}
+ )
+"""
+        model_section = _CLIENT_TEMPLATE.format(
+            user_id=user_id,
+            app_id=app_id,
+            model_id=model_id,
+            deployment_id=deployment_id,
+            base_url_str=base_url_str,
+        )
+
+    # Generate client template
+    client_template = _CLIENT_TEMPLATE.format(
+        model_section=model_section,
+    )
+
+    # Generate method signatures
+    method_signatures_str = []
+    for method_signature in method_signatures:
+        method_name = method_signature.name
+        if method_signature.method_type in [
+            resources_pb2.RunnerMethodType.UNARY_UNARY,
+            resources_pb2.RunnerMethodType.UNARY_STREAMING,
+        ]:
+            client_script_str = f'response = model.{method_name}('
+            annotations = _get_annotations_source(method_signature)
+            for param_name, (param_type, default_value) in annotations.items():
+                if param_name == "return":
+                    continue
+                if default_value is None:
+                    default_value = _set_default_value(param_type)
+                    if param_type == "str":
+                        default_value = repr(default_value)
+
+                client_script_str += f"{param_name}={default_value}, "
+            client_script_str = client_script_str.rstrip(", ") + ")"
+            if method_signature.method_type == resources_pb2.RunnerMethodType.UNARY_UNARY:
+                client_script_str += "\nprint(response)"
+            elif method_signature.method_type == resources_pb2.RunnerMethodType.UNARY_STREAMING:
+                client_script_str += "\nfor res in response:\n    print(res)"
+            client_script_str += "\n"
+            method_signatures_str.append(client_script_str)
+
+    method_signatures_str = "\n".join(method_signatures_str)
+    # Combine all parts
+    script_lines = []
+    script_lines.append("\n# Clarifai Model Client Script")
+    if not use_ctx:
+        script_lines.append(
+            "# Set the environment variables `CLARIFAI_DEPLOYMENT_ID` and `CLARIFAI_PAT` to run this script."
+        )
+    script_lines.append("# Example usage:")
+    script_lines.append(client_template)
+    script_lines.append("# Example model prediction from different model methods: \n")
+    script_lines.append(method_signatures_str)
+    script_lines.append("")
+    script = "\n".join(script_lines)
+    return script
 
 
 # get annotations source with default values
 def _get_annotations_source(method_signature: resources_pb2.MethodSignature) -> dict:
-  annotations = {}
-  for input_field in method_signature.input_fields:
-    param_name = input_field.name
-    param_type = _get_base_type(input_field)
-    if input_field.iterator:
-      param_type = f"Iterator[{param_type}]"
-    default_value = None
-    if input_field.default:
-      default_value = _parse_default_value(input_field)
-
-    annotations[param_name] = (param_type, default_value)
-  if not method_signature.output_fields:
-    raise ValueError("MethodSignature must have at least one output field")
-  for output_field in method_signature.output_fields:
-    param_name = output_field.name
-    param_type = _get_base_type(output_field)
-    if output_field.iterator:
-      param_type = f"Iterator[{param_type}]"
-    annotations[param_name] = (param_type, None)
-  return annotations
+    annotations = {}
+    for input_field in method_signature.input_fields:
+        param_name = input_field.name
+        param_type = _get_base_type(input_field)
+        if input_field.iterator:
+            param_type = f"Iterator[{param_type}]"
+        default_value = None
+        if input_field.default:
+            default_value = _parse_default_value(input_field)
+
+        annotations[param_name] = (param_type, default_value)
+    if not method_signature.output_fields:
+        raise ValueError("MethodSignature must have at least one output field")
+    for output_field in method_signature.output_fields:
+        param_name = output_field.name
+        param_type = _get_base_type(output_field)
+        if output_field.iterator:
+            param_type = f"Iterator[{param_type}]"
+        annotations[param_name] = (param_type, None)
+    return annotations
 
 
 def _get_base_type(field: resources_pb2.ModelTypeField) -> str:
-  data_type = field.type
-  if data_type == resources_pb2.ModelTypeField.DataType.NAMED_FIELDS:
-    annotations = {}
-    for type_arg in field.type_args:
-      field_name = type_arg.name
-      field_type = _get_base_type(type_arg)
-      annotations[field_name] = field_type
-    class_name = f"NamedFields[{', '.join(f'{k}: {v}' for k, v in annotations.items())}]"
-    return class_name
-  elif data_type == resources_pb2.ModelTypeField.DataType.TUPLE:
-    type_args_str = [_get_base_type(ta) for ta in field.type_args]
-    return f"Tuple[{', '.join(type_args_str)}]"
-  elif data_type == resources_pb2.ModelTypeField.DataType.LIST:
-    if len(field.type_args) != 1:
-      raise ValueError("List type must have exactly one type argument")
-    element_type = _get_base_type(field.type_args[0])
-    return f"List[{element_type}]"
-  else:
-    type_map = {
-        resources_pb2.ModelTypeField.DataType.STR: "str",
-        resources_pb2.ModelTypeField.DataType.BYTES: "bytes",
-        resources_pb2.ModelTypeField.DataType.INT: "int",
-        resources_pb2.ModelTypeField.DataType.FLOAT: "float",
-        resources_pb2.ModelTypeField.DataType.BOOL: "bool",
-        resources_pb2.ModelTypeField.DataType.NDARRAY: "np.ndarray",
-        resources_pb2.ModelTypeField.DataType.JSON_DATA: "data_types.JSON",
-        resources_pb2.ModelTypeField.DataType.TEXT: "data_types.Text",
-        resources_pb2.ModelTypeField.DataType.IMAGE: "data_types.Image",
-        resources_pb2.ModelTypeField.DataType.CONCEPT: "data_types.Concept",
-        resources_pb2.ModelTypeField.DataType.REGION: "data_types.Region",
-        resources_pb2.ModelTypeField.DataType.FRAME: "data_types.Frame",
-        resources_pb2.ModelTypeField.DataType.AUDIO: "data_types.Audio",
-        resources_pb2.ModelTypeField.DataType.VIDEO: "data_types.Video",
-    }
-    return type_map.get(data_type, "Any")
+    data_type = field.type
+    if data_type == resources_pb2.ModelTypeField.DataType.NAMED_FIELDS:
+        annotations = {}
+        for type_arg in field.type_args:
+            field_name = type_arg.name
+            field_type = _get_base_type(type_arg)
+            annotations[field_name] = field_type
+        class_name = f"NamedFields[{', '.join(f'{k}: {v}' for k, v in annotations.items())}]"
+        return class_name
+    elif data_type == resources_pb2.ModelTypeField.DataType.TUPLE:
+        type_args_str = [_get_base_type(ta) for ta in field.type_args]
+        return f"Tuple[{', '.join(type_args_str)}]"
+    elif data_type == resources_pb2.ModelTypeField.DataType.LIST:
+        if len(field.type_args) != 1:
+            raise ValueError("List type must have exactly one type argument")
+        element_type = _get_base_type(field.type_args[0])
+        return f"List[{element_type}]"
+    else:
+        type_map = {
+            resources_pb2.ModelTypeField.DataType.STR: "str",
+            resources_pb2.ModelTypeField.DataType.BYTES: "bytes",
+            resources_pb2.ModelTypeField.DataType.INT: "int",
+            resources_pb2.ModelTypeField.DataType.FLOAT: "float",
+            resources_pb2.ModelTypeField.DataType.BOOL: "bool",
+            resources_pb2.ModelTypeField.DataType.NDARRAY: "np.ndarray",
+            resources_pb2.ModelTypeField.DataType.JSON_DATA: "data_types.JSON",
+            resources_pb2.ModelTypeField.DataType.TEXT: "data_types.Text",
+            resources_pb2.ModelTypeField.DataType.IMAGE: "data_types.Image",
+            resources_pb2.ModelTypeField.DataType.CONCEPT: "data_types.Concept",
+            resources_pb2.ModelTypeField.DataType.REGION: "data_types.Region",
+            resources_pb2.ModelTypeField.DataType.FRAME: "data_types.Frame",
+            resources_pb2.ModelTypeField.DataType.AUDIO: "data_types.Audio",
+            resources_pb2.ModelTypeField.DataType.VIDEO: "data_types.Video",
+        }
+        return type_map.get(data_type, "Any")
 
 
 def _map_default_value(field_type):
-  """
+    """
     Map the default value of a field type to a string representation.
     """
-  default_value = None
-
-  if field_type == "str":
-    default_value = 'What is the future of AI?'
-  elif field_type == "bytes":
-    default_value = b""
-  elif field_type == "int":
-    default_value = 0
-  elif field_type == "float":
-    default_value = 0.0
-  elif field_type == "bool":
-    default_value = False
-  elif field_type == "data_types.Image":
-    default_value = data_types.Image.from_url("https://samples.clarifai.com/metro-north.jpg")
-  elif field_type == "data_types.Text":
-    default_value = data_types.Text("What's the future of AI?")
-  elif field_type == "data_types.Audio":
-    default_value = data_types.Audio.from_url("https://samples.clarifai.com/audio.mp3")
-  elif field_type == "data_types.Video":
-    default_value = data_types.Video.from_url("https://samples.clarifai.com/video.mp4")
-  elif field_type == "data_types.Concept":
-    default_value = data_types.Concept(id="concept_id", name="dog", value=0.95)
-  elif field_type == "data_types.Region":
-    default_value = data_types.Region(box=[0.1, 0.1, 0.5, 0.5],)
-  elif field_type == "data_types.Frame":
-    default_value = data_types.Frame.from_url("https://samples.clarifai.com/video.mp4", 0)
-  elif field_type == "data_types.NDArray":
-    default_value = data_types.NDArray([1, 2, 3])
-  else:
     default_value = None
-  return default_value
+
+    if field_type == "str":
+        default_value = 'What is the future of AI?'
+    elif field_type == "bytes":
+        default_value = b""
+    elif field_type == "int":
+        default_value = 0
+    elif field_type == "float":
+        default_value = 0.0
+    elif field_type == "bool":
+        default_value = False
+    elif field_type == "data_types.Image":
+        default_value = data_types.Image.from_url("https://samples.clarifai.com/metro-north.jpg")
+    elif field_type == "data_types.Text":
+        default_value = data_types.Text("What's the future of AI?")
+    elif field_type == "data_types.Audio":
+        default_value = data_types.Audio.from_url("https://samples.clarifai.com/audio.mp3")
+    elif field_type == "data_types.Video":
+        default_value = data_types.Video.from_url("https://samples.clarifai.com/video.mp4")
+    elif field_type == "data_types.Concept":
+        default_value = data_types.Concept(id="concept_id", name="dog", value=0.95)
+    elif field_type == "data_types.Region":
+        default_value = data_types.Region(
+            box=[0.1, 0.1, 0.5, 0.5],
+        )
+    elif field_type == "data_types.Frame":
+        default_value = data_types.Frame.from_url("https://samples.clarifai.com/video.mp4", 0)
+    elif field_type == "data_types.NDArray":
+        default_value = data_types.NDArray([1, 2, 3])
+    else:
+        default_value = None
+    return default_value
 
 
 def _set_default_value(field_type):
-  """
+    """
     Set the default value of a field if it is not set.
     """
-  default_value = None
-  default_value = _map_default_value(field_type)
-  if field_type.startswith("List["):
-    element_type = field_type[5:-1]
-    element_type_default_value = _map_default_value(element_type)
-    if element_type_default_value is not None:
-      default_value = f"[{element_type_default_value}]"
-  elif field_type.startswith("Tuple["):
-    element_types = field_type[6:-1].split(", ")
-    element_type_defaults = [_map_default_value(et) for et in element_types]
-    default_value = f"({', '.join([str(et) for et in element_type_defaults])})"
-  elif field_type.startswith("NamedFields["):
-    element_types = field_type[12:-1].split(", ")
-    element_type_defaults = [_map_default_value(et) for et in element_types]
-    default_value = f"{{{', '.join([str(et) for et in element_type_defaults])}}}"
-
-  return default_value
+    default_value = None
+    default_value = _map_default_value(field_type)
+    if field_type.startswith("List["):
+        element_type = field_type[5:-1]
+        element_type_default_value = _map_default_value(element_type)
+        if element_type_default_value is not None:
+            default_value = f"[{element_type_default_value}]"
+    elif field_type.startswith("Tuple["):
+        element_types = field_type[6:-1].split(", ")
+        element_type_defaults = [_map_default_value(et) for et in element_types]
+        default_value = f"({', '.join([str(et) for et in element_type_defaults])})"
+    elif field_type.startswith("NamedFields["):
+        element_types = field_type[12:-1].split(", ")
+        element_type_defaults = [_map_default_value(et) for et in element_types]
+        default_value = f"{{{', '.join([str(et) for et in element_type_defaults])}}}"
+
+    return default_value
 
 
 def _parse_default_value(field: resources_pb2.ModelTypeField):
-  if not field.default:
-    return None
-  default_str = field.default
-  data_type = field.type
-
-  try:
-    if data_type == resources_pb2.ModelTypeField.DataType.INT:
-      return str(int(default_str))
-    elif data_type == resources_pb2.ModelTypeField.DataType.FLOAT:
-      return str(float(default_str))
-    elif data_type == resources_pb2.ModelTypeField.DataType.BOOL:
-      return 'True' if default_str.lower() == 'true' else 'False'
-    elif data_type == resources_pb2.ModelTypeField.DataType.STR:
-      return repr(default_str)
-    elif data_type == resources_pb2.ModelTypeField.DataType.BYTES:
-      return f"b{repr(default_str.encode('utf-8'))}"
-    elif data_type == resources_pb2.ModelTypeField.DataType.JSON_DATA:
-      parsed = json.loads(default_str)
-      return repr(parsed)
-    elif data_type in (
-        resources_pb2.ModelTypeField.DataType.LIST,
-        resources_pb2.ModelTypeField.DataType.TUPLE,
-        resources_pb2.ModelTypeField.DataType.NAMED_FIELDS,
-    ):
-      parsed = json.loads(default_str)
-      return repr(parsed)
-    else:
-      return repr(default_str)
-  except (ValueError, json.JSONDecodeError):
-    return repr(default_str)
+    if not field.default:
+        return None
+    default_str = field.default
+    data_type = field.type
+
+    try:
+        if data_type == resources_pb2.ModelTypeField.DataType.INT:
+            return str(int(default_str))
+        elif data_type == resources_pb2.ModelTypeField.DataType.FLOAT:
+            return str(float(default_str))
+        elif data_type == resources_pb2.ModelTypeField.DataType.BOOL:
+            return 'True' if default_str.lower() == 'true' else 'False'
+        elif data_type == resources_pb2.ModelTypeField.DataType.STR:
+            return repr(default_str)
+        elif data_type == resources_pb2.ModelTypeField.DataType.BYTES:
+            return f"b{repr(default_str.encode('utf-8'))}"
+        elif data_type == resources_pb2.ModelTypeField.DataType.JSON_DATA:
+            parsed = json.loads(default_str)
+            return repr(parsed)
+        elif data_type in (
+            resources_pb2.ModelTypeField.DataType.LIST,
+            resources_pb2.ModelTypeField.DataType.TUPLE,
+            resources_pb2.ModelTypeField.DataType.NAMED_FIELDS,
+        ):
+            parsed = json.loads(default_str)
+            return repr(parsed)
+        else:
+            return repr(default_str)
+    except (ValueError, json.JSONDecodeError):
+        return repr(default_str)

clarifai/runners/utils/const.py

@@ -30,5 +30,8 @@ AVAILABLE_TORCH_IMAGES = [
     '2.7.0-py3.12-rocm6.3',
 ]
 CONCEPTS_REQUIRED_MODEL_TYPE = [
-    'visual-classifier', 'visual-detector', 'visual-segmenter', 'text-classifier'
+    'visual-classifier',
+    'visual-detector',
+    'visual-segmenter',
+    'text-classifier',
 ]

clarifai/runners/utils/data_types/__init__.py

@@ -0,0 +1,12 @@
+from .data_types import JSON  # noqa
+from .data_types import Audio  # noqa
+from .data_types import Concept  # noqa
+from .data_types import Frame  # noqa
+from .data_types import Image  # noqa
+from .data_types import MessageData  # noqa
+from .data_types import NamedFields  # noqa
+from .data_types import NamedFieldsMeta  # noqa
+from .data_types import Region  # noqa
+from .data_types import Text  # noqa
+from .data_types import Video  # noqa
+from .data_types import cast  # noqa