clarifai 11.6.0__tar.gz → 11.6.2__tar.gz

{clarifai-11.6.0/clarifai.egg-info → clarifai-11.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clarifai
-Version: 11.6.0
+Version: 11.6.2
 Home-page: https://github.com/Clarifai/clarifai-python
 Author: Clarifai
 Author-email: support@clarifai.com
@@ -19,7 +19,7 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: clarifai-grpc>=11.5.5
+Requires-Dist: clarifai-grpc>=11.6.0
 Requires-Dist: clarifai-protocol>=0.0.25
 Requires-Dist: numpy>=1.22.0
 Requires-Dist: tqdm>=4.65.0

clarifai-11.6.2/clarifai/__init__.py

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

{clarifai-11.6.0 → clarifai-11.6.2}/clarifai/cli/base.py

@@ -6,6 +6,7 @@ import sys
 import click
 import yaml
 
+from clarifai import __version__
 from clarifai.utils.cli import AliasedGroup, TableFormatter, load_command_modules
 from clarifai.utils.config import Config, Context
 from clarifai.utils.constants import DEFAULT_BASE, DEFAULT_CONFIG, DEFAULT_UI
@@ -14,6 +15,7 @@ from clarifai.utils.logging import logger
 
 # @click.group(cls=CustomMultiGroup)
 @click.group(cls=AliasedGroup)
+@click.version_option(version=__version__)
 @click.option('--config', default=DEFAULT_CONFIG)
 @click.pass_context
 def cli(ctx, config):

{clarifai-11.6.0 → clarifai-11.6.2}/clarifai/cli/model.py

@@ -1,5 +1,6 @@
 import os
 import shutil
+import tempfile
 
 import click
 
@@ -16,13 +17,19 @@ from clarifai.utils.constants import (
     DEFAULT_LOCAL_DEV_NODEPOOL_ID,
 )
 from clarifai.utils.logging import logger
+from clarifai.utils.misc import (
+    clone_github_repo,
+    format_github_repo_url,
+)
 
 
 @cli.group(
     ['model'], context_settings={'max_content_width': shutil.get_terminal_size().columns - 10}
 )
 def model():
-    """Manage models: upload, test, local dev, predict, etc"""
+    """Manage & Develop Models: init, download-checkpoints, signatures, upload\n
+    Run & Test Models Locally: local-runner, local-grpc, local-test\n
+    Model Inference: list, predict"""
 
 
 @model.command()
@@ -38,7 +45,22 @@ def model():
     required=False,
     help='Model type: "mcp" for MCPModelClass, "openai" for OpenAIModelClass, or leave empty for default ModelClass.',
 )
-def init(model_path, model_type_id):
+@click.option(
+    '--github-pat',
+    required=False,
+    help='GitHub Personal Access Token for authentication when cloning private repositories.',
+)
+@click.option(
+    '--github-repo',
+    required=False,
+    help='GitHub repository URL or "user/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.',
+)
+@click.option(
+    '--branch',
+    required=False,
+    help='Git branch to clone from the GitHub repository. If not specified, the default branch will be used.',
+)
+def init(model_path, model_type_id, github_pat, github_repo, branch):
     """Initialize a new model directory structure.
 
     Creates the following structure in the specified directory:
@@ -47,65 +69,113 @@ def init(model_path, model_type_id):
     ├── requirements.txt
     └── config.yaml
 
+    If --github-repo is provided, the entire repository contents will be copied to the target
+    directory instead of using default templates. The --github-pat option can be used for authentication
+    when cloning private repositories. The --branch option can be used to specify a specific
+    branch to clone from.
+
     MODEL_PATH: Path where to create the model directory structure. If not specified, the current directory is used by default.
     """
-    from clarifai.cli.templates.model_templates import (
-        get_config_template,
-        get_model_template,
-        get_requirements_template,
-    )
-
     # Resolve the absolute path
     model_path = os.path.abspath(model_path)
 
     # Create the model directory if it doesn't exist
     os.makedirs(model_path, exist_ok=True)
 
