clarifai 11.1.7rc1__py3-none-any.whl → 11.1.7rc2__py3-none-any.whl

clarifai/__init__.py

@@ -1 +1 @@
-__version__ = "11.1.7rc1"
+__version__ = "11.1.7rc2"

clarifai/client/cli/base_cli.py

@@ -0,0 +1,88 @@
+import click
+import os
+import yaml
+
+@click.group()
+@click.pass_context
+def cli(ctx):
+    """Clarifai CLI"""
+    ctx.ensure_object(dict)
+    config_path = 'config.yaml'
+    if os.path.exists(config_path):
+        ctx.obj = _from_yaml(config_path)
+        print("Loaded config from file.")
+        print(f"Config: {ctx.obj}")
+    else:
+        ctx.obj = {}
+
+def _from_yaml(filename: str):
+    try:
+        with open(filename, 'r') as f:
+            return yaml.safe_load(f)
+    except yaml.YAMLError as e:
+        click.echo(f"Error reading YAML file: {e}", err=True)
+        return {}
+
+def _dump_yaml(data, filename: str):
+    try:
+        with open(filename, 'w') as f:
+            yaml.dump(data, f)
+    except Exception as e:
+        click.echo(f"Error writing YAML file: {e}", err=True)
+
+def _set_base_url(env):
+    environments = {'prod': 'https://api.clarifai.com', 'staging': 'https://api-staging.clarifai.com', 'dev': 'https://api-dev.clarifai.com'}
+    return environments.get(env, 'https://api.clarifai.com')
+
+
+@cli.command()
+@click.option('--config', type=click.Path(), required=False, help='Path to the config file')
+@click.option('-e', '--env', required=False, help='Environment', type=click.Choice(['prod', 'staging', 'dev']))
+@click.option('--user_id', required=False, help='User ID')
+@click.pass_context
+def login(ctx, config, env, user_id):
+    """Login command to set PAT and other configurations."""
+
+    if config and os.path.exists(config):
+        ctx.obj = _from_yaml(config)
+        
+    if 'pat' in ctx.obj:
+        os.environ["CLARIFAI_PAT"] = ctx.obj['pat']
+        click.echo("Loaded PAT from config file.")
+    elif 'CLARIFAI_PAT' in os.environ:
+        ctx.obj['pat'] = os.environ["CLARIFAI_PAT"]
+        click.echo("Loaded PAT from environment variable.")
+    else:
+        _pat = click.prompt("Get your PAT from https://clarifai.com/settings/security and pass it here", type=str)
+        os.environ["CLARIFAI_PAT"] = _pat
+        ctx.obj['pat'] = _pat
+        click.echo("PAT saved successfully.")
+
+    if user_id:
+        ctx.obj['user_id'] = user_id
+        os.environ["CLARIFAI_USER_ID"] = ctx.obj['user_id']
+    elif 'user_id' in ctx.obj or 'CLARIFAI_USER_ID' in os.environ:
+        ctx.obj['user_id'] = ctx.obj.get('user_id', os.environ["CLARIFAI_USER_ID"])
+        os.environ["CLARIFAI_USER_ID"] = ctx.obj['user_id']
+
+    if env:
+        ctx.obj['env'] = env
+        ctx.obj['base_url'] = _set_base_url(env)
+        os.environ["CLARIFAI_API_BASE"] = ctx.obj['base_url']
+    elif 'env' in ctx.obj:
+        ctx.obj['env'] = ctx.obj.get('env', "prod")
+        ctx.obj['base_url'] = _set_base_url(ctx.obj['env'])
+        os.environ["CLARIFAI_API_BASE"] = ctx.obj['base_url']
+    elif 'CLARIFAI_API_BASE' in os.environ:
+        ctx.obj['base_url'] = os.environ["CLARIFAI_API_BASE"]
+    
+    _dump_yaml(ctx.obj, 'config.yaml')
+    
+    click.echo("Login successful.")
+
+# Import the model CLI commands to register them
+from clarifai.client.cli.model_cli import model  # Ensure this is the correct import path
+
+
+if __name__ == '__main__':
+    cli()

