clarifai 11.3.0rc2__tar.gz → 11.4.0__tar.gz

{clarifai-11.3.0rc2/clarifai.egg-info → clarifai-11.4.0}/PKG-INFO

@@ -1,7 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: clarifai
-Version: 11.3.0rc2
-Summary: Clarifai Python SDK
+Version: 11.4.0
 Home-page: https://github.com/Clarifai/clarifai-python
 Author: Clarifai
 Author-email: support@clarifai.com
@@ -20,8 +19,8 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: clarifai-grpc>=11.3.3
-Requires-Dist: clarifai-protocol>=0.0.22
+Requires-Dist: clarifai-grpc>=11.3.4
+Requires-Dist: clarifai-protocol>=0.0.23
 Requires-Dist: numpy>=1.22.0
 Requires-Dist: tqdm>=4.65.0
 Requires-Dist: rich>=13.4.2
@@ -34,7 +33,18 @@ Requires-Dist: click>=8.1.7
 Requires-Dist: requests>=2.32.3
 Requires-Dist: aiohttp>=3.10.0
 Provides-Extra: all
-Requires-Dist: pycocotools==2.0.6; extra == "all"
+Requires-Dist: pycocotools>=2.0.7; extra == "all"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
 
 <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.4.0/clarifai/__init__.py

@@ -0,0 +1 @@
+__version__ = "11.4.0"

{clarifai-11.3.0rc2 → clarifai-11.4.0}/clarifai/cli/__main__.py

@@ -1,4 +1,4 @@
 from clarifai.cli.base import main
 
 if __name__ == "__main__":
-  main()
+    main()

clarifai-11.4.0/clarifai/cli/base.py

