clarifai 9.6.1__py3-none-any.whl → 9.6.3__py3-none-any.whl

clarifai/runners/base.py

@@ -0,0 +1,140 @@
+# Copyright 2023 Clarifai, Inc.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# 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.
+"""Interface to Clarifai Runners API."""
+
+from typing import Type
+
+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.auth.helper import ClarifaiAuthHelper
+from clarifai.client import create_stub
+
+
+class BaseRunner:
+  """
+  Base class for remote inference runners. This should be subclassed with the run_input method
+  implemented to process each input in the request.
+
+  Then on the subclass call start() to start the run loop.
+  """
+
+  def __init__(self, auth: Type[ClarifaiAuthHelper], runner_id: str) -> None:
+    """
+    Args:
+      auth: ClarifaiAuthHelper - the auth object to use
+      runner_id: str - the id of the runner to use. Create the runner in the Clarifai API first
+
+    """
+    self.auth = auth
+    self.stub = create_stub(self.auth)
+    self.runner_id = runner_id
+
+    # Check that the runner exists.
+    response = self.stub.GetRunner(
+        service_pb2.GetRunnerRequest(
+            user_app_id=self.auth.get_user_app_id_proto(), runner_id=self.runner_id))
+    if work_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.auth.get_user_app_id_proto().user_id}/{self.auth.get_user_app_id_proto().app_id}. Error: {response.status.description}"
+      )
+
+  def start(self):
+    """
+    Start the run loop. This will ask the Clarifai API for work, and when it gets work, it will run
+    the model on the inputs and post the results back to the Clarifai API. It will then ask for more
+    work again.
+    """
+    self._long_poll_loop()
+
+  def _run(self, request: service_pb2.PostModelOutputsRequest) -> service_pb2.MultiOutputResponse:
+    """
+    Run the model on the given request. You shouldn't need to override this method, see run_input
+    for the implementation to process each input in the request.
+
+    Args:
+      request: service_pb2.PostModelOutputsRequest - the request to run the model on
+
+    Returns:
+      service_pb2.MultiOutputResponse - the response from the model's run_input implementation.
+    """
+    outputs = []
+    # TODO: parallelize this
+    for inp in request.inputs:
+      # TODO: handle errors
+      outputs.append(self.run_input(inp))
+
+    return service_pb2.MultiOutputResponse(
+        status=status_pb2.Status(
+            code=status_code_pb2.SUCCESS,
+            description="Success",
+        ),
+        outputs=outputs,
+    )
+
+  def run_input(self, input: resources_pb2.Input) -> resources_pb2.Output:
+    """
+    Run the model on the given input in the request. This is the method you should override to
+    process each input in the request.
+
+    Args:
+      input: resources_pb2.Input - the input to run the model on
+
+    Returns:
+      resources_pb2.Output - the response from the model's run_input implementation.
+    """
+    raise NotImplementedError("run_input() not implemented")
+
+  def _long_poll_loop(self):
+    """
+    This method will long poll for work, and when it gets work, it will run the model on the inputs
+    and post the results back to the Clarifai API. It will then long poll again for more work.
+    """
+    c = 0
+    # TODO: handle more errors within this loop so it never stops.
+    # TODO: perhaps have multiple processes running this loop to handle more work.
+    while True:
+      # Long poll waiting for work.
+      print("Loop iteration: {}".format(c))
+      work_response = self.stub.ListRunnerItems(
+          service_pb2.ListRunnerItemsRequest(
+              user_app_id=self.auth.get_user_app_id_proto(), runner_id=self.runner_id))
+      if work_response.status.code == status_code_pb2.RUNNER_NEEDS_RETRY:
+        c += 1
+        continue  # immediate restart the long poll
+      if work_response.status.code != status_code_pb2.SUCCESS:
+        raise Exception("Error getting work: {}".format(work_response.status.description))
+      if len(work_response.items) == 0:
+        print("No work to do. Waiting...")
+        continue
+
+      # We have work to do. Run the model on the inputs.
+      for item in work_response.items:
+        if not item.HasField('post_model_outputs_request'):
+          raise Exception("Unexpected work item type: {}".format(item))
+        print(
+            f"Working on item: {item.id} with inputs {len(item.post_model_outputs_request.inputs)}"
+        )
+        result = self._run(item.post_model_outputs_request)
+
+        result_response = self.stub.PostRunnerItemOutputs(
+            service_pb2.PostRunnerItemOutputsRequest(
+                user_app_id=self.auth.get_user_app_id_proto(),
+                item_id=item.id,
+                runner_id=self.runner_id,
+                runner_item_outputs=[service_pb2.RunnerItemOutput(multi_output_response=result)]))
+        if result_response.status.code != status_code_pb2.SUCCESS:
+          raise Exception(
+              json_format.MessageToJson(result_response, preserving_proto_field_name=True))
+          # raise Exception("Error posting result: {}".format(result_response.status.description))

