clarifai 11.6.6__tar.gz → 11.6.7__tar.gz

{clarifai-11.6.6/clarifai.egg-info → clarifai-11.6.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clarifai
-Version: 11.6.6
+Version: 11.6.7
 Home-page: https://github.com/Clarifai/clarifai-python
 Author: Clarifai
 Author-email: support@clarifai.com

clarifai-11.6.7/clarifai/__init__.py

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

{clarifai-11.6.6 → clarifai-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-11.6.6 → clarifai-11.6.7}/clarifai/cli/base.py

@@ -72,18 +72,18 @@ def login(ctx, api_url, user_id):
     """Login command to set PAT and other configurations."""
     from clarifai.utils.cli import validate_context_auth
 
+    # 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(
-        '> You can create one from your account settings: https://clarifai.com/settings/security\n'
+        f'> You can create one from your account settings: https://clarifai.com/{user_id}/settings/security\n'
     )
 
     # Securely input PAT
     pat = getpass.getpass('Enter your Personal Access Token: ')
 
-    # Input user_id if not supplied
-    if not user_id:
-        user_id = click.prompt('Enter your Clarifai user ID', type=str)
-
     # Progress indicator
     click.echo('\n> Verifying token...')
     validate_context_auth(pat, user_id, api_url)
@@ -122,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'])
 )
@@ -161,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):
@@ -173,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):
@@ -186,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')
@@ -233,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-11.6.6 → clarifai-11.6.7}/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-11.6.6 → clarifai-11.6.7}/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-11.6.6 → clarifai-11.6.7}/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-11.6.6 → clarifai-11.6.7}/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-11.6.6 → clarifai-11.6.7}/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',

{clarifai-11.6.6 → clarifai-11.6.7}/clarifai/client/app.py

@@ -14,6 +14,8 @@ from clarifai.client.input import Inputs
 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.workflow import Workflow
 from clarifai.constants.model import TRAINABLE_MODEL_TYPES
@@ -198,6 +200,151 @@ class App(Lister, BaseClient):
                     continue
             yield Workflow.from_auth_helper(auth=self.auth_helper, **workflow_info)
 
