clarifai 11.1.7rc1__tar.gz → 11.1.7rc3__tar.gz

{clarifai-11.1.7rc1/clarifai.egg-info → clarifai-11.1.7rc3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: clarifai
-Version: 11.1.7rc1
+Version: 11.1.7rc3
 Summary: Clarifai Python SDK
 Home-page: https://github.com/Clarifai/clarifai-python
 Author: Clarifai
@@ -19,8 +19,22 @@ Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
-Provides-Extra: all
 License-File: LICENSE
+Requires-Dist: clarifai-grpc>=11.2.4
+Requires-Dist: clarifai-protocol>=0.0.20
+Requires-Dist: numpy>=1.22.0
+Requires-Dist: tqdm>=4.65.0
+Requires-Dist: rich>=13.4.2
+Requires-Dist: PyYAML>=6.0.1
+Requires-Dist: schema==0.7.5
+Requires-Dist: Pillow>=9.5.0
+Requires-Dist: tabulate>=0.9.0
+Requires-Dist: fsspec>=2024.6.1
+Requires-Dist: click>=8.1.7
+Requires-Dist: requests>=2.32.3
+Requires-Dist: aiohttp>=3.8.1
+Provides-Extra: all
+Requires-Dist: pycocotools==2.0.6; extra == "all"
 
 <h1 align="center">
   <a href="https://www.clarifai.com/"><img alt="Clarifai" title="Clarifai" src="https://github.com/user-attachments/assets/623b883b-7fe5-4b95-bbfa-8691f5779af4"></a>

clarifai-11.1.7rc3/clarifai/__init__.py

@@ -0,0 +1 @@
+__version__ = "11.1.7rc3"

{clarifai-11.1.7rc1 → clarifai-11.1.7rc3}/clarifai/client/model.py

@@ -84,7 +84,6 @@ class Model(Lister, BaseClient):
         compute_cluster_id=compute_cluster_id,
         nodepool_id=nodepool_id,
         deployment_id=deployment_id,
-        user_id=self.user_id,  # FIXME the deployment's user_id can be different than the model's.
     )
     BaseClient.__init__(
         self,

{clarifai-11.1.7rc1 → clarifai-11.1.7rc3}/clarifai/client/model_client.py

@@ -1,5 +1,3 @@
-import inspect
-import json
 import time
 from typing import Any, Dict, Iterator, List
 
@@ -98,18 +96,19 @@ class ModelClient:
     '''
     for method_name, method_signature in self._method_signatures.items():
       # define the function in this client instance
-      if method_signature.method_type == 'predict':
+      if resources_pb2.RunnerMethodType.Name(method_signature.method_type) == 'UNARY_UNARY':
         call_func = self._predict
-      elif method_signature.method_type == 'generate':
+      elif resources_pb2.RunnerMethodType.Name(method_signature.method_type) == 'UNARY_STREAMING':
         call_func = self._generate
-      elif method_signature.method_type == 'stream':
+      elif resources_pb2.RunnerMethodType.Name(
+          method_signature.method_type) == 'STREAMING_STREAMING':
         call_func = self._stream
       else:
         raise ValueError(f"Unknown method type {method_signature.method_type}")
 
       # method argnames, in order, collapsing nested keys to corresponding user function args
       method_argnames = []
-      for var in method_signature.inputs:
+      for var in method_signature.input_fields:
         outer = var.name.split('.', 1)[0]
         if outer in method_argnames:
           continue
@@ -136,18 +135,18 @@ class ModelClient:
       # set names, annotations and docstrings
       f.__name__ = method_name
       f.__qualname__ = f'{self.__class__.__name__}.{method_name}'
-      f.__doc__ = method_signature.docstring
-      input_annotations = json.loads(method_signature.annotations_json)
-      return_annotation = input_annotations.pop('return', None)
-      sig = inspect.signature(f).replace(
-          parameters=[
-              inspect.Parameter(k, inspect.Parameter.POSITIONAL_OR_KEYWORD, annotation=v)
-              for k, v in input_annotations.items()
-          ],
-          return_annotation=return_annotation,
-      )
-      f.__signature__ = sig
-      f.__doc__ = method_signature.docstring
+      # TODO: set signature from annotations to the function, currently  MethodSignature don't have `annotations_json` field
+      # input_annotations = json.loads(method_signature.annotations_json)
+      # return_annotation = input_annotations.pop('return', None)
+      # sig = inspect.signature(f).replace(
+      #     parameters=[
+      #         inspect.Parameter(k, inspect.Parameter.POSITIONAL_OR_KEYWORD, annotation=v)
+      #         for k, v in input_annotations.items()
+      #     ],
+      #     return_annotation=return_annotation,
+      # )
+      # f.__signature__ = sig
+      f.__doc__ = method_signature.description
       setattr(self, method_name, f)
 
   def _define_compatability_functions(self):
@@ -177,8 +176,8 @@ class ModelClient:
       inputs,  # TODO set up functions according to fetched signatures?
       method_name: str = 'predict',
   ) -> Any:
-    input_signature = self._method_signatures[method_name].inputs
-    output_signature = self._method_signatures[method_name].outputs
+    input_signature = self._method_signatures[method_name].input_fields
+    output_signature = self._method_signatures[method_name].output_fields
 
     batch_input = True
     if isinstance(inputs, dict):
@@ -260,8 +259,8 @@ class ModelClient:
       inputs,  # TODO set up functions according to fetched signatures?
       method_name: str = 'generate',
   ) -> Any:
-    input_signature = self._method_signatures[method_name].inputs
-    output_signature = self._method_signatures[method_name].outputs
+    input_signature = self._method_signatures[method_name].input_fields
+    output_signature = self._method_signatures[method_name].output_fields
 
     batch_input = True
     if isinstance(inputs, dict):
@@ -350,8 +349,8 @@ class ModelClient:
       inputs,
       method_name: str = 'stream',
   ) -> Any:
-    input_signature = self._method_signatures[method_name].inputs
-    output_signature = self._method_signatures[method_name].outputs
+    input_signature = self._method_signatures[method_name].input_fields
+    output_signature = self._method_signatures[method_name].output_fields
 
     if isinstance(inputs, list):
       assert len(inputs) == 1, 'streaming methods do not support batched calls'

{clarifai-11.1.7rc1 → clarifai-11.1.7rc3}/clarifai/runners/dockerfile_template/Dockerfile.template

@@ -44,9 +44,6 @@ ENV PYTHONPATH=${PYTHONPATH}:/home/nonroot/main \
     CLARIFAI_COMPUTE_CLUSTER_ID=${CLARIFAI_COMPUTE_CLUSTER_ID} \
     CLARIFAI_API_BASE=${CLARIFAI_API_BASE:-https://api.clarifai.com}
 
-# # Write out the model function signatures
-# RUN ["python", "-m", "clarifai.cli", "model", "signatures", "--model_path", "/home/nonroot/main", "--out_path", "/home/nonroot/main/signatures.yaml"]
-
 # Finally run the clarifai entrypoint to start the runner loop and local dev server.
 # Note(zeiler): we may want to make this a clarifai CLI call.
 ENTRYPOINT ["python", "-m", "clarifai.runners.server"]

{clarifai-11.1.7rc1 → clarifai-11.1.7rc3}/clarifai/runners/models/model_builder.py

@@ -1,3 +1,4 @@
+import builtins
 import importlib
 import inspect
 import os
@@ -6,6 +7,7 @@ import sys
 import tarfile
 import time
 from string import Template
+from unittest.mock import MagicMock
 
 import yaml
 from clarifai_grpc.grpc.api import resources_pb2, service_pb2
@@ -80,7 +82,7 @@ class ModelBuilder:
 
   def load_model_class(self):
     """
-    Import the model class from the model.py file.
+    Import the model class from the model.py file, dynamically handling missing dependencies
     """
     # look for default model.py file location
     for loc in ["model.py", "1/model.py"]:
@@ -95,7 +97,29 @@ class ModelBuilder:
     spec = importlib.util.spec_from_file_location(module_name, model_file)
     module = importlib.util.module_from_spec(spec)
     sys.modules[module_name] = module
-    spec.loader.exec_module(module)
+
+    original_import = builtins.__import__
+
+    def custom_import(name, globals=None, locals=None, fromlist=(), level=0):
+
+      # Allow standard libraries and clarifai
+      if self._is_standard_or_clarifai(name):
+        return original_import(name, globals, locals, fromlist, level)
+
+      # Mock all third-party imports to avoid ImportErrors or other issues
+      return MagicMock()
+
+    # Replace the built-in __import__ function with our custom one
+    builtins.__import__ = custom_import
+
+    try:
+      spec.loader.exec_module(module)
+    except Exception as e:
+      logger.error(f"Error loading model.py: {e}")
+      raise
+    finally:
+      # Restore the original __import__ function
+      builtins.__import__ = original_import
 
     # Find all classes in the model.py file that are subclasses of ModelClass
     classes = [
@@ -122,6 +146,23 @@ class ModelBuilder:
     model_class = classes[0]
     return model_class
 
+  def _is_standard_or_clarifai(self, name):
+    """Check if import is from standard library or clarifai"""
+    if name.startswith("clarifai"):
+      return True
+
+    # Handle Python <3.10 compatibility
+    stdlib_names = getattr(sys, "stdlib_module_names", sys.builtin_module_names)
+    if name in stdlib_names:
+      return True
+
+    # Handle submodules (e.g., os.path)
+    parts = name.split(".")
+    for i in range(1, len(parts)):
+      if ".".join(parts[:i]) in stdlib_names:
+        return True
+    return False
+
   def _validate_folder(self, folder):
     if folder == ".":
       folder = ""  # will getcwd() next which ends with /
@@ -267,9 +308,18 @@ class ModelBuilder:
     """
     model_class = self.load_model_class()
     method_info = model_class._get_method_info()
-    signatures = {name: m.signature for name, m in method_info.items()}
+    signatures = {name: m.signature for name, m in method_info.values()}
     return signatures_to_yaml(signatures)
 
+  def get_method_signatures(self):
+    """
+    Returns the method signatures for the model class.
+    """
+    model_class = self.load_model_class()
+    method_info = model_class._get_method_info()
+    signatures = [method.signature for method in method_info.values()]
+    return signatures
+
   @property
   def client(self):
     if self._client is None:
@@ -548,10 +598,11 @@ class ModelBuilder:
     logger.info(f"Updated config.yaml with {len(concepts)} concepts.")
 
   def get_model_version_proto(self):
-
+    signatures = self.get_method_signatures()
     model_version_proto = resources_pb2.ModelVersion(
         pretrained_model_config=resources_pb2.PretrainedModelConfig(),
         inference_compute_info=self.inference_compute_info,
+        method_signatures=signatures,
     )
 
     model_type_id = self.config.get('model').get('model_type_id')
@@ -739,6 +790,7 @@ class ModelBuilder:
               model_id=self.model_proto.id,
               version_id=self.model_version_id,
           ))
+
       status_code = resp.model_version.status.code
       logs = self.get_model_build_logs()
       for log_entry in logs.log_entries:

{clarifai-11.1.7rc1 → clarifai-11.1.7rc3}/clarifai/runners/models/model_class.py

@@ -8,6 +8,7 @@ from typing import Any, Dict, Iterator, List
 
 from clarifai_grpc.grpc.api import resources_pb2, service_pb2
 from clarifai_grpc.grpc.api.status import status_code_pb2, status_pb2
+from google.protobuf import json_format
 
 from clarifai.runners.utils import data_types
 from clarifai.runners.utils.method_signatures import (build_function_signature, deserialize,
@@ -84,6 +85,7 @@ class ModelClass(ABC):
     try:
       # TODO add method name field to proto
       method_name = 'predict'
+      inference_params = get_inference_params(request)
       if len(request.inputs) > 0 and '_method_name' in request.inputs[0].data.metadata:
         method_name = request.inputs[0].data.metadata['_method_name']
       if method_name == '_GET_SIGNATURES':  # special case to fetch signatures, TODO add endpoint for this
@@ -94,15 +96,17 @@ class ModelClass(ABC):
       method_info = method._cf_method_info
       signature = method_info.signature
       python_param_types = method_info.python_param_types
-      inputs = self._convert_input_protos_to_python(request.inputs, signature.inputs,
-                                                    python_param_types)
+      inputs = self._convert_input_protos_to_python(request.inputs, inference_params,
+                                                    signature.input_fields, python_param_types)
       if len(inputs) == 1:
         inputs = inputs[0]
         output = method(**inputs)
-        outputs.append(self._convert_output_to_proto(output, signature.outputs))
+        outputs.append(self._convert_output_to_proto(output, signature.output_fields))
       else:
         outputs = self._batch_predict(method, inputs)
-        outputs = [self._convert_output_to_proto(output, signature.outputs) for output in outputs]
+        outputs = [
+            self._convert_output_to_proto(output, signature.output_fields) for output in outputs
+        ]
 
       return service_pb2.MultiOutputResponse(
           outputs=outputs, status=status_pb2.Status(code=status_code_pb2.SUCCESS))
@@ -119,6 +123,7 @@ class ModelClass(ABC):
                       ) -> Iterator[service_pb2.MultiOutputResponse]:
     try:
       method_name = 'generate'
+      inference_params = get_inference_params(request)
       if len(request.inputs) > 0 and '_method_name' in request.inputs[0].data.metadata:
         method_name = request.inputs[0].data.metadata['_method_name']
       method = getattr(self, method_name)
@@ -126,20 +131,21 @@ class ModelClass(ABC):
       signature = method_info.signature
       python_param_types = method_info.python_param_types
 
-      inputs = self._convert_input_protos_to_python(request.inputs, signature.inputs,
-                                                    python_param_types)
+      inputs = self._convert_input_protos_to_python(request.inputs, inference_params,
+                                                    signature.input_fields, python_param_types)
       if len(inputs) == 1:
         inputs = inputs[0]
         for output in method(**inputs):
           resp = service_pb2.MultiOutputResponse()
-          self._convert_output_to_proto(output, signature.outputs, proto=resp.outputs.add())
+          self._convert_output_to_proto(output, signature.output_fields, proto=resp.outputs.add())
           resp.status.code = status_code_pb2.SUCCESS
           yield resp
       else:
         for outputs in self._batch_generate(method, inputs):
           resp = service_pb2.MultiOutputResponse()
           for output in outputs:
-            self._convert_output_to_proto(output, signature.outputs, proto=resp.outputs.add())
+            self._convert_output_to_proto(
+                output, signature.output_fields, proto=resp.outputs.add())
           resp.status.code = status_code_pb2.SUCCESS
           yield resp
     except Exception as e:
@@ -158,6 +164,7 @@ class ModelClass(ABC):
       assert len(request.inputs) == 1, "Streaming requires exactly one input"
 
       method_name = 'generate'
+      inference_params = get_inference_params(request)
       if len(request.inputs) > 0 and '_method_name' in request.inputs[0].data.metadata:
         method_name = request.inputs[0].data.metadata['_method_name']
       method = getattr(self, method_name)
@@ -166,14 +173,14 @@ class ModelClass(ABC):
       python_param_types = method_info.python_param_types
 
       # find the streaming vars in the signature
-      stream_sig = get_stream_from_signature(signature.inputs)
+      stream_sig = get_stream_from_signature(signature.input_fields)
       if stream_sig is None:
         raise ValueError("Streaming method must have a Stream input")
       stream_argname = stream_sig.name
 
       # convert all inputs for the first request, including the first stream value
-      inputs = self._convert_input_protos_to_python(request.inputs, signature.inputs,
-                                                    python_param_types)
+      inputs = self._convert_input_protos_to_python(request.inputs, inference_params,
+                                                    signature.input_fields, python_param_types)
       kwargs = inputs[0]
 
       # first streaming item
@@ -184,8 +191,8 @@ class ModelClass(ABC):
         yield first_item
         # subsequent streaming items contain only the streaming input
         for request in request_iterator:
-          item = self._convert_input_protos_to_python(request.inputs, stream_sig,
-                                                      python_param_types)
+          item = self._convert_input_protos_to_python(request.inputs, inference_params,
+                                                      [stream_sig], python_param_types)
           item = item[0][stream_argname]
           yield item
 
@@ -194,7 +201,7 @@ class ModelClass(ABC):
 
       for output in method(**kwargs):
         resp = service_pb2.MultiOutputResponse()
-        self._convert_output_to_proto(output, signature.outputs, proto=resp.outputs.add())
+        self._convert_output_to_proto(output, signature.output_fields, proto=resp.outputs.add())
         resp.status.code = status_code_pb2.SUCCESS
         yield resp
     except Exception as e:
@@ -206,11 +213,13 @@ class ModelClass(ABC):
           details=str(e),
           stack_trace=traceback.format_exc().split('\n')))
 
-  def _convert_input_protos_to_python(self, inputs: List[resources_pb2.Input], variables_signature,
+  def _convert_input_protos_to_python(self, inputs: List[resources_pb2.Input],
+                                      inference_params: dict,
+                                      variables_signature: List[resources_pb2.ModelTypeField],
                                       python_param_types) -> List[Dict[str, Any]]:
     result = []
     for input in inputs:
-      kwargs = deserialize(input.data, variables_signature)
+      kwargs = deserialize(input.data, variables_signature, inference_params)
       # dynamic cast to annotated types
       for k, v in kwargs.items():
         if k not in python_param_types:
@@ -219,7 +228,9 @@ class ModelClass(ABC):
       result.append(kwargs)
     return result
 
-  def _convert_output_to_proto(self, output: Any, variables_signature,
+  def _convert_output_to_proto(self,
+                               output: Any,
+                               variables_signature: List[resources_pb2.ModelTypeField],
                                proto=None) -> resources_pb2.Output:
     if proto is None:
       proto = resources_pb2.Output()
@@ -256,6 +267,18 @@ class ModelClass(ABC):
     return method_info
 
 
+# Helper function to get the inference params
+def get_inference_params(request) -> dict:
+  """Get the inference params from the request."""
+  inference_params = {}
+  if request.model.model_version.id != "":
+    output_info = request.model.model_version.output_info
+    output_info = json_format.MessageToDict(output_info, preserving_proto_field_name=True)
+    if "params" in output_info:
+      inference_params = output_info["params"]
+  return inference_params
+
+
 class _MethodInfo:
 
   def __init__(self, method):

clarifai-11.1.7rc3/clarifai/runners/models/temp.py

@@ -0,0 +1,25 @@
+prediction = model.predict(text1 = "what is api?")
+
+
+print(f"The answer is {prediction.answer_text}")
+
+
+print(f"The answer is {prediction}")
+
+
+
+
+# case 1
+class MyModel(ModelClass):
+
+    def predict(self, text: str) -> Output:
+
+        return Output(answer_text= f" {text} hello world")
+
+
+# case 2
+class MyModel(ModelClass):
+
+    def predict(self, text: str) -> str:
+
+        return f" {text} hello world"