clarifai/runners/example.py

@@ -0,0 +1,36 @@
+from clarifai_grpc.grpc.api import resources_pb2
+
+from clarifai.auth.helper import ClarifaiAuthHelper
+from clarifai.runners.base import BaseRunner
+
+
+class MyRunner(BaseRunner):
+  """ A custom runner that adds "Hello World" to the end of the text and replaces the domain of the
+  image URL as an example.
+  """
+
+  def run_input(self, input: resources_pb2.Input) -> resources_pb2.Output:
+    """ This is the method that will be called when the runner is run. It takes in an input and
+    returns an output.
+    """
+
+    output = resources_pb2.Output()
+
+    data = input.data
+
+    if data.text.raw != "":
+      output.data.text.raw = data.text.raw + "Hello World"
+    if data.image.url != "":
+      output.data.text.raw = data.image.url.replace("samples.clarifai.com", "newdomain.com")
+    return output
+
+
+if __name__ == '__main__':
+  # Make sure you set these env vars before running the example.
+  # CLARIFAI_PAT
+  # CLARIFAI_USER_ID
+  # CLARIFAI_APP_ID
+  auth = ClarifaiAuthHelper.from_env()
+
+  # You need to first create a runner in the Clarifai API and then use the ID here.
+  MyRunner(auth, runner_id="laptop_runner").start()

