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

clarifai_utils/client/user.py

@@ -1,28 +1,32 @@
 from typing import Any, Dict, List
 
-from clarifai_grpc.grpc.api import resources_pb2, service_pb2  # noqa: F401
+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 clarifai.client.app import App
 from clarifai.client.base import BaseClient
 from clarifai.client.lister import Lister
+from clarifai.client.runner import Runner
+from clarifai.errors import UserError
 from clarifai.utils.logging import get_logger
 
 
 class User(Lister, BaseClient):
   """User is a class that provides access to Clarifai API endpoints related to user information."""
 
-  def __init__(self, user_id: str = "", **kwargs):
+  def __init__(self, user_id: str = "", base_url: str = "https://api.clarifai.com", **kwargs):
     """Initializes an User object.
 
     Args:
         user_id (str): The user ID for the user to interact with.
-        **kwargs: Additional keyword arguments to be passed to the ClarifaiAuthHelper.
+        base_url (str): Base API url. Default "https://api.clarifai.com"
+        **kwargs: Additional keyword arguments to be passed to the User.
     """
     self.kwargs = {**kwargs, 'id': user_id}
     self.user_info = resources_pb2.User(**self.kwargs)
     self.logger = get_logger(logger_level="INFO", name=__name__)
-    BaseClient.__init__(self, user_id=self.id, app_id="")
+    BaseClient.__init__(self, user_id=self.id, app_id="", base=base_url)
     Lister.__init__(self)
 
   def list_apps(self, filter_by: Dict[str, Any] = {}) -> List[App]:
@@ -45,6 +49,27 @@ class User(Lister, BaseClient):
 
     return [App(**app_info) for app_info in all_apps_info]
 
+  def list_runners(self, filter_by: Dict[str, Any] = {}) -> List[Runner]:
+    """List all runners for the user
+
+    Args:
+        filter_by (dict): A dictionary of filters to apply to the list of runners.
+
+    Returns:
+        List[Runner]: A list of Runner objects for the runners.
+
+    Example:
+        >>> from clarifai.client.user import User
+        >>> client = User(user_id="user_id")
+        >>> all_runners= client.list_runners()
+    """
+    request_data = dict(user_app_id=self.user_app_id, per_page=self.default_page_size, **filter_by)
+    all_runners_info = list(
+        self.list_all_pages_generator(self.STUB.ListRunners, service_pb2.ListRunnersRequest,
+                                      request_data))
+
+    return [Runner(check_runner_exists=False, **runner_info) for runner_info in all_runners_info]
+
   def create_app(self, app_id: str, base_workflow: str = 'Language-Understanding',
                  **kwargs) -> App:
     """Creates an app for the user.
@@ -73,6 +98,41 @@ class User(Lister, BaseClient):
     kwargs.update({'user_id': self.id})
     return App(app_id=app_id, **kwargs)
 
+  def create_runner(self, runner_id: str, labels: List[str], description: str) -> Runner:
+    """Create a runner
+
+    Args:
+      runner_id (str): The Id of runner to create
+      labels (List[str]): Labels to match runner
+      description (str): Description of Runner
+
+    Returns:
+      Runner: A runner object for the specified Runner ID
+
+    Example:
+        >>> from clarifai.client.user import User
+        >>> client = User(user_id="user_id")
+        >>> runner = client.create_runner(runner_id="runner_id", labels=["label to link runner"], description="laptop runner")
+    """
+    if not isinstance(labels, List):
+      raise UserError("Labels must be a List of strings")
+
+    request = service_pb2.PostRunnersRequest(
+        user_app_id=self.user_app_id,
+        runners=[resources_pb2.Runner(id=runner_id, labels=labels, description=description)])
+    response = self._grpc_request(self.STUB.PostRunners, request)
+
+    if response.status.code != status_code_pb2.SUCCESS:
+      raise Exception(response.status)
+    self.logger.info("\nRunner created\n%s", response.status)
+
+    return Runner(
+        runner_id=runner_id,
+        user_id=self.id,
+        labels=labels,
+        description=description,
+        check_runner_exists=False)
+
   def app(self, app_id: str, **kwargs) -> App:
     """Returns an App object for the specified app ID.
 
@@ -96,6 +156,34 @@ class User(Lister, BaseClient):
     kwargs['user_id'] = self.id
     return App(app_id=app_id, **kwargs)
 