-    # Create the 1/ subdirectory
-    model_version_dir = os.path.join(model_path, "1")
-    os.makedirs(model_version_dir, exist_ok=True)
-
-    # Create model.py
-    model_py_path = os.path.join(model_version_dir, "model.py")
-    if os.path.exists(model_py_path):
-        logger.warning(f"File {model_py_path} already exists, skipping...")
-    else:
-        model_template = get_model_template(model_type_id)
-        with open(model_py_path, 'w') as f:
-            f.write(model_template)
-        logger.info(f"Created {model_py_path}")
-
-    # Create requirements.txt
-    requirements_path = os.path.join(model_path, "requirements.txt")
-    if os.path.exists(requirements_path):
-        logger.warning(f"File {requirements_path} already exists, skipping...")
-    else:
-        requirements_template = get_requirements_template(model_type_id)
-        with open(requirements_path, 'w') as f:
-            f.write(requirements_template)
-        logger.info(f"Created {requirements_path}")
-
-    # Create config.yaml
-    config_path = os.path.join(model_path, "config.yaml")
-    if os.path.exists(config_path):
-        logger.warning(f"File {config_path} already exists, skipping...")
-    else:
-        config_model_type_id = "text-to-text"  # default
-
-        config_template = get_config_template(config_model_type_id)
-        with open(config_path, 'w') as f:
-            f.write(config_template)
-        logger.info(f"Created {config_path}")
-
-    logger.info(f"Model initialization complete in {model_path}")
-    logger.info("Next steps:")
-    logger.info("1. Search for '# TODO: please fill in' comments in the generated files")
-    logger.info("2. Update the model configuration in config.yaml")
-    logger.info("3. Add your model dependencies to requirements.txt")
-    logger.info("4. Implement your model logic in 1/model.py")
-
+    # Handle GitHub repository cloning if provided
+    if github_repo:
+        logger.info(f"Initializing model from GitHub repository: {github_repo}")
+
+        # Check if it's a local path or normalize the GitHub repo URL
+        if os.path.exists(github_repo):
+            repo_url = github_repo
+        else:
+            repo_url = format_github_repo_url(github_repo)
+
+        # Create a temporary directory for cloning
+        with tempfile.TemporaryDirectory() as temp_dir:
+            clone_dir = os.path.join(temp_dir, "repo")
+
+            # Clone the repository
+            if not clone_github_repo(repo_url, clone_dir, github_pat, branch):
+                logger.error(
+                    "Failed to clone repository. Falling back to template-based initialization."
+                )
+                github_repo = None  # Fall back to template mode
+            else:
+                # Copy the entire repository content to target directory (excluding .git)
+                for item in os.listdir(clone_dir):
+                    if item == '.git':
+                        continue
+
+                    source_path = os.path.join(clone_dir, item)
+                    target_path = os.path.join(model_path, item)
+
+                    if os.path.isdir(source_path):
+                        shutil.copytree(source_path, target_path, dirs_exist_ok=True)
+                    else:
+                        shutil.copy2(source_path, target_path)
+
+                logger.info("Model initialization complete with GitHub repository")
+                logger.info("Next steps:")
+                logger.info("1. Review the model configuration")
+                logger.info("2. Install any required dependencies manually")
+                logger.info("3. Test the model locally using 'clarifai model local-test'")
+                return
+
+    # Fall back to template-based initialization if no GitHub repo or if GitHub repo failed
+    if not github_repo:
+        from clarifai.cli.templates.model_templates import (
+            get_config_template,
+            get_model_template,
+            get_requirements_template,
+        )
 
