clarifai 10.5.2__tar.gz → 10.5.4__tar.gz

{clarifai-10.5.2/clarifai.egg-info → clarifai-10.5.4}/PKG-INFO

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

clarifai-10.5.4/VERSION

@@ -0,0 +1 @@
+10.5.4

{clarifai-10.5.2 → clarifai-10.5.4}/clarifai/client/auth/helper.py

@@ -5,6 +5,7 @@ from urllib.parse import urlparse
 
 from clarifai_grpc.channel.clarifai_channel import ClarifaiChannel
 from clarifai_grpc.grpc.api import resources_pb2, service_pb2_grpc
+from clarifai.utils.constants import CLARIFAI_PAT_ENV_VAR, CLARIFAI_SESSION_TOKEN_ENV_VAR
 
 DEFAULT_BASE = "https://api.clarifai.com"
 DEFAULT_UI = "https://clarifai.com"
@@ -237,8 +238,8 @@ Additionally, these optional params are supported:
     """
     user_id = os.environ.get("CLARIFAI_USER_ID", "")
     app_id = os.environ.get("CLARIFAI_APP_ID", "")
-    token = os.environ.get("CLARIFAI_SESSION_TOKEN", "")
-    pat = os.environ.get("CLARIFAI_PAT", "")
+    token = os.environ.get(CLARIFAI_SESSION_TOKEN_ENV_VAR, "")
+    pat = os.environ.get(CLARIFAI_PAT_ENV_VAR, "")
     base = os.environ.get("CLARIFAI_API_BASE", DEFAULT_BASE)
     ui = os.environ.get("CLARIFAI_UI", DEFAULT_UI)
     root_certificates_path = os.environ.get("CLARIFAI_ROOT_CERTIFICATES_PATH", None)

{clarifai-10.5.2 → clarifai-10.5.4}/clarifai/client/input.py

@@ -65,7 +65,7 @@ class Inputs(Lister, BaseClient):
 
   @staticmethod
   def _get_proto(input_id: str,
-                 dataset_id: Union[str, None],
+                 dataset_id: str = None,
                  imagepb: Image = None,
                  video_pb: Video = None,
                  audio_pb: Audio = None,
@@ -481,7 +481,11 @@ class Inputs(Lister, BaseClient):
     return input_protos
 
   @staticmethod
-  def get_bbox_proto(input_id: str, label: str, bbox: List, label_id: str = None) -> Annotation:
+  def get_bbox_proto(input_id: str,
+                     label: str,
+                     bbox: List,
+                     label_id: str = None,
+                     annot_id: str = None) -> Annotation:
     """Create an annotation proto for each bounding box, label input pair.
 
     Args:
@@ -489,6 +493,7 @@ class Inputs(Lister, BaseClient):
         label (str): annotation label name
         bbox (List): a list of a single bbox's coordinates. # bbox ordering: [xmin, ymin, xmax, ymax]
         label_id (str): annotation label ID
+        annot_id (str): annotation ID
 
     Returns:
         An annotation object for the specified input ID.