+  def runner(self, runner_id: str) -> Runner:
+    """Returns a Runner object if exists.
+
+    Args:
+        runner_id (str): The runner ID to interact with
+
+    Returns:
+        Runner: A Runner object for the existing runner ID.
+
+    Example:
+        >>> from clarifai.client.user import User
+        >>> client = User(user_id="user_id")
+        >>> runner = client.runner(runner_id="runner_id")
+    """
+    request = service_pb2.GetRunnerRequest(user_app_id=self.user_app_id, runner_id=runner_id)
+    response = self._grpc_request(self.STUB.GetRunner, request)
+    if response.status.code != status_code_pb2.SUCCESS:
+      raise Exception(
+          f"""Error getting runner, are you use this is a valid runner id {runner_id} at the user_id/app_id
+          {self.user_app_id.user_id}/{self.user_app_id.app_id}.
+          Error: {response.status.description}""")
+
+    dict_response = MessageToDict(response, preserving_proto_field_name=True)
+    kwargs = self.process_response_keys(dict_response[list(dict_response.keys())[1]],
+                                        list(dict_response.keys())[1])
+
+    return Runner(check_runner_exists=False, **kwargs)
+
   def delete_app(self, app_id: str) -> None:
     """Deletes an app for the user.
 
@@ -113,6 +201,24 @@ class User(Lister, BaseClient):
       raise Exception(response.status)
     self.logger.info("\nApp Deleted\n%s", response.status)
 
+  def delete_runner(self, runner_id: str) -> None:
+    """Deletes all spectified runner ids
+
+    Args:
+        runner_ids (str): List of runners to delete
+
+    Example:
+        >>> from clarifai.client.user import User
+        >>> client = User(user_id="user_id")
+        >>> client.delete_runner(runner_id="runner_id")
+    """
+    request = service_pb2.DeleteRunnersRequest(user_app_id=self.user_app_id, ids=[runner_id])
+    response = self._grpc_request(self.STUB.DeleteRunners, request)
+
+    if response.status.code != status_code_pb2.SUCCESS:
+      raise Exception(response.status)
+    self.logger.info("\nRunner Deleted\n%s", response.status)
+
   def __getattr__(self, name):
     return getattr(self.user_info, name)
 

clarifai_utils/client/workflow.py

@@ -10,6 +10,7 @@ from clarifai.client.lister import Lister
 from clarifai.errors import UserError
 from clarifai.urls.helper import ClarifaiUrlHelper
 from clarifai.utils.logging import get_logger
+from clarifai.workflows.export import Exporter
 
 
 class Workflow(Lister, BaseClient):
@@ -20,6 +21,7 @@ class Workflow(Lister, BaseClient):
                workflow_id: str = "",
                workflow_version: Dict = {'id': ""},
                output_config: Dict = {'min_value': 0},
+               base_url: str = "https://api.clarifai.com",
                **kwargs):
     """Initializes a Workflow object.
 
@@ -32,7 +34,8 @@ class Workflow(Lister, BaseClient):
           max_concepts (int): The maximum number of concepts to return.
           select_concepts (list[Concept]): The concepts to select.
           sample_ms (int): The number of milliseconds to sample.
-        **kwargs: Additional keyword arguments to be passed to the ClarifaiAuthHelper.
+        base_url (str): Base API url. Default "https://api.clarifai.com"
+        **kwargs: Additional keyword arguments to be passed to the Workflow.
     """
     if url_init != "" and workflow_id != "":
       raise UserError("You can only specify one of url_init or workflow_id.")
@@ -47,7 +50,7 @@ class Workflow(Lister, BaseClient):
     self.output_config = output_config
     self.workflow_info = resources_pb2.Workflow(**self.kwargs)
     self.logger = get_logger(logger_level="INFO")
-    BaseClient.__init__(self, user_id=self.user_id, app_id=self.app_id)
+    BaseClient.__init__(self, user_id=self.user_id, app_id=self.app_id, base=base_url)
     Lister.__init__(self)
 
   def predict(self, inputs: List[Input]):
@@ -182,6 +185,28 @@ class Workflow(Lister, BaseClient):
         for workflow_version_info in all_workflow_versions_info
     ]
 
+  def export(self, out_path: str):
+    """Exports the workflow to a yaml file.
+
+    Args:
+        out_path (str): The path to save the yaml file to.
+
+    Example:
+        >>> from clarifai.client.workflow import Workflow
+        >>> workflow = Workflow("https://clarifai.com/clarifai/main/workflows/Demographics")
+        >>> 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)
+    if response.status.code != status_code_pb2.SUCCESS:
+      raise Exception(f"Workflow Export failed with response {response.status!r}")
+
+    with Exporter(response) as e:
+      e.parse()
+      e.export(out_path)
+
+    self.logger.info(f"Exported workflow to {out_path}")
+
   def __getattr__(self, name):
     return getattr(self.workflow_info, name)
 

