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

clarifai/modules/style.css

@@ -203,6 +203,13 @@ code
   border-color: #d0d5dd;
   box-shadow: 0 1px 2px rgba(16,24,40,.05);
 }
+
+.stTextInput > div > div > input {
+    background-color: white;
+}
+
+
+
 div[data-testid="stFileUploader"]>section {
   border: 1px dashed #d0d5dd;
   border-radius: 8px;

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.2.dist-info → clarifai-9.6.3.dist-info}/METADATA

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

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

@@ -81,9 +81,11 @@ clarifai/models/model_serving/models/pb_model.py,sha256=gLIP0dNXLD9lfBQmXEnGgjDo
 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
@@ -169,14 +171,16 @@ clarifai_utils/models/model_serving/models/pb_model.py,sha256=gLIP0dNXLD9lfBQmXE
 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.2.dist-info/LICENSE,sha256=GuQZ4iPZUwh44duTbVr7ZzYp_SaJDLR9MvzU7YqlZXM,555
-clarifai-9.6.2.dist-info/METADATA,sha256=Gjat6WZxP8vWHO409bYRj5A6M4-v6dlAP_ftN7iDeyU,2985
-clarifai-9.6.2.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-clarifai-9.6.2.dist-info/entry_points.txt,sha256=cna1vVlFIZZZlxHy1AbhooFGy-dw1W2xRfbOVRSWSKg,255
-clarifai-9.6.2.dist-info/top_level.txt,sha256=w3e8wx1HuK3_huGQosppv1_FSoNjBUd09KBKMK3wR-U,24
-clarifai-9.6.2.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/modules/style.css

@@ -203,6 +203,13 @@ code
   border-color: #d0d5dd;
   box-shadow: 0 1px 2px rgba(16,24,40,.05);
 }
+
+.stTextInput > div > div > input {
+    background-color: white;
+}
+
+
+
 div[data-testid="stFileUploader"]>section {
   border: 1px dashed #d0d5dd;
   border-radius: 8px;

clarifai_utils/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_utils/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()