clarifai 11.2.3rc1__tar.gz → 11.2.3rc3__tar.gz

{clarifai-11.2.3rc1/clarifai.egg-info → clarifai-11.2.3rc3}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: clarifai
-Version: 11.2.3rc1
+Version: 11.2.3rc3
 Summary: Clarifai Python SDK
 Home-page: https://github.com/Clarifai/clarifai-python
 Author: Clarifai
@@ -21,7 +21,7 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: clarifai-grpc>=11.2.6
-Requires-Dist: clarifai-protocol>=0.0.21
+Requires-Dist: clarifai-protocol>=0.0.22
 Requires-Dist: numpy>=1.22.0
 Requires-Dist: tqdm>=4.65.0
 Requires-Dist: rich>=13.4.2
@@ -35,6 +35,17 @@ Requires-Dist: requests>=2.32.3
 Requires-Dist: aiohttp>=3.10.0
 Provides-Extra: all
 Requires-Dist: pycocotools==2.0.6; extra == "all"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 <h1 align="center">
   <a href="https://www.clarifai.com/"><img alt="Clarifai" title="Clarifai" src="https://github.com/user-attachments/assets/623b883b-7fe5-4b95-bbfa-8691f5779af4"></a>

clarifai-11.2.3rc3/clarifai/__init__.py

@@ -0,0 +1 @@
+__version__ = "11.2.3rc3"

clarifai-11.2.3rc3/clarifai/cli/base.py