clarifai_utils/constants/search.py

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

clarifai_utils/datasets/upload/loaders/xview_detection.py

@@ -42,7 +42,7 @@ class xviewDetectionDataLoader(ClarifaiDataLoader):
     self.img_comp_dir = os.path.join(self.data_dir, "train_images_comp")
     self.label_file = os.path.join(self.data_dir, "xview_train.geojson")
 
-    # self.preprocess()
+    self.preprocess()
     self.all_data = self.xview_data_parser()
 
     self.load_data()

clarifai_utils/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_utils/models/model_serving/cli/deploy_cli.py

@@ -15,8 +15,7 @@ import argparse
 
 from clarifai.auth.helper import ClarifaiAuthHelper
 from clarifai.models.api import Models
-from clarifai.models.model_serving.constants import MODEL_TYPES
-from clarifai.models.model_serving.model_config.deploy import ClarifaiFieldsMap
+from clarifai.models.model_serving.model_config import MODEL_TYPES, get_model_config
 
 
 def deploy(model_url,
@@ -50,7 +49,7 @@ def deploy(model_url,
   assert model_type, "Can not parse model_type from url, please input it directly"
   # key map
   assert model_type in MODEL_TYPES, f"model_type should be one of {MODEL_TYPES}"
-  clarifai_key_map = ClarifaiFieldsMap(model_type=model_type)
+  clarifai_key_map = get_model_config(model_type=model_type).field_maps
   # if updating new version of existing model
   if update_version:
     resp = model_api.post_model_version(

clarifai_utils/models/model_serving/cli/repository.py

@@ -14,8 +14,8 @@
 
 import argparse
 
-from ..constants import MODEL_TYPES
-from ..model_config.triton_config import TritonModelConfig
+from ..constants import MAX_HW_DIM
+from ..model_config import MODEL_TYPES, get_model_config
 from ..pb_model_repository import TritonModelRepository
 
 
@@ -63,7 +63,6 @@ def model_upload_init():
       help="Directory to create triton repository.")
 
   args = parser.parse_args()
-  MAX_HW_DIM = 1024
 
   if len(args.image_shape) != 2:
     raise ValueError(
@@ -75,10 +74,9 @@ def model_upload_init():
         f"H and W each have a maximum value of 1024. Got H: {args.image_shape[0]}, W: {args.image_shape[1]}"
     )
 
-  model_config = TritonModelConfig(
+  model_config = get_model_config(args.model_type).make_triton_model_config(
       model_name=args.model_name,
       model_version="1",
-      model_type=args.model_type,
       image_shape=args.image_shape,
   )
 

clarifai_utils/models/model_serving/constants.py

@@ -1,5 +1 @@
-# Clarifai model types
-MODEL_TYPES = [
-    "visual-detector", "visual-classifier", "text-classifier", "text-to-text", "text-embedder",
-    "text-to-image", "visual-embedder", "visual-segmenter"
-]
+MAX_HW_DIM = 1024

clarifai_utils/models/model_serving/docs/custom_config.md

@@ -15,17 +15,16 @@ $ clarifai-model-upload-init --model_name <Your model name> \
 
 ## Generating the triton model repository without the commandline
 
-The triton model repository can be generated via a python script specifying the same values as required in the commandline. Below is a sample of how the code would be structured.
+The triton model repository can be generated via a python script specifying the same values as required in the commandline. Below is a sample of how the code would be structured with `visual_classifier`.
 
 ```python
-from clarifai.models.model_serving.model_config.triton_config import TritonModelConfig
-from clarifai.models.model_serving pb_model_repository import TritonModelRepository
+from clarifai.models.model_serving.model_config import get_model_config, ModelTypes, TritonModelConfig
+from clarifai.models.model_serving.pb_model_repository import TritonModelRepository
 
-
-model_config = TritonModelConfig(
+model_type = ModelTypes.visual_classifier
+model_config: TritonModelConfig = get_model_config(model_type).make_triton_model_config(
 	model_name="<model_name>",
 	model_version="1",
-	model_type="<model_type>",
 	image_shape=<[H,W]>, # 0 < [H,W] <= 1024
 )
 

clarifai_utils/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_utils/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_utils/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_utils/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_utils/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_utils/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_utils/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_utils/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_utils/models/model_serving/model_config/__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 .config import *  # noqa # pylint: disable=unused-import
+from .serializer import Serializer  # noqa # pylint: disable=unused-import