clarifai 11.6.5__py3-none-any.whl → 11.6.7__py3-none-any.whl

clarifai/__init__.py

@@ -1 +1 @@
-__version__ = "11.6.5"
+__version__ = "11.6.7"

clarifai/cli/README.md

@@ -121,6 +121,57 @@ Delete existing Compute Clusters:
 $ clarifai computecluster delete --compute_cluster_id <compute-cluster-id>
 ```
 
+## Pipelines
+
+### List Pipelines
+
+List all pipelines for the user across all apps:
+
+```bash
+$ clarifai pipeline list
+```
+
+List pipelines within a specific app:
+
+```bash
+$ clarifai pipeline list --app_id <app-id>
+```
+
+List with pagination:
+
+```bash
+$ clarifai pipeline list --page_no 1 --per_page 10
+```
+
+### List Pipeline Steps
+
+List all pipeline steps for the user across all apps:
+
+```bash
+$ clarifai pipelinestep list
+```
+
+List pipeline steps within a specific app:
+
+```bash
+$ clarifai pipelinestep list --app_id <app-id>
+```
+
+List pipeline steps for a specific pipeline:
+
+```bash
+$ clarifai pipelinestep list --app_id <app-id> --pipeline_id <pipeline-id>
+```
+
+### Aliases
+
+Both commands support the `ls` alias for convenience:
+
+```bash
+$ clarifai pipeline ls
+$ clarifai pipelinestep ls
+```
+
 ## Learn More
 
 * [Example Configs](https://github.com/Clarifai/examples/tree/main/ComputeOrchestration/configs)

clarifai/cli/base.py

@@ -1,3 +1,4 @@
+import getpass
 import json
 import os
 import sys
@@ -71,33 +72,44 @@ def login(ctx, api_url, user_id):
     """Login command to set PAT and other configurations."""
     from clarifai.utils.cli import validate_context_auth
 
-    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 out of env var rather than config): ',
-        'ENVVAR',
+    # Input user_id if not supplied
+    if not user_id:
+        user_id = click.prompt('Enter your Clarifai user ID', type=str)
+
+    click.echo('> To authenticate, you\'ll need a Personal Access Token (PAT).')
+    click.echo(
+        f'> You can create one from your account settings: https://clarifai.com/{user_id}/settings/security\n'
     )
 
-    # Validate the Context Credentials
+    # Securely input PAT
+    pat = getpass.getpass('Enter your Personal Access Token: ')
+
+    # Progress indicator
+    click.echo('\n> Verifying token...')
     validate_context_auth(pat, user_id, api_url)
 
+    # Context naming
+    default_context_name = 'default'
+    click.echo('\n> Let\'s save these credentials to a new context.')
+    click.echo('> You can have multiple contexts to easily switch between accounts or projects.\n')
+    context_name = click.prompt("Enter a name for this context", default=default_context_name)
+
+    # Save context
     context = Context(
-        name,
+        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.contexts[context_name] = context
+    ctx.obj.current_context = context_name
     ctx.obj.to_yaml()
-    logger.info(
-        f"Login successful and Configuration saved successfully for context '{context.name}'"
-    )
+    click.secho('✅ Success! You are now logged in.', fg='green')
+    click.echo(f'Credentials saved to the \'{context_name}\' context.\n')
+    click.echo('💡 To switch contexts later, use `clarifai config use-context <name>`.')
+
+    logger.info(f"Login successful for user '{user_id}' in context '{context_name}'")
 
 
 def pat_display(pat):
@@ -110,7 +122,7 @@ def input_or_default(prompt, default):
 
 
 # Context management commands under config group
-@config.command(aliases=['get-contexts', 'list-contexts'])
+@config.command(aliases=['get-contexts', 'list-contexts', 'ls'])
 @click.option(
     '-o', '--output-format', default='wide', type=click.Choice(['wide', 'name', 'json', 'yaml'])
 )
@@ -149,7 +161,7 @@ def get_contexts(ctx, output_format):
             print(yaml.safe_dump(dicts))
 
 
-@config.command(aliases=['use-context'])
+@config.command(aliases=['use-context', 'use'])
 @click.argument('name', type=str)
 @click.pass_context
 def use_context(ctx, name):
@@ -161,7 +173,7 @@ def use_context(ctx, name):
     print(f'Set {name} as the current context')
 
 
-@config.command(aliases=['current-context'])
+@config.command(aliases=['current-context', 'current'])
 @click.option('-o', '--output-format', default='name', type=click.Choice(['name', 'json', 'yaml']))
 @click.pass_context
 def current_context(ctx, output_format):
@@ -174,7 +186,7 @@ def current_context(ctx, output_format):
         print(yaml.safe_dump(ctx.obj.contexts[ctx.obj.current_context].to_serializable_dict()))
 
 
-@config.command(aliases=['create-context', 'set-context'])
+@config.command(aliases=['create-context', 'create'])
 @click.argument('name')
 @click.option('--user-id', required=False, help='User ID')
 @click.option('--base-url', required=False, help='Base URL')
@@ -221,7 +233,7 @@ def edit(
     os.system(f'{os.environ.get("EDITOR", "vi")} {ctx.obj.filename}')
 
 
-@config.command(aliases=['delete-context'])
+@config.command(aliases=['delete-context', 'delete'])
 @click.argument('name')
 @click.pass_context
 def delete_context(ctx, name):

clarifai/cli/model.py

@@ -9,6 +9,7 @@ from clarifai.utils.cli import (
     check_ollama_installed,
     check_requirements_installed,
     customize_ollama_model,
+    parse_requirements,
     validate_context,
 )
 from clarifai.utils.constants import (
@@ -83,7 +84,14 @@ def model():
     required=False,
 )
 def init(
-    model_path, model_type_id, github_pat, github_url, toolkit, model_name, port, context_length
+    model_path,
+    model_type_id,
+    github_pat,
+    github_url,
+    toolkit,
+    model_name,
+    port,
+    context_length,
 ):
     """Initialize a new model directory structure.
 
@@ -99,6 +107,13 @@ def init(
     branch to clone from.
 
     MODEL_PATH: Path where to create the model directory structure. If not specified, the current directory is used by default.
+    MODEL_TYPE_ID: Type of model to create. If not specified, defaults to "text-to-text" for text models.
+    GITHUB_PAT: GitHub Personal Access Token for authentication when cloning private repositories.
+    GITHUB_URL: GitHub repository URL or "repo" format to clone a repository from. If provided, the entire repository contents will be copied to the target directory instead of using default templates.
+    TOOLKIT: Toolkit to use for model initialization. Currently supports "ollama".
+    MODEL_NAME: Model name to configure when using --toolkit. For ollama toolkit, this sets the Ollama model to use (e.g., "llama3.1", "mistral", etc.).
+    PORT: Port to run the Ollama server on. Defaults to 23333.
+    CONTEXT_LENGTH: Context length for the Ollama model. Defaults to 8192.
     """
     # Resolve the absolute path
     model_path = os.path.abspath(model_path)
@@ -509,8 +524,13 @@ def run_locally(model_path, port, mode, keep_env, keep_image, skip_dockerfile=Fa
     show_default=True,
     help="The number of threads to use. On community plan, the compute time allocation is drained at a rate proportional to the number of threads.",
 )  # pylint: disable=range-builtin-not-iterating
+@click.option(
+    '--verbose',
+    is_flag=True,
+    help='Show detailed logs including Ollama server output. By default, Ollama logs are suppressed.',
+)
 @click.pass_context
-def local_runner(ctx, model_path, pool_size):
+def local_runner(ctx, model_path, pool_size, verbose):
     """Run the model as a local runner to help debug your model connected to the API or to
     leverage local compute resources manually. This relies on many variables being present in the env
     of the currently selected context. If they are not present then default values will be used to
@@ -552,7 +572,23 @@ def local_runner(ctx, model_path, pool_size):
     from clarifai.runners.server import serve
 
     validate_context(ctx)
-    logger.info("Checking setup for local runner...")
+    builder = ModelBuilder(model_path, download_validation_only=True)
+    logger.info("> Checking local runner requirements...")
+    if not check_requirements_installed(model_path):
+        logger.error(f"Requirements not installed for model at {model_path}.")
+        raise click.Abort()
+
+    # Post check while running `clarifai model local-runner` we check if the toolkit is ollama
+    dependencies = parse_requirements(model_path)
+    if "ollama" in dependencies or builder.config.get('toolkit', {}).get('provider') == 'ollama':
+        logger.info("Verifying Ollama installation...")
+        if not check_ollama_installed():
+            logger.error(
+                "Ollama application is not installed. Please install it from `https://ollama.com/` to use the Ollama toolkit."
+            )
+            raise click.Abort()
+
+    logger.info("> Verifying local runner setup...")
     logger.info(f"Current context: {ctx.obj.current.name}")
     user_id = ctx.obj.current.user_id
     logger.info(f"Current user_id: {user_id}")