@@ -0,0 +1,268 @@
+import json
+import os
+import shutil
+import sys
+
+import click
+import yaml
+
+from clarifai.utils.cli import AliasedGroup, TableFormatter, load_command_modules
+from clarifai.utils.config import Config, Context
+from clarifai.utils.constants import DEFAULT_CONFIG
+from clarifai.utils.logging import logger
+
+
+# @click.group(cls=CustomMultiGroup)
+@click.group(cls=AliasedGroup)
+@click.option('--config', default=DEFAULT_CONFIG)
+@click.pass_context
+def cli(ctx, config):
+    """Clarifai CLI"""
+    ctx.ensure_object(dict)
+    if os.path.exists(config):
+        cfg = Config.from_yaml(filename=config)
+        ctx.obj = cfg
+    else:
+        cfg = Config(
+            filename=config,
+            current_context='default',
+            contexts={
+                'default': Context(
+                    'default',
+                    CLARIFAI_PAT=os.environ.get('CLARIFAI_PAT', ''),
+                    CLARIFAI_USER_ID=os.environ.get('CLARIFAI_USER_ID', ''),
+                    CLARIFAI_API_BASE=os.environ.get('CLARIFAI_API_BASE', 'api.clarifai.com'),
+                )
+            },
+        )
+        try:
+            cfg.to_yaml(config)
+        except Exception:
+            logger.warning(
+                "Could not write configuration to disk. Could be a read only file system."
+            )
+        ctx.obj = cfg  # still have the default config even if couldn't write.
+
+
+@cli.command()
+@click.argument('shell', type=click.Choice(['bash', 'zsh']))
+def shell_completion(shell):
+    """Shell completion script"""
+    os.system(f"_CLARIFAI_COMPLETE={shell}_source clarifai")
+
+
+@cli.group(
+    ['cfg'],
+    cls=AliasedGroup,
+    context_settings={'max_content_width': shutil.get_terminal_size().columns - 10},
+)
+def config():
+    """Manage CLI configuration"""
+
+
+@config.command(['e'])
+@click.pass_context
+def edit(ctx):
+    """Edit the configuration file"""
+    os.system(f'{os.environ.get("EDITOR", "vi")} {ctx.obj.filename}')
+
+
+@config.command(['current'])
+@click.option('-o', '--output-format', default='name', type=click.Choice(['name', 'json', 'yaml']))
+@click.pass_context
+def current_context(ctx, output_format):
+    """Get the current context"""
+    if output_format == 'name':
+        print(ctx.obj.current_context)
+    elif output_format == 'json':
+        print(json.dumps(ctx.obj.contexts[ctx.obj.current_context].to_serializable_dict()))
+    else:
+        print(yaml.safe_dump(ctx.obj.contexts[ctx.obj.current_context].to_serializable_dict()))
+
+
+@config.command(['list', 'ls'])
+@click.option(
+    '-o', '--output-format', default='wide', type=click.Choice(['wide', 'name', 'json', 'yaml'])
+)
+@click.pass_context
+def get_contexts(ctx, output_format):
+    """Get all contexts"""
+    if output_format == 'wide':
+        columns = {
+            '': lambda c: '*' if c.name == ctx.obj.current_context else '',
+            'NAME': lambda c: c.name,
+            'USER_ID': lambda c: c.user_id,
+            'API_BASE': lambda c: c.api_base,
+            'PAT': lambda c: pat_display(c.pat),
+        }
+        additional_columns = set()
+        for cont in ctx.obj.contexts.values():
+            if 'env' in cont:
+                for key in cont.to_column_names():
+                    if key not in columns:
+                        additional_columns.add(key)
+        for key in sorted(additional_columns):
+            columns[key] = lambda c, k=key: getattr(c, k) if hasattr(c, k) else ""
+
+        formatter = TableFormatter(
+            custom_columns=columns,
+        )
+        print(formatter.format(ctx.obj.contexts.values(), fmt="plain"))
+    elif output_format == 'name':
+        print('\n'.join(ctx.obj.contexts))
+    elif output_format in ('json', 'yaml'):
+        dicts = [v.__dict__ for c, v in ctx.obj.contexts.items()]
+        for d in dicts:
+            d.pop('pat')
+        if output_format == 'json':
+            print(json.dumps(dicts))
+        elif output_format == 'yaml':
+            print(yaml.safe_dump(dicts))
+
+
+@config.command(['use'])
+@click.argument('context-name', type=str)
+@click.pass_context
+def use_context(ctx, context_name):
+    """Set the current context"""
+    if context_name not in ctx.obj.contexts:
+        raise click.UsageError('Context not found')
+    ctx.obj.current_context = context_name
+    ctx.obj.to_yaml()
+    print(f'Set {context_name} as the current context')
+
+
+@config.command(['cat'])
+@click.option('-o', '--output-format', default='yaml', type=click.Choice(['yaml', 'json']))
+@click.pass_obj
+def dump(ctx_obj, output_format):
+    """Dump the configuration to stdout"""
+    if output_format == 'yaml':
+        yaml.safe_dump(ctx_obj.to_dict(), sys.stdout)
+    else:
+        json.dump(ctx_obj.to_dict(), sys.stdout, indent=2)
+
+
+@cli.command()
+@click.argument('api_url', default="https://api.clarifai.com")
+@click.option('--user_id', required=False, help='User ID')
+@click.pass_context
+def login(ctx, api_url, user_id):
+    """Login command to set PAT and other configurations."""
+
+    name = input('context name (default: "default"): ')
+    user_id = user_id if user_id is not None else input('user id: ')
+    pat = input_or_default(
+        'personal access token value (default: "ENVVAR" to get our of env var rather than config): ',
+        'ENVVAR',
+    )
+
+    context = Context(
+        name,
+        CLARIFAI_API_BASE=api_url,
+        CLARIFAI_USER_ID=user_id,
+        CLARIFAI_PAT=pat,
+    )
+
+    if context.name == '':
+        context.name = 'default'
+
+    ctx.obj.contexts[context.name] = context
+    ctx.obj.current_context = context.name
+
+    ctx.obj.to_yaml()
+
+
+@cli.group(cls=AliasedGroup)
+def context():
+    """Manage contexts"""
+
+
+def pat_display(pat):
+    return pat[:5] + "****"
+
+
+def input_or_default(prompt, default):
+    value = input(prompt)
+    return value if value else default
+
+
+@context.command()
+@click.argument('name')
+@click.option('--user-id', required=False, help='User ID')
+@click.option('--base-url', required=False, help='Base URL')
+@click.option('--pat', required=False, help='Personal access token')
+@click.pass_context
+def create(
+    ctx,
+    name,
+    user_id=None,
+    base_url=None,
+    pat=None,
+):
+    """Create a new context"""
+    if name in ctx.obj.contexts:
+        print(f'{name} already exists')
+        sys.exit(1)
+    if not user_id:
+        user_id = input('user id: ')
+    if not base_url:
+        base_url = input_or_default(
+            'base url (default: https://api.clarifai.com): ', 'https://api.clarifai.com'
+        )
+    if not pat:
+        pat = input_or_default(
+            'personal access token value (default: "ENVVAR" to get our of env var rather than config): ',
+            'ENVVAR',
+        )
+
+    context = Context(name, CLARIFAI_USER_ID=user_id, CLARIFAI_API_BASE=base_url, CLARIFAI_PAT=pat)
+    ctx.obj.contexts[context.name] = context
+    ctx.obj.to_yaml()
+
+
+# write a click command to delete a context
+@context.command(['rm'])
+@click.argument('name')
+@click.pass_context
+def delete(ctx, name):
+    """Delete a context"""
+    if name not in ctx.obj.contexts:
+        print(f'{name} is not a valid context')
+        sys.exit(1)
+    ctx.obj.contexts.pop(name)
+    ctx.obj.to_yaml()
+    print(f'{name} deleted')
+
+
+@context.command()
+@click.argument('name', type=str)
+@click.pass_context
+def use(ctx, name):
+    """Set the current context"""
+    if name not in ctx.obj.contexts:
+        raise click.UsageError('Context not found')
+    ctx.obj.current_context = name
+    ctx.obj.to_yaml()
+    print(f'Set {name} as the current context')
+
+
+@cli.command()
+@click.argument('script', type=str)
+@click.option('--context', type=str, help='Context to use')
+@click.pass_context
+def run(ctx, script, context=None):
+    """Execute a script with the current context's environment"""
+    context = ctx.obj.current if not context else context
+    cmd = f'CLARIFAI_USER_ID={context.user_id} CLARIFAI_API_BASE={context.base_url} CLARIFAI_PAT={context.pat} '
+    cmd += ' '.join([f'{k}={v}' for k, v in context.env.items()])
+    cmd += f' {script}'
+    os.system(cmd)
+
+
+# Import the CLI commands to register them
+load_command_modules()
+
+
+def main():
+    cli()

clarifai-11.4.0/clarifai/cli/compute_cluster.py

@@ -0,0 +1,75 @@
+import shutil
+
+import click
+
+from clarifai.cli.base import cli
+from clarifai.utils.cli import AliasedGroup, display_co_resources, validate_context
+
+
+@cli.group(
+    ['computecluster', 'cc'],
+    cls=AliasedGroup,
+    context_settings={'max_content_width': shutil.get_terminal_size().columns - 10},
+)
+def computecluster():
+    """Manage Compute Clusters: create, delete, list"""
+
+
+@computecluster.command(['c'])
+@click.argument('compute_cluster_id')
+@click.option(
+    '--config',
+    type=click.Path(exists=True),
+    required=True,
+    help='Path to the compute cluster config file.',
+)
+@click.pass_context
+def create(ctx, compute_cluster_id, config):
+    """Create a new Compute Cluster with the given config file."""
+    from clarifai.client.user import 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
+    )
+    if compute_cluster_id:
+        user.create_compute_cluster(config, compute_cluster_id=compute_cluster_id)
+    else:
+        user.create_compute_cluster(config)
+
+
+@computecluster.command(['ls'])
+@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."""
+    from clarifai.client.user import 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
+    )
+    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,
+        },
+    )
+
+
+@computecluster.command(['rm'])
+@click.argument('compute_cluster_id')
+@click.pass_context
+def delete(ctx, compute_cluster_id):
+    """Deletes a compute cluster for the user."""
+    from clarifai.client.user import 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.delete_compute_clusters([compute_cluster_id])

clarifai-11.4.0/clarifai/cli/deployment.py

@@ -0,0 +1,129 @@
+import shutil
+
+import click
+
+from clarifai.cli.base import cli
+from clarifai.utils.cli import AliasedGroup, display_co_resources, from_yaml, validate_context
+
+
+@cli.group(
+    ['deployment', 'dp'],
+    cls=AliasedGroup,
+    context_settings={'max_content_width': shutil.get_terminal_size().columns - 10},
+)
+def deployment():
+    """Manage Deployments: create, delete, list"""
+
+
+@deployment.command(['c'])
+@click.argument('nodepool_id')
+@click.argument('deployment_id')
+@click.option(
+    '--config',
+    type=click.Path(exists=True),
+    required=True,
+    help='Path to the deployment config file.',
+)
+@click.pass_context
+def create(ctx, nodepool_id, deployment_id, config):
+    """Create a new Deployment with the given config file."""
+
+    from clarifai.client.nodepool import Nodepool
+
+    validate_context(ctx)
+    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.current.user_id,
+        pat=ctx.obj.current.pat,
+        base_url=ctx.obj.current.api_base,
+    )
+    if deployment_id:
+        nodepool.create_deployment(config, deployment_id=deployment_id)
+    else:
+        nodepool.create_deployment(config)
+
+
+@deployment.command(['ls'])
+@click.argument('nodepool_id', default="")
+@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."""
+    from clarifai.client.compute_cluster import ComputeCluster
+    from clarifai.client.nodepool import Nodepool
+    from clarifai.client.user import User
+
+    validate_context(ctx)
+    if nodepool_id:
+        nodepool = Nodepool(
+            nodepool_id=nodepool_id,
+            user_id=ctx.obj.current.user_id,
+            pat=ctx.obj.current.pat,
+            base_url=ctx.obj.current.api_base,
+        )
+        response = nodepool.list_deployments(page_no=page_no, per_page=per_page)
+    else:
+        user = User(
+            user_id=ctx.obj.current.user_id,
+            pat=ctx.obj.current.pat,
+            base_url=ctx.obj.current.api_base,
+        )
+        ccs = user.list_compute_clusters(page_no, per_page)
+        nps = []
+        for cc in ccs:
+            compute_cluster = ComputeCluster(
+                compute_cluster_id=cc.id,
+                user_id=ctx.obj.current.user_id,
+                pat=ctx.obj.current.pat,
+                base_url=ctx.obj.current.api_base,
+            )
+            nps.extend([i for i in compute_cluster.list_nodepools(page_no, per_page)])
+        response = []
+        for np in nps:
+            nodepool = Nodepool(
+                nodepool_id=np.id,
+                user_id=ctx.obj.current.user_id,
+                pat=ctx.obj.current.pat,
+                base_url=ctx.obj.current.api_base,
+            )
+            response.extend(
+                [i for i in nodepool.list_deployments(page_no=page_no, per_page=per_page)]
+            )
+
+    display_co_resources(
+        response,
+        custom_columns={
+            'ID': lambda c: c.id,
+            'USER_ID': lambda c: c.user_id,
+            'COMPUTE_CLUSTER_ID': lambda c: c.nodepools[0].compute_cluster.id,
+            'NODEPOOL_ID': lambda c: c.nodepools[0].id,
+            'MODEL_USER_ID': lambda c: c.worker.model.user_id,
+            'MODEL_APP_ID': lambda c: c.worker.model.app_id,
+            'MODEL_ID': lambda c: c.worker.model.id,
+            'MODEL_VERSION_ID': lambda c: c.worker.model.model_version.id,
+            'DESCRIPTION': lambda c: c.description,
+        },
+    )
+
+
+@deployment.command(['rm'])
+@click.argument('nodepool_id')
+@click.argument('deployment_id')
+@click.pass_context
+def delete(ctx, nodepool_id, deployment_id):
+    """Deletes a deployment for the nodepool."""
+    from clarifai.client.nodepool import Nodepool
+
+    validate_context(ctx)
+    nodepool = Nodepool(
+        nodepool_id=nodepool_id,
+        user_id=ctx.obj.current.user_id,
+        pat=ctx.obj.current.pat,
+        base_url=ctx.obj.current.api_base,
+    )
+    nodepool.delete_deployments([deployment_id])