truefoundry 0.5.0rc6__py3-none-any.whl → 0.5.1__py3-none-any.whl

truefoundry/ml/autogen/client_README.md

@@ -102,6 +102,7 @@ Class | Method | HTTP request | Description
 *MlfoundryArtifactsApi* | [**delete_dataset_post**](truefoundry/ml/autogen/client/docs/MlfoundryArtifactsApi.md#delete_dataset_post) | **POST** /api/2.0/mlflow/mlfoundry-artifacts/datasets/delete | Delete Dataset
 *MlfoundryArtifactsApi* | [**delete_files_for_dataset_delete**](truefoundry/ml/autogen/client/docs/MlfoundryArtifactsApi.md#delete_files_for_dataset_delete) | **DELETE** /api/2.0/mlflow/mlfoundry-artifacts/datasets/files/ | Delete Files For Dataset
 *MlfoundryArtifactsApi* | [**delete_model_version_post**](truefoundry/ml/autogen/client/docs/MlfoundryArtifactsApi.md#delete_model_version_post) | **POST** /api/2.0/mlflow/mlfoundry-artifacts/model-versions/delete | Delete Model Version
+*MlfoundryArtifactsApi* | [**export_deployment_files_by_fqn_post**](truefoundry/ml/autogen/client/docs/MlfoundryArtifactsApi.md#export_deployment_files_by_fqn_post) | **POST** /api/2.0/mlflow/mlfoundry-artifacts/model-versions/export-deployment-files-by-fqn | Export Deployment Files By Fqn
 *MlfoundryArtifactsApi* | [**finalize_artifact_version_post**](truefoundry/ml/autogen/client/docs/MlfoundryArtifactsApi.md#finalize_artifact_version_post) | **POST** /api/2.0/mlflow/mlfoundry-artifacts/artifact-versions/finalize | Finalize Artifact Version
 *MlfoundryArtifactsApi* | [**get_artifact_by_fqn_get**](truefoundry/ml/autogen/client/docs/MlfoundryArtifactsApi.md#get_artifact_by_fqn_get) | **GET** /api/2.0/mlflow/mlfoundry-artifacts/artifacts/get-by-fqn | Get Artifact By Fqn
 *MlfoundryArtifactsApi* | [**get_artifact_by_id_get**](truefoundry/ml/autogen/client/docs/MlfoundryArtifactsApi.md#get_artifact_by_id_get) | **GET** /api/2.0/mlflow/mlfoundry-artifacts/artifacts/get | Get Artifact By Id
@@ -132,6 +133,7 @@ Class | Method | HTTP request | Description
 *MlfoundryArtifactsApi* | [**update_artifact_version_post**](truefoundry/ml/autogen/client/docs/MlfoundryArtifactsApi.md#update_artifact_version_post) | **POST** /api/2.0/mlflow/mlfoundry-artifacts/artifact-versions/update | Update Artifact Version
 *MlfoundryArtifactsApi* | [**update_dataset_post**](truefoundry/ml/autogen/client/docs/MlfoundryArtifactsApi.md#update_dataset_post) | **POST** /api/2.0/mlflow/mlfoundry-artifacts/datasets/update | Update Dataset
 *MlfoundryArtifactsApi* | [**update_model_version_post**](truefoundry/ml/autogen/client/docs/MlfoundryArtifactsApi.md#update_model_version_post) | **POST** /api/2.0/mlflow/mlfoundry-artifacts/model-versions/update | Update Model Version
+*MlfoundryArtifactsApi* | [**validate_external_storage_root_path_post**](truefoundry/ml/autogen/client/docs/MlfoundryArtifactsApi.md#validate_external_storage_root_path_post) | **POST** /api/2.0/mlflow/mlfoundry-artifacts/artifact-versions/validate-storage-root | Validate External Storage Root Path
 *RunArtifactsApi* | [**list_run_artifacts_get**](truefoundry/ml/autogen/client/docs/RunArtifactsApi.md#list_run_artifacts_get) | **GET** /api/2.0/mlflow/artifacts/list | List Run Artifacts
 *RunsApi* | [**create_run_post**](truefoundry/ml/autogen/client/docs/RunsApi.md#create_run_post) | **POST** /api/2.0/mlflow/runs/create | Create Run
 *RunsApi* | [**delete_run_post**](truefoundry/ml/autogen/client/docs/RunsApi.md#delete_run_post) | **POST** /api/2.0/mlflow/runs/delete | Delete Run
@@ -211,6 +213,7 @@ Class | Method | HTTP request | Description
  - [ExperimentIdRequestDto](truefoundry/ml/autogen/client/docs/ExperimentIdRequestDto.md)
  - [ExperimentResponseDto](truefoundry/ml/autogen/client/docs/ExperimentResponseDto.md)
  - [ExperimentTagDto](truefoundry/ml/autogen/client/docs/ExperimentTagDto.md)
+ - [ExportDeploymentFilesRequestDto](truefoundry/ml/autogen/client/docs/ExportDeploymentFilesRequestDto.md)
  - [ExternalArtifactSource](truefoundry/ml/autogen/client/docs/ExternalArtifactSource.md)
  - [FastAIFramework](truefoundry/ml/autogen/client/docs/FastAIFramework.md)
  - [FileInfoDto](truefoundry/ml/autogen/client/docs/FileInfoDto.md)
@@ -233,6 +236,7 @@ Class | Method | HTTP request | Description
  - [HTTPValidationError](truefoundry/ml/autogen/client/docs/HTTPValidationError.md)
  - [ImageContentPart](truefoundry/ml/autogen/client/docs/ImageContentPart.md)
  - [ImageUrl](truefoundry/ml/autogen/client/docs/ImageUrl.md)
+ - [InferMethodName](truefoundry/ml/autogen/client/docs/InferMethodName.md)
  - [InternalMetadata](truefoundry/ml/autogen/client/docs/InternalMetadata.md)
  - [KerasFramework](truefoundry/ml/autogen/client/docs/KerasFramework.md)
  - [LatestRunLogDto](truefoundry/ml/autogen/client/docs/LatestRunLogDto.md)
@@ -270,7 +274,9 @@ Class | Method | HTTP request | Description
  - [ModelConfiguration](truefoundry/ml/autogen/client/docs/ModelConfiguration.md)
  - [ModelDto](truefoundry/ml/autogen/client/docs/ModelDto.md)
  - [ModelResponseDto](truefoundry/ml/autogen/client/docs/ModelResponseDto.md)
+ - [ModelServer](truefoundry/ml/autogen/client/docs/ModelServer.md)
  - [ModelVersionDto](truefoundry/ml/autogen/client/docs/ModelVersionDto.md)
+ - [ModelVersionEnvironment](truefoundry/ml/autogen/client/docs/ModelVersionEnvironment.md)
  - [ModelVersionManifest](truefoundry/ml/autogen/client/docs/ModelVersionManifest.md)
  - [ModelVersionResponseDto](truefoundry/ml/autogen/client/docs/ModelVersionResponseDto.md)
  - [MultiPartUploadDto](truefoundry/ml/autogen/client/docs/MultiPartUploadDto.md)
@@ -298,6 +304,8 @@ Class | Method | HTTP request | Description
  - [SetTagRequestDto](truefoundry/ml/autogen/client/docs/SetTagRequestDto.md)
  - [SignedURLDto](truefoundry/ml/autogen/client/docs/SignedURLDto.md)
  - [SklearnFramework](truefoundry/ml/autogen/client/docs/SklearnFramework.md)
+ - [SklearnModelSchema](truefoundry/ml/autogen/client/docs/SklearnModelSchema.md)
+ - [SklearnSerializationFormat](truefoundry/ml/autogen/client/docs/SklearnSerializationFormat.md)
  - [Source](truefoundry/ml/autogen/client/docs/Source.md)
  - [Source1](truefoundry/ml/autogen/client/docs/Source1.md)
  - [SpaCyFramework](truefoundry/ml/autogen/client/docs/SpaCyFramework.md)
@@ -322,9 +330,13 @@ Class | Method | HTTP request | Description
  - [UpdateRunResponseDto](truefoundry/ml/autogen/client/docs/UpdateRunResponseDto.md)
  - [Url](truefoundry/ml/autogen/client/docs/Url.md)
  - [UserMessage](truefoundry/ml/autogen/client/docs/UserMessage.md)
+ - [ValidateExternalStorageRootRequestDto](truefoundry/ml/autogen/client/docs/ValidateExternalStorageRootRequestDto.md)
+ - [ValidateExternalStorageRootResponseDto](truefoundry/ml/autogen/client/docs/ValidateExternalStorageRootResponseDto.md)
  - [ValidationError](truefoundry/ml/autogen/client/docs/ValidationError.md)
  - [ValidationErrorLocInner](truefoundry/ml/autogen/client/docs/ValidationErrorLocInner.md)
  - [XGBoostFramework](truefoundry/ml/autogen/client/docs/XGBoostFramework.md)
+ - [XGBoostModelSchema](truefoundry/ml/autogen/client/docs/XGBoostModelSchema.md)
+ - [XGBoostSerializationFormat](truefoundry/ml/autogen/client/docs/XGBoostSerializationFormat.md)
 
 
 <a id="documentation-for-authorization"></a>

truefoundry/ml/autogen/entities/artifacts.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  artifacts.json
-#   timestamp: 2024-11-22T19:31:48+00:00
+#   timestamp: 2024-12-09T09:04:12+00:00
 
 from __future__ import annotations
 
@@ -52,11 +52,11 @@ class AgentWithFQN(Agent):
 class BaseArtifactVersion(BaseModel):
     description: Optional[constr(max_length=512)] = Field(
         None,
-        description="+label=Description\n+docs=Description of the artifact version",
+        description="+label=Description\n+usage=Description of the artifact or model version\n+docs=Description of the artifact or model version",
     )
     metadata: Dict[str, Any] = Field(
         ...,
-        description="+label=Metadata\n+docs=Metadata for the model version\n+usage=Metadata for the model version\n+uiType=JsonInput",
+        description="+label=Metadata\n+docs=Metadata for the artifact or model version\n+usage=Metadata for the artifact or model version\n+uiType=JsonInput",
     )
 
 
@@ -226,6 +226,23 @@ class ModelConfiguration(BaseModel):
     )
 
 
+class ModelVersionEnvironment(BaseModel):
+    """
+    +label=Environment
+    """
+
+    python_version: Optional[constr(regex=r"^\d+(\.\d+){1,2}([\-\.a-z0-9]+)?$")] = (
+        Field(
+            None,
+            description="+label=Python Version\n+usage=Python version for the model version",
+        )
+    )
+    pip_packages: Optional[List[str]] = Field(
+        None,
+        description="+label=PIP Packages\n+usage=PIP packages for the model version",
+    )
+
+
 class ONNXFramework(BaseModel):
     """
     +docs=ONNX framework for the model version
@@ -259,17 +276,44 @@ class PyTorchFramework(BaseModel):
     )
 
 
-class SklearnFramework(BaseModel):
+class InferMethodName(str, Enum):
     """
-    +docs=Scikit-learn framework for the model version
-    +label=Sklearn
+    +label=Inference Method Name
+    +usage=Name of the method used for inference
     """
 
-    type: Literal["sklearn"] = Field(
-        ..., description="+label=Type\n+usage=Type of the framework\n+value=sklearn"
+    predict = "predict"
+    predict_proba = "predict_proba"
+
+
+class SklearnModelSchema(BaseModel):
+    """
+    +label=Sklearn Model Schema
+    """
+
+    infer_method_name: InferMethodName = Field(
+        ...,
+        description="+label=Inference Method Name\n+usage=Name of the method used for inference",
+    )
+    inputs: List[Dict[str, Any]] = Field(
+        ..., description="+label= Input Schema\n+usage=Schema of the input"
+    )
+    outputs: List[Dict[str, Any]] = Field(
+        ..., description="+label= Output Schema\n+usage=Schema of the output"
     )
 
 
+class SklearnSerializationFormat(str, Enum):
+    """
+    +label=Serialization format
+    +usage=Serialization format used for sklearn models
+    """
+
+    cloudpickle = "cloudpickle"
+    joblib = "joblib"
+    pickle = "pickle"
+
+
 class SpaCyFramework(BaseModel):
     """
     +docs=spaCy framework for the model version
@@ -357,11 +401,11 @@ class TransformersFramework(BaseModel):
     )
     pipeline_tag: Optional[str] = Field(
         None,
-        description="+label=Pipeline Tag\n+usage=Pipeline tag\n+docs=Pipeline tag for the framework",
+        description="+label=Pipeline Tag\n+usage=The `pipeline()` task this model can be used with e.g. `text-generation`. See [huggingface docs](https://huggingface.co/docs/transformers/main/en/main_classes/pipelines#transformers.pipeline.task) for all possible values\n+docs=Pipeline tag for the framework",
     )
     base_model: Optional[str] = Field(
         None,
-        description="+label=Base Model\n+usage=Base model\n+docs=Base model Id. If this is a finetuned model, this points to the base model used for finetuning",
+        description="+label=Base Model\n+usage=Base model Id. If this is a finetuned model, this points to the base model used for finetuning\n+docs=Base model Id. If this is a finetuned model, this points to the base model used for finetuning",
     )
 
 
@@ -401,17 +445,35 @@ class UserMessage(BaseModel):
     )
 
 
-class XGBoostFramework(BaseModel):
+class XGBoostModelSchema(BaseModel):
     """
-    +docs=XGBoost framework for the model version
-    +label=XGBoost
+    +label=XGBoost Model Schema
     """
 
-    type: Literal["xgboost"] = Field(
-        ..., description="+label=Type\n+usage=Type of the framework\n+value=xgboost"
+    infer_method_name: Literal["predict"] = Field(
+        ...,
+        description="+label=Inference Method Name\n+usage=Name of the method used for inference",
+    )
+    inputs: List[Dict[str, Any]] = Field(
+        ..., description="+label= Input Schema\n+usage=Schema of the input"
+    )
+    outputs: List[Dict[str, Any]] = Field(
+        ..., description="+label= Output Schema\n+usage=Schema of the output"
     )
 
 
+class XGBoostSerializationFormat(str, Enum):
+    """
+    +label=Serialization format
+    +usage=Serialization format used for XGBoost models
+    """
+
+    cloudpickle = "cloudpickle"
+    joblib = "joblib"
+    pickle = "pickle"
+    json = "json"
+
+
 class AgentOpenAPITool(BaseModel):
     type: Literal["openapi-tool"] = Field(..., description="+value=openapi-tool")
     name: constr(regex=r"^[a-zA-Z][a-zA-Z0-9\-]{1,30}[a-zA-Z0-9]$") = Field(
@@ -505,6 +567,47 @@ class ChatPrompt(BasePrompt):
     )
 
 
+class SklearnFramework(BaseModel):
+    """
+    +docs=Scikit-learn framework for the model version
+    +label=Sklearn
+    """
+
+    type: Literal["sklearn"] = Field(
+        ..., description="+label=Type\n+usage=Type of the framework\n+value=sklearn"
+    )
+    model_filepath: Optional[str] = Field(
+        None,
+        description="+label=Model file path\n+usage=Relative path to the model file",
+    )
+    serialization_format: Optional[SklearnSerializationFormat] = None
+    model_schema: Optional[SklearnModelSchema] = None
+
+
+class XGBoostFramework(BaseModel):
+    """
+    +docs=XGBoost framework for the model version
+    +label=XGBoost
+    """
+
+    type: Literal["xgboost"] = Field(
+        ..., description="+label=Type\n+usage=Type of the framework\n+value=xgboost"
+    )
+    serialization_format: Optional[XGBoostSerializationFormat] = None
+    model_filepath: Optional[str] = Field(
+        None,
+        description="+label=Model file path\n+usage=Relative path to the model file",
+    )
+    model_schema: Optional[XGBoostModelSchema] = None
+
+
+class AgentApp(BaseModel):
+    type: Literal["agent-app"] = Field(..., description="+value=agent-app")
+    tools: List[AgentOpenAPIToolWithFQN]
+    agents: List[AgentWithFQN]
+    root_agent: constr(min_length=1)
+
+
 class ModelVersion(BaseArtifactVersion):
     type: Literal["model-version"] = Field(
         ..., description='+label=Type\n+usage=Model Version\n+value="model-version"'
@@ -533,18 +636,8 @@ class ModelVersion(BaseArtifactVersion):
     ] = Field(
         None, description="+label=Framework\n+usage=Framework for the model version"
     )
+    environment: Optional[ModelVersionEnvironment] = None
     step: conint(ge=0) = Field(0, description="+label=Step")
-    model_schema: Optional[Dict[str, Any]] = Field(
-        None,
-        description="+label=Model Schema\n+usage=Schema of the model\n+uiType=Hidden",
-    )
-
-
-class AgentApp(BaseModel):
-    type: Literal["agent-app"] = Field(..., description="+value=agent-app")
-    tools: List[AgentOpenAPIToolWithFQN]
-    agents: List[AgentWithFQN]
-    root_agent: constr(min_length=1)
 
 
 class VersionedArtifactType(BaseModel):

truefoundry/ml/autogen/models/signature.py

@@ -1,13 +1,16 @@
 from dataclasses import dataclass, is_dataclass
-from typing import Any, Dict, Optional, Union
+from typing import TYPE_CHECKING, Any, Dict, Optional, Union
 
 import numpy as np
-import pandas as pd
+
+if TYPE_CHECKING:
+    import pandas as pd
+
 
 from .schema import ParamSchema, Schema, convert_dataclass_to_schema
 from .utils import infer_param_schema, infer_schema
 
-MlflowInferableDataset = Union[pd.DataFrame, np.ndarray, Dict[str, np.ndarray]]
+MlflowInferableDataset = Union["pd.DataFrame", "np.ndarray", Dict[str, "np.ndarray"]]
 
 
 class ModelSignature:

truefoundry/ml/autogen/models/utils.py

@@ -4,7 +4,12 @@ from collections import defaultdict
 from typing import Any, Dict, List, Optional, Union
 
 import numpy as np
-import pandas as pd
+
+try:
+    import pandas as pd
+except ImportError:
+    pd = None
+
 
 from .exceptions import MlflowException
 from .schema import (
@@ -330,7 +335,7 @@ def infer_schema(data: Any) -> Schema:  # noqa: C901
                 ]
             )
     # pandas.Series
-    elif isinstance(data, pd.Series):
+    elif pd and isinstance(data, pd.Series):
         name = getattr(data, "name", None)
         schema = Schema(
             [
@@ -342,7 +347,7 @@ def infer_schema(data: Any) -> Schema:  # noqa: C901
             ]
         )
     # pandas.DataFrame
-    elif isinstance(data, pd.DataFrame):
+    elif pd and isinstance(data, pd.DataFrame):
         schema = Schema(
             [
                 ColSpec(
@@ -473,13 +478,13 @@ def _is_none_or_nan(x):
 
 
 def _infer_required(col) -> bool:
-    if isinstance(col, (list, pd.Series)):
+    if pd and isinstance(col, (list, pd.Series)):
         return not any(_is_none_or_nan(x) for x in col)
     return not _is_none_or_nan(col)
 
 
-def _infer_pandas_column(col: pd.Series) -> DataType:
-    if not isinstance(col, pd.Series):
+def _infer_pandas_column(col: "pd.Series") -> DataType:
+    if pd and not isinstance(col, pd.Series):
         raise TypeError(f"Expected pandas.Series, got '{type(col)}'.")
     if len(col.values.shape) > 1:
         raise MlflowException(f"Expected 1d array, got array with shape {col.shape}")
@@ -496,7 +501,7 @@ def _infer_pandas_column(col: pd.Series) -> DataType:
             # For backwards compatibility, we fall back to string
             # if the provided array is of string type
             # This is for diviner test where df field is ('key2', 'key1', 'key0')
-            if pd.api.types.is_string_dtype(col):
+            if pd and pd.api.types.is_string_dtype(col):
                 return DataType.string
             raise MlflowException(
                 f"Failed to infer schema for pandas.Series {col}. Error: {e}"

truefoundry/ml/cli/commands/model_init.py

@@ -0,0 +1,97 @@
+import os
+from typing import Optional
+
+import rich_click as click
+
+from truefoundry.deploy.cli.console import console
+from truefoundry.deploy.cli.const import COMMAND_CLS
+from truefoundry.deploy.cli.util import handle_exception_wrapper
+from truefoundry.ml.autogen.client.models import ModelServer
+from truefoundry.ml.cli.utils import (
+    AppName,
+    NonEmptyString,
+)
+from truefoundry.ml.mlfoundry_api import get_client
+
+
+@click.command(
+    name="model",
+    cls=COMMAND_CLS,
+    help="Generating application code for the specified model version.",
+)
+@click.option(
+    "--name",
+    required=True,
+    type=AppName(),
+    help="Name for the model server deployment",
+    show_default=True,
+)
+@click.option(
+    "--model-version-fqn",
+    "--model_version_fqn",
+    type=NonEmptyString(),
+    required=True,
+    show_default=True,
+    help="Fully Qualified Name (FQN) of the model version to deploy, e.g., 'model:tenant_name/my-model/linear-regression:2'",
+)
+@click.option(
+    "-w",
+    "--workspace-fqn",
+    "--workspace_fqn",
+    type=NonEmptyString(),
+    required=True,
+    show_default=True,
+    help="Fully Qualified Name (FQN) of the workspace to deploy",
+)
+@click.option(
+    "--model-server",
+    "--model_server",
+    type=click.Choice(ModelServer, case_sensitive=False),
+    default=ModelServer.FASTAPI.value,
+    show_default=True,
+    help="Specify the model server (Case Insensitive).",
+)
+@click.option(
+    "--output-dir",
+    "--output_dir",
+    type=click.Path(exists=True, file_okay=False, writable=True),
+    help="Output directory for the model server code",
+    required=False,
+    show_default=True,
+    default=os.getcwd(),
+)
+@handle_exception_wrapper
+def model_init_command(
+    name: str,
+    model_version_fqn: str,
+    workspace_fqn: str,
+    model_server: ModelServer,
+    output_dir: Optional[str],
+):
+    """
+    Generates application code for the specified model version.
+    """
+    ml_client = get_client()
+    console.print(f"Generating application code for {model_version_fqn!r}")
+    output_dir = ml_client._initialize_model_server(
+        name=name,
+        model_version_fqn=model_version_fqn,
+        workspace_fqn=workspace_fqn,
+        model_server=ModelServer[model_server.upper()],
+        output_dir=output_dir,
+    )
+    message = f"""
+[bold green]Model Server code initialized successfully![/bold green]
+
+[bold]Code Location:[/bold] {output_dir}
+
+[bold]Next Steps:[/bold]
+- Navigate to the model server directory:
+[green]cd {output_dir}[/green]
+- Refer to the README file in the directory for further instructions.
+"""
+    console.print(message)
+
+
+def get_model_init_command():
+    return model_init_command

truefoundry/ml/cli/utils.py

@@ -0,0 +1,34 @@
+import rich_click as click
+
+from truefoundry.ml import MlFoundryException
+from truefoundry.ml.validation_utils import (
+    _APP_NAME_REGEX,
+)
+
+
+class AppName(click.ParamType):
+    """
+    Custom ParamType to validate application names.
+    """
+
+    name = "application-name"
+
+    def convert(self, value, param, ctx):
+        try:
+            if not value or not _APP_NAME_REGEX.match(value):
+                raise MlFoundryException(
+                    f"{value!r} must be lowercase and cannot contain spaces. It can only contain alphanumeric characters and hyphens. "
+                    f"Length must be between 1 and 30 characters."
+                )
+        except MlFoundryException as e:
+            self.fail(str(e), param, ctx)
+        return value
+
+
+class NonEmptyString(click.ParamType):
+    name = "non-empty-string"
+
+    def convert(self, value, param, ctx):
+        if isinstance(value, str) and not value.strip():
+            self.fail("Value cannot be empty or contain only spaces.", param, ctx)
+        return value