clarifai 9.8.2__py3-none-any.whl → 9.9.0__py3-none-any.whl

clarifai/client/app.py

@@ -13,6 +13,7 @@ from clarifai.client.input import Inputs
 from clarifai.client.lister import Lister
 from clarifai.client.model import Model
 from clarifai.client.module import Module
+from clarifai.client.search import Search
 from clarifai.client.workflow import Workflow
 from clarifai.errors import UserError
 from clarifai.urls.helper import ClarifaiUrlHelper
@@ -555,6 +556,22 @@ class App(Lister, BaseClient):
       raise Exception(response.status)
     self.logger.info("\nModule Deleted\n%s", response.status)
 
+  def search(self, **kwargs) -> Model:
+    """Returns a Search object for the user and app ID.
+
+    Args:
+        see the Search class in clarifai.client.search for kwargs.
+
+    Returns:
+        Search: A Search object for the user and app ID.
+
+    Example:
+        >>> from clarifai.client.app import App
+        >>> app = App(app_id="app_id", user_id="user_id")
+        >>> search_client = app.search(top_k=12, metric="euclidean")
+    """
+    return Search(**kwargs)
+
   def __getattr__(self, name):
     return getattr(self.app_info, name)
 

clarifai/client/search.py

@@ -0,0 +1,173 @@
+from typing import Any, Callable, Dict, Generator
+
+from clarifai_grpc.grpc.api import resources_pb2, service_pb2
+from clarifai_grpc.grpc.api.status import status_code_pb2
+from google.protobuf.json_format import MessageToDict
+from google.protobuf.struct_pb2 import Struct
+from schema import SchemaError
+
+from clarifai.client.base import BaseClient
+from clarifai.client.input import Inputs
+from clarifai.client.lister import Lister
+from clarifai.constants.search import DEFAULT_SEARCH_METRIC, DEFAULT_TOP_K
+from clarifai.errors import UserError
+from clarifai.schema.search import get_schema
+
+
+class Search(Lister, BaseClient):
+
+  def __init__(self,
+               user_id,
+               app_id,
+               top_k: int = DEFAULT_TOP_K,
+               metric: str = DEFAULT_SEARCH_METRIC):
+    """Initialize the Search object.
+
+        Args:
+            user_id (str): User ID.
+            app_id (str): App ID.
+            top_k (int, optional): Top K results to retrieve. Defaults to 10.
+            metric (str, optional): Similarity metric (either 'cosine' or 'euclidean'). Defaults to 'cosine'.
+
+        Raises:
+            UserError: If the metric is not 'cosine' or 'euclidean'.
+        """
+    if metric not in ["cosine", "euclidean"]:
+      raise UserError("Metric should be either cosine or euclidean")
+
+    self.user_id = user_id
+    self.app_id = app_id
+    self.metric_distance = dict(cosine="COSINE_DISTANCE", euclidean="EUCLIDEAN_DISTANCE")[metric]
+    self.data_proto = resources_pb2.Data()
+
+    self.inputs = Inputs(user_id=self.user_id, app_id=self.app_id)
+    self.rank_filter_schema = get_schema()
+    BaseClient.__init__(self, user_id=self.user_id, app_id=self.app_id)
+    Lister.__init__(self, page_size=top_k)
+
+  def _get_annot_proto(self, **kwargs):
+    """Get an Annotation proto message based on keyword arguments.
+
+        Args:
+            **kwargs: Keyword arguments specifying the resource.
+
+        Returns:
+            resources_pb2.Annotation: An Annotation proto message.
+        """
+    if not kwargs:
+      return resources_pb2.Annotation()
+
+    self.data_proto = resources_pb2.Data()
+    for key, value in kwargs.items():
+      if key == "image_bytes":
+        image_proto = self.inputs.get_input_from_bytes("", image_bytes=value).data.image
+        self.data_proto.image.CopyFrom(image_proto)
+
+      elif key == "image_url":
+        image_proto = self.inputs.get_input_from_url("", image_url=value).data.image
+        self.data_proto.image.CopyFrom(image_proto)
+
+      elif key == "concepts":
+        for concept in value:
+          concept_proto = resources_pb2.Concept(**concept)
+          self.data_proto.concepts.add().CopyFrom(concept_proto)
+
+      elif key == "text_raw":
+        text_proto = self.inputs.get_input_from_bytes(
+            "", text_bytes=bytes(value, 'utf-8')).data.text
+        self.data_proto.text.CopyFrom(text_proto)
+
+      elif key == "metadata":
+        metadata_struct = Struct()
+        metadata_struct.update(value)
+        self.data_proto.metadata.CopyFrom(metadata_struct)
+
+      elif key == "geo_point":
+        geo_point_proto = self._get_geo_point_proto(value["longitude"], value["latitude"],
+                                                    value["geo_limit"])
+        self.data_proto.geo.CopyFrom(geo_point_proto)
+
+      else:
+        raise UserError(f"kwargs contain key that is not supported: {key}")
+    return resources_pb2.Annotation(data=self.data_proto)
+
+  def _get_geo_point_proto(self, longitude: float, latitude: float,
+                           geo_limit: float) -> resources_pb2.Geo:
+    """Get a GeoPoint proto message based on geographical data.
+
+        Args:
+            longitude (float): Longitude coordinate.
+            latitude (float): Latitude coordinate.
+            geo_limit (float): Geographical limit.
+
+        Returns:
+            resources_pb2.Geo: A Geo proto message.
+        """
+    return resources_pb2.Geo(
+        geo_point=resources_pb2.GeoPoint(longitude=longitude, latitude=latitude),
+        geo_limit=resources_pb2.GeoLimit(type="withinKilometers", value=geo_limit))
+
+  def list_all_pages_generator(
+      self, endpoint: Callable[..., Any], proto_message: Any,
+      request_data: Dict[str, Any]) -> Generator[Dict[str, Any], None, None]:
+    """Lists all pages of a resource.
+
+        Args:
+            endpoint (Callable): The endpoint to call.
+            proto_message (Any): The proto message to use.
+            request_data (dict): The request data to use.
+
+        Yields:
+            response_dict: The next item in the listing.
+        """
+    page = 1
+    request_data['pagination'] = service_pb2.Pagination(page=page, per_page=self.default_page_size)
+    while True:
+      request_data['pagination'].page = page
+      response = self._grpc_request(endpoint, proto_message(**request_data))
+      dict_response = MessageToDict(response, preserving_proto_field_name=True)
+      if response.status.code != status_code_pb2.SUCCESS:
+        raise Exception(f"Listing failed with response {response!r}")
+
+      if 'hits' not in list(dict_response.keys()):
+        break
+      page += 1
+      yield response
+
+  def query(self, ranks=[{}], filters=[{}]):
+    """Perform a query with rank and filters.
+
+        Args:
+            ranks (List[Dict], optional): List of rank parameters. Defaults to [{}].
+            filters (List[Dict], optional): List of filter parameters. Defaults to [{}].
+
+        Returns:
+            Generator[Dict[str, Any], None, None]: A generator of query results.
+        """
+    try:
+      self.rank_filter_schema.validate(ranks)
+      self.rank_filter_schema.validate(filters)
+    except SchemaError as err:
+      raise UserError(f"Invalid rank or filter input: {err}")
+
+    rank_annot_proto, filters_annot_proto = [], []
+    for rank_dict in ranks:
+      rank_annot_proto.append(self._get_annot_proto(**rank_dict))
+    for filter_dict in filters:
+      filters_annot_proto.append(self._get_annot_proto(**filter_dict))
+
+    all_ranks = [resources_pb2.Rank(annotation=rank_annot) for rank_annot in rank_annot_proto]
+    all_filters = [
+        resources_pb2.Filter(annotation=filter_annot) for filter_annot in filters_annot_proto
+    ]
+
+    request_data = dict(
+        user_app_id=self.user_app_id,
+        searches=[
+            resources_pb2.Search(
+                query=resources_pb2.Query(ranks=all_ranks, filters=all_filters),
+                metric=self.metric_distance)
+        ])
+
+    return self.list_all_pages_generator(self.STUB.PostAnnotationsSearches,
+                                         service_pb2.PostAnnotationsSearchesRequest, request_data)

clarifai/client/workflow.py

@@ -194,7 +194,7 @@ class Workflow(Lister, BaseClient):
     Example:
         >>> from clarifai.client.workflow import Workflow
         >>> workflow = Workflow("https://clarifai.com/clarifai/main/workflows/Demographics")
-        >>> workflow.export('out_path')
+        >>> workflow.export('out_path.yml')
     """
     request = service_pb2.GetWorkflowRequest(user_app_id=self.user_app_id, workflow_id=self.id)
     response = self._grpc_request(self.STUB.GetWorkflow, request)

clarifai/constants/search.py

@@ -0,0 +1,2 @@
+DEFAULT_TOP_K = 10
+DEFAULT_SEARCH_METRIC = "cosine"

clarifai/models/model_serving/README.md

@@ -16,10 +16,10 @@ $ clarifai-model-upload-init --model_name <Your model name> \
 3. Add your model loading and inference code inside `inference.py` script of the generated model repository under the `setup()` and `predict()` functions respectively. Refer to  The [Inference Script section]() for a description of this file.
 4. Testing your implementation locally by running `<your_triton_folder>/1/test.py` with basic predefined tests.
 To avoid missing dependencies when deploying, recommend to use conda to create clean environment from [Clarifai base envs](./envs/). Then install everything in `requirements.txt`. Follow instruction inside [test.py](./models/test.py) for implementing custom tests.
-  * Create conda env: The base envs are attached in [./envs](./envs/), these are yaml file named as `triton_conda-python_version-torch_version-xxxx.yaml` format. Make sure base env that you're about to create is matched the one in your_triton_folder/triton_conda.yaml. To create conda env and install requirements run:
+  * Create conda env and install requirements:
 ```bash
-# create env
-conda env create -n <your_env> -f <base env name>.yaml
+# create env (note: only python version 3.8 is supported currently)
+conda create -n <your_env> python=3.8
 # activate it
 conda activate <your_env>
 # install dependencies

clarifai/models/model_serving/docs/dependencies.md

@@ -3,14 +3,9 @@
 Each model built for inference with triton requires certain dependencies & dependency versions be installed for successful inference execution.
 An execution environment is created for each model to be deployed on Clarifai and all necessary dependencies as listed in the `requirements.txt` file are installed there.
 
-Pre-configured base environments with certain dependencies pre-installed are provided for users to build on top of as presented in the `triton_conda.yaml` file.
+## Supported python and torch versions
 
-## Available pre-configured environments.
-
-1. ```yaml
-	 name: triton_conda-cp3.8-torch1.13.1-19f97078
-	 ```
-All dependencies in this environment can be [found here](../envs/triton_conda.yaml).
-
-By default all `triton_conda.yaml` files in the generated model repository use the environment above as its currently the only one available.
-Dependencies specified in the `requirements.txt` file are prioritized in case there's a difference in versions with those pre-installed in the base pre-configured environment.
+Currently, models must use python 3.8 (any 3.8.x).  Supported torch versions are 1.13.1 and 2.0.1.
+If your model depends on torch, torch must be listed in your requirements.txt file (even if it is
+already a dependency of another package).  An appropriate supported torch version will be selected
+based on your requirements.txt.

clarifai/models/model_serving/examples/image_classification/age_vit/requirements.txt

@@ -1,5 +1,6 @@
 clarifai>9.5.3 # for model upload features
 tritonclient[all]
+torch==1.13.1
 transformers==4.30.2
 scipy==1.10.1
 sentencepiece==0.1.99

clarifai/models/model_serving/examples/text_classification/xlm-roberta/requirements.txt

@@ -1,5 +1,6 @@
 clarifai>9.5.3 # for model upload features
 tritonclient[all]
+torch==1.13.1
 transformers==4.30.2
 scipy==1.10.1
 sentencepiece==0.1.99

clarifai/models/model_serving/examples/text_to_image/sd-v1.5/requirements.txt

@@ -1,5 +1,6 @@
 clarifai>9.5.3
 tritonclient[all]
+torch==1.13.1
 transformers==4.30.2
 Pillow==10.0.0
 diffusers==0.19.0

clarifai/models/model_serving/examples/text_to_text/bart-summarize/requirements.txt

@@ -1,3 +1,4 @@
 clarifai>9.5.3
 tritonclient[all]
+torch==1.13.1
 transformers==4.30.2

clarifai/models/model_serving/examples/visual_detection/yolov5x/requirements.txt

@@ -5,7 +5,7 @@ matplotlib>=3.2.2
 opencv-python>=4.1.1
 Pillow>=7.1.2
 PyYAML>=5.3.1
-torch>=1.7.0
+torch>=1.7.0,<2.0
 torchvision>=0.8.1
 protobuf<4.21.3  # https://github.com/ultralytics/yolov5/issues/8012
 pandas>=1.1.4

clarifai/models/model_serving/examples/visual_embedding/vit-base/requirements.txt

@@ -1,4 +1,5 @@
 clarifai>9.5.3
 tritonclient[all]
+torch==1.13.1
 transformers==4.30.2
 Pillow==10.0.0

clarifai/models/model_serving/examples/visual_segmentation/segformer-b2/requirements.txt

@@ -1,3 +1,4 @@
+torch==1.13.1
 clarifai>9.5.3
 tritonclient[all]
 transformers==4.30.2

clarifai/models/model_serving/pb_model_repository.py

@@ -78,11 +78,9 @@ class TritonModelRepository:
             pass
         else:
           continue
-      # gen requirements & conda yaml
+      # gen requirements
       with open(os.path.join(repository_path, "requirements.txt"), "w") as f:
         f.write("clarifai>9.5.3\ntritonclient[all]")  # for model upload utils
-      with open(os.path.join(repository_path, "triton_conda.yaml"), "w") as conda_env:
-        conda_env.write("name: triton_conda-cp3.8-torch1.13.1-19f97078")
 
     if not os.path.isdir(model_version_path):
       os.mkdir(model_version_path)

clarifai/schema/search.py

@@ -0,0 +1,60 @@
+from schema import And, Optional, Regex, Schema
+
+
+def get_schema() -> Schema:
+  """Initialize the schema for rank and filter.
+
+        This schema validates:
+
+        - Rank and filter must be a list
+        - Each item in the list must be a dict
+        - The dict can contain these optional keys:
+            - 'image_url': Valid URL string
+            - 'text_raw': Non-empty string
+            - 'metadata': Dict
+            - 'image_bytes': Bytes
+            - 'geo_point': Dict with 'longitude', 'latitude' and 'geo_limit' as float, float and int respectively
+            - 'concepts': List where each item is a concept dict
+        - Concept dict requires at least one of:
+            - 'name': Non-empty string with dashes/underscores
+            - 'id': Non-empty string
+            - 'language': Non-empty string
+            - 'value': 0 or 1 integer
+
+        Returns:
+            Schema: The schema for rank and filter.
+        """
+  # Schema for a single concept
+  concept_schema = Schema({
+      Optional('value'):
+          And(int, lambda x: x in [0, 1]),
+      Optional('id'):
+          And(str, len),
+      Optional('language'):
+          And(str, len),
+      # Non-empty strings with internal dashes and underscores.
+      Optional('name'):
+          And(str, len, Regex(r'^[0-9A-Za-z]+([-_][0-9A-Za-z]+)*$'))
+  })
+
+  # Schema for a rank or filter item
+  rank_filter_item_schema = Schema({
+      Optional('image_url'):
+          And(str, Regex(r'^https?://')),
+      Optional('text_raw'):
+          And(str, len),
+      Optional('metadata'):
+          dict,
+      Optional('image_bytes'):
+          bytes,
+      Optional('geo_point'): {
+          'longitude': float,
+          'latitude': float,
+          'geo_limit': int
+      },
+      Optional("concepts"):
+          And(list, lambda x: all(concept_schema.is_valid(item) and len(item) > 0 for item in x)),
+  })
+
+  # Schema for rank and filter args
+  return Schema([rank_filter_item_schema])

clarifai/versions.py

@@ -1,6 +1,6 @@
 import os
 
-CLIENT_VERSION = '9.8.2'
+CLIENT_VERSION = '9.9.0'
 OS_VER = os.sys.platform
 PYTHON_VERSION = '.'.join(
     map(str, [os.sys.version_info.major, os.sys.version_info.minor, os.sys.version_info.micro]))

clarifai/workflows/export.py

@@ -1,14 +1,13 @@
-import yaml
+from typing import Any, Dict
 
+import yaml
 from google.protobuf.json_format import MessageToDict
 
 VALID_YAML_KEYS = ["workflow", "id", "nodes", "node_inputs", "node_id", "model"]
 
 
 def clean_up_unused_keys(wf: dict):
-  """Removes unused keys from dict before exporting to yaml.
-    Supports nested dicts.
-    """
+  """Removes unused keys from dict before exporting to yaml. Supports nested dicts."""
   new_wf = dict()
   for key, val in wf.items():
     if key not in VALID_YAML_KEYS:
@@ -44,10 +43,12 @@ class Exporter:
   def __enter__(self):
     return self
 
-  def parse(self):
+  def parse(self) -> Dict[str, Any]:
     """Reads a resources_pb2.Workflow object (e.g. from a GetWorkflow response)
