clarifai 9.7.0__py3-none-any.whl → 9.7.2__py3-none-any.whl

clarifai_utils/listing/module_versions.py

@@ -1,42 +0,0 @@
-from clarifai_grpc.grpc.api import resources_pb2, service_pb2
-from clarifai_grpc.grpc.api.status import status_code_pb2
-
-from clarifai.client import V2Stub
-
-
-def module_versions_generator(stub: V2Stub,
-                              user_id: str,
-                              app_id: str,
-                              module_id: str,
-                              page_size: int = 64):
-  """
-  Lists all the module versions in the given userAppID user_id, app_id app, module_id module.
-
-  Args:
-    stub: client stub.
-    user_id: the user to list from.
-    app_id: the app in the user_id account to list from.
-    module_id: the module in the app to list from.
-    page_size: the pagination size to use while iterating.
-
-  Returns:
-    module_versions: a list of ModuleVersion protos for all the modules in the app.
-  """
-  userDataObject = resources_pb2.UserAppIDSet(user_id=user_id, app_id=app_id)
-
-  success_status = {status_code_pb2.SUCCESS}
-
-  page = 1
-  while True:
-    response = stub.ListModuleVersions(
-        service_pb2.ListModuleVersionsRequest(
-            user_app_id=userDataObject, module_id=module_id, page=page, per_page=page_size),)
-
-    if response.status.code not in success_status:
-      raise Exception("ListModuleVersions failed with response %r" % response)
-    for item in response.module_versions:
-      yield item
-    page += 1
-    # if we don't get a full page back we know we're done.
-    if len(response.module_versions) < page_size:
-      break

clarifai_utils/listing/modules.py

@@ -1,36 +0,0 @@
-from clarifai_grpc.grpc.api import resources_pb2, service_pb2
-from clarifai_grpc.grpc.api.status import status_code_pb2
-
-from clarifai.client import V2Stub
-
-
-def modules_generator(stub: V2Stub, user_id: str, app_id: str, page_size: int = 64):
-  """
-  Lists all the modules in the given userAppID user_id, app_id app.
-
-  Args:
-    stub: client stub.
-    user_id: the user to list from.
-    app_id: the app in the user_id account to list from.
-    page_size: the pagination size to use while iterating.
-
-  Returns:
-    imvs: a list of Module protos for all the modules in the app.
-  """
-  userDataObject = resources_pb2.UserAppIDSet(user_id=user_id, app_id=app_id)
-
-  success_status = {status_code_pb2.SUCCESS}
-
-  page = 1
-  while True:
-    response = stub.ListModules(
-        service_pb2.ListModulesRequest(user_app_id=userDataObject, page=page, per_page=page_size),)
-
-    if response.status.code not in success_status:
-      raise Exception("ListModules failed with response %r" % response)
-    for item in response.modules:
-      yield item
-    page += 1
-    # if we don't get a full page back we know we're done.
-    if len(response.modules) < page_size:
-      break

clarifai_utils/runners/base.py

@@ -1,140 +0,0 @@
-# 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

@@ -1,36 +0,0 @@
-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()