@@ -0,0 +1,113 @@
+import os
+
+import click
+
+from ..utils.cli import dump_yaml, from_yaml, load_command_modules, set_base_url
+
+
+class CustomMultiGroup(click.Group):
+
+  def group(self, *args, **kwargs):
+    """Behaves the same as `click.Group.group()` except if passed
+        a list of names, all after the first will be aliases for the first.
+        """
+
+    def decorator(f):
+      aliased_group = []
+      if isinstance(args[0], list):
+        # we have a list so create group aliases
+        _args = [args[0][0]] + list(args[1:])
+        for alias in args[0][1:]:
+          grp = super(CustomMultiGroup, self).group(alias, *args[1:], **kwargs)(f)
+          grp.short_help = "Alias for '{}'".format(_args[0])
+          aliased_group.append(grp)
+      else:
+        _args = args
+
+      # create the main group
+      grp = super(CustomMultiGroup, self).group(*_args, **kwargs)(f)
+
+      # for all of the aliased groups, share the main group commands
+      for aliased in aliased_group:
+        aliased.commands = grp.commands
+
+      return grp
+
+    return decorator
+
+
+@click.group(cls=CustomMultiGroup)
+@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)
+  else:
+    ctx.obj = {}
+
+
+@cli.command()
+@click.option('--config', type=click.Path(), required=False, help='Path to the config file')
+@click.option(
+    '-e',
+    '--env',
+    required=False,
+    help='Environment to use, choose from prod, staging and dev',
+    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:
+    ctx.obj['user_id'] = ctx.obj.get('user_id', "")
+    os.environ["CLARIFAI_USER_ID"] = ctx.obj['user_id']
+  elif 'CLARIFAI_USER_ID' in os.environ:
+    ctx.obj['user_id'] = os.environ["CLARIFAI_USER_ID"]
+  else:
+    user_id = click.prompt("Pass the User ID here", type=str)
+    os.environ["CLARIFAI_USER_ID"] = user_id
+    ctx.obj['user_id'] = user_id
+    click.echo("User ID saved successfully.")
+
+  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')
+
+
+# Import the CLI commands to register them
+load_command_modules()
+
+
+def main():
+  cli()

{clarifai-11.2.3rc1 → clarifai-11.2.3rc3}/clarifai/cli/compute_cluster.py

@@ -1,59 +1,51 @@
 import click
-
 from clarifai.cli.base import cli
 from clarifai.client.user import User
-from clarifai.utils.cli import AliasedGroup, display_co_resources, validate_context
+from clarifai.utils.cli import display_co_resources
 
 
-@cli.group(['computecluster', 'cc'], cls=AliasedGroup)
+@cli.group(['computecluster', 'cc'])
 def computecluster():
   """Manage Compute Clusters: create, delete, list"""
+  pass
 
 
-@computecluster.command(['c'])
-@click.argument('compute_cluster_id')
+@computecluster.command()
 @click.option(
     '--config',
     type=click.Path(exists=True),
     required=True,
     help='Path to the compute cluster config file.')
+@click.option(
+    '-cc_id',
+    '--compute_cluster_id',
+    required=False,
+    help='New Compute Cluster ID for the compute cluster to create.')
 @click.pass_context
-def create(ctx, compute_cluster_id, config):
+def create(ctx, config, compute_cluster_id):
   """Create a new Compute Cluster with the given config file."""
-  validate_context(ctx)
-  user = User(
-      user_id=ctx.obj.current.user_id, pat=ctx.obj.current.pat, base_url=ctx.obj.current.api_base)
+  user = User(user_id=ctx.obj['user_id'], pat=ctx.obj['pat'], base_url=ctx.obj['base_url'])
   if compute_cluster_id:
     user.create_compute_cluster(config, compute_cluster_id=compute_cluster_id)
   else:
     user.create_compute_cluster(config)
 
 
-@computecluster.command(['ls'])
+@computecluster.command()
 @click.option('--page_no', required=False, help='Page number to list.', default=1)
 @click.option('--per_page', required=False, help='Number of items per page.', default=16)
 @click.pass_context
 def list(ctx, page_no, per_page):
   """List all compute clusters for the user."""
-  validate_context(ctx)
-  user = User(
-      user_id=ctx.obj.current.user_id, pat=ctx.obj.current.pat, base_url=ctx.obj.current.api_base)
+  user = User(user_id=ctx.obj['user_id'], pat=ctx.obj['pat'], base_url=ctx.obj['base_url'])
   response = user.list_compute_clusters(page_no, per_page)
-  display_co_resources(
-      response,
-      custom_columns={
-          'ID': lambda c: c.id,
-          'USER_ID': lambda c: c.user_id,
-          'DESCRIPTION': lambda c: c.description,
-      })
+  display_co_resources(response, "Compute Cluster")
 
 
-@computecluster.command(['rm'])
-@click.argument('compute_cluster_id')
+@computecluster.command()
+@click.option('-cc_id', '--compute_cluster_id', help='Compute Cluster ID of the user to delete.')
 @click.pass_context
 def delete(ctx, compute_cluster_id):
   """Deletes a compute cluster for the user."""
-  validate_context(ctx)
-  user = User(
-      user_id=ctx.obj.current.user_id, pat=ctx.obj.current.pat, base_url=ctx.obj.current.api_base)
+  user = User(user_id=ctx.obj['user_id'], pat=ctx.obj['pat'], base_url=ctx.obj['base_url'])
   user.delete_compute_clusters([compute_cluster_id])

clarifai-11.2.3rc3/clarifai/cli/deployment.py

@@ -0,0 +1,84 @@
+import click
+from clarifai.cli.base import cli
+from clarifai.client.nodepool import Nodepool
+from clarifai.utils.cli import display_co_resources, from_yaml
+
+
+@cli.group(['deployment', 'dpl'])
+def deployment():
+  """Manage Deployments: create, delete, list"""
+  pass
+
+
+@deployment.command()
+@click.option(
+    '-np_id',
+    '--nodepool_id',
+    required=False,
+    help='Nodepool ID for the Nodepool to interact with.')
+@click.option(
+    '--config',
+    type=click.Path(exists=True),
+    required=True,
+    help='Path to the deployment config file.')
+@click.option(
+    '-dpl_id',
+    '--deployment_id',
+    required=False,
+    help='New deployment ID for the deployment to create.')
+@click.pass_context
+def create(ctx, nodepool_id, config, deployment_id):
+  """Create a new Deployment with the given config file."""
+  if not nodepool_id:
+    deployment_config = from_yaml(config)
+    nodepool_id = deployment_config['deployment']['nodepools'][0]['id']
+
+  nodepool = Nodepool(
+      nodepool_id=nodepool_id,
+      user_id=ctx.obj['user_id'],
+      pat=ctx.obj['pat'],
+      base_url=ctx.obj['base_url'])
+  if deployment_id:
+    nodepool.create_deployment(config, deployment_id=deployment_id)
+  else:
+    nodepool.create_deployment(config)
+
+
+@deployment.command()
+@click.option(
+    '-np_id',
+    '--nodepool_id',
+    required=True,
+    help='Nodepool ID for the Nodepool to interact with.')
+@click.option('--page_no', required=False, help='Page number to list.', default=1)
+@click.option('--per_page', required=False, help='Number of items per page.', default=16)
+@click.pass_context
+def list(ctx, nodepool_id, page_no, per_page):
+  """List all deployments for the nodepool."""
+
+  nodepool = Nodepool(
+      nodepool_id=nodepool_id,
+      user_id=ctx.obj['user_id'],
+      pat=ctx.obj['pat'],
+      base_url=ctx.obj['base_url'])
+  response = nodepool.list_deployments(page_no=page_no, per_page=per_page)
+  display_co_resources(response, "Deployment")
+
+
+@deployment.command()
+@click.option(
+    '-np_id',
+    '--nodepool_id',
+    required=True,
+    help='Nodepool ID for the Nodepool to interact with.')
+@click.option('-dpl_id', '--deployment_id', help='Deployment ID of the nodepool to delete.')
+@click.pass_context
+def delete(ctx, nodepool_id, deployment_id):
+  """Deletes a deployment for the nodepool."""
+
+  nodepool = Nodepool(
+      nodepool_id=nodepool_id,
+      user_id=ctx.obj['user_id'],
+      pat=ctx.obj['pat'],
+      base_url=ctx.obj['base_url'])
+  nodepool.delete_deployments([deployment_id])

{clarifai-11.2.3rc1 → clarifai-11.2.3rc3}/clarifai/cli/model.py

@@ -5,7 +5,7 @@ from clarifai.cli.base import cli
 
 @cli.group(['model'])
 def model():
-  """Manage models: upload, test, local dev, predict, etc"""
+  """Manage models: upload, test locally, run locally, predict, and more"""
 
 
 @model.command()
@@ -76,6 +76,31 @@ def download_checkpoints(model_path, out_path, stage):
     required=False,
     default=".",
 )
+@click.option(
+    '--out_path',
+    type=click.Path(exists=False),
+    required=False,
+    default=None,
+    help='Path to write the method signature defitions to. If not provided, use stdout.')
+def signatures(model_path, out_path):
+  """Generate method signatures for the model."""
+
+  from clarifai.runners.models.model_builder import ModelBuilder
+  builder = ModelBuilder(model_path, download_validation_only=True)
+  signatures = builder.method_signatures_yaml()
+  if out_path:
+    with open(out_path, 'w') as f:
+      f.write(signatures)
+  else:
+    click.echo(signatures)
+
+
+@model.command()
+@click.option(
+    '--model_path',
+    type=click.Path(exists=True),
+    required=True,
+    help='Path to the model directory.')
 @click.option(
     '--mode',
     type=click.Choice(['env', 'container'], case_sensitive=False),
@@ -96,14 +121,11 @@ def download_checkpoints(model_path, out_path, stage):
     help=
     'Keep the Docker image after testing the model locally (applicable for container mode). Defaults to False.'
 )
-@click.option(
-    '--skip_dockerfile',
-    is_flag=True,
-    help=
-    'Flag to skip generating a dockerfile so that you can manually edit an already created dockerfile. Apply for `--mode conatainer`.',
-)
-def test_locally(model_path, keep_env=False, keep_image=False, mode='env', skip_dockerfile=False):
-  """Test model locally."""
+def test_locally(model_path, keep_env=False, keep_image=False, mode='env'):
+  """Test model locally.
+
+  MODEL_PATH: Path to the model directory. If not specified, the current directory is used by default.
+  """
   try:
     from clarifai.runners.models import model_run_locally
     if mode == 'env' and keep_image:
@@ -117,11 +139,7 @@ def test_locally(model_path, keep_env=False, keep_image=False, mode='env', skip_
     elif mode == "container":
       click.echo("Testing model locally inside a container...")
       model_run_locally.main(
-          model_path,
-          inside_container=True,
-          run_model_server=False,
-          keep_image=keep_image,
-          skip_dockerfile=skip_dockerfile)
+          model_path, inside_container=True, run_model_server=False, keep_image=keep_image)
     click.echo("Model tested successfully.")
   except Exception as e:
     click.echo(f"Failed to test model locally: {e}", err=True)
@@ -161,14 +179,11 @@ def test_locally(model_path, keep_env=False, keep_image=False, mode='env', skip_
     help=
     'Keep the Docker image after testing the model locally (applicable for container mode). Defaults to False.'
 )
-@click.option(
-    '--skip_dockerfile',
-    is_flag=True,
-    help=
-    'Flag to skip generating a dockerfile so that you can manually edit an already created dockerfile. Apply for `--mode conatainer`.',
-)
-def run_locally(model_path, port, mode, keep_env, keep_image, skip_dockerfile=False):
-  """Run the model locally and start a gRPC server to serve the model."""
+def run_locally(model_path, port, mode, keep_env, keep_image):
+  """Run the model locally and start a gRPC server to serve the model.
+
+  MODEL_PATH: Path to the model directory. If not specified, the current directory is used by default.
+  """
   try:
     from clarifai.runners.models import model_run_locally
     if mode == 'env' and keep_image:
@@ -186,8 +201,7 @@ def run_locally(model_path, port, mode, keep_env, keep_image, skip_dockerfile=Fa
           inside_container=True,
           run_model_server=True,
           port=port,
-          keep_image=keep_image,
-          skip_dockerfile=skip_dockerfile)
+          keep_image=keep_image)
     click.echo(f"Model server started locally from {model_path} in {mode} mode.")
   except Exception as e:
     click.echo(f"Failed to starts model server locally: {e}", err=True)