@@ -693,8 +729,12 @@ def local_runner(ctx, model_path, pool_size):
     if len(model_versions) == 0:
         logger.warning("No model versions found. Creating a new version for local runner.")
         version = model.create_version(pretrained_model_config={"local_dev": True}).model_version
+        ctx.obj.current.CLARIFAI_MODEL_VERSION_ID = version.id
+        ctx.obj.to_yaml()
     else:
         version = model_versions[0].model_version
+        ctx.obj.current.CLARIFAI_MODEL_VERSION_ID = version.id
+        ctx.obj.to_yaml()  # save to yaml file.
 
     logger.info(f"Current model version {version.id}")
 
@@ -796,10 +836,6 @@ def local_runner(ctx, model_path, pool_size):
 
     logger.info(f"Current deployment_id: {deployment_id}")
 
-    logger.info(
-        f"Full url for the model:\n{ctx.obj.current.ui}/users/{user_id}/apps/{app_id}/models/{model.id}/versions/{version.id}"
-    )
-
     # Now that we have all the context in ctx.obj, we need to update the config.yaml in
     # the model_path directory with the model object containing user_id, app_id, model_id, version_id
     config_file = os.path.join(model_path, 'config.yaml')
@@ -837,6 +873,16 @@ def local_runner(ctx, model_path, pool_size):
             )
             raise click.Abort()
 
+        try:
+            logger.info("Customizing Ollama model with provided parameters...")
+            customize_ollama_model(
+                model_path=model_path,
+                verbose=True if verbose else False,
+            )
+        except Exception as e:
+            logger.error(f"Failed to customize Ollama model: {e}")
+            raise click.Abort()
+
     # don't mock for local runner since you need the dependencies to run the code anyways.
     method_signatures = builder.get_method_signatures(mocking=False)
 
@@ -861,7 +907,7 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
         f"Playground: To chat with your model, visit:\n{ctx.obj.current.ui}/playground?model={model.id}__{version.id}&user_id={user_id}&app_id={app_id}"
     )
 
-    logger.info("Now starting the local runner...")
+    logger.info("✅ Starting local runner...")
 
     # This reads the config.yaml from the model_path so we alter it above first.
     serve(
@@ -874,6 +920,7 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
         runner_id=runner_id,
         base_url=ctx.obj.current.api_base,
         pat=ctx.obj.current.pat,
+        context=ctx.obj.current,
     )
 
 

clarifai/cli/pipeline.py

@@ -4,15 +4,24 @@ import shutil
 import click
 
 from clarifai.cli.base import cli
+from clarifai.client.app import App
+from clarifai.client.user import User
+from clarifai.utils.cli import (
+    AliasedGroup,
+    convert_timestamp_to_string,
+    display_co_resources,
+    validate_context,
+)
 from clarifai.utils.logging import logger
 
 
 @cli.group(
     ['pipeline', 'pl'],
+    cls=AliasedGroup,
     context_settings={'max_content_width': shutil.get_terminal_size().columns - 10},
 )
 def pipeline():
-    """Manage pipelines: upload, init, etc"""
+    """Manage pipelines: upload, init, list, etc"""
 
 
 @pipeline.command()