@@ -499,31 +504,35 @@ class Inputs(Lister, BaseClient):
     """
     if not isinstance(bbox, list):
       raise UserError("must be a list of bbox cooridnates")
-    input_annot_proto = resources_pb2.Annotation(
-        input_id=input_id,
-        data=resources_pb2.Data(regions=[
-            resources_pb2.Region(
-                region_info=resources_pb2.RegionInfo(bounding_box=resources_pb2.BoundingBox(
-                    # bbox ordering: [xmin, ymin, xmax, ymax]
-                    # top_row must be less than bottom row
-                    # left_col must be less than right col
-                    top_row=bbox[1],  #y_min
-                    left_col=bbox[0],  #x_min
-                    bottom_row=bbox[3],  #y_max
-                    right_col=bbox[2]  #x_max
-                )),
-                data=resources_pb2.Data(concepts=[
-                    resources_pb2.Concept(
-                        id=f"id-{''.join(label.split(' '))}", name=label, value=1.)
-                    if not label_id else resources_pb2.Concept(id=label_id, name=label, value=1.)
-                ]))
-        ]))
+    annot_data = resources_pb2.Data(regions=[
+        resources_pb2.Region(
+            region_info=resources_pb2.RegionInfo(bounding_box=resources_pb2.BoundingBox(
+                # bbox ordering: [xmin, ymin, xmax, ymax]
+                # top_row must be less than bottom row
+                # left_col must be less than right col
+                top_row=bbox[1],  #y_min
+                left_col=bbox[0],  #x_min
+                bottom_row=bbox[3],  #y_max
+                right_col=bbox[2]  #x_max
+            )),
+            data=resources_pb2.Data(concepts=[
+                resources_pb2.Concept(id=f"id-{''.join(label.split(' '))}", name=label, value=1.)
+                if not label_id else resources_pb2.Concept(id=label_id, name=label, value=1.)
+            ]))
+    ])
+    if annot_id:
+      input_annot_proto = resources_pb2.Annotation(id=annot_id, input_id=input_id, data=annot_data)
+    else:
+      input_annot_proto = resources_pb2.Annotation(input_id=input_id, data=annot_data)
 
     return input_annot_proto
 
   @staticmethod
-  def get_mask_proto(input_id: str, label: str, polygons: List[List[float]],
-                     label_id: str = None) -> Annotation:
+  def get_mask_proto(input_id: str,
+                     label: str,
+                     polygons: List[List[float]],
+                     label_id: str = None,
+                     annot_id: str = None) -> Annotation:
     """Create an annotation proto for each polygon box, label input pair.
 
     Args:
@@ -531,6 +540,7 @@ class Inputs(Lister, BaseClient):
         label (str): annotation label name
         polygons (List): Polygon x,y points iterable
         label_id (str): annotation label ID
+        annot_id (str): annotation ID
 
     Returns:
         An annotation object for the specified input ID.
@@ -541,23 +551,24 @@ class Inputs(Lister, BaseClient):
     """
     if not isinstance(polygons, list):
       raise UserError("polygons must be a list of points")
-    input_mask_proto = resources_pb2.Annotation(
-        input_id=input_id,
-        data=resources_pb2.Data(regions=[
-            resources_pb2.Region(
-                region_info=resources_pb2.RegionInfo(polygon=resources_pb2.Polygon(
-                    points=[
-                        resources_pb2.Point(
-                            row=_point[1],  # row is y point
-                            col=_point[0],  # col is x point
-                            visibility="VISIBLE") for _point in polygons
-                    ])),
-                data=resources_pb2.Data(concepts=[
-                    resources_pb2.Concept(
-                        id=f"id-{''.join(label.split(' '))}", name=label, value=1.)
-                    if not label_id else resources_pb2.Concept(id=label_id, name=label, value=1.)
-                ]))
-        ]))
+    annot_data = resources_pb2.Data(regions=[
+        resources_pb2.Region(
+            region_info=resources_pb2.RegionInfo(polygon=resources_pb2.Polygon(
+                points=[
+                    resources_pb2.Point(
+                        row=_point[1],  # row is y point
+                        col=_point[0],  # col is x point
+                        visibility="VISIBLE") for _point in polygons
+                ])),
+            data=resources_pb2.Data(concepts=[
+                resources_pb2.Concept(id=f"id-{''.join(label.split(' '))}", name=label, value=1.)
+                if not label_id else resources_pb2.Concept(id=label_id, name=label, value=1.)
+            ]))
+    ])
+    if annot_id:
+      input_mask_proto = resources_pb2.Annotation(id=annot_id, input_id=input_id, data=annot_data)
+    else:
+      input_mask_proto = resources_pb2.Annotation(input_id=input_id, data=annot_data)
 
     return input_mask_proto
 
@@ -707,7 +718,7 @@ class Inputs(Lister, BaseClient):
 
     return input_job_id, response
 
-  def patch_inputs(self, inputs: List[Input], action: str = 'merge') -> str:
+  def patch_inputs(self, inputs: List[Input], action: str = 'merge') -> None:
     """Patch list of input objects to the app.
 
     Args:
