clarifai 11.8.1__tar.gz → 11.8.2__tar.gz

{clarifai-11.8.1/clarifai.egg-info → clarifai-11.8.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clarifai
-Version: 11.8.1
+Version: 11.8.2
 Home-page: https://github.com/Clarifai/clarifai-python
 Author: Clarifai
 Author-email: support@clarifai.com
@@ -19,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.7.9
-Requires-Dist: clarifai-protocol>=0.0.30
+Requires-Dist: clarifai-grpc>=11.8.2
+Requires-Dist: clarifai-protocol>=0.0.32
 Requires-Dist: numpy>=1.22.0
 Requires-Dist: tqdm>=4.65.0
 Requires-Dist: PyYAML>=6.0.1
@@ -34,6 +34,7 @@ Requires-Dist: aiohttp>=3.10.0
 Requires-Dist: uv==0.7.12
 Requires-Dist: ruff==0.11.4
 Requires-Dist: psutil==7.0.0
+Requires-Dist: pygments>=2.19.2
 Requires-Dist: pydantic_core==2.33.2
 Requires-Dist: packaging==25.0
 Provides-Extra: all

clarifai-11.8.2/clarifai/__init__.py

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

{clarifai-11.8.1 → clarifai-11.8.2}/clarifai/cli/model.py

@@ -7,13 +7,18 @@ import click
 
 from clarifai.cli.base import cli, pat_display
 from clarifai.utils.cli import (
+    check_lmstudio_installed,
     check_ollama_installed,
     check_requirements_installed,
+    customize_huggingface_model,
+    customize_lmstudio_model,
     customize_ollama_model,
     parse_requirements,
     validate_context,
 )
 from clarifai.utils.constants import (
+    DEFAULT_HF_MODEL_REPO_BRANCH,
+    DEFAULT_LMSTUDIO_MODEL_REPO_BRANCH,
     DEFAULT_LOCAL_RUNNER_APP_ID,
     DEFAULT_LOCAL_RUNNER_COMPUTE_CLUSTER_CONFIG,
     DEFAULT_LOCAL_RUNNER_COMPUTE_CLUSTER_ID,
@@ -22,8 +27,9 @@ from clarifai.utils.constants import (
     DEFAULT_LOCAL_RUNNER_MODEL_TYPE,
     DEFAULT_LOCAL_RUNNER_NODEPOOL_CONFIG,
     DEFAULT_LOCAL_RUNNER_NODEPOOL_ID,
-    DEFAULT_OLLAMA_MODEL_REPO,
     DEFAULT_OLLAMA_MODEL_REPO_BRANCH,
+    DEFAULT_TOOLKIT_MODEL_REPO,
+    DEFAULT_VLLM_MODEL_REPO_BRANCH,
 )
 from clarifai.utils.logging import logger
 from clarifai.utils.misc import (
@@ -68,14 +74,14 @@ def model():
 )
 @click.option(
     '--toolkit',
-    type=click.Choice(['ollama'], case_sensitive=False),
+    type=click.Choice(['ollama', 'huggingface', 'lmstudio', 'vllm'], case_sensitive=False),
     required=False,
-    help='Toolkit to use for model initialization. Currently supports "ollama".',
+    help='Toolkit to use for model initialization. Currently supports "ollama", "huggingface", "lmstudio" and "vllm".',
 )
 @click.option(
     '--model-name',
     required=False,
-    help='Model name to configure when using --toolkit. For ollama toolkit, this sets the Ollama model to use (e.g., "llama3.1", "mistral", etc.).',
+    help='Model name to configure when using --toolkit. For ollama toolkit, this sets the Ollama model to use (e.g., "llama3.1", "mistral", etc.). For vllm & huggingface toolkit, this sets the Hugging Face model repo_id (e.g., "unsloth/Llama-3.2-1B-Instruct").\n For lmstudio toolkit, this sets the LM Studio model name (e.g., "qwen/qwen3-4b-thinking-2507").\n',
 )
 @click.option(
     '--port',
@@ -112,14 +118,16 @@ def init(
     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.
-    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.
+    MODEL_PATH: Path where to create the model directory structure. If not specified, the current directory is used by default.\n
+
+    OPTIONS:\n
+    MODEL_TYPE_ID: Type of model to create. If not specified, defaults to "text-to-text" for text models.\n
+    GITHUB_PAT: GitHub Personal Access Token for authentication when cloning private repositories.\n
+    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.\n
+    TOOLKIT: Toolkit to use for model initialization. Currently supports "ollama", "huggingface", "lmstudio" and "vllm".\n
+    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.). For vllm & huggingface toolkit, this sets the Hugging Face model repo_id (e.g., "Qwen/Qwen3-4B-Instruct-2507"). For lmstudio toolkit, this sets the LM Studio model name (e.g., "qwen/qwen3-4b-thinking-2507").\n
+    PORT: Port to run the (Ollama/lmstudio) server on. Defaults to 23333.\n
+    CONTEXT_LENGTH: Context length for the (Ollama/lmstudio) model. Defaults to 8192.\n
     """
     # Resolve the absolute path
     model_path = os.path.abspath(model_path)
@@ -152,8 +160,22 @@ def init(
                 "Ollama is not installed. Please install it from `https://ollama.com/` to use the Ollama toolkit."
             )
             raise click.Abort()
-        github_url = DEFAULT_OLLAMA_MODEL_REPO
+        github_url = DEFAULT_TOOLKIT_MODEL_REPO
         branch = DEFAULT_OLLAMA_MODEL_REPO_BRANCH
+    elif toolkit == 'huggingface':
+        github_url = DEFAULT_TOOLKIT_MODEL_REPO
+        branch = DEFAULT_HF_MODEL_REPO_BRANCH
+    elif toolkit == 'lmstudio':
+        if not check_lmstudio_installed():
+            logger.error(
+                "LM Studio is not installed. Please install it from `https://lmstudio.com/` to use the LM Studio toolkit."
+            )
+            raise click.Abort()
+        github_url = DEFAULT_TOOLKIT_MODEL_REPO
+        branch = DEFAULT_LMSTUDIO_MODEL_REPO_BRANCH
+    elif toolkit == 'vllm':
+        github_url = DEFAULT_TOOLKIT_MODEL_REPO
+        branch = DEFAULT_VLLM_MODEL_REPO_BRANCH
 
     if github_url:
         downloader = GitHubDownloader(
@@ -247,6 +269,13 @@ def init(
     if (model_name or port or context_length) and (toolkit == 'ollama'):
         customize_ollama_model(model_path, model_name, port, context_length)
 
+    if (model_name or port or context_length) and (toolkit == 'lmstudio'):
+        customize_lmstudio_model(model_path, model_name, port, context_length)
+
+    if model_name and (toolkit == 'huggingface' or toolkit == 'vllm'):
+        # Update the config.yaml file with the provided model name
+        customize_huggingface_model(model_path, model_name)
+
     if github_url:
         logger.info("Model initialization complete with GitHub repository")
         logger.info("Next steps:")
@@ -294,7 +323,7 @@ def init(
         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_model_type_id = DEFAULT_LOCAL_RUNNER_MODEL_TYPE  # default
 
             config_template = get_config_template(config_model_type_id)
             with open(config_path, 'w') as f:

{clarifai-11.8.1 → clarifai-11.8.2}/clarifai/cli/templates/model_templates.py

@@ -178,7 +178,7 @@ class MyModel(OpenAIModelClass):
 '''
 
 
-def get_config_template(model_type_id: str = "text-to-text") -> str:
+def get_config_template(model_type_id: str = "any-to-any") -> str:
     """Return the template for config.yaml."""
     return f'''# Configuration file for your Clarifai model
 

{clarifai-11.8.1 → clarifai-11.8.2}/clarifai/client/base.py

@@ -1,5 +1,5 @@
 from datetime import datetime
-from typing import Any, Callable
+from typing import Any, Callable, Dict, Optional
 
 from clarifai_grpc.grpc.api import resources_pb2
 from google.protobuf import struct_pb2
@@ -88,20 +88,46 @@ class BaseClient:
         self.root_certificates_path = self.auth_helper._root_certificates_path
 
     @property
-    def async_stub(self):
+    def async_stub(self) -> Any:
         """Returns the asynchronous gRPC stub for the API interaction.
-        Lazy initialization of async stub"""
+
+        Returns:
+            Any: The async gRPC stub object for making asynchronous API calls.
+
+        Note:
+            Uses lazy initialization - stub is created on first access.
+        """
         if self._async_stub is None:
             self._async_stub = create_stub(self.auth_helper, is_async=True)
         return self._async_stub
 
     @classmethod
-    def from_env(cls, validate: bool = False):
+    def from_env(cls, validate: bool = False) -> 'BaseClient':
+        """Creates a BaseClient instance from environment variables.
+
+        Args:
+            validate (bool): Whether to validate the authentication credentials.
+                           Defaults to False.
+
+        Returns:
+            BaseClient: A new BaseClient instance configured from environment variables.
+        """
         auth = ClarifaiAuthHelper.from_env(validate=validate)
         return cls.from_auth_helper(auth)
 
     @classmethod
-    def from_auth_helper(cls, auth: ClarifaiAuthHelper, **kwargs):
+    def from_auth_helper(cls, auth: ClarifaiAuthHelper, **kwargs) -> 'BaseClient':
+        """Creates a BaseClient instance from a ClarifaiAuthHelper.
+
+        Args:
+            auth (ClarifaiAuthHelper): The authentication helper containing credentials.
+            **kwargs: Additional keyword arguments to override auth helper values.
+                     Supported keys: user_id, app_id, pat, token, root_certificates_path,
+                     base, ui, url.
+
+        Returns:
+            BaseClient: A new BaseClient instance configured from the auth helper.
+        """
         default_kwargs = {
             "user_id": kwargs.get("user_id", None) or auth.user_id,
             "app_id": kwargs.get("app_id", None) or auth.app_id,
@@ -132,15 +158,18 @@ class BaseClient:
 
         return cls(**kwargs)
 
-    def _grpc_request(self, method: Callable, argument: Any):
+    def _grpc_request(self, method: Callable[..., Any], argument: Any) -> Any:
         """Makes a gRPC request to the API.
 
         Args:
-            method (Callable): The gRPC method to call.
-            argument (Any): The argument to pass to the gRPC method.
+            method (Callable[..., Any]): The gRPC stub method to call.
+            argument (Any): The protobuf request object to pass to the gRPC method.
 
         Returns:
-            res (Any): The result of the gRPC method call.
+            Any: The protobuf response object from the gRPC method call.
+
+        Raises:
+            Exception: If the API request fails.
         """
 
         try:
@@ -150,14 +179,16 @@ class BaseClient:
         except ApiError:
             raise Exception("ApiError")
 
-    def convert_string_to_timestamp(self, date_str) -> Timestamp:
+    def convert_string_to_timestamp(self, date_str: str) -> Timestamp:
         """Converts a string to a Timestamp object.
 
         Args:
-            date_str (str): The string to convert.
+            date_str (str): The date string to convert. Accepts formats like
+                          '%Y-%m-%dT%H:%M:%S.%fZ' or '%Y-%m-%dT%H:%M:%SZ'.
 
         Returns:
-            Timestamp: The converted Timestamp object.
+            Timestamp: The converted protobuf Timestamp object. Returns empty Timestamp
+                      if the date string format is invalid.
         """
         # Parse the string into a Python datetime object
         try:
@@ -174,15 +205,22 @@ class BaseClient:
 
         return timestamp_obj
 
-    def process_response_keys(self, old_dict, listing_resource=None):
+    def process_response_keys(
+        self, old_dict: Dict[str, Any], listing_resource: Optional[str] = None
+    ) -> Dict[str, Any]:
         """Converts keys in a response dictionary to resource proto format.
 
+        This method processes dictionary keys to match protobuf resource naming conventions,
+        particularly for converting 'id' to '{resource}_id' format.
+
         Args:
-            old_dict (dict): The dictionary to convert.
-            listing_resource (str, optional): The resource type for which the keys are being processed.
+            old_dict (Dict[str, Any]): The dictionary to convert with keys to process.
+            listing_resource (Optional[str]): The resource type for which the keys are being
+                                            processed (e.g., 'model', 'workflow'). If provided,
+                                            renames 'id' to '{listing_resource}_id'.
 
         Returns:
-            new_dict (dict): The dictionary with processed keys.
+            Dict[str, Any]: The dictionary with processed keys and converted values.
         """
         if listing_resource:
             old_dict[f'{listing_resource}_id'] = old_dict['id']

{clarifai-11.8.1 → clarifai-11.8.2}/clarifai/client/dataset.py

@@ -4,7 +4,16 @@ import uuid
 from concurrent.futures import ThreadPoolExecutor, as_completed
 from datetime import datetime
 from multiprocessing import cpu_count
-from typing import Dict, Generator, List, Optional, Tuple, Type, TypeVar, Union
+from typing import (
+    Dict,
+    Generator,
+    List,
+    Optional,
+    Tuple,
+    Type,
+    TypeVar,
+    Union,
+)
 
 import requests
 from clarifai_grpc.grpc.api import resources_pb2, service_pb2
@@ -122,10 +131,13 @@ class Dataset(Lister, BaseClient):
         Args:
             **kwargs: Additional keyword arguments to be passed to Dataset Version.
               - description (str): The description of the dataset version.
-              - metadata (dict): The metadata of the dataset version.
+              - metadata (Dict[str, Any]): The metadata dictionary for the dataset version.
 
         Returns:
-            Dataset: A Dataset object for the specified dataset ID.
+            Dataset: A Dataset object for the newly created dataset version.
+
+        Raises:
+            Exception: If the dataset version creation fails.
 
         Example:
             >>> from clarifai.client.dataset import Dataset
@@ -172,13 +184,13 @@ class Dataset(Lister, BaseClient):
         self.logger.info("\nDataset Version Deleted\n%s", response.status)
 
     def list_versions(
-        self, page_no: int = None, per_page: int = None
+        self, page_no: Optional[int] = None, per_page: Optional[int] = None
     ) -> Generator['Dataset', None, None]:
         """Lists all the versions for the dataset.
 
         Args:
-            page_no (int): The page number to list.
-            per_page (int): The number of items per page.
+            page_no (Optional[int]): The page number to list. If None, lists all pages.
+            per_page (Optional[int]): The number of items per page. If None, uses default.
 
         Yields:
             Dataset: Dataset objects for the versions of the dataset.

{clarifai-11.8.1 → clarifai-11.8.2}/clarifai/client/model.py

@@ -2,7 +2,7 @@ import itertools
 import json
 import os
 import time
-from typing import Any, Dict, Generator, Iterable, Iterator, List, Tuple, Union
+from typing import Any, Dict, Generator, Iterable, Iterator, List, Optional, Tuple, Union
 
 import numpy as np
 import requests
@@ -178,20 +178,26 @@ class Model(Lister, BaseClient):
 
         return templates
 
-    def get_params(self, template: str = None, save_to: str = 'params.yaml') -> Dict[str, Any]:
-        """Returns the model params for the model type and yaml file.
+    def get_params(
+        self, template: Optional[str] = None, save_to: str = 'params.yaml'
+    ) -> Dict[str, Any]:
+        """Returns the model params for the model type and saves them to a yaml file.
 
         Args:
-            template (str): The template to use for the model type.
-            yaml_file (str): The yaml file to save the model params.
+            template (Optional[str]): The template to use for the model type. Required for most
+                                    model types except 'clusterer' and 'embedding-classifier'.
+            save_to (str): The yaml file path to save the model params. Defaults to 'params.yaml'.
 
         Returns:
-            params (Dict): Dictionary of model params for the model type.
+            Dict[str, Any]: Dictionary of model params for the model type.
+
+        Raises:
+            UserError: If the model type is not trainable, or if template is required but not provided.
 
         Example:
             >>> from clarifai.client.model import Model
             >>> model = Model(model_id='model_id', user_id='user_id', app_id='app_id')
-            >>> model_params = model.get_params(template='template', yaml_file='model_params.yaml')
+            >>> model_params = model.get_params(template='template', save_to='model_params.yaml')
         """
         if not self.model_info.model_type_id:
             self.load_info()
@@ -260,19 +266,22 @@ class Model(Lister, BaseClient):
             find_and_replace_key(self.training_params, key, value)
 
     def get_param_info(self, param: str) -> Dict[str, Any]:
-        """Returns the param info for the param.
+        """Returns the parameter info for the specified parameter.
 
         Args:
-            param (str): The param to get the info for.
+            param (str): The parameter name to get information for.
 
         Returns:
-            param_info (Dict): Dictionary of model param info for the param.
+            Dict[str, Any]: Dictionary containing model parameter info for the specified param.
+
+        Raises:
+            UserError: If the model type is not trainable or if training params are not loaded.
 
         Example:
             >>> from clarifai.client.model import Model
             >>> model = Model(model_id='model_id', user_id='user_id', app_id='app_id')
-            >>> model_params = model.get_params(template='template', yaml_file='model_params.yaml')
-            >>> model.get_param_info('param')
+            >>> model_params = model.get_params(template='template', save_to='model_params.yaml')
+            >>> param_info = model.get_param_info('learning_rate')
         """
         if self.model_info.model_type_id not in TRAINABLE_MODEL_TYPES:
             raise UserError(f"Model type {self.model_info.model_type_id} is not trainable")

{clarifai-11.8.1 → clarifai-11.8.2}/clarifai/client/model_client.py

@@ -314,6 +314,7 @@ class ModelClient:
         self,
         base_url: str = None,
         use_ctx: bool = False,
+        colorize: bool = False,
     ) -> str:
         """Generate a client script for this model.
 
@@ -335,6 +336,7 @@ class ModelClient:
             compute_cluster_id=self.request_template.runner_selector.nodepool.compute_cluster.id,
             nodepool_id=self.request_template.runner_selector.nodepool.id,
             use_ctx=use_ctx,
+            colorize=colorize,
         )
 
     def _define_compatability_functions(self):

{clarifai-11.8.1 → clarifai-11.8.2}/clarifai/client/module.py

@@ -1,4 +1,4 @@
-from typing import Dict, Generator
+from typing import Dict, Generator, Optional
 
 from clarifai_grpc.grpc.api import resources_pb2, service_pb2
 
@@ -15,25 +15,26 @@ class Module(Lister, BaseClient):
 
     def __init__(
         self,
-        url: str = None,
-        module_id: str = None,
-        module_version: Dict = {'id': ""},
+        url: Optional[str] = None,
+        module_id: Optional[str] = None,
+        module_version: Dict[str, str] = {'id': ""},
         base_url: str = DEFAULT_BASE,
-        pat: str = None,
-        token: str = None,
-        root_certificates_path: str = None,
+        pat: Optional[str] = None,
+        token: Optional[str] = None,
+        root_certificates_path: Optional[str] = None,
         **kwargs,
     ):
         """Initializes a Module object.
 
         Args:
-            url (str): The URL to initialize the module object.
-            module_id (str): The Module ID to interact with.
-            module_version (dict): The Module Version to interact with.
+            url (Optional[str]): The URL to initialize the module object.
+            module_id (Optional[str]): The Module ID to interact with.
+            module_version (Dict[str, str]): The Module Version to interact with.
+                                           Defaults to {'id': ""} for latest version.
             base_url (str): Base API url. Default "https://api.clarifai.com"
-            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.
+            pat (Optional[str]): A personal access token for authentication. Can be set as env var CLARIFAI_PAT.
+            token (Optional[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 (Optional[str]): Path to the SSL root certificates file, used to establish secure gRPC connections.
             **kwargs: Additional keyword arguments to be passed to the Module.
         """
         if url and module_id:

{clarifai-11.8.1 → clarifai-11.8.2}/clarifai/client/nodepool.py

@@ -334,7 +334,9 @@ class Nodepool(Lister, BaseClient):
             f"Runner with ID '{response.runners[0].id}' is created:\n{response.status}"
         )
 
-        dict_response = MessageToDict(response.runners[0], preserving_proto_field_name=True)
+        dict_response = MessageToDict(
+            response.runners[0], preserving_proto_field_name=True, use_integers_for_enums=True
+        )
         kwargs = self.process_response_keys(dict_response, 'runner')
         return Runner.from_auth_helper(auth=self.auth_helper, **kwargs)
 

{clarifai-11.8.1 → clarifai-11.8.2}/clarifai/client/pipeline.py

@@ -1,6 +1,6 @@
 import time
 import uuid
-from typing import Dict, List
+from typing import Dict, List, Optional
 
 from clarifai_grpc.grpc.api import resources_pb2, service_pb2
 from clarifai_grpc.grpc.api.status import status_code_pb2
@@ -19,35 +19,35 @@ class Pipeline(Lister, BaseClient):
 
     def __init__(
         self,
-        url: str = None,
-        pipeline_id: str = None,
-        pipeline_version_id: str = None,
-        pipeline_version_run_id: str = None,
-        user_id: str = None,
-        app_id: str = None,
-        nodepool_id: str = None,
-        compute_cluster_id: str = None,
-        log_file: str = None,
+        url: Optional[str] = None,
+        pipeline_id: Optional[str] = None,
+        pipeline_version_id: Optional[str] = None,
+        pipeline_version_run_id: Optional[str] = None,
+        user_id: Optional[str] = None,
+        app_id: Optional[str] = None,
+        nodepool_id: Optional[str] = None,
+        compute_cluster_id: Optional[str] = None,
+        log_file: Optional[str] = None,
         base_url: str = DEFAULT_BASE,
-        pat: str = None,
-        token: str = None,
-        root_certificates_path: str = None,
+        pat: Optional[str] = None,
+        token: Optional[str] = None,
+        root_certificates_path: Optional[str] = None,
         **kwargs,
     ):
         """Initializes a Pipeline object.
 
         Args:
-            url (str): The URL to initialize the pipeline object.
-            pipeline_id (str): The Pipeline ID to interact with.
-            pipeline_version_id (str): The Pipeline Version ID to interact with.
-            pipeline_version_run_id (str): The Pipeline Version Run ID. If not provided, a UUID will be generated.
-            user_id (str): The User ID that owns the pipeline.
-            app_id (str): The App ID that contains the pipeline.
-            nodepool_id (str): The Nodepool ID to run the pipeline on.
-            compute_cluster_id (str): The Compute Cluster ID to run the pipeline on.
-            log_file (str): Path to file where logs should be written. If not provided, logs are displayed on console.
+            url (Optional[str]): The URL to initialize the pipeline object.
+            pipeline_id (Optional[str]): The Pipeline ID to interact with.
+            pipeline_version_id (Optional[str]): The Pipeline Version ID to interact with.
+            pipeline_version_run_id (Optional[str]): The Pipeline Version Run ID. If not provided, a UUID will be generated.
+            user_id (Optional[str]): The User ID that owns the pipeline.
+            app_id (Optional[str]): The App ID that contains the pipeline.
+            nodepool_id (Optional[str]): The Nodepool ID to run the pipeline on.
+            compute_cluster_id (Optional[str]): The Compute Cluster ID to run the pipeline on.
+            log_file (Optional[str]): Path to file where logs should be written. If not provided, logs are displayed on console.
             base_url (str): Base API url. Default "https://api.clarifai.com"
-            pat (str): A personal access token for authentication. Can be set as env var CLARIFAI_PAT
+            pat (Optional[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.
             **kwargs: Additional keyword arguments to be passed to the Pipeline.

{clarifai-11.8.1 → clarifai-11.8.2}/clarifai/client/pipeline_step.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from clarifai.client.base import BaseClient
 from clarifai.client.lister import Lister
 from clarifai.urls.helper import ClarifaiUrlHelper
@@ -9,31 +11,31 @@ class PipelineStep(Lister, BaseClient):
 
     def __init__(
         self,
-        url: str = None,
-        pipeline_step_id: str = None,
-        pipeline_step_version_id: str = None,
-        user_id: str = None,
-        app_id: str = None,
-        pipeline_id: str = None,
+        url: Optional[str] = None,
+        pipeline_step_id: Optional[str] = None,
+        pipeline_step_version_id: Optional[str] = None,
+        user_id: Optional[str] = None,
+        app_id: Optional[str] = None,
+        pipeline_id: Optional[str] = None,
         base_url: str = DEFAULT_BASE,
-        pat: str = None,
-        token: str = None,
-        root_certificates_path: str = None,
+        pat: Optional[str] = None,
+        token: Optional[str] = None,
+        root_certificates_path: Optional[str] = None,
         **kwargs,
     ):
         """Initializes a PipelineStep object.
 
         Args:
-            url (str): The URL to initialize the pipeline step object.
-            pipeline_step_id (str): The PipelineStep ID for the PipelineStep to interact with.
-            pipeline_step_version_id (str): The PipelineStep version ID for the PipelineStep to interact with.
-            user_id (str): The User ID for the PipelineStep to interact with.
-            app_id (str): The App ID for the PipelineStep to interact with.
-            pipeline_id (str): The Pipeline ID for the PipelineStep to interact with.
+            url (Optional[str]): The URL to initialize the pipeline step object.
+            pipeline_step_id (Optional[str]): The PipelineStep ID for the PipelineStep to interact with.
+            pipeline_step_version_id (Optional[str]): The PipelineStep version ID for the PipelineStep to interact with.
+            user_id (Optional[str]): The User ID for the PipelineStep to interact with.
+            app_id (Optional[str]): The App ID for the PipelineStep to interact with.
+            pipeline_id (Optional[str]): The Pipeline ID for the PipelineStep to interact with.
             base_url (str): Base API url. Default "https://api.clarifai.com"
-            pat (str): A personal access token for authentication.
-            token (str): A session token for authentication.
-            root_certificates_path (str): Path to the SSL root certificates file.
+            pat (Optional[str]): A personal access token for authentication.
+            token (Optional[str]): A session token for authentication.
+            root_certificates_path (Optional[str]): Path to the SSL root certificates file.
             **kwargs: Additional keyword arguments to be passed to the BaseClient.
         """
         if url: