truefoundry 0.5.1rc8__tar.gz → 0.5.2rc1__tar.gz

{truefoundry-0.5.1rc8 → truefoundry-0.5.2rc1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: truefoundry
-Version: 0.5.1rc8
+Version: 0.5.2rc1
 Summary: Truefoundry CLI
 Author: Abhishek Choudhary
 Author-email: abhishek@truefoundry.com

{truefoundry-0.5.1rc8 → truefoundry-0.5.2rc1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "truefoundry"
-version = "0.5.1rc8"
+version = "0.5.2rc1"
 description = "Truefoundry CLI"
 authors = ["Abhishek Choudhary <abhishek@truefoundry.com>"]
 readme = "README.md"
@@ -75,6 +75,7 @@ shap =  [
     { version = ">=0.40.0", python = "<3.12" },
     { version = ">=0.45.0", python = ">=3.12" },
 ]
+xgboost = "^2.1.3"
 
 
 [tool.poetry-dynamic-versioning]

{truefoundry-0.5.1rc8 → truefoundry-0.5.2rc1}/truefoundry/deploy/cli/commands/apply_command.py

@@ -30,13 +30,20 @@ from truefoundry.deploy.lib.model.entity import ApplyResult
     required=True,
     multiple=True,
 )
+@click.option(
+    "--dry-run",
+    "--dry_run",
+    is_flag=True,
+    show_default=True,
+    help="Simulate the process without actually applying the manifest",
+)
 @handle_exception_wrapper
-def apply_command(files: Tuple[str, ...]):
+def apply_command(files: Tuple[str, ...], dry_run: bool = False):
     apply_results: List[ApplyResult] = []
     client = ServiceFoundryServiceClient()
     for file in files:
         with console.status(PROMPT_APPLYING_MANIFEST.format(file), spinner="dots"):
-            for apply_result in apply_lib.apply_manifest_file(file, client):
+            for apply_result in apply_lib.apply_manifest_file(file, client, dry_run):
                 if apply_result.success:
                     console.print(f"[green]\u2714 {apply_result.message}[/]")
                 else:

{truefoundry-0.5.1rc8 → truefoundry-0.5.2rc1}/truefoundry/deploy/lib/clients/servicefoundry_client.py

@@ -680,9 +680,9 @@ class ServiceFoundryServiceClient(BaseServiceFoundryServiceClient):
         return parse_obj_as(List[Deployment], response)
 
     @check_min_cli_version
-    def apply(self, manifest: Dict[str, Any]):
+    def apply(self, manifest: Dict[str, Any], dry_run: bool = False):
         url = f"{self._api_server_url}/{VERSION_PREFIX}/apply"
-        body = {"manifest": manifest}
+        body = {"manifest": manifest, "dryRun": dry_run}
         response = session_with_retries().put(
             url, headers=self._get_header(), json=body
         )

{truefoundry-0.5.1rc8 → truefoundry-0.5.2rc1}/truefoundry/deploy/lib/dao/apply.py

@@ -15,6 +15,7 @@ def _apply_manifest(
     client: Optional[ServiceFoundryServiceClient] = None,
     filename: Optional[str] = None,
     index: Optional[int] = None,
+    dry_run: bool = False,
 ) -> ApplyResult:
     client = client or ServiceFoundryServiceClient()
 
@@ -32,29 +33,38 @@ def _apply_manifest(
             message=f"Failed to apply manifest{file_metadata}. Error: {ex}",
         )
 
+    prefix = "[Dry Run] " if dry_run else ""
+    suffix = " (No changes were applied)" if dry_run else ""
     try:
-        client.apply(manifest.dict())
+        client.apply(manifest.dict(), dry_run)
+
         return ApplyResult(
             success=True,
-            message=f"Successfully configured manifest {manifest.name} of type {manifest.type}",
+            message=(
+                f"{prefix}Successfully configured manifest {manifest.name} of type {manifest.type}.{suffix}"
+            ),
         )
     except Exception as ex:
         return ApplyResult(
             success=False,
-            message=f"Failed to apply manifest {manifest.name} of type {manifest.type}. Error: {ex}",
+            message=(
+                f"{prefix}Failed to apply manifest {manifest.name} of type {manifest.type}. Error: {ex}.{suffix}"
+            ),
         )
 
 
 def apply_manifest(
     manifest: Dict[str, Any],
     client: Optional[ServiceFoundryServiceClient] = None,
+    dry_run: bool = False,
 ) -> ApplyResult:
-    return _apply_manifest(manifest=manifest, client=client)
+    return _apply_manifest(manifest=manifest, client=client, dry_run=dry_run)
 
 
 def apply_manifest_file(
     filepath: str,
     client: Optional[ServiceFoundryServiceClient] = None,
+    dry_run: bool = False,
 ) -> Iterator[ApplyResult]:
     client = client or ServiceFoundryServiceClient()
     filename = Path(filepath).name
@@ -67,14 +77,19 @@ def apply_manifest_file(
             message=f"Failed to read file {filepath} as a valid YAML file. Error: {ex}",
         )
     else:
+        prefix = "[Dry Run] " if dry_run else ""
         for index, manifest in enumerate(manifests_it):
             if not isinstance(manifest, dict):
                 yield ApplyResult(
                     success=False,
-                    message=f"Failed to apply manifest at index {index} from file {filename}. Error: A manifest must be a dict, got type {type(manifest)}",
+                    message=f"{prefix}Failed to apply manifest at index {index} from file {filename}. Error: A manifest must be a dict, got type {type(manifest)}",
                 )
                 continue
 
             yield _apply_manifest(
-                manifest=manifest, client=client, filename=filename, index=index
+                manifest=manifest,
+                client=client,
+                filename=filename,
+                index=index,
+                dry_run=dry_run,
             )

{truefoundry-0.5.1rc8 → truefoundry-0.5.2rc1}/truefoundry/ml/__init__.py

@@ -1,9 +1,10 @@
-from truefoundry.ml.autogen.client.models import (
-    LibraryName,
+from truefoundry.ml.autogen.client.models import (  # type: ignore[attr-defined]
+    InferMethodName,
     ModelVersionEnvironment,
     SklearnModelSchema,
     XGBoostModelSchema,
 )
+from truefoundry.ml.autogen.entities.artifacts import LibraryName
 from truefoundry.ml.enums import (
     DataSlice,
     FileFormat,
@@ -40,6 +41,7 @@ from truefoundry.ml.model_framework import (
     TransformersFramework,
     XGBoostFramework,
     sklearn_infer_schema,
+    xgboost_infer_schema,
 )
 
 __all__ = [
@@ -51,9 +53,11 @@ __all__ = [
     "DataSlice",
     "FastAIFramework",
     "FileFormat",
+    "get_client",
     "GluonFramework",
     "H2OFramework",
     "Image",
+    "InferMethodName",
     "KerasFramework",
     "LibraryName",
     "LightGBMFramework",
@@ -68,6 +72,7 @@ __all__ = [
     "PaddleFramework",
     "Plot",
     "PyTorchFramework",
+    "sklearn_infer_schema",
     "SklearnFramework",
     "SklearnModelSchema",
     "SpaCyFramework",
@@ -75,10 +80,9 @@ __all__ = [
     "TensorFlowFramework",
     "TransformersFramework",
     "ViewType",
+    "xgboost_infer_schema",
     "XGBoostFramework",
     "XGBoostModelSchema",
-    "get_client",
-    "sklearn_infer_schema",
 ]
 
 init_logger()

{truefoundry-0.5.1rc8 → truefoundry-0.5.2rc1}/truefoundry/ml/cli/commands/model_init.py

@@ -6,7 +6,7 @@ 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.autogen.client import ModelServer  # type: ignore[attr-defined]
 from truefoundry.ml.cli.utils import (
     AppName,
     NonEmptyString,

{truefoundry-0.5.1rc8 → truefoundry-0.5.2rc1}/truefoundry/ml/mlfoundry_api.py

@@ -18,7 +18,7 @@ from typing import (
 import coolname
 
 from truefoundry.common.utils import ContextualDirectoryManager, relogin_error_message
-from truefoundry.ml import ModelVersionEnvironment, constants
+from truefoundry.ml import constants
 from truefoundry.ml.autogen.client import (  # type: ignore[attr-defined]
     ArtifactDto,
     ArtifactType,
@@ -35,6 +35,7 @@ from truefoundry.ml.autogen.client import (  # type: ignore[attr-defined]
     MlfoundryArtifactsApi,
     ModelDto,
     ModelServer,
+    ModelVersionEnvironment,
     RunsApi,
     RunTagDto,
     SearchRunsRequestDto,

{truefoundry-0.5.1rc8 → truefoundry-0.5.2rc1}/truefoundry/ml/mlfoundry_run.py

@@ -18,7 +18,7 @@ from urllib.parse import urljoin, urlsplit
 
 from truefoundry import version
 from truefoundry.common.utils import relogin_error_message
-from truefoundry.ml import ModelVersionEnvironment, constants
+from truefoundry.ml import constants
 from truefoundry.ml.autogen.client import (  # type: ignore[attr-defined]
     ArtifactType,
     DeleteRunRequest,
@@ -29,6 +29,7 @@ from truefoundry.ml.autogen.client import (  # type: ignore[attr-defined]
     MetricDto,
     MetricsApi,
     MlfoundryArtifactsApi,
+    ModelVersionEnvironment,
     ParamDto,
     RunDataDto,
     RunDto,

{truefoundry-0.5.1rc8 → truefoundry-0.5.2rc1}/truefoundry/ml/model_framework.py

@@ -35,6 +35,7 @@ from truefoundry.pydantic_v1 import BaseModel, Field
 
 if TYPE_CHECKING:
     from sklearn.base import BaseEstimator
+    from xgboost import Booster, XGBModel
 
 # Map serialization format to corresponding pip packages
 SERIALIZATION_FORMAT_TO_PACKAGES_NAME_MAP = {
@@ -467,6 +468,24 @@ def auto_update_model_framework_details(
                 )
 
 
+def _infer_schema(
+    model_input: Any,
+    model: Union["BaseEstimator", "Booster", "XGBModel"],
+    infer_method_name: str = "predict",
+) -> Dict[str, Any]:
+    if not hasattr(model, infer_method_name):
+        raise ValueError(
+            f"Model does not have the method '{infer_method_name}' to infer the schema."
+        )
+    model_infer_method = getattr(model, infer_method_name)
+    model_output = model_infer_method(model_input)
+
+    model_signature = infer_signature(
+        model_input=model_input, model_output=model_output
+    )
+    return model_signature.to_dict()
+
+
 def sklearn_infer_schema(
     model_input: Any,
     model: "BaseEstimator",
@@ -483,19 +502,37 @@ def sklearn_infer_schema(
     Returns:
         SklearnModelSchema: The inferred schema of the Sklearn model.
     """
-    if not hasattr(model, infer_method_name):
-        raise ValueError(
-            f"Model does not have the method '{infer_method_name}' to infer the schema."
-        )
-    model_infer_method = getattr(model, infer_method_name)
-    model_output = model_infer_method(model_input)
-
-    model_signature = infer_signature(
-        model_input=model_input, model_output=model_output
+    model_signature_json = _infer_schema(
+        model_input=model_input, model=model, infer_method_name=infer_method_name
     )
-    model_signature_json = model_signature.to_dict()
     return autogen_artifacts.SklearnModelSchema(
         infer_method_name=infer_method_name,
         inputs=json.loads(model_signature_json["inputs"]),
         outputs=json.loads(model_signature_json["outputs"]),
     )
+
+
+def xgboost_infer_schema(
+    model_input: Any,
+    model: Union["Booster", "XGBModel"],
+    infer_method_name: str = "predict",
+) -> autogen_artifacts.XGBoostModelSchema:
+    """
+    Infer the schema of an XGBoost model.
+
+    Args:
+        model_input (Any): The input data to be used for schema inference.
+        model (Any): The XGBoost model instance.
+        infer_method_name (str): The name of the method to be used for schema inference.
+            Eg: predict (default), predict_proba
+    Returns:
+        XGBoostModelSchema: The inferred schema of the XGBoost model.
+    """
+    model_signature_json = _infer_schema(
+        model_input=model_input, model=model, infer_method_name=infer_method_name
+    )
+    return autogen_artifacts.XGBoostModelSchema(
+        infer_method_name=infer_method_name,
+        inputs=json.loads(model_signature_json["inputs"]),
+        outputs=json.loads(model_signature_json["outputs"]),
+    )