@@ -719,7 +730,6 @@ class Inputs(Lister, BaseClient):
     """
     if not isinstance(inputs, list):
       raise UserError("inputs must be a list of Input objects")
-    uuid.uuid4().hex  # generate a unique id for this job
     request = service_pb2.PatchInputsRequest(
         user_app_id=self.user_app_id, inputs=inputs, action=action)
     response = self._grpc_request(self.STUB.PatchInputs, request)
@@ -727,9 +737,9 @@ class Inputs(Lister, BaseClient):
       try:
         self.logger.warning(f"Patch inputs failed, status: {response.annotations[0].status}")
       except Exception:
-        self.logger.warning(f"Patch inputs failed, status: {response.status.details}")
-
-    self.logger.info("\nPatch Inputs Successful\n%s", response.status)
+        self.logger.warning(f"Patch inputs failed, status: {response.status}")
+    else:
+      self.logger.info("\nPatch Inputs Successful\n%s", response.status)
 
   def upload_annotations(self, batch_annot: List[resources_pb2.Annotation], show_log: bool = True
                         ) -> Union[List[resources_pb2.Annotation], List[None]]:
@@ -761,6 +771,67 @@ class Inputs(Lister, BaseClient):
 
     return retry_upload
 
+  def patch_annotations(self, batch_annot: List[resources_pb2.Annotation],
+                        action: str = 'merge') -> None:
+    """Patch image annotations to app.
+
+    Args:
+        batch_annot: annot batch protos
+        action (str): Action to perform on the input. Options: 'merge', 'overwrite', 'remove'.
+
+    """
+    if not isinstance(batch_annot, list):
+      raise UserError("batch_annot must be a list of Annotation objects")
+    request = service_pb2.PatchAnnotationsRequest(
+        user_app_id=self.user_app_id, annotations=batch_annot, action=action)
+    response = self._grpc_request(self.STUB.PatchAnnotations, request)
+    response_dict = MessageToDict(response)
+    if response.status.code != status_code_pb2.SUCCESS:
+      try:
+        for annot in response_dict["annotations"]:
+          if annot['status']['code'] != status_code_pb2.ANNOTATION_SUCCESS:
+            self.logger.warning(f"Patch annotations failed, status: {annot['status']}")
+      except Exception:
+        self.logger.warning(f"Patch annotations failed due to {response.status}")
+    else:
+      self.logger.info("\nPatch Annotations Uploaded Successful\n%s", response.status)
+
+  def patch_concepts(self,
+                     concept_ids: List[str],
+                     labels: List[str] = [],
+                     values: List[float] = [],
+                     action: str = 'overwrite') -> None:
+    """Patch concepts to app.
+
+    Args:
+        concept_ids:  A list of concept
+        labels: A list of label names
+        values: concept value
+        action (str): Action to perform on the input. Options: 'overwrite'.
+
+    """
+    if not labels:
+      labels = list(concept_ids)
+    if values:
+      concepts=[
+              resources_pb2.Concept(
+              id=concept_id, name=label, value=value)\
+              for concept_id, label, value in zip(concept_ids, labels, values)
+          ]
+    else:
+      concepts=[
+              resources_pb2.Concept(
+              id=concept_id, name=label, value=1.)\
+              for concept_id, label in zip(concept_ids, labels)
+          ]
+    request = service_pb2.PatchConceptsRequest(
+        user_app_id=self.user_app_id, concepts=concepts, action=action)
+    response = self._grpc_request(self.STUB.PatchConcepts, request)
+    if response.status.code != status_code_pb2.SUCCESS:
+      self.logger.warning(f"Patch Concepts failed, status: {response.status.details}")
+    else:
+      self.logger.info("\nPatch Concepts Successful\n%s", response.status)
+
   def _upload_batch(self, inputs: List[Input]) -> List[Input]:
     """Upload a batch of input objects to the app.
 

{clarifai-10.5.2 → clarifai-10.5.4}/clarifai/constants/dataset.py