-@model.command()
+        # Create the 1/ subdirectory
+        model_version_dir = os.path.join(model_path, "1")
+        os.makedirs(model_version_dir, exist_ok=True)
+
+        # Create model.py
+        model_py_path = os.path.join(model_version_dir, "model.py")
+        if os.path.exists(model_py_path):
+            logger.warning(f"File {model_py_path} already exists, skipping...")
+        else:
+            model_template = get_model_template(model_type_id)
+            with open(model_py_path, 'w') as f:
+                f.write(model_template)
+            logger.info(f"Created {model_py_path}")
+
+        # Create requirements.txt
+        requirements_path = os.path.join(model_path, "requirements.txt")
+        if os.path.exists(requirements_path):
+            logger.warning(f"File {requirements_path} already exists, skipping...")
+        else:
+            requirements_template = get_requirements_template(model_type_id)
+            with open(requirements_path, 'w') as f:
+                f.write(requirements_template)
+            logger.info(f"Created {requirements_path}")
+
+        # Create config.yaml
+        config_path = os.path.join(model_path, "config.yaml")
+        if os.path.exists(config_path):
+            logger.warning(f"File {config_path} already exists, skipping...")
+        else:
+            config_model_type_id = "text-to-text"  # default
+
+            config_template = get_config_template(config_model_type_id)
+            with open(config_path, 'w') as f:
+                f.write(config_template)
+            logger.info(f"Created {config_path}")
+
+        logger.info(f"Model initialization complete in {model_path}")
+        logger.info("Next steps:")
+        logger.info("1. Search for '# TODO: please fill in' comments in the generated files")
+        logger.info("2. Update the model configuration in config.yaml")
+        logger.info("3. Add your model dependencies to requirements.txt")
+        logger.info("4. Implement your model logic in 1/model.py")
+
+
+@model.command(help="Upload a trained model.")
 @click.argument("model_path", type=click.Path(exists=True), required=False, default=".")
 @click.option(
     '--stage',
@@ -138,7 +208,7 @@ def upload(ctx, model_path, stage, skip_dockerfile):
     )
 
 