@@ -241,8 +255,7 @@ def predict(ctx, config, model_id, user_id, app_id, model_url, file_path, url, b
   import json
 
   from clarifai.client.model import Model
-  from clarifai.utils.cli import from_yaml, validate_context
-  validate_context(ctx)
+  from clarifai.utils.cli import from_yaml
   if config:
     config = from_yaml(config)
     model_id, user_id, app_id, model_url, file_path, url, bytes, input_type, compute_cluster_id, nodepool_id, deployment_id, inference_params, output_config = (

clarifai-11.2.3rc3/clarifai/cli/nodepool.py

@@ -0,0 +1,91 @@
+import click
+from clarifai.cli.base import cli
+from clarifai.client.compute_cluster import ComputeCluster
+from clarifai.utils.cli import display_co_resources, dump_yaml, from_yaml
+
+
+@cli.group(['nodepool', 'np'])
+def nodepool():
+  """Manage Nodepools: create, delete, list"""
+  pass
+
+
+@nodepool.command()
+@click.option(
+    '-cc_id',
+    '--compute_cluster_id',
+    required=False,
+    help='Compute Cluster ID for the compute cluster to interact with.')
+@click.option(
+    '--config',
+    type=click.Path(exists=True),
+    required=True,
+    help='Path to the nodepool config file.')
+@click.option(
+    '-np_id', '--nodepool_id', required=False, help='New Nodepool ID for the nodepool to create.')
+@click.pass_context
+def create(ctx, compute_cluster_id, config, nodepool_id):
+  """Create a new Nodepool with the given config file."""
+
+  nodepool_config = from_yaml(config)
+  if not compute_cluster_id:
+    if 'compute_cluster' not in nodepool_config['nodepool']:
+      click.echo(
+          "Please provide a compute cluster ID either in the config file or using --compute_cluster_id flag",
+          err=True)
+      return
+    compute_cluster_id = nodepool_config['nodepool']['compute_cluster']['id']
+  else:
+    if 'compute_cluster' not in nodepool_config['nodepool']:
+      nodepool_config['nodepool']['compute_cluster']['id'] = compute_cluster_id
+      dump_yaml(config, nodepool_config)
+
+  compute_cluster = ComputeCluster(
+      compute_cluster_id=compute_cluster_id,
+      user_id=ctx.obj['user_id'],
+      pat=ctx.obj['pat'],
+      base_url=ctx.obj['base_url'])
+  if nodepool_id:
+    compute_cluster.create_nodepool(config, nodepool_id=nodepool_id)
+  else:
+    compute_cluster.create_nodepool(config)
+
+
+@nodepool.command()
+@click.option(
+    '-cc_id',
+    '--compute_cluster_id',
+    required=True,
+    help='Compute Cluster ID for the compute cluster to interact with.')
+@click.option('--page_no', required=False, help='Page number to list.', default=1)
+@click.option('--per_page', required=False, help='Number of items per page.', default=16)
+@click.pass_context
+def list(ctx, compute_cluster_id, page_no, per_page):
+  """List all nodepools for the user."""
+
+  compute_cluster = ComputeCluster(
+      compute_cluster_id=compute_cluster_id,
+      user_id=ctx.obj['user_id'],
+      pat=ctx.obj['pat'],
+      base_url=ctx.obj['base_url'])
+  response = compute_cluster.list_nodepools(page_no, per_page)
+  display_co_resources(response, "Nodepool")
+
+
+@nodepool.command()
+@click.option(
+    '-cc_id',
+    '--compute_cluster_id',
+    required=True,
+    help='Compute Cluster ID for the compute cluster to interact with.')
+@click.option('-np_id', '--nodepool_id', help='Nodepool ID of the user to delete.')
+@click.pass_context
+def delete(ctx, compute_cluster_id, nodepool_id):
+  """Deletes a nodepool for the user."""
+
+  compute_cluster = ComputeCluster(
+      compute_cluster_id=compute_cluster_id,
+      user_id=ctx.obj['user_id'],
+      pat=ctx.obj['pat'],
+      base_url=ctx.obj['base_url'])
+  compute_cluster.delete_nodepools([nodepool_id])

{clarifai-11.2.3rc1 → clarifai-11.2.3rc3}/clarifai/client/app.py

@@ -629,7 +629,7 @@ class App(Lister, BaseClient):
 
     Args:
         model_id (str): The model ID for the model to interact with.
-        model_version (Dict): The model version ID for the model version to interact with.
+        model_version_id (str): The model version ID for the model version to interact with.
 
     Returns:
         Model: A Model object for the existing model ID.