clarifai 9.6.2__tar.gz → 9.6.3__tar.gz

{clarifai-9.6.2/clarifai.egg-info → clarifai-9.6.3}/PKG-INFO

@@ -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 → clarifai-9.6.3}/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-9.6.2/clarifai_utils/runners/api.py → clarifai-9.6.3/clarifai/runners/base.py

@@ -10,7 +10,7 @@
 # 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 Models API."""
+"""Interface to Clarifai Runners API."""
 
 from typing import Type
 
@@ -24,23 +24,55 @@ from clarifai.client import create_stub
 
 class BaseRunner:
   """
-  Interface to Clarifai models api
+  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, item: service_pb2.PostModelOutputsRequest) -> service_pb2.MultiOutputResponse:
+  def _run(self, request: service_pb2.PostModelOutputsRequest) -> service_pb2.MultiOutputResponse:
     """
-    Run the model on the given item.
+    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 = []
-    for inp in item.inputs:
+    # TODO: parallelize this
+    for inp in request.inputs:
+      # TODO: handle errors
       outputs.append(self.run_input(inp))
 
     return service_pb2.MultiOutputResponse(
@@ -53,12 +85,25 @@ class BaseRunner:
 
   def run_input(self, input: resources_pb2.Input) -> resources_pb2.Output:
     """
-    Run the model on the given input.
+    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))
@@ -81,7 +126,7 @@ class BaseRunner:
         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 = self._run(item.post_model_outputs_request)
 
         result_response = self.stub.PostRunnerItemOutputs(
             service_pb2.PostRunnerItemOutputsRequest(

clarifai-9.6.3/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 → clarifai-9.6.3/clarifai.egg-info}/PKG-INFO

@@ -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 → clarifai-9.6.3}/clarifai.egg-info/SOURCES.txt

@@ -93,7 +93,8 @@ clarifai/modules/css.py
 clarifai/modules/pages.py
 clarifai/modules/style.css
 clarifai/runners/__init__.py
-clarifai/runners/api.py
+clarifai/runners/base.py
+clarifai/runners/example.py
 clarifai/urls/__init__.py
 clarifai/urls/helper.py
 clarifai_utils/__init__.py
@@ -181,7 +182,8 @@ clarifai_utils/modules/css.py
 clarifai_utils/modules/pages.py
 clarifai_utils/modules/style.css
 clarifai_utils/runners/__init__.py
-clarifai_utils/runners/api.py
+clarifai_utils/runners/base.py
+clarifai_utils/runners/example.py
 clarifai_utils/urls/__init__.py
 clarifai_utils/urls/helper.py
 tests/test_auth.py

{clarifai-9.6.2 → clarifai-9.6.3}/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-9.6.2/clarifai/runners/api.py → clarifai-9.6.3/clarifai_utils/runners/base.py

@@ -10,7 +10,7 @@
 # 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 Models API."""
+"""Interface to Clarifai Runners API."""
 
 from typing import Type
 
@@ -24,23 +24,55 @@ from clarifai.client import create_stub
 
 class BaseRunner:
   """
-  Interface to Clarifai models api
+  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, item: service_pb2.PostModelOutputsRequest) -> service_pb2.MultiOutputResponse:
+  def _run(self, request: service_pb2.PostModelOutputsRequest) -> service_pb2.MultiOutputResponse:
     """
-    Run the model on the given item.
+    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 = []
-    for inp in item.inputs:
+    # TODO: parallelize this
+    for inp in request.inputs:
+      # TODO: handle errors
       outputs.append(self.run_input(inp))
 
     return service_pb2.MultiOutputResponse(
@@ -53,12 +85,25 @@ class BaseRunner:
 
   def run_input(self, input: resources_pb2.Input) -> resources_pb2.Output:
     """
-    Run the model on the given input.
+    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))
@@ -81,7 +126,7 @@ class BaseRunner:
         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 = self._run(item.post_model_outputs_request)
 
         result_response = self.stub.PostRunnerItemOutputs(
             service_pb2.PostRunnerItemOutputsRequest(

clarifai-9.6.3/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()

{clarifai-9.6.2 → clarifai-9.6.3}/setup.py

@@ -7,7 +7,7 @@ packages = setuptools.find_namespace_packages(include=["clarifai*"])
 
 setuptools.setup(
     name="clarifai",
-    version="9.6.2",
+    version="9.6.3",
     author="Clarifai",
     author_email="support@clarifai.com",
     description="Clarifai Python Utilities",