-@model.command()
+@model.command(help="Download model checkpoint files.")
 @click.argument(
     "model_path",
     type=click.Path(exists=True),
@@ -172,7 +242,7 @@ def download_checkpoints(model_path, out_path, stage):
     builder.download_checkpoints(stage=stage, checkpoint_path_override=out_path)
 
 
-@model.command()
+@model.command(help="Generate model method signatures.")
 @click.argument(
     "model_path",
     type=click.Path(exists=True),
@@ -203,7 +273,7 @@ def signatures(model_path, out_path):
         click.echo(signatures)
 
 
-@model.command()
+@model.command(name="local-test", help="Execute all model unit tests locally.")
 @click.argument(
     "model_path",
     type=click.Path(exists=True),
@@ -262,7 +332,7 @@ def test_locally(model_path, keep_env=False, keep_image=False, mode='env', skip_
         click.echo(f"Failed to test model locally: {e}", err=True)
 
 
-@model.command()
+@model.command(name="local-grpc", help="Run the model locally via a gRPC server.")
 @click.argument(
     "model_path",
     type=click.Path(exists=True),
@@ -330,7 +400,7 @@ def run_locally(model_path, port, mode, keep_env, keep_image, skip_dockerfile=Fa
         click.echo(f"Failed to starts model server locally: {e}", err=True)
 
 
-@model.command()
+@model.command(name="local-runner", help="Run the model locally for dev, debug, or local compute.")
 @click.argument(
     "model_path",
     type=click.Path(exists=True),
@@ -494,7 +564,13 @@ def local_dev(ctx, model_path):
         )
         if y.lower() != 'y':
             raise click.Abort()
-        model = app.create_model(model_id, model_type_id=DEFAULT_LOCAL_DEV_MODEL_TYPE)
+        try:
+            model_type_id = ctx.obj.current.model_type_id
+        except AttributeError:
+            model_type_id = DEFAULT_LOCAL_DEV_MODEL_TYPE
+
+        model = app.create_model(model_id, model_type_id=model_type_id)
+        ctx.obj.current.CLARIFAI_MODEL_TYPE_ID = model_type_id
         ctx.obj.current.CLARIFAI_MODEL_ID = model_id
         ctx.obj.to_yaml()  # save to yaml file.
 
@@ -613,6 +689,7 @@ def local_dev(ctx, model_path):
             f"config.yaml not found in {model_path}. Please ensure you are passing the correct directory."
         )
     config = ModelBuilder._load_config(config_file)
+    model_type_id = config.get('model', {}).get('model_type_id', DEFAULT_LOCAL_DEV_MODEL_TYPE)
     # The config.yaml doens't match what we created above.
     if 'model' in config and model_id != config['model'].get('id'):
         logger.info(f"Current model section of config.yaml: {config.get('model', {})}")
@@ -622,7 +699,7 @@ def local_dev(ctx, model_path):
         if y.lower() != 'y':
             raise click.Abort()
         config = ModelBuilder._set_local_dev_model(
-            config, user_id, app_id, model_id, DEFAULT_LOCAL_DEV_MODEL_TYPE
+            config, user_id, app_id, model_id, model_type_id
         )
         ModelBuilder._backup_config(config_file)
         ModelBuilder._save_config(config_file, config)
@@ -663,7 +740,7 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
     )
 
 
-@model.command()
+@model.command(help="Perform a prediction using the model.")
 @click.option(
     '--config',
     type=click.Path(exists=True),
@@ -845,7 +922,7 @@ def predict(
 )
 @click.pass_context
 def list_model(ctx, user_id, app_id):
-    """List models of user/community
+    """List models of user/community.
 
     USER_ID: User id. If not specified, the current user is used by default. Set "all" to get all public models in Clarifai platform.
     """

{clarifai-11.6.0 → clarifai-11.6.2}/clarifai/cli/pipeline_step.py

@@ -8,7 +8,7 @@ from clarifai.utils.logging import logger
 
 
 @cli.group(
-    ['pipelinestep'],
+    ['pipelinestep', 'ps'],
     context_settings={'max_content_width': shutil.get_terminal_size().columns - 10},
 )
 def pipeline_step():

{clarifai-11.6.0 → clarifai-11.6.2}/clarifai/client/model.py

@@ -66,6 +66,7 @@ class Model(Lister, BaseClient):
         compute_cluster_id: str = None,
         nodepool_id: str = None,
         deployment_id: str = None,
+        deployment_user_id: str = None,
         **kwargs,
     ):
         """Initializes a Model object.
@@ -78,6 +79,10 @@ class Model(Lister, BaseClient):
             pat (str): A personal access token for authentication. Can be set as env var CLARIFAI_PAT
             token (str): A session token for authentication. Accepts either a session token or a pat. Can be set as env var CLARIFAI_SESSION_TOKEN
             root_certificates_path (str): Path to the SSL root certificates file, used to establish secure gRPC connections.
+            compute_cluster_id (str): Compute cluster ID for runner selector.
+            nodepool_id (str): Nodepool ID for runner selector.
+            deployment_id (str): Deployment ID for runner selector.
+            deployment_user_id (str): User ID to use for runner selector (organization or user). If not provided, defaults to PAT owner user_id.
             **kwargs: Additional keyword arguments to be passed to the Model.
         """
         if url and model_id:
@@ -115,10 +120,13 @@ class Model(Lister, BaseClient):
         )
         Lister.__init__(self)
 
+        self.deployment_user_id = deployment_user_id
+
         self._set_runner_selector(
             compute_cluster_id=compute_cluster_id,
             nodepool_id=nodepool_id,
             deployment_id=deployment_id,
+            deployment_user_id=deployment_user_id,
         )
 
     @classmethod
@@ -633,9 +641,13 @@ class Model(Lister, BaseClient):
         compute_cluster_id: str = None,
         nodepool_id: str = None,
         deployment_id: str = None,
+        deployment_user_id: str = None,
     ):
-        # Get UserID
-        if any([deployment_id, nodepool_id, compute_cluster_id]):
+        # Get UserID for runner selector
+        user_id = None
+        if deployment_user_id:
+            user_id = deployment_user_id
+        elif any([deployment_id, nodepool_id, compute_cluster_id]):
             from clarifai.client.user import User
 
             user_id = (
@@ -643,13 +655,11 @@ class Model(Lister, BaseClient):
                 .get_user_info(user_id='me')
                 .user.id
             )
-
         runner_selector = None
         if deployment_id and (compute_cluster_id or nodepool_id):
             raise UserError(
                 "You can only specify one of deployment_id or compute_cluster_id and nodepool_id."
             )
-
         if deployment_id:
             runner_selector = Deployment.get_runner_selector(
                 user_id=user_id, deployment_id=deployment_id
@@ -658,7 +668,6 @@ class Model(Lister, BaseClient):
             runner_selector = Nodepool.get_runner_selector(
                 user_id=user_id, compute_cluster_id=compute_cluster_id, nodepool_id=nodepool_id
             )
-
         # set the runner selector
         self._runner_selector = runner_selector
 

{clarifai-11.6.0 → clarifai-11.6.2}/clarifai/runners/utils/code_script.py

@@ -127,7 +127,7 @@ from clarifai.runners.utils import data_types
 
     base_url_str = ""
     if base_url is not None:
-        base_url_str = f"base_url={base_url},"
+        base_url_str = f"base_url='{base_url}',"
 
     # Join all non-empty lines
     optional_lines = "\n    ".join(
@@ -321,7 +321,10 @@ def _set_default_value(field_type):
         default_value = f"{{{', '.join([str(et) for et in element_type_defaults])}}}"
 
     if is_iterator:
-        default_value = f'iter([{default_value}])'
+        if field_type == "str":
+            default_value = f"iter(['{default_value}'])"
+        else:
+            default_value = f"iter([{default_value}])"
     return default_value
 
 

{clarifai-11.6.0 → clarifai-11.6.2}/clarifai/utils/constants.py

@@ -1,4 +1,5 @@
 import os
+from pathlib import Path
 
 DEFAULT_UI = os.environ.get("CLARIFAI_UI", "https://clarifai.com")
 DEFAULT_BASE = os.environ.get("CLARIFAI_API_BASE", "https://api.clarifai.com")
@@ -10,7 +11,8 @@ CLARIFAI_PAT_ENV_VAR = "CLARIFAI_PAT"
 CLARIFAI_SESSION_TOKEN_ENV_VAR = "CLARIFAI_SESSION_TOKEN"
 CLARIFAI_USER_ID_ENV_VAR = "CLARIFAI_USER_ID"
 
-DEFAULT_CONFIG = f'{os.environ["HOME"]}/.config/clarifai/config'
+HOME_PATH = Path.home()
+DEFAULT_CONFIG = HOME_PATH / '.config/clarifai/config'
 
 # Default clusters, etc. for local dev runner easy setup
 DEFAULT_LOCAL_DEV_COMPUTE_CLUSTER_ID = "local-dev-compute-cluster"
@@ -45,7 +47,7 @@ DEFAULT_LOCAL_DEV_NODEPOOL_CONFIG = {
         },
         "instance_types": [
             {
-                "id": "local-cpu",
+                "id": "local",
                 "compute_info": {
                     "cpu_limit": str(os.cpu_count()),
                     "cpu_memory": "16Gi",  # made up as we don't schedule based on this for local dev.

{clarifai-11.6.0 → clarifai-11.6.2}/clarifai/utils/misc.py

@@ -1,11 +1,16 @@
 import os
 import re
+import shutil
+import subprocess
+import urllib.parse
 import uuid
 from typing import Any, Dict, List
 
 from clarifai_grpc.grpc.api.status import status_code_pb2
 
 from clarifai.errors import UserError
+from clarifai.utils.constants import HOME_PATH
+from clarifai.utils.logging import logger
 
 RETRYABLE_CODES = [
     status_code_pb2.MODEL_DEPLOYING,
@@ -13,7 +18,7 @@ RETRYABLE_CODES = [
     status_code_pb2.MODEL_BUSY_PLEASE_RETRY,
 ]
 
-DEFAULT_CONFIG = f'{os.environ["HOME"]}/.config/clarifai/config'
+DEFAULT_CONFIG = HOME_PATH / '.config/clarifai/config'
 
 
 def status_is_retryable(status_code: int) -> bool:
@@ -104,3 +109,60 @@ def clean_input_id(input_id: str) -> str:
     input_id = input_id.lower().strip('_-')
     input_id = re.sub('[^a-z0-9-_]+', '', input_id)
     return input_id
+
+
+def format_github_repo_url(github_repo):
+    """Format GitHub repository URL to a standard format."""
+    if github_repo.startswith('http'):
+        return github_repo
+    elif '/' in github_repo and not github_repo.startswith('git@'):
+        # Handle "user/repo" format
+        return f"https://github.com/{github_repo}.git"
+    else:
+        return github_repo
+
+
+def clone_github_repo(repo_url, target_dir, github_pat=None, branch=None):
+    """Clone a GitHub repository with optional GitHub PAT authentication and branch specification."""
+    # Handle local file paths - just copy instead of cloning
+    if os.path.exists(repo_url):
+        try:
+            shutil.copytree(repo_url, target_dir, ignore=shutil.ignore_patterns('.git'))
+            logger.info(f"Successfully copied local repository from {repo_url}")
+            return True
+        except Exception as e:
+            logger.error(f"Failed to copy local repository: {e}")
+            return False
+
+    cmd = ["git", "clone"]
+
+    # Add branch specification if provided
+    if branch:
+        cmd.extend(["-b", branch])
+
+    # Handle authentication with GitHub PAT
+    if github_pat:
+        # Parse the URL and validate the hostname
+        parsed_url = urllib.parse.urlparse(repo_url)
+        if parsed_url.hostname == "github.com":
+            # Insert GitHub PAT into the URL for authentication
+            authenticated_url = f"https://{github_pat}@{parsed_url.netloc}{parsed_url.path}"
+            cmd.append(authenticated_url)
+        else:
+            logger.error(f"Invalid repository URL: {repo_url}")
+            return False
+    else:
+        cmd.append(repo_url)
+
+    cmd.append(target_dir)
+
+    try:
+        result = subprocess.run(cmd, capture_output=True, text=True, check=True)
+        if branch:
+            logger.info(f"Successfully cloned repository from {repo_url} (branch: {branch})")
+        else:
+            logger.info(f"Successfully cloned repository from {repo_url}")
+        return True
+    except subprocess.CalledProcessError as e:
+        logger.error(f"Failed to clone repository: {e.stderr}")
+        return False

{clarifai-11.6.0 → clarifai-11.6.2/clarifai.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clarifai
-Version: 11.6.0
+Version: 11.6.2
 Home-page: https://github.com/Clarifai/clarifai-python
 Author: Clarifai
 Author-email: support@clarifai.com
@@ -19,7 +19,7 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: clarifai-grpc>=11.5.5
+Requires-Dist: clarifai-grpc>=11.6.0
 Requires-Dist: clarifai-protocol>=0.0.25
 Requires-Dist: numpy>=1.22.0
 Requires-Dist: tqdm>=4.65.0

{clarifai-11.6.0 → clarifai-11.6.2}/clarifai.egg-info/requires.txt

@@ -1,4 +1,4 @@
-clarifai-grpc>=11.5.5
+clarifai-grpc>=11.6.0
 clarifai-protocol>=0.0.25
 numpy>=1.22.0
 tqdm>=4.65.0

{clarifai-11.6.0 → clarifai-11.6.2}/requirements.txt

@@ -1,4 +1,4 @@
-clarifai-grpc>=11.5.5
+clarifai-grpc>=11.6.0
 clarifai-protocol>=0.0.25
 numpy>=1.22.0
 tqdm>=4.65.0

clarifai-11.6.0/clarifai/__init__.py

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