@@ -22,3 +22,5 @@ TASK_TO_ANNOTATION_TYPE = {
 }
 
 MAX_RETRIES = 2
+
+CONTENT_TYPE = {"json": "application/json", "zip": "application/zip"}

{clarifai-10.5.2 → clarifai-10.5.4}/clarifai/datasets/export/inputs_annotations.py

@@ -12,6 +12,7 @@ from google.protobuf.json_format import MessageToDict
 from PIL import ImageFile
 from tqdm import tqdm
 
+from clarifai.constants.dataset import CONTENT_TYPE
 from clarifai.errors import UserError
 from clarifai.utils.logging import get_logger
 
@@ -61,8 +62,11 @@ class DatasetExportReader:
   def _download_temp_archive(self, archive_url: str,
                              chunk_size: int = 128) -> tempfile.TemporaryFile:
     """Downloads the temp archive of InputBatches."""
-    session = requests.Session()
-    r = session.get(archive_url, stream=True)
+    r = self.session.get(archive_url, stream=True)
+    if r.headers['content-type'] == CONTENT_TYPE['json']:
+      raise Exception("File is a json file :\n {}".format(r.json()))
+    elif r.headers['content-type'] != CONTENT_TYPE['zip']:
+      raise Exception('File is not a zip file')
     temp_file = tempfile.TemporaryFile()
     for chunk in r.iter_content(chunk_size=chunk_size):
       temp_file.write(chunk)

{clarifai-10.5.2 → clarifai-10.5.4}/clarifai/models/model_serving/cli/login.py

@@ -1,6 +1,6 @@
 import argparse
 
-from clarifai.utils.constants import CLARIFAI_PAT_PATH
+from clarifai.models.model_serving.constants import CLARIFAI_PAT_PATH
 from ..utils import _persist_pat
 from .base import BaseClarifaiCli
 

{clarifai-10.5.2 → clarifai-10.5.4}/clarifai/models/model_serving/constants.py

@@ -1,13 +1,20 @@
 import os
 
-from clarifai.utils.constants import CLARIFAI_HOME
-
 MAX_HW_DIM = 1024
 IMAGE_TENSOR_NAME = "image"
 TEXT_TENSOR_NAME = "text"
 
 BUILT_MODEL_EXT = ".clarifai"
 
+USER_CACHE_DIR = os.path.join(os.path.expanduser("~"), ".cache")
+CLARIFAI_HOME = os.path.expanduser(
+    os.getenv(
+        "CLARIFAI_HOME",
+        os.path.join(os.getenv("XDG_CACHE_HOME", USER_CACHE_DIR), "clarifai"),
+    ))
+os.makedirs(CLARIFAI_HOME, exist_ok=True)
+CLARIFAI_PAT_PATH = os.path.join(CLARIFAI_HOME, "pat")
+
 CLARIFAI_EXAMPLES_REPO = "https://github.com/Clarifai/examples.git"
 repo_name = CLARIFAI_EXAMPLES_REPO.split("/")[-1].replace(".git", "")
 CLARIFAI_EXAMPLES_REPO_PATH = os.path.join(CLARIFAI_HOME, repo_name)

{clarifai-10.5.2 → clarifai-10.5.4}/clarifai/models/model_serving/utils.py

@@ -1,6 +1,7 @@
 import os
 
-from clarifai.utils.constants import CLARIFAI_PAT_ENV_VAR, CLARIFAI_PAT_PATH
+from clarifai.models.model_serving.constants import CLARIFAI_PAT_PATH
+from clarifai.utils.constants import CLARIFAI_PAT_ENV_VAR
 
 
 def _persist_pat(pat: str):

{clarifai-10.5.2 → clarifai-10.5.4}/clarifai/rag/rag.py

@@ -14,7 +14,9 @@ from clarifai.constants.rag import MAX_UPLOAD_BATCH_SIZE
 from clarifai.errors import UserError
 from clarifai.rag.utils import (convert_messages_to_str, format_assistant_message, load_documents,
                                 split_document)
+from clarifai.utils.constants import CLARIFAI_USER_ID_ENV_VAR
 from clarifai.utils.logging import get_logger
+from clarifai.utils.misc import get_from_dict_or_env
 
 DEFAULT_RAG_PROMPT_TEMPLATE = "Context information is below:\n{data.hits}\nGiven the context information and not prior knowledge, answer the query.\nQuery: {data.text.raw}\nAnswer: "
 
@@ -75,6 +77,12 @@ class RAG:
         >>> rag_agent = RAG.setup(app_url=YOUR_APP_URL)
         >>> rag_agent.chat(messages=[{"role":"human", "content":"What is Clarifai"}])
     """
+    if not app_url:
+      try:
+        user_id = get_from_dict_or_env(key="user_id", env_key=CLARIFAI_USER_ID_ENV_VAR, **kwargs)
+      except Exception:
+        pass
+
     now_ts = uuid.uuid4().hex[:10]
     if user_id and not app_url:
       user = User(user_id=user_id, base_url=base_url, pat=pat)

clarifai-10.5.4/clarifai/utils/constants.py

@@ -0,0 +1,3 @@
+CLARIFAI_PAT_ENV_VAR = "CLARIFAI_PAT"
+CLARIFAI_SESSION_TOKEN_ENV_VAR = "CLARIFAI_SESSION_TOKEN"
+CLARIFAI_USER_ID_ENV_VAR = "CLARIFAI_USER_ID"

{clarifai-10.5.2 → clarifai-10.5.4}/clarifai/utils/logging.py

@@ -3,6 +3,7 @@ from collections import defaultdict
 from typing import Dict, List, Optional, Union
 
 from rich import print as rprint
+from rich.console import Console
 from rich.logging import RichHandler
 from rich.table import Table
 from rich.traceback import install
@@ -84,7 +85,8 @@ def _configure_logger(name: str, logger_level: Union[int, str] = logging.NOTSET)
     logger.removeHandler(handler)
 
   # Add the new rich handler and formatter
-  handler = RichHandler(rich_tracebacks=True, log_time_format="%Y-%m-%d %H:%M:%S")
+  handler = RichHandler(
+      rich_tracebacks=True, log_time_format="%Y-%m-%d %H:%M:%S", console=Console(width=255))
   formatter = logging.Formatter('%(name)s:  %(message)s')
   handler.setFormatter(formatter)
   logger.addHandler(handler)

{clarifai-10.5.2 → clarifai-10.5.4}/clarifai/versions.py

@@ -1,6 +1,6 @@
 import os
 
-CLIENT_VERSION = "10.5.2"
+CLIENT_VERSION = "10.5.4"
 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-10.5.2 → clarifai-10.5.4/clarifai.egg-info}/PKG-INFO

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

{clarifai-10.5.2 → clarifai-10.5.4}/tests/test_app.py

@@ -1,5 +1,6 @@
 import logging
 import os
+import time
 import uuid
 
 import pytest
@@ -113,6 +114,16 @@ class TestApp:
     all_datasets = list(create_app.list_datasets())
     assert len(all_datasets) == 1
 
+  def test_export_dataset(self, create_app):
+    dataset = create_app.dataset(dataset_id=CREATE_DATASET_ID)
+    dataset_demo_version = dataset.create_version()
+    versions = list(dataset.list_versions())
+    time.sleep(5)
+    dataset_demo_version.export(save_path='tests/output_demo.zip')
+    assert len(versions) == 1  #test for create_version
+    assert os.path.exists('tests/output_demo.zip') is True
+    os.remove('tests/output_demo.zip')
+
   def test_delete_dataset(self, create_app, caplog):
     with caplog.at_level(logging.INFO):
       create_app.delete_dataset(CREATE_DATASET_ID)

{clarifai-10.5.2 → clarifai-10.5.4}/tests/test_data_upload.py

@@ -3,6 +3,7 @@ import os
 import uuid
 
 import pytest
+from google.protobuf.struct_pb2 import Struct
 
 from clarifai.client.user import User
 from clarifai.datasets.upload.utils import load_module_dataloader
@@ -107,6 +108,51 @@ class Testdataupload:
     assert len(paginated_inputs) == 5
     assert len(image_filterd_inputs) == 2  # 2 images uploaded in the above tests
 
+  def test_patch_inputs(self):
+    metadata = Struct()
+    metadata.update({'test': 'SUCCESS'})
+    new_input = self.input_object._get_proto(input_id='input_1', metadata=metadata)
+    self.input_object.patch_inputs([new_input], action='merge')
+    for input_item in list(self.input_object.list_inputs()):
+      if input_item.id == 'input_1':
+        assert input_item.data.metadata["test"] == "SUCCESS"
+        break
+
+  def test_patch_annotations(self, caplog):
+    bbox_points = [.2, .2, .8, .8]
+    annotation = self.input_object.get_bbox_proto(
+        input_id="input_1",
+        label="input_1_label",
+        bbox=bbox_points,
+        label_id="id-input_1_label",
+        annot_id="input_1_annot")
+    with caplog.at_level(logging.INFO):
+      self.input_object.upload_annotations([annotation])
+      assert "SUCCESS" in caplog.text  #upload annotations check
+
+    bbox_points = [.4, .4, .6, .6]
+    annotation = self.input_object.get_bbox_proto(
+        input_id="input_1",
+        label="input_1_label",
+        bbox=bbox_points,
+        label_id="id-input_1_label",
+        annot_id="input_1_annot")
+    self.input_object.patch_annotations([annotation], action='merge')
+    test_annotation = list(self.input_object.list_annotations())[0]
+    assert test_annotation.id == "input_1_annot"
+    annot_bbox = test_annotation.data.regions[0].region_info.bounding_box
+    assert round(annot_bbox.left_col, 1) == .4 and round(annot_bbox.top_row, 1) == .4 and round(
+        annot_bbox.right_col, 1) == .6 and round(annot_bbox.bottom_row, 1) == .6
+
+  def test_patch_concepts(self):
+    self.input_object.patch_concepts(
+        concept_ids=["id-input_1_label"], labels=["SUCCESS"], values=[], action='overwrite')
+    concepts = list(self.app.list_concepts())
+    for concept in concepts:
+      if concept.id == "id-input_1_label":
+        assert concepts[0].name == "SUCCESS"
+        break
+
   def test_aggregate_inputs(self, caplog):
     uploaded_inputs = list(self.input_object.list_inputs())
     with caplog.at_level(logging.INFO):
@@ -123,7 +169,7 @@ class Testdataupload:
       self.input_object.delete_inputs(uploaded_inputs)
       assert "Inputs Deleted" in caplog.text  # Testing delete inputs action
     assert len(uploaded_inputs) == 5  # 5 inputs are uploaded from the CSV file
-    assert len(concepts) == 2  # Test for list concepts
+    assert len(concepts) == 3  # Test for list concepts
 
   def test_upload_folder(self, caplog):
     self.dataset.upload_from_folder(folder_path=FOLDER_PATH, input_type='image', labels=True)

clarifai-10.5.2/VERSION

@@ -1 +0,0 @@
-10.5.2

clarifai-10.5.2/clarifai/utils/constants.py

@@ -1,12 +0,0 @@
-import os
-
-USER_CACHE_DIR = os.path.join(os.path.expanduser("~"), ".cache")
-CLARIFAI_HOME = os.path.expanduser(
-    os.getenv(
-        "CLARIFAI_HOME",
-        os.path.join(os.getenv("XDG_CACHE_HOME", USER_CACHE_DIR), "clarifai"),
-    ))
-os.makedirs(CLARIFAI_HOME, exist_ok=True)
-CLARIFAI_PAT_PATH = os.path.join(CLARIFAI_HOME, "pat")
-CLARIFAI_PAT_ENV_VAR = "CLARIFAI_PAT"
-CLARIFAI_SESSION_TOKEN_ENV_VAR = "CLARIFAI_SESSION_TOKEN"