clarifai/client/cli/model_cli.py

@@ -0,0 +1,29 @@
+import click
+from clarifai.client.cli.base_cli import cli
+
+@cli.group()
+def model():
+    """Manage models: upload, test locally"""
+    pass
+
+@model.command()
+@click.argument('model_path', type=click.Path(exists=True))
+@click.option('--download_checkpoints', is_flag=True, help='Flag to download checkpoints before uploading and including them in the tar file that is uploaded. Defaults to False, which will attempt to download them at docker build time.', )
+@click.option('--skip_dockerfile', is_flag =True, help='Flag to skip generating a dockerfile so that you can manually edit an already created dockerfile.', )
+def upload(model_path, download_checkpoints, skip_dockerfile):
+    """Upload a model to Clarifai."""
+    from clarifai.runners.models import model_upload
+
+    model_upload.main(model_path, download_checkpoints, skip_dockerfile)
+    
+@model.command()
+@click.argument('model_path', type=click.Path(exists=True))
+def test_locally(model_path):
+    """Test model locally."""
+    try:
+        from clarifai.runners.models import run_test_locally
+        run_test_locally.main(model_path)
+        click.echo(f"Model tested locally from {model_path}.")
+    except Exception as e:
+        click.echo(f"Failed to test model locally: {e}", err=True)
+

clarifai/client/model.py

@@ -84,7 +84,6 @@ class Model(Lister, BaseClient):
         compute_cluster_id=compute_cluster_id,
         nodepool_id=nodepool_id,
         deployment_id=deployment_id,