{clarifai-9.6.1.dist-info → clarifai-9.6.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: clarifai
-Version: 9.6.1
+Version: 9.6.3
 Summary: Clarifai Python Utilities
 Home-page: https://github.com/Clarifai/clarifai-python-utils
 Author: Clarifai

{clarifai-9.6.1.dist-info → clarifai-9.6.3.dist-info}/RECORD

@@ -1,6 +1,6 @@
 clarifai/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clarifai/auth/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-clarifai/auth/helper.py,sha256=Oy7xc7uQJZq6li_obVC2A5NcJt1LS-HWSAkZ_c9Ekcw,13909
+clarifai/auth/helper.py,sha256=4ZxyH43qQOoHse_ypmcaUpbhV4BrZ3I61GhgbxF2_9Q,13921
 clarifai/client/__init__.py,sha256=DlA1iS8Szl3I7oGw5UBVra7-dZ1M_wKxcZXCoUcDBJ8,121
 clarifai/client/abc.py,sha256=lRAIhYSUwHh0Xp6yZWVWXqWF1mOy9A-8aKscmoPXEnM,536
 clarifai/client/stub.py,sha256=pa1Sh9HeUG7Ipi3f-OmTRFp0hvH31PF60NsC7IwFBNI,3606
@@ -46,7 +46,7 @@ clarifai/listing/modules.py,sha256=yM074edY2d19HHt2MpO6_oAzDxM8yuc4hMns4D8zQTs,1
 clarifai/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clarifai/models/api.py,sha256=fsE6eLZ0NgcvDpAQcRpT2DPataBTg0gIEOWxtoNeYXM,9555
 clarifai/models/model_serving/__init__.py,sha256=Nls28G-fedNw2oQZIkPQSN__TgjJXbG9RDzzuHIM0VI,575
-clarifai/models/model_serving/constants.py,sha256=HbUJJ_yncYr8MFFUtJv-tnaZxnI0G5Upy6rrtD1WMZY,112
+clarifai/models/model_serving/constants.py,sha256=JUXeo3Nla9UMA9U9yG-nbOfcRdEAwl30lj13Rp11xcg,196
 clarifai/models/model_serving/pb_model_repository.py,sha256=jtODfmEa-GrMlyFDNo_1jAYLuJTSy_IBd9BSpK12O8w,3411
 clarifai/models/model_serving/cli/__init__.py,sha256=Nls28G-fedNw2oQZIkPQSN__TgjJXbG9RDzzuHIM0VI,575
 clarifai/models/model_serving/cli/deploy_cli.py,sha256=PVoMUbM-EQ0GGzws7XpPr59IwdBawIl71CM2jOoh-C4,3825
@@ -58,28 +58,39 @@ clarifai/models/model_serving/examples/image_classification/age_vit/1/model.py,s
 clarifai/models/model_serving/examples/text_classification/xlm-roberta/1/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clarifai/models/model_serving/examples/text_classification/xlm-roberta/1/inference.py,sha256=jzdWLJQ8K6h-CFrmZju-DTuQNPSRXhJTS3zXdNaiA7A,2173
 clarifai/models/model_serving/examples/text_classification/xlm-roberta/1/model.py,sha256=kC2gglV8QI8G4TNwjerDOO-Xm3UHtoMGeapLRpnKP8E,1941
+clarifai/models/model_serving/examples/text_to_text/bart-summarize/1/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+clarifai/models/model_serving/examples/text_to_text/bart-summarize/1/inference.py,sha256=ekHKG926K3JOKUvFPdL0wuhPyTCpkCYsiY39YhchKaA,1847
+clarifai/models/model_serving/examples/text_to_text/bart-summarize/1/model.py,sha256=gLIP0dNXLD9lfBQmXEnGgjDo39QnCcu0PiFB37Wqxgg,1863
 clarifai/models/model_serving/examples/visual_detection/yolov5x/1/inference.py,sha256=bF-hhNBIZTq5Fci182OkWnToAQMJz4W2tzRf9D4oIsQ,2906
 clarifai/models/model_serving/examples/visual_detection/yolov5x/1/model.py,sha256=kC2gglV8QI8G4TNwjerDOO-Xm3UHtoMGeapLRpnKP8E,1941
+clarifai/models/model_serving/examples/visual_embedding/vit-base/1/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+clarifai/models/model_serving/examples/visual_embedding/vit-base/1/inference.py,sha256=P1JLU-N7IzYRzAjRlJjiqat0CF8M7Fzl_U6sfOBa2jM,1971
+clarifai/models/model_serving/examples/visual_embedding/vit-base/1/model.py,sha256=gLIP0dNXLD9lfBQmXEnGgjDo39QnCcu0PiFB37Wqxgg,1863
+clarifai/models/model_serving/examples/visual_segmentation/segformer-b2/1/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+clarifai/models/model_serving/examples/visual_segmentation/segformer-b2/1/inference.py,sha256=Det16IapShTKwD6eEOFm7zczNF73ctoJ3sEb9EIY9nU,2119
+clarifai/models/model_serving/examples/visual_segmentation/segformer-b2/1/model.py,sha256=gLIP0dNXLD9lfBQmXEnGgjDo39QnCcu0PiFB37Wqxgg,1863
 clarifai/models/model_serving/model_config/__init__.py,sha256=Nls28G-fedNw2oQZIkPQSN__TgjJXbG9RDzzuHIM0VI,575
-clarifai/models/model_serving/model_config/deploy.py,sha256=hkxsQ4kIqXrVLklf_YW9xCYibKnUwSuTvtI2a_Ed4EQ,1731
+clarifai/models/model_serving/model_config/deploy.py,sha256=4JJlor543ePredE88kR8vwvw25xpYb8ESctp7Jr7A_c,2801
 clarifai/models/model_serving/model_config/serializer.py,sha256=rr5Bc7vuExT6L1hoBOaMNKeESQ-qH4TzPleopvdthR4,4231
-clarifai/models/model_serving/model_config/triton_config.py,sha256=d_wn6zaFORyO5YZpqHzCu-cfWANpkRniHyh6w7IgmTk,4489
+clarifai/models/model_serving/model_config/triton_config.py,sha256=VG6XjSGVP1pG5YTwfoWVKf4rpXDcf1dumHPaSdMi8bQ,5683
 clarifai/models/model_serving/models/__init__.py,sha256=Nls28G-fedNw2oQZIkPQSN__TgjJXbG9RDzzuHIM0VI,575
 clarifai/models/model_serving/models/inference.py,sha256=BpniZvGAVjMaJaBkZMQob3qqG1QKEA7px12WKzMBMeo,1639
-clarifai/models/model_serving/models/model_types.py,sha256=UAe-mDh5b7h19Dht60Dz0zLIbQ4k4SIFta-S-EkI10M,3701
-clarifai/models/model_serving/models/output.py,sha256=H6bbnai87ZtYxeKaMmO4WCvr8VXq99dXgAcq3F4WrDU,2334
-clarifai/models/model_serving/models/pb_model.py,sha256=kC2gglV8QI8G4TNwjerDOO-Xm3UHtoMGeapLRpnKP8E,1941
+clarifai/models/model_serving/models/model_types.py,sha256=MI9liI-Isg1LxQbtOLhILMmK4vQZi5DunEY6GmftIZc,7069
+clarifai/models/model_serving/models/output.py,sha256=jzF6QMUXnQIWAeyY3-7qGfrr8HtFCth5wr10eSPyFdI,3852
+clarifai/models/model_serving/models/pb_model.py,sha256=gLIP0dNXLD9lfBQmXEnGgjDo39QnCcu0PiFB37Wqxgg,1863
 clarifai/modules/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clarifai/modules/css.py,sha256=kadCEunmyh5h2yf0-4aysE3ZcZ6qaQcxuAgDXS96yF8,2020
 clarifai/modules/pages.py,sha256=iOoM3RNRMgXlV0qBqcdQofxoXo2RuRQh0h9c9BIS0-I,1383
-clarifai/modules/style.css,sha256=ANCqydlU3YA_JKyMCyE99-AiSDGmWq87UWNy53oPT8A,6003
+clarifai/modules/style.css,sha256=j7FNPZVhLPj35vvBksAJ90RuX5sLuqzDR5iM2WIEhiA,6073
 clarifai/runners/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clarifai/runners/api.py,sha256=ikjLONGzmkekjXoEvqXD9pv1kfh1OtHAbAh-3j-sfMc,3578
+clarifai/runners/base.py,sha256=s9xXgyyvKkVlA4ypGUVdMZFTziBC-RLeBHuoDLMdGD0,5713
+clarifai/runners/example.py,sha256=s_t2-7aZqXtV9MX7cZNIXJm0gSKCGd1bejbI3ag7a8o,1129
 clarifai/urls/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clarifai/urls/helper.py,sha256=RHDsZhXE_Vp4QGWmSjatn3j0k6Zu2O1b2gmvI-F_rHY,4276
 clarifai_utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clarifai_utils/auth/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-clarifai_utils/auth/helper.py,sha256=Oy7xc7uQJZq6li_obVC2A5NcJt1LS-HWSAkZ_c9Ekcw,13909
+clarifai_utils/auth/helper.py,sha256=4ZxyH43qQOoHse_ypmcaUpbhV4BrZ3I61GhgbxF2_9Q,13921
 clarifai_utils/client/__init__.py,sha256=DlA1iS8Szl3I7oGw5UBVra7-dZ1M_wKxcZXCoUcDBJ8,121
 clarifai_utils/client/abc.py,sha256=lRAIhYSUwHh0Xp6yZWVWXqWF1mOy9A-8aKscmoPXEnM,536
 clarifai_utils/client/stub.py,sha256=pa1Sh9HeUG7Ipi3f-OmTRFp0hvH31PF60NsC7IwFBNI,3606
@@ -125,7 +136,7 @@ clarifai_utils/listing/modules.py,sha256=yM074edY2d19HHt2MpO6_oAzDxM8yuc4hMns4D8
 clarifai_utils/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clarifai_utils/models/api.py,sha256=fsE6eLZ0NgcvDpAQcRpT2DPataBTg0gIEOWxtoNeYXM,9555
 clarifai_utils/models/model_serving/__init__.py,sha256=Nls28G-fedNw2oQZIkPQSN__TgjJXbG9RDzzuHIM0VI,575
-clarifai_utils/models/model_serving/constants.py,sha256=HbUJJ_yncYr8MFFUtJv-tnaZxnI0G5Upy6rrtD1WMZY,112
+clarifai_utils/models/model_serving/constants.py,sha256=JUXeo3Nla9UMA9U9yG-nbOfcRdEAwl30lj13Rp11xcg,196
 clarifai_utils/models/model_serving/pb_model_repository.py,sha256=jtODfmEa-GrMlyFDNo_1jAYLuJTSy_IBd9BSpK12O8w,3411
 clarifai_utils/models/model_serving/cli/__init__.py,sha256=Nls28G-fedNw2oQZIkPQSN__TgjJXbG9RDzzuHIM0VI,575
 clarifai_utils/models/model_serving/cli/deploy_cli.py,sha256=PVoMUbM-EQ0GGzws7XpPr59IwdBawIl71CM2jOoh-C4,3825
@@ -137,28 +148,39 @@ clarifai_utils/models/model_serving/examples/image_classification/age_vit/1/mode
 clarifai_utils/models/model_serving/examples/text_classification/xlm-roberta/1/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clarifai_utils/models/model_serving/examples/text_classification/xlm-roberta/1/inference.py,sha256=jzdWLJQ8K6h-CFrmZju-DTuQNPSRXhJTS3zXdNaiA7A,2173
 clarifai_utils/models/model_serving/examples/text_classification/xlm-roberta/1/model.py,sha256=kC2gglV8QI8G4TNwjerDOO-Xm3UHtoMGeapLRpnKP8E,1941
+clarifai_utils/models/model_serving/examples/text_to_text/bart-summarize/1/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+clarifai_utils/models/model_serving/examples/text_to_text/bart-summarize/1/inference.py,sha256=ekHKG926K3JOKUvFPdL0wuhPyTCpkCYsiY39YhchKaA,1847
+clarifai_utils/models/model_serving/examples/text_to_text/bart-summarize/1/model.py,sha256=gLIP0dNXLD9lfBQmXEnGgjDo39QnCcu0PiFB37Wqxgg,1863
 clarifai_utils/models/model_serving/examples/visual_detection/yolov5x/1/inference.py,sha256=bF-hhNBIZTq5Fci182OkWnToAQMJz4W2tzRf9D4oIsQ,2906
 clarifai_utils/models/model_serving/examples/visual_detection/yolov5x/1/model.py,sha256=kC2gglV8QI8G4TNwjerDOO-Xm3UHtoMGeapLRpnKP8E,1941
+clarifai_utils/models/model_serving/examples/visual_embedding/vit-base/1/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+clarifai_utils/models/model_serving/examples/visual_embedding/vit-base/1/inference.py,sha256=P1JLU-N7IzYRzAjRlJjiqat0CF8M7Fzl_U6sfOBa2jM,1971
+clarifai_utils/models/model_serving/examples/visual_embedding/vit-base/1/model.py,sha256=gLIP0dNXLD9lfBQmXEnGgjDo39QnCcu0PiFB37Wqxgg,1863
+clarifai_utils/models/model_serving/examples/visual_segmentation/segformer-b2/1/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+clarifai_utils/models/model_serving/examples/visual_segmentation/segformer-b2/1/inference.py,sha256=Det16IapShTKwD6eEOFm7zczNF73ctoJ3sEb9EIY9nU,2119
+clarifai_utils/models/model_serving/examples/visual_segmentation/segformer-b2/1/model.py,sha256=gLIP0dNXLD9lfBQmXEnGgjDo39QnCcu0PiFB37Wqxgg,1863
 clarifai_utils/models/model_serving/model_config/__init__.py,sha256=Nls28G-fedNw2oQZIkPQSN__TgjJXbG9RDzzuHIM0VI,575
-clarifai_utils/models/model_serving/model_config/deploy.py,sha256=hkxsQ4kIqXrVLklf_YW9xCYibKnUwSuTvtI2a_Ed4EQ,1731
+clarifai_utils/models/model_serving/model_config/deploy.py,sha256=4JJlor543ePredE88kR8vwvw25xpYb8ESctp7Jr7A_c,2801
 clarifai_utils/models/model_serving/model_config/serializer.py,sha256=rr5Bc7vuExT6L1hoBOaMNKeESQ-qH4TzPleopvdthR4,4231
-clarifai_utils/models/model_serving/model_config/triton_config.py,sha256=d_wn6zaFORyO5YZpqHzCu-cfWANpkRniHyh6w7IgmTk,4489
+clarifai_utils/models/model_serving/model_config/triton_config.py,sha256=VG6XjSGVP1pG5YTwfoWVKf4rpXDcf1dumHPaSdMi8bQ,5683
 clarifai_utils/models/model_serving/models/__init__.py,sha256=Nls28G-fedNw2oQZIkPQSN__TgjJXbG9RDzzuHIM0VI,575
 clarifai_utils/models/model_serving/models/inference.py,sha256=BpniZvGAVjMaJaBkZMQob3qqG1QKEA7px12WKzMBMeo,1639
-clarifai_utils/models/model_serving/models/model_types.py,sha256=UAe-mDh5b7h19Dht60Dz0zLIbQ4k4SIFta-S-EkI10M,3701
-clarifai_utils/models/model_serving/models/output.py,sha256=H6bbnai87ZtYxeKaMmO4WCvr8VXq99dXgAcq3F4WrDU,2334
-clarifai_utils/models/model_serving/models/pb_model.py,sha256=kC2gglV8QI8G4TNwjerDOO-Xm3UHtoMGeapLRpnKP8E,1941
+clarifai_utils/models/model_serving/models/model_types.py,sha256=MI9liI-Isg1LxQbtOLhILMmK4vQZi5DunEY6GmftIZc,7069
+clarifai_utils/models/model_serving/models/output.py,sha256=jzF6QMUXnQIWAeyY3-7qGfrr8HtFCth5wr10eSPyFdI,3852
+clarifai_utils/models/model_serving/models/pb_model.py,sha256=gLIP0dNXLD9lfBQmXEnGgjDo39QnCcu0PiFB37Wqxgg,1863
 clarifai_utils/modules/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clarifai_utils/modules/css.py,sha256=kadCEunmyh5h2yf0-4aysE3ZcZ6qaQcxuAgDXS96yF8,2020
 clarifai_utils/modules/pages.py,sha256=iOoM3RNRMgXlV0qBqcdQofxoXo2RuRQh0h9c9BIS0-I,1383
-clarifai_utils/modules/style.css,sha256=ANCqydlU3YA_JKyMCyE99-AiSDGmWq87UWNy53oPT8A,6003
+clarifai_utils/modules/style.css,sha256=j7FNPZVhLPj35vvBksAJ90RuX5sLuqzDR5iM2WIEhiA,6073
 clarifai_utils/runners/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clarifai_utils/runners/api.py,sha256=ikjLONGzmkekjXoEvqXD9pv1kfh1OtHAbAh-3j-sfMc,3578
+clarifai_utils/runners/base.py,sha256=s9xXgyyvKkVlA4ypGUVdMZFTziBC-RLeBHuoDLMdGD0,5713
+clarifai_utils/runners/example.py,sha256=s_t2-7aZqXtV9MX7cZNIXJm0gSKCGd1bejbI3ag7a8o,1129
 clarifai_utils/urls/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clarifai_utils/urls/helper.py,sha256=RHDsZhXE_Vp4QGWmSjatn3j0k6Zu2O1b2gmvI-F_rHY,4276
-clarifai-9.6.1.dist-info/LICENSE,sha256=GuQZ4iPZUwh44duTbVr7ZzYp_SaJDLR9MvzU7YqlZXM,555
-clarifai-9.6.1.dist-info/METADATA,sha256=CcJqlpFo2K6AsXSI8h9F-WtaLahjPoegLpvL6DFbCsI,2985
-clarifai-9.6.1.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-clarifai-9.6.1.dist-info/entry_points.txt,sha256=cna1vVlFIZZZlxHy1AbhooFGy-dw1W2xRfbOVRSWSKg,255
-clarifai-9.6.1.dist-info/top_level.txt,sha256=w3e8wx1HuK3_huGQosppv1_FSoNjBUd09KBKMK3wR-U,24
-clarifai-9.6.1.dist-info/RECORD,,
+clarifai-9.6.3.dist-info/LICENSE,sha256=GuQZ4iPZUwh44duTbVr7ZzYp_SaJDLR9MvzU7YqlZXM,555
+clarifai-9.6.3.dist-info/METADATA,sha256=OsPBVEV14RHZoCYHyfJFQEc7tTwqlb5SNAp09OE7upc,2985
+clarifai-9.6.3.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
+clarifai-9.6.3.dist-info/entry_points.txt,sha256=cna1vVlFIZZZlxHy1AbhooFGy-dw1W2xRfbOVRSWSKg,255
+clarifai-9.6.3.dist-info/top_level.txt,sha256=w3e8wx1HuK3_huGQosppv1_FSoNjBUd09KBKMK3wR-U,24
+clarifai-9.6.3.dist-info/RECORD,,

clarifai_utils/auth/helper.py

@@ -131,7 +131,7 @@ class ClarifaiAuthHelper:
 
     # Then add in the query params.
     try:
-      auth = auth.add_streamlit_query_params(query_params)
+      auth.add_streamlit_query_params(st.experimental_get_query_params())
     except Exception as e:
       st.error(e)
       st.stop()
@@ -165,7 +165,7 @@ class ClarifaiAuthHelper:
     auth = ClarifaiAuthHelper("", "", "", "", validate=False)
 
     # Then add in the query params.
-    auth = auth.add_streamlit_query_params(query_params)
+    auth.add_streamlit_query_params(query_params)
 
     # Then validate.
     auth.validate()
@@ -238,7 +238,7 @@ 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("CLARIFAI_SESSION_TOKEN", "")
+    token = os.environ.get("CLARIFAI_SESSION_TOKEN", "")
     pat = os.environ.get("CLARIFAI_PAT", "")
     base = os.environ.get("CLARIFAI_API_BASE", DEFAULT_BASE)
     ui = os.environ.get("CLARIFAI_UI", DEFAULT_UI)

clarifai_utils/models/model_serving/constants.py

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

clarifai_utils/models/model_serving/examples/text_to_text/bart-summarize/1/inference.py

@@ -0,0 +1,47 @@
+# This file contains boilerplate code to allow users write their model
+# inference code that will then interact with the Triton Inference Server
+# Python backend to serve end user requests.
+# The module name, module path, class name & get_predictions() method names MUST be maintained as is
+# but other methods may be added within the class as deemed fit provided
+# they are invoked within the main get_predictions() inference method
+# if they play a role in any step of model inference
+"""User model inference script."""
+
+import os
+from pathlib import Path
+import numpy as np
+from transformers import pipeline
+
+from clarifai.models.model_serving.models.model_types import text_to_text
+from clarifai.models.model_serving.models.output import TextOutput
+
+
+class InferenceModel:
+  """User model inference class."""
+
+  def __init__(self) -> None:
+    """
+    Load inference time artifacts that are called frequently .e.g. models, tokenizers, etc.
+    in this method so they are loaded only once for faster inference.
+    """
+    self.base_path: Path = os.path.dirname(__file__)
+    self.huggingface_model_path = os.path.join(self.base_path, "bart-large-summarizer")
+    self.pipeline = pipeline("summarization", model=self.huggingface_model_path)
+
+  @text_to_text
+  def get_predictions(self, input_data):
+    """
+    Generates summaries of input text.
+
+    Args:
+    -----
+      input_data: A single input data item to predict on.
+        Input data can be an image or text, etc depending on the model type.
+
+    Returns:
+    --------
+      One of the clarifai.models.model_serving.models.output types. Refer to the README/docs
+    """
+    summary = self.pipeline(input_data, max_length=50, min_length=30, do_sample=False)
+    generated_text = np.array([summary[0]['summary_text']], dtype=object)
+    return TextOutput(predicted_text=generated_text)

clarifai_utils/models/model_serving/examples/text_to_text/bart-summarize/1/model.py

@@ -0,0 +1,60 @@
+# Copyright 2023 Clarifai, Inc.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# 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.
+"""Triton inference server Python Backend Model."""
+
+import os
+import sys
+
+try:
+  import triton_python_backend_utils as pb_utils
+except ModuleNotFoundError:
+  pass
+from google.protobuf import text_format
+from tritonclient.grpc.model_config_pb2 import ModelConfig
+
+
+class TritonPythonModel:
+  """
+  Triton Python BE Model.
+  """
+
+  def initialize(self, args):
+    """
+    Triton server init.
+    """
+    args["model_repository"] = args["model_repository"].replace("/1/model.py", "")
+    sys.path.append(os.path.dirname(__file__))
+    from inference import InferenceModel
+
+    self.inference_obj = InferenceModel()
+
+    # Read input_name from config file
+    self.config_msg = ModelConfig()
+    with open(os.path.join(args["model_repository"], "config.pbtxt"), "r") as f:
+      cfg = f.read()
+    text_format.Merge(cfg, self.config_msg)
+    self.input_name = [inp.name for inp in self.config_msg.input][0]
+
+  def execute(self, requests):
+    """
+    Serve model inference requests.
+    """
+    responses = []
+
+    for request in requests:
+      in_batch = pb_utils.get_input_tensor_by_name(request, self.input_name)
+      in_batch = in_batch.as_numpy()
+      inference_response = self.inference_obj.get_predictions(in_batch)
+      responses.append(inference_response)
+
+    return responses

clarifai_utils/models/model_serving/examples/visual_embedding/vit-base/1/inference.py

@@ -0,0 +1,51 @@
+# This file contains boilerplate code to allow users write their model
+# inference code that will then interact with the Triton Inference Server
+# Python backend to serve end user requests.
+# The module name, module path, class name & get_predictions() method names MUST be maintained as is
+# but other methods may be added within the class as deemed fit provided
+# they are invoked within the main get_predictions() inference method
+# if they play a role in any step of model inference
+"""User model inference script."""
+
+import os
+from pathlib import Path
+
+import torch
+from transformers import AutoModel, ViTImageProcessor
+
+from clarifai.models.model_serving.models.model_types import visual_embedder
+from clarifai.models.model_serving.models.output import EmbeddingOutput
+
+
+class InferenceModel:
+  """User model inference class."""
+
+  def __init__(self) -> None:
+    """
+    Load inference time artifacts that are called frequently .e.g. models, tokenizers, etc.
+    in this method so they are loaded only once for faster inference.
+    """
+    self.base_path: Path = os.path.dirname(__file__)
+    self.huggingface_model_path = os.path.join(self.base_path, "vit-base-patch16-224")
+    self.processor = ViTImageProcessor.from_pretrained(self.huggingface_model_path)
+    self.model = AutoModel.from_pretrained(self.huggingface_model_path)
+
+  @visual_embedder
+  def get_predictions(self, input_data):
+    """
+    Main model inference method.
+
+    Args:
+    -----
+      input_data: A single input data item to predict on.
+        Input data can be an image or text, etc depending on the model type.
+
+    Returns:
+    --------
+      One of the clarifai.models.model_serving.models.output types. Refer to the README/docs
+    """
+    inputs = self.processor(images=input_data, return_tensors="pt")
+    with torch.no_grad():
+      embedding_vector = self.model(**inputs).last_hidden_state[:, 0].cpu().numpy()
+
+    return EmbeddingOutput(embedding_vector=embedding_vector[0])

clarifai_utils/models/model_serving/examples/visual_embedding/vit-base/1/model.py

@@ -0,0 +1,60 @@
+# Copyright 2023 Clarifai, Inc.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# 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.
+"""Triton inference server Python Backend Model."""
+
+import os
+import sys
+
+try:
+  import triton_python_backend_utils as pb_utils
+except ModuleNotFoundError:
+  pass
+from google.protobuf import text_format
+from tritonclient.grpc.model_config_pb2 import ModelConfig
+
+
+class TritonPythonModel:
+  """
+  Triton Python BE Model.
+  """
+
+  def initialize(self, args):
+    """
+    Triton server init.
+    """
+    args["model_repository"] = args["model_repository"].replace("/1/model.py", "")
+    sys.path.append(os.path.dirname(__file__))
+    from inference import InferenceModel
+
+    self.inference_obj = InferenceModel()
+
+    # Read input_name from config file
+    self.config_msg = ModelConfig()
+    with open(os.path.join(args["model_repository"], "config.pbtxt"), "r") as f:
+      cfg = f.read()
+    text_format.Merge(cfg, self.config_msg)
+    self.input_name = [inp.name for inp in self.config_msg.input][0]
+
+  def execute(self, requests):
+    """
+    Serve model inference requests.
+    """
+    responses = []
+
+    for request in requests:
+      in_batch = pb_utils.get_input_tensor_by_name(request, self.input_name)
+      in_batch = in_batch.as_numpy()
+      inference_response = self.inference_obj.get_predictions(in_batch)
+      responses.append(inference_response)
+
+    return responses

clarifai_utils/models/model_serving/examples/visual_segmentation/segformer-b2/1/inference.py

@@ -0,0 +1,55 @@
+# This file contains boilerplate code to allow users write their model
+# inference code that will then interact with the Triton Inference Server
+# Python backend to serve end user requests.
+# The module name, module path, class name & get_predictions() method names MUST be maintained as is
+# but other methods may be added within the class as deemed fit provided
+# they are invoked within the main get_predictions() inference method
+# if they play a role in any step of model inference
+"""User model inference script."""
+
+import os
+from pathlib import Path
+
+import torch
+from transformers import AutoModelForSemanticSegmentation, SegformerImageProcessor
+
+from clarifai.models.model_serving.models.model_types import visual_segmenter
+from clarifai.models.model_serving.models.output import MasksOutput
+
+
+class InferenceModel:
+  """User model inference class."""
+
+  def __init__(self) -> None:
+    """
+    Load inference time artifacts that are called frequently .e.g. models, tokenizers, etc.
+    in this method so they are loaded only once for faster inference.
+    """
+    self.base_path: Path = os.path.dirname(__file__)
+    self.huggingface_model_path = os.path.join(self.base_path, "segformer_b2_clothes")
+    #self.labels_path = os.path.join(Path(self.base_path).parents[0], "labels.txt")
+    self.processor = SegformerImageProcessor.from_pretrained(self.huggingface_model_path)
+    self.model = AutoModelForSemanticSegmentation.from_pretrained(self.huggingface_model_path)
+
+  @visual_segmenter
+  def get_predictions(self, input_data):
+    """
+    Main model inference method.
+
+    Args:
+    -----
+      input_data: A single input data item to predict on.
+        Input data can be an image or text, etc depending on the model type.
+
+    Returns:
+    --------
+      One of the clarifai.models.model_serving.models.output types. Refer to the README/docs
+    """
+    inputs = self.processor(images=input_data, return_tensors="pt")
+    with torch.no_grad():
+      output = self.model(**inputs)
+
+    logits = output.logits.cpu()
+    mask = logits.argmax(dim=1)[0].numpy()
+
+    return MasksOutput(predicted_mask=mask)