clarifai 11.4.8__py3-none-any.whl → 11.4.9__py3-none-any.whl

clarifai/__init__.py

@@ -1 +1 @@
-__version__ = "11.4.8"
+__version__ = "11.4.9"

clarifai/cli/model.py

@@ -25,6 +25,86 @@ def model():
     """Manage models: upload, test, local dev, predict, etc"""
 
 
+@model.command()
+@click.argument(
+    "model_path",
+    type=click.Path(),
+    required=False,
+    default=".",
+)
+@click.option(
+    '--model-type-id',
+    type=click.Choice(['mcp', 'openai'], case_sensitive=False),
+    required=False,
+    help='Model type: "mcp" for MCPModelClass, "openai" for OpenAIModelClass, or leave empty for default ModelClass.',
+)
+def init(model_path, model_type_id):
+    """Initialize a new model directory structure.
+
+    Creates the following structure in the specified directory:
+    ├── 1/
+    │   └── model.py
+    ├── requirements.txt
+    └── config.yaml
+
+    MODEL_PATH: Path where to create the model directory structure. If not specified, the current directory is used by default.
+    """
+    from clarifai.cli.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")
+
+
 @model.command()
 @click.argument("model_path", type=click.Path(exists=True), required=False, default=".")
 @click.option(

clarifai/cli/model_templates.py

@@ -0,0 +1,243 @@
+"""Templates for model initialization."""
+
+from clarifai import __version__
+
+
+def get_model_class_template() -> str:
+    """Return the template for a basic ModelClass-based model."""
+    return '''from typing import Iterator, List
+from clarifai.runners.models.model_class import ModelClass
+from clarifai.runners.util.data_utils import Param
+
+class MyModel(ModelClass):
+    """A custom model implementation using ModelClass."""
+
+    def load_model(self):
+        """Load the model here.
+        # TODO: please fill in
+        # Add your model loading logic here
+        """
+        pass
+
+    @ModelClass.method
+    def predict(
+        self,
+        prompt: str = "",
+        chat_history: List[dict] = None,
+        max_tokens: int = Param(default=256, description="The maximum number of tokens to generate. Shorter token lengths will provide faster performance."),
+        temperature: float = Param(default=1.0, description="A decimal number that determines the degree of randomness in the response"),
+        top_p: float = Param(default=1.0, description="An alternative to sampling with temperature, where the model considers the results of the tokens with top_p probability mass."),
+    ) -> str:
+        """This is the method that will be called when the runner is run. It takes in an input and returns an output."""
+        # TODO: please fill in
+        # Implement your prediction logic here
+        pass  # Replace with your actual logic
+
+    @ModelClass.method
+    def generate(
+        self,
+        prompt: str = "",
+        chat_history: List[dict] = None,
+        max_tokens: int = Param(default=256, description="The maximum number of tokens to generate. Shorter token lengths will provide faster performance."),
+        temperature: float = Param(default=1.0, description="A decimal number that determines the degree of randomness in the response"),
+        top_p: float = Param(default=1.0, description="An alternative to sampling with temperature, where the model considers the results of the tokens with top_p probability mass."),
+    ) -> Iterator[str]:
+        """Example yielding a streamed response."""
+        # TODO: please fill in
+        # Implement your generation logic here
+        pass # Replace with your actual logic
+'''
+
+
+def get_mcp_model_class_template() -> str:
+    """Return the template for an MCPModelClass-based model."""
+    return '''from typing import Any
+
+from fastmcp import FastMCP  # use fastmcp v2 not the built in mcp
+from pydantic import Field
+
+from clarifai.runners.models.mcp_class import MCPModelClass
+
+# TODO: please fill in
+# Configure your FastMCP server
+server = FastMCP("my-mcp-server", instructions="", stateless_http=True)
+
+
+# TODO: please fill in
+# Add your tools, resources, and prompts here
+@server.tool("example_tool", description="An example tool")
+def example_tool(input_param: Any = Field(description="Example input parameter")):
+    """Example tool implementation."""
+    # TODO: please fill in
+    # Implement your tool logic here
+    return f"Processed: {input_param}"
+
+
+# Static resource example
+@server.resource("config://version")
+def get_version():
+    """Example static resource."""
+    # TODO: please fill in
+    # Return your resource data
+    return "1.0.0"
+
+
+@server.prompt()
+def example_prompt(text: str) -> str:
+    """Example prompt template."""
+    # TODO: please fill in
+    # Define your prompt template
+    return f"Process this text: {text}"
+
+
+class MyModel(MCPModelClass):
+    """A custom model implementation using MCPModelClass."""
+
+    def get_server(self) -> FastMCP:
+        """Return the FastMCP server instance."""
+        return server
+'''
+
+
+def get_openai_model_class_template() -> str:
+    """Return the template for an OpenAIModelClass-based model."""
+    return '''from typing import List
+from openai import OpenAI
+from clarifai.runners.models.openai_class import OpenAIModelClass
+from clarifai.runners.util.data_utils import Param
+from clarifai.runners.utils.openai_convertor import build_openai_messages
+
+class MyModel(OpenAIModelClass):
+    """A custom model implementation using OpenAIModelClass."""
+
+    # TODO: please fill in
+    # Configure your OpenAI-compatible client for local model
+    client = OpenAI(
+        api_key="local-key",  # TODO: please fill in - use your local API key
+        base_url="http://localhost:8000/v1",  # TODO: please fill in - your local model server endpoint
+    )
+
+    # TODO: please fill in
+    # Specify the model name to use
+    model = "my-local-model"  # TODO: please fill in - replace with your local model name
+
+    def load_model(self):
+        """Optional: Add any additional model loading logic here."""
+        # TODO: please fill in (optional)
+        # Add any initialization logic if needed
+        pass
+
+    @OpenAIModelClass.method
+    def predict(
+        self,
+        prompt: str = "",
+        chat_history: List[dict] = None,
+        max_tokens: int = Param(default=256, description="The maximum number of tokens to generate. Shorter token lengths will provide faster performance."),
+        temperature: float = Param(default=1.0, description="A decimal number that determines the degree of randomness in the response"),
+        top_p: float = Param(default=1.0, description="An alternative to sampling with temperature, where the model considers the results of the tokens with top_p probability mass."),
+    ) -> str:
+        """Run a single prompt completion using the OpenAI client."""
+        # TODO: please fill in
+        # Implement your prediction logic here
+        messages = build_openai_messages(prompt, chat_history)
+        response = self.client.chat.completions.create(
+            model=self.model,
+            messages=messages,
+            max_completion_tokens=max_tokens,
+            temperature=temperature,
+            top_p=top_p,
+        )
+        return response.choices[0].message.content
+
+    @OpenAIModelClass.method
+    def generate(
+        self,
+        prompt: str = "",
+        chat_history: List[dict] = None,
+        max_tokens: int = Param(default=256, description="The maximum number of tokens to generate. Shorter token lengths will provide faster performance."),
+        temperature: float = Param(default=1.0, description="A decimal number that determines the degree of randomness in the response"),
+        top_p: float = Param(default=1.0, description="An alternative to sampling with temperature, where the model considers the results of the tokens with top_p probability mass."),
+    ):
+        """Stream a completion response using the OpenAI client."""
+        # TODO: please fill in
+        # Implement your streaming logic here
+        messages = build_openai_messages(prompt, chat_history)
+        stream = self.client.chat.completions.create(
+            model=self.model,
+            messages=messages,
+            max_completion_tokens=max_tokens,
+            temperature=temperature,
+            top_p=top_p,
+            stream=True,
+        )
+        for chunk in stream:
+            if chunk.choices:
+                text = (chunk.choices[0].delta.content
+                        if (chunk and chunk.choices[0].delta.content) is not None else '')
+                yield text
+'''
+
+
+def get_config_template(model_type_id: str = "text-to-text") -> str:
+    """Return the template for config.yaml."""
+    return f'''# Configuration file for your Clarifai model
+
+model:
+  id: "my-model"  # TODO: please fill in - replace with your model ID
+  user_id: "user_id"  # TODO: please fill in - replace with your user ID
+  app_id: "app_id"  # TODO: please fill in - replace with your app ID
+  model_type_id: "{model_type_id}"  # TODO: please fill in - replace if different model type ID
+
+build_info:
+  python_version: "3.12"
+
+# TODO: please fill in - adjust compute requirements for your model
+inference_compute_info:
+  cpu_limit: "1"  # TODO: please fill in - Amount of CPUs to use as a limit
+  cpu_memory: "1Gi"  # TODO: please fill in - Amount of CPU memory to use as a limit
+  cpu_requests: "0.5"  # TODO: please fill in - Amount of CPUs to use as a minimum
+  cpu_memory_requests: "512Mi"  # TODO: please fill in - Amount of CPU memory to use as a minimum
+  num_accelerators: 1  # TODO: please fill in - Amount of GPU/TPUs to use
+  accelerator_type: ["NVIDIA-*"]  # TODO: please fill in - type of accelerators requested
+  accelerator_memory: "1Gi"  # TODO: please fill in - Amount of accelerator/GPU memory to use as a minimum
+
+# TODO: please fill in (optional) - add checkpoints section if needed
+# checkpoints:
+#   type: "huggingface"  # supported type
+#   repo_id: "your-model-repo"  # for huggingface
+#   when: "build"  # or "runtime", "upload"
+'''
+
+
+def get_requirements_template(model_type_id: str = None) -> str:
+    """Return the template for requirements.txt."""
+    requirements = f'''# Clarifai SDK - required
+clarifai>={__version__}
+'''
+    if model_type_id == "mcp":
+        requirements += "fastmcp\n"
+    elif model_type_id == "openai":
+        requirements += "openai\n"
+    requirements += '''
+# TODO: please fill in - add your model's dependencies here
+# Examples:
+# torch>=2.0.0
+# transformers>=4.30.0
+# numpy>=1.21.0
+# pillow>=9.0.0
+'''
+    return requirements
+
+
+# Mapping of model type IDs to their corresponding templates
+MODEL_TYPE_TEMPLATES = {
+    "mcp": get_mcp_model_class_template,
+    "openai": get_openai_model_class_template,
+}
+
+
+def get_model_template(model_type_id: str = None) -> str:
+    """Get the appropriate model template based on model_type_id."""
+    if model_type_id in MODEL_TYPE_TEMPLATES:
+        return MODEL_TYPE_TEMPLATES[model_type_id]()
+    return get_model_class_template()

{clarifai-11.4.8.dist-info → clarifai-11.4.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clarifai
-Version: 11.4.8
+Version: 11.4.9
 Home-page: https://github.com/Clarifai/clarifai-python
 Author: Clarifai
 Author-email: support@clarifai.com
@@ -608,3 +608,8 @@ rag_agent = RAG(workflow_url="WORKFLOW_URL")
 
 See many more code examples in this [repo](https://github.com/Clarifai/examples).
 Also see the official [Python SDK docs](https://clarifai-python.readthedocs.io/en/latest/index.html)
+
+## :open_file_folder: Model Upload
+
+Examples for uploading models and runners have been moved to this [repo](https://github.com/Clarifai/runners-examples).
+Find our official documentation at [docs.clarifai.com/compute/models/upload](https://docs.clarifai.com/compute/models/upload).

{clarifai-11.4.8.dist-info → clarifai-11.4.9.dist-info}/RECORD

@@ -1,4 +1,4 @@
-clarifai/__init__.py,sha256=fdwUPqydH_J5QG9a6SZJDmJJHKUfCG6gEA5tSBI_n0k,23
+clarifai/__init__.py,sha256=SIhopzpvdgMSl3sPaYcNcFup4S7F1oJ6rqaOtCSjmJ4,23
 clarifai/cli.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clarifai/errors.py,sha256=GXa6D4v_L404J83jnRNFPH7s-1V9lk7w6Ws99f1g-AY,2772
 clarifai/versions.py,sha256=ecSuEB_nOL2XSoYHDw2n23XUbm_KPOGjudMXmQrGdS8,224
@@ -8,7 +8,8 @@ clarifai/cli/__main__.py,sha256=7nPbLW7Jr2shkgMPvnxpn4xYGMvIcnqluJ69t9w4H_k,74
 clarifai/cli/base.py,sha256=mzfAHRhon6tKntpxk241GD-Sjrb2-V99nAOasElLuuw,8254
 clarifai/cli/compute_cluster.py,sha256=8Xss0Obrp6l1XuxJe0luOqU_pf8vXGDRi6jyIe8qR6k,2282
 clarifai/cli/deployment.py,sha256=9C4I6_kyMxRkWl6h681wc79-3mAtDHtTUaxRv05OZMs,4262
-clarifai/cli/model.py,sha256=R9Bl32ELs4w658dDLeugjwf5d_3SMJiv64ciEqoWaTQ,27291
+clarifai/cli/model.py,sha256=9sJ5p4TJc41vOeeFoMC3e8cciscSU7TmvAgW0wfO54U,30191
+clarifai/cli/model_templates.py,sha256=_ZonIBnY9KKSJY31KZbUys_uN_k_Txu7Dip12KWfmSU,9633
 clarifai/cli/nodepool.py,sha256=H6OIdUW_EiyDUwZogzEDoYmVwEjLMsgoDlPyE7gjIuU,4245
 clarifai/client/__init__.py,sha256=NhpNFRJY6mTi8ca-5hUeTEmYeDKHDNXY48FN63pDuos,703
 clarifai/client/app.py,sha256=D0FG9v07g1dExLnQsYt0OQjsJCkVvuw76BOpcqaCzfM,41380
@@ -106,9 +107,9 @@ clarifai/workflows/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuF
 clarifai/workflows/export.py,sha256=Oq3RVNKvv1iH46U6oIjXa-MXWJ4sTlXr_NSfwoxr3H4,2149
 clarifai/workflows/utils.py,sha256=ESL3INcouNcLKCh-nMpfXX-YbtCzX7tz7hT57_RGQ3M,2079
 clarifai/workflows/validate.py,sha256=UhmukyHkfxiMFrPPeBdUTiCOHQT5-shqivlBYEyKTlU,2931
-clarifai-11.4.8.dist-info/licenses/LICENSE,sha256=mUqF_d12-qE2n41g7C5_sq-BMLOcj6CNN-jevr15YHU,555
-clarifai-11.4.8.dist-info/METADATA,sha256=MpDyC9bKsOSoUeOw-xPJDPHPFvaBCR0eNPb6vJy3z74,22398
-clarifai-11.4.8.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-clarifai-11.4.8.dist-info/entry_points.txt,sha256=X9FZ4Z-i_r2Ud1RpZ9sNIFYuu_-9fogzCMCRUD9hyX0,51
-clarifai-11.4.8.dist-info/top_level.txt,sha256=wUMdCQGjkxaynZ6nZ9FAnvBUCgp5RJUVFSy2j-KYo0s,9
-clarifai-11.4.8.dist-info/RECORD,,
+clarifai-11.4.9.dist-info/licenses/LICENSE,sha256=mUqF_d12-qE2n41g7C5_sq-BMLOcj6CNN-jevr15YHU,555
+clarifai-11.4.9.dist-info/METADATA,sha256=ik-jR4kso026x30ICc47SoptmYdxq1Ut5lsUifmp55o,22682
+clarifai-11.4.9.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+clarifai-11.4.9.dist-info/entry_points.txt,sha256=X9FZ4Z-i_r2Ud1RpZ9sNIFYuu_-9fogzCMCRUD9hyX0,51
+clarifai-11.4.9.dist-info/top_level.txt,sha256=wUMdCQGjkxaynZ6nZ9FAnvBUCgp5RJUVFSy2j-KYo0s,9
+clarifai-11.4.9.dist-info/RECORD,,