@@ -113,6 +122,19 @@ def run(
         monitor_interval = config_data.get('monitor_interval', monitor_interval)
         log_file = config_data.get('log_file', log_file)
         monitor = config_data.get('monitor', monitor)
+    elif ctx.obj.current:
+        if not user_id:
+            user_id = ctx.obj.current.get('user_id', '')
+        if not app_id:
+            app_id = ctx.obj.current.get('app_id', '')
+        if not pipeline_id:
+            pipeline_id = ctx.obj.current.get('pipeline_id', '')
+        if not pipeline_version_id:
+            pipeline_version_id = ctx.obj.current.get('pipeline_version_id', '')
+        if not nodepool_id:
+            nodepool_id = ctx.obj.current.get('nodepool_id', '')
+        if not compute_cluster_id:
+            compute_cluster_id = ctx.obj.current.get('compute_cluster_id', '')
 
     # compute_cluster_id and nodepool_id are mandatory regardless of whether pipeline_url is provided
     if not compute_cluster_id or not nodepool_id:
@@ -275,3 +297,50 @@ def init(pipeline_path):
     )
     logger.info("4. Add dependencies to requirements.txt files as needed")
     logger.info("5. Run 'clarifai pipeline upload config.yaml' to upload your pipeline")
+
+
+@pipeline.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.option(
+    '--app_id',
+    required=False,
+    help='App ID to list pipelines from. If not provided, lists across all apps.',
+)
+@click.pass_context
+def list(ctx, page_no, per_page, app_id):
+    """List all pipelines for the user."""
+    validate_context(ctx)
+
+    if app_id:
+        app = App(
+            app_id=app_id,
+            user_id=ctx.obj.current.user_id,
+            pat=ctx.obj.current.pat,
+            base_url=ctx.obj.current.api_base,
+        )
+        response = app.list_pipelines(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,
+        )
+        response = user.list_pipelines(page_no=page_no, per_page=per_page)
+
+    display_co_resources(
+        response,
+        custom_columns={
+            'ID': lambda p: getattr(p, 'pipeline_id', ''),
+            'USER_ID': lambda p: getattr(p, 'user_id', ''),
+            'APP_ID': lambda p: getattr(p, 'app_id', ''),
+            'VERSION_ID': lambda p: getattr(p, 'pipeline_version_id', ''),
+            'DESCRIPTION': lambda p: getattr(p, 'description', ''),
+            'CREATED_AT': lambda ps: convert_timestamp_to_string(getattr(ps, 'created_at', '')),
+            'MODIFIED_AT': lambda ps: convert_timestamp_to_string(getattr(ps, 'modified_at', '')),
+        },
+        sort_by_columns=[
+            ('CREATED_AT', 'desc'),
+            ('ID', 'asc'),
+        ],
+    )

clarifai/cli/pipeline_step.py

@@ -4,15 +4,24 @@ import shutil
 import click
 
 from clarifai.cli.base import cli
+from clarifai.client.app import App
+from clarifai.client.user import User
+from clarifai.utils.cli import (
+    AliasedGroup,
+    convert_timestamp_to_string,
+    display_co_resources,
+    validate_context,
+)
 from clarifai.utils.logging import logger
 
 
 @cli.group(
     ['pipelinestep', 'ps'],
+    cls=AliasedGroup,
     context_settings={'max_content_width': shutil.get_terminal_size().columns - 10},
 )
 def pipeline_step():
-    """Manage pipeline steps: upload, test, etc"""
+    """Manage pipeline steps: upload, test, list, etc"""
 
 
 @pipeline_step.command()
@@ -102,3 +111,60 @@ def init(pipeline_step_path):
     logger.info("2. Update the pipeline step configuration in config.yaml")
     logger.info("3. Add your pipeline step dependencies to requirements.txt")
     logger.info("4. Implement your pipeline step logic in 1/pipeline_step.py")
+
+
+@pipeline_step.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.option(
+    '--app_id',
+    required=False,
+    help='App ID to list pipeline steps from. If not provided, lists across all apps.',
+)
+@click.option(
+    '--pipeline_id',
+    required=False,
+    help='Pipeline ID to list pipeline steps from. Must be used with --app_id.',
+)
+@click.pass_context
+def list(ctx, page_no, per_page, app_id, pipeline_id):
+    """List all pipeline steps for the user."""
+    validate_context(ctx)
+
+    if pipeline_id and not app_id:
+        raise click.UsageError("--pipeline_id must be used together with --app_id")
+
+    if app_id:
+        app = App(
+            app_id=app_id,
+            user_id=ctx.obj.current.user_id,
+            pat=ctx.obj.current.pat,
+            base_url=ctx.obj.current.api_base,
+        )
+        response = app.list_pipeline_steps(
+            pipeline_id=pipeline_id, 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,
+        )
+        response = user.list_pipeline_steps(page_no=page_no, per_page=per_page)
+
+    display_co_resources(
+        response,
+        custom_columns={
+            'PIPELINE_STEP_ID': lambda ps: getattr(ps, 'pipeline_step_id', ''),
+            'USER_ID': lambda ps: getattr(ps, 'user_id', ''),
+            'APP_ID': lambda ps: getattr(ps, 'app_id', ''),
+            'VERSION_ID': lambda ps: getattr(ps, 'pipeline_step_version_id', ''),
+            'DESCRIPTION': lambda ps: getattr(ps, 'description', ''),
+            'CREATED_AT': lambda ps: convert_timestamp_to_string(getattr(ps, 'created_at', '')),
+            'MODIFIED_AT': lambda ps: convert_timestamp_to_string(getattr(ps, 'modified_at', '')),
+        },
+        sort_by_columns=[
+            ('CREATED_AT', 'desc'),
+            ('PIPELINE_STEP_ID', 'asc'),
+        ],
+    )

clarifai/cli/templates/pipeline_step_templates.py

@@ -35,7 +35,7 @@ def get_pipeline_step_template():
     return '''import argparse
 
 import clarifai
-
+from clarifai.utils.logging import logger
 
 def main():
     parser = argparse.ArgumentParser(description='Concatenate two strings.')
@@ -44,9 +44,9 @@ def main():
 
     args = parser.parse_args()
 
-    print(clarifai.__version__)
+    logger.info(clarifai.__version__)
 
-    print(f"Concatenation Output: {args.param_a + args.param_b}")
+    logger.info(f"Concatenation Output: {args.param_a + args.param_b}")
 
 
 if __name__ == "__main__":

clarifai/cli/templates/pipeline_templates.py

@@ -25,12 +25,12 @@ def get_pipeline_config_template():
           steps:
           - - name: step-a
               templateRef:
-                name: users/your_user_id/apps/your_app_id/pipeline-steps/stepA  # TODO: please fill in
-                template: users/your_user_id/apps/your_app_id/pipeline-steps/stepA  # TODO: please fill in
+                name: users/your_user_id/apps/your_app_id/pipeline_steps/stepA  # TODO: please fill in
+                template: users/your_user_id/apps/your_app_id/pipeline_steps/stepA  # TODO: please fill in
           - - name: step-b
               templateRef:
-                name: users/your_user_id/apps/your_app_id/pipeline-steps/stepB  # TODO: please fill in
-                template: users/your_user_id/apps/your_app_id/pipeline-steps/stepB  # TODO: please fill in
+                name: users/your_user_id/apps/your_app_id/pipeline_steps/stepB  # TODO: please fill in
+                template: users/your_user_id/apps/your_app_id/pipeline_steps/stepB  # TODO: please fill in
 """
 
 
@@ -60,7 +60,7 @@ def get_pipeline_step_template(step_id: str):
     return f'''import argparse
 
 import clarifai
-
+from clarifai.utils.logging import logger
 
 def main():
     parser = argparse.ArgumentParser(description='{step_id} processing step.')
@@ -68,10 +68,10 @@ def main():
 
     args = parser.parse_args()
 
-    print(clarifai.__version__)
+    logger.info(clarifai.__version__)
 
     # TODO: Implement your pipeline step logic here
-    print(f"{step_id} processed: {{args.input_text}}")
+    logger.info(f"{step_id} processed: {{args.input_text}}")
 
 
 if __name__ == "__main__":

clarifai/client/__init__.py

@@ -8,6 +8,7 @@ from clarifai.client.lister import Lister
 from clarifai.client.model import Model
 from clarifai.client.module import Module
 from clarifai.client.pipeline import Pipeline
+from clarifai.client.pipeline_step import PipelineStep
 from clarifai.client.search import Search
 from clarifai.client.user import User
 from clarifai.client.workflow import Workflow
@@ -20,6 +21,7 @@ __all__ = [
     'Model',
     'Workflow',
     'Pipeline',
+    'PipelineStep',
     'Module',
     'Lister',
     'Dataset',