+    def list_pipelines(
+        self,
+        filter_by: Dict[str, Any] = {},
+        only_in_app: bool = True,
+        page_no: int = None,
+        per_page: int = None,
+    ) -> Generator[dict, None, None]:
+        """Lists all the pipelines for the user.
+
+        Args:
+            filter_by (dict): A dictionary of filters to apply to the list of pipelines.
+            only_in_app (bool): If True, only return pipelines that are in the app.
+            page_no (int): The page number to list.
+            per_page (int): The number of items per page.
+
+        Yields:
+            Dict: Dictionaries containing information about the pipelines.
+
+        Example:
+            >>> from clarifai.client.app import App
+            >>> app = App(app_id="app_id", user_id="user_id")
+            >>> all_pipelines = list(app.list_pipelines())
+
+        Note:
+            Defaults to 16 per page if page_no is specified and per_page is not specified.
+            If both page_no and per_page are None, then lists all the resources.
+        """
+        request_data = dict(user_app_id=self.user_app_id, **filter_by)
+        all_pipelines_info = self.list_pages_generator(
+            self.STUB.ListPipelines,
+            service_pb2.ListPipelinesRequest,
+            request_data,
+            per_page=per_page,
+            page_no=page_no,
+        )
+
+        for pipeline_info in all_pipelines_info:
+            pipeline = self._process_pipeline_info(
+                pipeline_info, self.auth_helper, self.id, only_in_app
+            )
+            if pipeline is not None:
+                yield pipeline
+
+    @staticmethod
+    def _process_pipeline_info(pipeline_info, auth_helper, app_id=None, only_in_app=False):
+        """Helper method to process pipeline info and create Pipeline objects.
+
+        Args:
+            pipeline_info: Raw pipeline info from API
+            auth_helper: Auth helper instance
+            app_id: App ID to filter by (if only_in_app is True)
+            only_in_app: Whether to filter by app_id
+
+        Returns:
+            Pipeline object or None if filtered out
+        """
+        if only_in_app and app_id:
+            if pipeline_info.get('app_id') != app_id:
+                return None
+
+        # Map API field names to constructor parameter names
+        pipeline_kwargs = pipeline_info.copy()
+        if 'id' in pipeline_kwargs:
+            pipeline_kwargs['pipeline_id'] = pipeline_kwargs.pop('id')
+        if 'pipeline_version' in pipeline_kwargs:
+            pipeline_version = pipeline_kwargs.pop('pipeline_version')
+            pipeline_kwargs['pipeline_version_id'] = pipeline_version.get('id', '')
+
+        return Pipeline.from_auth_helper(auth=auth_helper, **pipeline_kwargs)
+
+    @staticmethod
+    def _process_pipeline_step_info(
+        pipeline_step_info, auth_helper, app_id=None, only_in_app=False
+    ):
+        """Helper method to process pipeline step info and create PipelineStep objects.
+
+        Args:
+            pipeline_step_info: Raw pipeline step info from API
+            auth_helper: Auth helper instance
+            app_id: App ID to filter by (if only_in_app is True)
+            only_in_app: Whether to filter by app_id
+
+        Returns:
+            PipelineStep object or None if filtered out
+        """
+        if only_in_app and app_id:
+            if pipeline_step_info.get('app_id') != app_id:
+                return None
+
+        # Map API field names to constructor parameter names
+        step_kwargs = pipeline_step_info.copy()
+        if 'pipeline_step' in step_kwargs:
+            pipeline_step = step_kwargs.pop('pipeline_step')
+            step_kwargs['pipeline_step_id'] = pipeline_step.get('id', '')
+
+        return PipelineStep.from_auth_helper(auth=auth_helper, **step_kwargs)
+
+    def list_pipeline_steps(
+        self,
+        pipeline_id: str = None,
+        filter_by: Dict[str, Any] = {},
+        only_in_app: bool = True,
+        page_no: int = None,
+        per_page: int = None,
+    ) -> Generator[dict, None, None]:
+        """Lists all the pipeline steps for the user.
+
+        Args:
+            pipeline_id (str): If provided, only list pipeline steps from this pipeline.
+            filter_by (dict): A dictionary of filters to apply to the list of pipeline steps.
+            only_in_app (bool): If True, only return pipeline steps that are in the app.
+            page_no (int): The page number to list.
+            per_page (int): The number of items per page.
+
+        Yields:
+            Dict: Dictionaries containing information about the pipeline steps.
+
+        Example:
+            >>> from clarifai.client.app import App
+            >>> app = App(app_id="app_id", user_id="user_id")
+            >>> all_pipeline_steps = list(app.list_pipeline_steps())
+
+        Note:
+            Defaults to 16 per page if page_no is specified and per_page is not specified.
+            If both page_no and per_page are None, then lists all the resources.
+        """
+        request_data = dict(user_app_id=self.user_app_id, **filter_by)
+        if pipeline_id:
+            request_data['pipeline_id'] = pipeline_id
+
+        all_pipeline_steps_info = self.list_pages_generator(
+            self.STUB.ListPipelineStepVersions,
+            service_pb2.ListPipelineStepVersionsRequest,
+            request_data,
+            per_page=per_page,
+            page_no=page_no,
+        )
+
+        for pipeline_step_info in all_pipeline_steps_info:
+            pipeline_step = self._process_pipeline_step_info(
+                pipeline_step_info, self.auth_helper, self.id, only_in_app
+            )
+            if pipeline_step is not None:
+                yield pipeline_step
+
     def list_modules(
         self,
         filter_by: Dict[str, Any] = {},

{clarifai-11.6.6 → clarifai-11.6.7}/clarifai/client/nodepool.py

@@ -94,7 +94,9 @@ class Nodepool(Lister, BaseClient):
         ), "worker info not found in the config file"
         assert "scheduling_choice" in deployment, "scheduling_choice not found in the config file"
         assert "nodepools" in deployment, "nodepools not found in the config file"
-        deployment['user_id'] = self.user_app_id.user_id
+        deployment['user_id'] = (
+            deployment['user_id'] if 'user_id' in deployment else self.user_app_id.user_id
+        )
         if "autoscale_config" in deployment:
             deployment['autoscale_config'] = resources_pb2.AutoscaleConfig(
                 **deployment['autoscale_config']
@@ -103,7 +105,10 @@ class Nodepool(Lister, BaseClient):
             resources_pb2.Nodepool(
                 id=nodepool['id'],
                 compute_cluster=resources_pb2.ComputeCluster(
-                    id=nodepool['compute_cluster']['id'], user_id=self.user_app_id.user_id
+                    id=nodepool['compute_cluster']['id'],
+                    user_id=nodepool['compute_cluster']['user_id']
+                    if 'user_id' in nodepool['compute_cluster']
+                    else self.user_app_id.user_id,
                 ),
             )
             for nodepool in deployment['nodepools']