truefoundry 0.11.3rc2__py3-none-any.whl → 0.11.5__py3-none-any.whl

truefoundry/deploy/_autogen/models.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  application.json
-#   timestamp: 2025-07-28T14:11:36+00:00
+#   timestamp: 2025-08-06T19:58:42+00:00
 
 from __future__ import annotations
 
@@ -157,8 +157,8 @@ class CanaryStep(BaseModel):
         ...,
         description="Percentage of total traffic to be shifted to the canary release.\nThe rest will continue to go to the existing deployment",
     )
-    pause_duration: conint(ge=0) = Field(
-        30,
+    pause_duration: Optional[conint(ge=0)] = Field(
+        None,
         description="Duration for which to pause the release. The release process will wait for these seconds before proceeding to the next step.\nIf this is not set, the step will pause indefinitely on this step",
     )
 
@@ -1088,11 +1088,11 @@ class TrueFoundryInteractiveLogin(BaseModel):
 
 
 class VolumeBrowser(BaseModel):
-    username: constr(regex=r"^[a-z][a-z0-9]{1,8}[a-z0-9]$") = Field(
-        ..., description="Username for logging in the volume browser."
+    username: Optional[constr(regex=r"^[a-z][a-z0-9]{1,8}[a-z0-9]$")] = Field(
+        None, description="Username for logging in the volume browser."
     )
-    password_secret_fqn: constr(regex=r"^tfy-secret:\/\/.+:.+:.+$") = Field(
-        ...,
+    password_secret_fqn: Optional[constr(regex=r"^tfy-secret:\/\/.+:.+:.+$")] = Field(
+        None,
         description="TFY Secret containing the password for logging in the volume browser.",
     )
     endpoint: Endpoint
@@ -1282,11 +1282,11 @@ class HealthProbe(BaseModel):
         1,
         description="Time to wait for a response from the endpoint before considering it down",
     )
-    success_threshold: conint(ge=1, le=100) = Field(
+    success_threshold: conint(ge=1, le=5000) = Field(
         1,
         description="Number of successful responses from the endpoint before container is considered healthy",
     )
-    failure_threshold: conint(ge=1, le=100) = Field(
+    failure_threshold: conint(ge=1, le=5000) = Field(
         3,
         description="Number of consecutive failures before the container is considered down",
     )
@@ -1593,6 +1593,7 @@ class BaseService(BaseModel):
     kustomize: Optional[Kustomize] = None
     liveness_probe: Optional[HealthProbe] = None
     readiness_probe: Optional[HealthProbe] = None
+    startup_probe: Optional[HealthProbe] = None
     workspace_fqn: Optional[str] = Field(
         None, description="Fully qualified name of the workspace"
     )

truefoundry/ml/artifact/truefoundry_artifact_repo.py

@@ -654,7 +654,7 @@ class MlFoundryArtifactsRepository:
                 artifact_identifier=self.artifact_identifier, paths=[remote_file_path]
             )[0]
 
-        if progress_bar is None or not progress_bar.disable:
+        if progress_bar is None or progress_bar.disable:
             logger.info("Downloading %s to %s", remote_file_path, local_path)
 
         if progress_bar is not None:

truefoundry/ml/integrations/huggingface/trainer_callback.py

@@ -0,0 +1,198 @@
+import logging
+import math
+import os
+from typing import TYPE_CHECKING, Any, Dict, Optional
+
+import numpy as np
+
+from truefoundry import ml
+
+try:
+    from transformers.integrations.integration_utils import rewrite_logs
+    from transformers.trainer_callback import TrainerCallback
+except ImportError as e:
+    raise ImportError(
+        "Importing this module requires `transformers` to be installed"
+    ) from e
+
+if TYPE_CHECKING:
+    from transformers.trainer_callback import TrainerControl, TrainerState
+    from transformers.training_args import TrainingArguments
+
+    from truefoundry.ml import MlFoundryRun
+
+logger = logging.getLogger(__name__)
+
+
+class TrueFoundryMLCallback(TrainerCallback):
+    def __init__(
+        self,
+        run: "MlFoundryRun",
+        log_checkpoints: bool = True,
+        checkpoint_artifact_name: Optional[str] = None,
+        auto_end_run_on_train_end: bool = False,
+    ):
+        """
+        Args:
+            run: The run entity to log metrics to.
+            log_checkpoints: Whether to log checkpoints or not, defaults to True.
+            checkpoint_artifact_name: The name of the artifact to log checkpoints to, required if log_checkpoints is True.
+            auto_end_run_on_train_end: Whether to end the run automatically when training ends, defaults to False.
+
+            Usage:
+                from transformers import Trainer
+                from truefoundry.ml.integrations.huggingface.trainer_callback import TrueFoundryMLCallback
+                from truefoundry.ml import get_client
+
+                client = get_client()
+                run = client.create_run(ml_repo="my-ml-repo", run_name="my-run", auto_end=False)
+
+                callback = TrueFoundryMLCallback(
+                    run=run,
+                    log_checkpoints=True,
+                    checkpoint_artifact_name="my-checkpoint",
+                    auto_end_run_on_train_end=True,
+                )
+
+                trainer = Trainer(
+                    ...,
+                    callbacks=[callback]
+                )
+        """
+        self._run = run
+        self._log_checkpoints = log_checkpoints
+        if self._log_checkpoints and not checkpoint_artifact_name:
+            raise ValueError(
+                "`checkpoint_artifact_name` is required when `log_checkpoints` is True"
+            )
+        self._checkpoint_artifact_name = checkpoint_artifact_name
+        self._auto_end_run_on_train_end = auto_end_run_on_train_end
+
+    @classmethod
+    def with_managed_run(
+        cls,
+        ml_repo: str,
+        run_name: Optional[str] = None,
+        log_checkpoints: bool = True,
+        checkpoint_artifact_name: Optional[str] = None,
+        auto_end_run_on_train_end: bool = True,
+    ) -> "TrueFoundryMLCallback":
+        """
+        Args:
+            ml_repo: The name of the ML Repository to log metrics and data to.
+            run_name: The name of the run, if not provided, a random name will be generated.
+            log_checkpoints: Whether to log checkpoints or not, defaults to True.
+            checkpoint_artifact_name: The name of the artifact to log checkpoints to, required if log_checkpoints is True.
+            auto_end_run_on_train_end: Whether to end the run automatically when training ends, defaults to True.
+
+        Usage:
+            from transformers import Trainer
+            from truefoundry.ml.integrations.huggingface.trainer_callback import TrueFoundryMLCallback
+
+            callback = TrueFoundryMLCallback.with_managed_run(
+                ml_repo="my-ml-repo",
+                run_name="my-run",
+                log_checkpoints=True,
+                checkpoint_artifact_name="my-checkpoint",
+                auto_end_run_on_train_end=True,
+            )
+            trainer = Trainer(
+                ...,
+                callbacks=[callback]
+            )
+        """
+        run = ml.get_client().create_run(
+            ml_repo=ml_repo, run_name=run_name, auto_end=False
+        )
+        return cls(
+            run=run,
+            log_checkpoints=log_checkpoints,
+            checkpoint_artifact_name=checkpoint_artifact_name,
+            auto_end_run_on_train_end=auto_end_run_on_train_end,
+        )
+
+    def _drop_non_finite_values(self, dct: Dict[str, Any]) -> Dict[str, Any]:
+        sanitized = {}
+        for k, v in dct.items():
+            if isinstance(v, (int, float, np.integer, np.floating)) and math.isfinite(
+                v
+            ):
+                sanitized[k] = v
+            else:
+                logger.warning(
+                    f'Trainer is attempting to log a value of "{v}" of'
+                    f' type {type(v)} for key "{k}" as a metric.'
+                    " Mlfoundry's log_metric() only accepts finite float and"
+                    " int types so we dropped this attribute."
+                )
+        return sanitized
+
+    @property
+    def run(self) -> "MlFoundryRun":
+        return self._run
+
+    # noinspection PyMethodOverriding
+    def on_log(
+        self,
+        args: "TrainingArguments",
+        state: "TrainerState",
+        control: "TrainerControl",
+        logs: Optional[Dict[str, Any]] = None,
+        **kwargs,
+    ):
+        logs = logs or {}
+        if not state.is_world_process_zero:
+            return
+
+        metrics = self._drop_non_finite_values(logs)
+        self._run.log_metrics(rewrite_logs(metrics), step=state.global_step)
+
+    def on_save(
+        self,
+        args: "TrainingArguments",
+        state: "TrainerState",
+        control: "TrainerControl",
+        **kwargs,
+    ):
+        if not state.is_world_process_zero:
+            return
+
+        if not self._log_checkpoints:
+            return
+
+        if not self._checkpoint_artifact_name:
+            return
+
+        ckpt_dir = f"checkpoint-{state.global_step}"
+        artifact_path = os.path.join(args.output_dir, ckpt_dir)
+        description = None
+        _job_name = os.getenv("TFY_INTERNAL_COMPONENT_NAME")
+        _job_run_name = os.getenv("TFY_INTERNAL_JOB_RUN_NAME")
+        if _job_name:
+            description = f"Checkpoint from job={_job_name} run={_job_run_name}"
+        logger.info(f"Uploading checkpoint {ckpt_dir} ...")
+        metadata = {}
+        for log in state.log_history:
+            if isinstance(log, dict) and log.get("step") == state.global_step:
+                metadata = log.copy()
+        metadata = self._drop_non_finite_values(metadata)
+        self._run.log_artifact(
+            name=self._checkpoint_artifact_name,
+            artifact_paths=[(artifact_path, None)],
+            metadata=metadata,
+            step=state.global_step,
+            description=description,
+        )
+
+    def on_train_end(
+        self,
+        args: "TrainingArguments",
+        state: "TrainerState",
+        control: "TrainerControl",
+        **kwargs,
+    ):
+        """
+        Event called at the end of training.
+        """
+        if self._auto_end_run_on_train_end:
+            self._run.end()

{truefoundry-0.11.3rc2.dist-info → truefoundry-0.11.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: truefoundry
-Version: 0.11.3rc2
+Version: 0.11.5
 Summary: TrueFoundry CLI
 Author-email: TrueFoundry Team <abhishek@truefoundry.com>
 Requires-Python: <3.14,>=3.8.1
@@ -30,7 +30,7 @@ Requires-Dist: requirements-parser<0.12.0,>=0.11.0
 Requires-Dist: rich-click<2.0.0,>=1.2.1
 Requires-Dist: rich<14.0.0,>=13.7.1
 Requires-Dist: tqdm<5.0.0,>=4.0.0
-Requires-Dist: truefoundry-sdk<0.2.0,>=0.1.9
+Requires-Dist: truefoundry-sdk<0.2.0,>=0.1.10
 Requires-Dist: typing-extensions>=4.0
 Requires-Dist: urllib3<3,>=1.26.18
 Requires-Dist: yq<4.0.0,>=3.1.0

{truefoundry-0.11.3rc2.dist-info → truefoundry-0.11.5.dist-info}/RECORD

@@ -54,7 +54,7 @@ truefoundry/common/utils.py,sha256=P0FuAadoJGdpieUORLSN-PiFnkyoGO-K2cS4OPITBWg,6
 truefoundry/common/warnings.py,sha256=xDMhR_-ZGC40Ycaj6nlFb5MYPexn8WbKCHd4FlflTXQ,705
 truefoundry/deploy/__init__.py,sha256=sP-6Nv-_uV2o3knWcNSGV07j_Hkq0lfUkfZffBg-Hfo,2874
 truefoundry/deploy/python_deploy_codegen.py,sha256=k19_m5DGsUyjOUCSKwIVP8vDna2sq01tHABsUfoVpW4,8019
-truefoundry/deploy/_autogen/models.py,sha256=oOBwFb7qumBz1XXllns8wL02-NVvYq5iOOGZlEP3BzU,75893
+truefoundry/deploy/_autogen/models.py,sha256=e75fSAlUJhPW3IN9Lg3ogSnCR9crIuHAsZaDSCNvkS0,75977
 truefoundry/deploy/builder/__init__.py,sha256=VR07ZB7ziONEBbVgg1JdRTWY7t4qJjJTMhc2VodXYdA,5036
 truefoundry/deploy/builder/constants.py,sha256=amUkHoHvVKzGv0v_knfiioRuKiJM0V0xW0diERgWiI0,508
 truefoundry/deploy/builder/docker_service.py,sha256=sm7GWeIqyrKaZpxskdLejZlsxcZnM3BTDJr6orvPN4E,3948
@@ -349,7 +349,7 @@ truefoundry/ml/_autogen/models/schema.py,sha256=a_bp42MMPUbwO3407m0UW2W8EOhnxZXf
 truefoundry/ml/_autogen/models/signature.py,sha256=rBjpxUIsEeWM0sIyYG5uCJB18DKHR4k5yZw8TzuoP48,4987
 truefoundry/ml/_autogen/models/utils.py,sha256=c7RtSLXhOLcP8rjuUtfnMdaKVTZvvbsmw98gPAkAFrs,24371
 truefoundry/ml/artifact/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-truefoundry/ml/artifact/truefoundry_artifact_repo.py,sha256=hbgLxSoihkLVuICzRueuh8iAIc-yruCW5TuMXYQ-aCU,35692
+truefoundry/ml/artifact/truefoundry_artifact_repo.py,sha256=8BFKaXDxutw8bPJLnDI0bO0oNS_xJKo2ijubc2PLFsU,35688
 truefoundry/ml/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 truefoundry/ml/cli/cli.py,sha256=MwpY7z_NEeJE_XIP7XbZELjNeu2vpMmohttHCKDRk54,335
 truefoundry/ml/cli/utils.py,sha256=j6_mZ4Spn114mz3P4QQ8jx0tmorXIuyQnHXVUSDvZi4,1035
@@ -357,6 +357,9 @@ truefoundry/ml/cli/commands/__init__.py,sha256=diDUiRUX4l6TtNLI4iF-ZblczkELM7FRV
 truefoundry/ml/cli/commands/download.py,sha256=N9MhsEQ3U24v_OmnMZT8Q4SoAi38Sm7a21unrACOSDw,2573
 truefoundry/ml/cli/commands/model_init.py,sha256=INyUAU6hiFClI8cZqX5hgnrtNbeKxlZxrjFrjzStU18,2664
 truefoundry/ml/clients/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+truefoundry/ml/integrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+truefoundry/ml/integrations/huggingface/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+truefoundry/ml/integrations/huggingface/trainer_callback.py,sha256=Zu5AUbH_ct8I1dHyNYJQZBj9Y__hKo0sc2OxpPXJARE,6952
 truefoundry/ml/log_types/__init__.py,sha256=g4u4D4Jaj0aBK5GtrLV88-qThKZR9pSZ17vFEkN-LmM,125
 truefoundry/ml/log_types/plot.py,sha256=LDh4uy6z2P_a2oPM2lc85c0lt8utVvunohzeMawFjZw,7572
 truefoundry/ml/log_types/pydantic_base.py,sha256=eBlw_AEyAz4iJKDP4zgJOCFWcldwQqpf7FADW1jzIQY,272
@@ -383,7 +386,7 @@ truefoundry/workflow/remote_filesystem/__init__.py,sha256=LQ95ViEjJ7Ts4JcCGOxMPs
 truefoundry/workflow/remote_filesystem/logger.py,sha256=em2l7D6sw7xTLDP0kQSLpgfRRCLpN14Qw85TN7ujQcE,1022
 truefoundry/workflow/remote_filesystem/tfy_signed_url_client.py,sha256=xcT0wQmQlgzcj0nP3tJopyFSVWT1uv3nhiTIuwfXYeg,12342
 truefoundry/workflow/remote_filesystem/tfy_signed_url_fs.py,sha256=nSGPZu0Gyd_jz0KsEE-7w_BmnTD8CVF1S8cUJoxaCbc,13305
-truefoundry-0.11.3rc2.dist-info/METADATA,sha256=JnuUsg_bJq6c07XAzjN-khBwx5sDL9nVkdA7NEGGvlk,2762
-truefoundry-0.11.3rc2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-truefoundry-0.11.3rc2.dist-info/entry_points.txt,sha256=xVjn7RMN-MW2-9f7YU-bBdlZSvvrwzhpX1zmmRmsNPU,98
-truefoundry-0.11.3rc2.dist-info/RECORD,,
+truefoundry-0.11.5.dist-info/METADATA,sha256=BUNv9InD1VRtqlp8rb4eQkqKpCUgKQfFsrq9OjTgm9Q,2760
+truefoundry-0.11.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+truefoundry-0.11.5.dist-info/entry_points.txt,sha256=xVjn7RMN-MW2-9f7YU-bBdlZSvvrwzhpX1zmmRmsNPU,98
+truefoundry-0.11.5.dist-info/RECORD,,