-        Returns a cleaned workflow dict.
-        """
+
+    Returns:
+        dict: A dict representation of the workflow.
+    """
     if isinstance(self.wf, list):
       self.wf = self.wf[0]
     wf = {"workflow": MessageToDict(self.wf, preserving_proto_field_name=True)}
@@ -57,7 +58,7 @@ class Exporter:
 
   def export(self, out_path):
     with open(out_path, 'w') as out_file:
-      yaml.dump(self.wf_dict["workflow"], out_file, default_flow_style=True)
+      yaml.dump(self.wf_dict["workflow"], out_file, default_flow_style=False)
 
   def __exit__(self, *args):
     self.close()

clarifai/workflows/utils.py

@@ -31,7 +31,7 @@ def is_same_yaml_model(api_model: resources_pb2.Model, yaml_model: Dict) -> bool
 
   yaml_model_from_api = dict()
   for k, _ in yaml_model.items():
-    if k == "output_info":
+    if k == "output_info" and api_model["model_version"].get("output_info", "") != "":
       yaml_model_from_api[k] = dict(params=api_model["model_version"]["output_info"].get("params"))
     else:
       yaml_model_from_api[k] = api_model.get(k)

clarifai/workflows/validate.py

@@ -1,7 +1,7 @@
 from schema import And, Optional, Regex, Schema, SchemaError, Use
 
 # Non-empty, up to 32-character ASCII strings with internal dashes and underscores.
-_id_validator = And(str, lambda s: 0 < len(s) <= 32, Regex(r'^[0-9A-Za-z]+([-_][0-9A-Za-z]+)*$'))
+_id_validator = And(str, lambda s: 0 < len(s) <= 48, Regex(r'^[0-9A-Za-z]+([-_][0-9A-Za-z]+)*$'))
 
 # 32-character hex string, converted to lower-case.
 _hex_id_validator = And(str, Use(str.lower), Regex(r'^[0-9a-f]{32}'))

{clarifai-9.8.2.dist-info → clarifai-9.9.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: clarifai
-Version: 9.8.2
+Version: 9.9.0
 Summary: Clarifai Python SDK
 Home-page: https://github.com/Clarifai/clarifai-python
 Author: Clarifai