-        user_id=self.user_id,  # FIXME the deployment's user_id can be different than the model's.
     )
     BaseClient.__init__(
         self,

clarifai/client/model_client.py

@@ -1,5 +1,3 @@
-import inspect
-import json
 import time
 from typing import Any, Dict, Iterator, List
 
@@ -98,18 +96,19 @@ class ModelClient:
     '''
     for method_name, method_signature in self._method_signatures.items():
       # define the function in this client instance
-      if method_signature.method_type == 'predict':
+      if resources_pb2.RunnerMethodType.Name(method_signature.method_type) == 'UNARY_UNARY':
         call_func = self._predict
-      elif method_signature.method_type == 'generate':
+      elif resources_pb2.RunnerMethodType.Name(method_signature.method_type) == 'UNARY_STREAMING':
         call_func = self._generate
-      elif method_signature.method_type == 'stream':
+      elif resources_pb2.RunnerMethodType.Name(
+          method_signature.method_type) == 'STREAMING_STREAMING':
         call_func = self._stream
       else:
         raise ValueError(f"Unknown method type {method_signature.method_type}")
 
       # method argnames, in order, collapsing nested keys to corresponding user function args
       method_argnames = []
-      for var in method_signature.inputs:
+      for var in method_signature.input_fields:
         outer = var.name.split('.', 1)[0]
         if outer in method_argnames:
           continue
@@ -136,18 +135,17 @@ class ModelClient:
       # set names, annotations and docstrings
       f.__name__ = method_name
       f.__qualname__ = f'{self.__class__.__name__}.{method_name}'
-      f.__doc__ = method_signature.docstring
-      input_annotations = json.loads(method_signature.annotations_json)
-      return_annotation = input_annotations.pop('return', None)
-      sig = inspect.signature(f).replace(
-          parameters=[
-              inspect.Parameter(k, inspect.Parameter.POSITIONAL_OR_KEYWORD, annotation=v)
-              for k, v in input_annotations.items()
-          ],
-          return_annotation=return_annotation,
-      )
-      f.__signature__ = sig
-      f.__doc__ = method_signature.docstring
+      # input_annotations = json.loads(method_signature.annotations_json)
+      # return_annotation = input_annotations.pop('return', None)
+      # sig = inspect.signature(f).replace(
+      #     parameters=[
+      #         inspect.Parameter(k, inspect.Parameter.POSITIONAL_OR_KEYWORD, annotation=v)
+      #         for k, v in input_annotations.items()
+      #     ],
+      #     return_annotation=return_annotation,
+      # )
+      # f.__signature__ = sig
+      f.__doc__ = method_signature.description
       setattr(self, method_name, f)
 
   def _define_compatability_functions(self):
@@ -177,8 +175,8 @@ class ModelClient:
       inputs,  # TODO set up functions according to fetched signatures?
       method_name: str = 'predict',
   ) -> Any:
-    input_signature = self._method_signatures[method_name].inputs
-    output_signature = self._method_signatures[method_name].outputs
+    input_signature = self._method_signatures[method_name].input_fields
+    output_signature = self._method_signatures[method_name].output_fields
 
     batch_input = True
     if isinstance(inputs, dict):
@@ -260,8 +258,8 @@ class ModelClient:
       inputs,  # TODO set up functions according to fetched signatures?
       method_name: str = 'generate',
   ) -> Any:
-    input_signature = self._method_signatures[method_name].inputs
-    output_signature = self._method_signatures[method_name].outputs
+    input_signature = self._method_signatures[method_name].input_fields
+    output_signature = self._method_signatures[method_name].output_fields
 
     batch_input = True
     if isinstance(inputs, dict):
@@ -350,8 +348,8 @@ class ModelClient:
       inputs,
       method_name: str = 'stream',
   ) -> Any:
-    input_signature = self._method_signatures[method_name].inputs
-    output_signature = self._method_signatures[method_name].outputs
+    input_signature = self._method_signatures[method_name].input_fields
+    output_signature = self._method_signatures[method_name].output_fields
 
     if isinstance(inputs, list):
       assert len(inputs) == 1, 'streaming methods do not support batched calls'

clarifai/runners/dockerfile_template/Dockerfile.cpu.template

@@ -0,0 +1,31 @@
+ARG BASE_IMAGE=${BASE_IMAGE}
+FROM ${BASE_IMAGE} as build
+
+# Set the working directory to /app
+WORKDIR /app
+
+COPY requirements.txt .
+# Install requirements and cleanup before leaving this line.
+# Note(zeiler): this could be in a future template as {{model_python_deps}}
+RUN pip install --no-cache-dir -r requirements.txt
+
+# Install Clarifai SDK
+RUN pip install --no-cache-dir clarifai
+
+# These will be set by the templaing system.
+ENV CLARIFAI_PAT=${CLARIFAI_PAT}
+ENV CLARIFAI_USER_ID=${CLARIFAI_USER_ID}
+ENV CLARIFAI_RUNNER_ID=${CLARIFAI_RUNNER_ID}
+ENV CLARIFAI_NODEPOOL_ID=${CLARIFAI_NODEPOOL_ID}
+ENV CLARIFAI_COMPUTE_CLUSTER_ID=${CLARIFAI_COMPUTE_CLUSTER_ID}
+ENV CLARIFAI_API_BASE=${CLARIFAI_API_BASE}
+
+# Copy the current folder into /app/model_dir that the SDK will expect.
+COPY . /app/model_dir/${name}
+
+# Add the model directory to the python path.
+ENV PYTHONPATH "${PYTHONPATH}:/app/model_dir/${name}"
+
+# Finally run the clarifai entrypoint to start the runner loop and local dev server.
+# Note(zeiler): we may want to make this a clarifai CLI call.
+CMD ["-m", "clarifai.runners.server", "--model_path", "/app/model_dir/${name}"]

clarifai/runners/dockerfile_template/Dockerfile.cuda.template

@@ -0,0 +1,42 @@
+ARG TARGET_PLATFORM=linux/amd64
+FROM --platform=$TARGET_PLATFORM ${BASE_IMAGE} as build
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+#############################
+# User specific requirements
+#############################
+COPY requirements.txt .
+
+# Install requirements and cleanup before leaving this line.
+# Note(zeiler): this could be in a future template as {{model_python_deps}}
+RUN pip install --no-cache-dir -r requirements.txt
+
+# Install Clarifai SDK
+RUN pip install --no-cache-dir clarifai
+
+# These will be set by the templaing system.
+ENV CLARIFAI_PAT=${CLARIFAI_PAT}
+ENV CLARIFAI_USER_ID=${CLARIFAI_USER_ID}
+ENV CLARIFAI_RUNNER_ID=${CLARIFAI_RUNNER_ID}
+ENV CLARIFAI_NODEPOOL_ID=${CLARIFAI_NODEPOOL_ID}
+ENV CLARIFAI_COMPUTE_CLUSTER_ID=${CLARIFAI_COMPUTE_CLUSTER_ID}
+ENV CLARIFAI_API_BASE=${CLARIFAI_API_BASE}
+
+# Set the NUMBA cache dir to /tmp
+ENV NUMBA_CACHE_DIR=/tmp/numba_cache
+ENV HOME=/tmp
+
+# Set the working directory to /app
+WORKDIR /app
+
+# Copy the current folder into /app/model_dir that the SDK will expect.
+# Note(zeiler): would be nice to exclude checkpoints in case they were pre-downloaded.
+COPY . /app/model_dir/${name}
+
+# Add the model directory to the python path.
+ENV PYTHONPATH=${PYTHONPATH}:/app/model_dir/${name}
+
+# Finally run the clarifai entrypoint to start the runner loop and local dev server.
+# Note(zeiler): we may want to make this a clarifai CLI call.
+CMD ["-m", "clarifai.runners.server", "--model_path", "/app/model_dir/${name}"]

clarifai/runners/dockerfile_template/Dockerfile.nim

@@ -0,0 +1,71 @@
+FROM nvcr.io/nim/meta/llama-3.1-8b-instruct:1.1.2 as build
+
+FROM gcr.io/distroless/python3-debian12:debug
+
+
+COPY --from=build /bin/bash /bin/rbash
+COPY --from=build /bin/sh /bin/sh
+COPY --from=build /bin/rsh /bin/rsh
+
+# we have to overwrite the python3 binary that the distroless image uses
+COPY --from=build /opt/nim/llm/.venv/bin/python3.10 /usr/bin/python3
+COPY --from=build /opt/nim/llm/.venv/bin/python3.10 /usr/local/bin/python3.10
+
+# also copy in all the lib files for it.
+COPY --from=build /lib /lib
+COPY --from=build /lib64 /lib64
+COPY --from=build /usr/lib/ /usr/lib/
+COPY --from=build /usr/local/lib/ /usr/local/lib/
+# ldconfig is needed to update the shared library cache so system libraries (like CUDA) can be found
+COPY --from=build /usr/sbin/ldconfig /sbin/ldconfig
+COPY --from=build /usr/sbin/ldconfig.real /sbin/ldconfig.real
+COPY --from=build /etc/ld.so.conf /etc/ld.so.conf
+COPY --from=build /etc/ld.so.cache /etc/ld.so.cache
+COPY --from=build /etc/ld.so.conf.d/ /etc/ld.so.conf.d/
+
+# COPY NIM files
+COPY  --from=build /opt /opt
+COPY  --from=build /etc/nim /etc/nim
+
+# Set environment variables to use the nim libraries and python
+ENV PYTHONPATH=${PYTHONPATH}:/opt/nim/llm/.venv/lib/python3.10/site-packages:/opt/nim/llm
+ENV PATH="/opt/nim/llm/.venv/bin:/opt/hpcx/ucc/bin:/opt/hpcx/ucx/bin:/opt/hpcx/ompi/bin:$PATH"
+
+ENV LD_LIBRARY_PATH="/opt/hpcx/ucc/lib/ucc:/opt/hpcx/ucc/lib:/opt/hpcx/ucx/lib/ucx:/opt/hpcx/ucx/lib:/opt/hpcx/ompi/lib:/opt/hpcx/ompi/lib/openmpi:/opt/nim/llm/.venv/lib/python3.10/site-packages/tensorrt_llm/libs:/opt/nim/llm/.venv/lib/python3.10/site-packages/nvidia/cublas/lib:/opt/nim/llm/.venv/lib/python3.10/site-packages/tensorrt_libs:/opt/nim/llm/.venv/lib/python3.10/site-packages/nvidia/nccl/lib:$LD_LIBRARY_PATH"
+
+ENV LIBRARY_PATH=/opt/hpcx/ucc/lib:/opt/hpcx/ucx/lib:/opt/hpcx/ompi/lib:$LIBRARY_PATH
+
+ENV CPATH=/opt/hpcx/ompi/include:/opt/hpcx/ucc/include:/opt/hpcx/ucx/include:$CPATH
+ENV LLM_PROJECT_DIR=/opt/nim/llm
+
+# Set environment variables for MPI
+ENV OMPI_HOME=/opt/hpcx/ompi
+ENV HPCX_MPI_DIR=/opt/hpcx/ompi
+ENV MPIf_HOME=/opt/hpcx/ompi
+ENV OPAL_PREFIX=/opt/hpcx/ompi
+
+# Set environment variables for UCC
+ENV UCC_DIR=/opt/hpcx/ucc/lib/cmake/ucc
+ENV UCC_HOME=/opt/hpcx/ucc
+ENV HPCX_UCC_DIR=/opt/hpcx/ucc
+ENV USE_UCC=1
+ENV USE_SYSTEM_UCC=1
+
+# Set environment variables for HPC-X
+ENV HPCX_DIR=/opt/hpcx
+ENV HPCX_UCX_DIR=/opt/hpcx/ucx
+ENV HPCX_MPI_DIR=/opt/hpcx/ompi
+
+# Set environment variables for UCX
+ENV UCX_DIR=/opt/hpcx/ucx/lib/cmake/ucx
+ENV UCX_HOME=/opt/hpcx/ucx
+
+ENV HOME=/opt/nim/llm
+
+# ln is needed to create symbolic links (needed by nvidia-container-runtime)
+COPY --from=build /usr/bin/ln /usr/bin/ln
+
+# Run ldconfig in the build stage to update the library cache else CUDA libraries won't be found
+RUN ldconfig -v
+
+SHELL ["/bin/rbash", "-c"]

clarifai/runners/models/model_builder.py

@@ -267,9 +267,18 @@ class ModelBuilder:
     """
     model_class = self.load_model_class()
     method_info = model_class._get_method_info()
-    signatures = {name: m.signature for name, m in method_info.items()}
+    signatures = {name: m.signature for name, m in method_info.values()}
     return signatures_to_yaml(signatures)
 
+  def get_method_signatures(self):
+    """
+    Returns the method signatures for the model class.
+    """
+    model_class = self.load_model_class()
+    method_info = model_class._get_method_info()
+    signatures = [method.signature for method in method_info.values()]
+    return signatures
+
   @property
   def client(self):
     if self._client is None:
@@ -553,6 +562,8 @@ class ModelBuilder:
         pretrained_model_config=resources_pb2.PretrainedModelConfig(),
         inference_compute_info=self.inference_compute_info,
     )
+    # TODO: update this to `model_signatures` field when it's available in the API
+    model_version_proto.model_signature.extend(self.get_method_signatures())
 
     model_type_id = self.config.get('model').get('model_type_id')
     if model_type_id in CONCEPTS_REQUIRED_MODEL_TYPE: