truefoundry 0.5.0rc6__tar.gz → 0.5.0rc7__tar.gz

{truefoundry-0.5.0rc6 → truefoundry-0.5.0rc7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: truefoundry
-Version: 0.5.0rc6
+Version: 0.5.0rc7
 Summary: Truefoundry CLI
 Author: Abhishek Choudhary
 Author-email: abhishek@truefoundry.com
@@ -37,7 +37,7 @@ Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
 Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
 Requires-Dist: python-socketio[client] (>=5.5.2,<6.0.0)
 Requires-Dist: questionary (>=1.10.0,<2.0.0)
-Requires-Dist: requests (>=2.31.0,<3.0.0)
+Requires-Dist: requests (>=2.18.0,<3.0.0)
 Requires-Dist: requirements-parser (>=0.11.0,<0.12.0)
 Requires-Dist: rich (>=13.7.1,<14.0.0)
 Requires-Dist: rich-click (>=1.2.1,<2.0.0)

{truefoundry-0.5.0rc6 → truefoundry-0.5.0rc7}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "truefoundry"
-version = "0.5.0rc6"
+version = "0.5.0rc7"
 description = "Truefoundry CLI"
 authors = ["Abhishek Choudhary <abhishek@truefoundry.com>"]
 readme = "README.md"
@@ -29,7 +29,7 @@ python-dotenv = ">=1.0.1,<2.0.0"
 python-socketio = { version = ">=5.5.2,<6.0.0", extras = ["client"] }
 PyYAML = ">=6.0.0,<7.0.0"
 questionary = ">=1.10.0,<2.0.0"
-requests = ">=2.31.0,<3.0.0"
+requests = ">=2.18.0,<3.0.0"
 requirements-parser = ">=0.11.0,<0.12.0"
 rich = ">=13.7.1,<14.0.0"
 rich-click = ">=1.2.1,<2.0.0"

{truefoundry-0.5.0rc6 → truefoundry-0.5.0rc7}/truefoundry/ml/__init__.py

@@ -1,4 +1,4 @@
-from truefoundry.ml.autogen.client.models.library_name import LibraryName
+from truefoundry.ml.autogen.client.models import LibraryName, ModelVersionEnvironment
 from truefoundry.ml.enums import (
     DataSlice,
     FileFormat,
@@ -49,6 +49,7 @@ __all__ = [
     "Image",
     "MlFoundryRun",
     "MlFoundryException",
+    "ModelVersionEnvironment",
     "ModelFramework",
     "ModelType",
     "ModelVersion",

{truefoundry-0.5.0rc6 → truefoundry-0.5.0rc7}/truefoundry/ml/artifact/truefoundry_artifact_repo.py

@@ -897,6 +897,9 @@ class MlFoundryArtifactsRepository:
             page_token = page.next_page_token
 
     def _is_directory(self, artifact_path):
+        # TODO: Ideally server should return a flag to indicate if it is a directory
+        # For now we can rely on list_artifacts because generally in cloud buckets
+        # directories are not stored as separate entities - empty directories ideally do not exist
         for _ in self.list_artifacts(artifact_path, page_size=3):
             return True
         return False
@@ -1014,7 +1017,9 @@ class MlFoundryArtifactsRepository:
 
     def _get_file_paths_recur(self, src_artifact_dir_path, dst_local_dir_path):
         local_dir = os.path.join(dst_local_dir_path, src_artifact_dir_path)
-        dir_content = [  # prevent infinite loop, sometimes the dir is recursively included
+        # prevent infinite loop, sometimes the dir is recursively included
+        # TODO (chiragjn): Check why and when this happens
+        dir_content = [
             file_info
             for file_info in self.list_artifacts(src_artifact_dir_path)
             if file_info.path != "." and file_info.path != src_artifact_dir_path
@@ -1099,8 +1104,8 @@ class MlFoundryArtifactsRepository:
 
         try:
             progress_bar.start()
-            # Check if the artifacts points to a directory
-            if self._is_directory(artifact_path):
+            # empty string is treated as root directory
+            if not artifact_path or self._is_directory(artifact_path):
                 futures: List[Future] = []
                 file_paths: List[Tuple[str, str]] = []
                 abort_event = Event()

{truefoundry-0.5.0rc6 → truefoundry-0.5.0rc7}/truefoundry/ml/autogen/client/__init__.py

@@ -312,6 +312,9 @@ from truefoundry.ml.autogen.client.models.model_configuration import ModelConfig
 from truefoundry.ml.autogen.client.models.model_dto import ModelDto
 from truefoundry.ml.autogen.client.models.model_response_dto import ModelResponseDto
 from truefoundry.ml.autogen.client.models.model_version_dto import ModelVersionDto
+from truefoundry.ml.autogen.client.models.model_version_environment import (
+    ModelVersionEnvironment,
+)
 from truefoundry.ml.autogen.client.models.model_version_manifest import (
     ModelVersionManifest,
 )
@@ -355,6 +358,9 @@ from truefoundry.ml.autogen.client.models.search_runs_request_dto import (
 from truefoundry.ml.autogen.client.models.search_runs_response_dto import (
     SearchRunsResponseDto,
 )
+from truefoundry.ml.autogen.client.models.serialization_format import (
+    SerializationFormat,
+)
 from truefoundry.ml.autogen.client.models.set_experiment_tag_request_dto import (
     SetExperimentTagRequestDto,
 )

{truefoundry-0.5.0rc6 → truefoundry-0.5.0rc7}/truefoundry/ml/autogen/client/models/__init__.py

@@ -283,6 +283,9 @@ from truefoundry.ml.autogen.client.models.model_configuration import ModelConfig
 from truefoundry.ml.autogen.client.models.model_dto import ModelDto
 from truefoundry.ml.autogen.client.models.model_response_dto import ModelResponseDto
 from truefoundry.ml.autogen.client.models.model_version_dto import ModelVersionDto
+from truefoundry.ml.autogen.client.models.model_version_environment import (
+    ModelVersionEnvironment,
+)
 from truefoundry.ml.autogen.client.models.model_version_manifest import (
     ModelVersionManifest,
 )
@@ -326,6 +329,9 @@ from truefoundry.ml.autogen.client.models.search_runs_request_dto import (
 from truefoundry.ml.autogen.client.models.search_runs_response_dto import (
     SearchRunsResponseDto,
 )
+from truefoundry.ml.autogen.client.models.serialization_format import (
+    SerializationFormat,
+)
 from truefoundry.ml.autogen.client.models.set_experiment_tag_request_dto import (
     SetExperimentTagRequestDto,
 )

truefoundry-0.5.0rc7/truefoundry/ml/autogen/client/models/model_version_environment.py

@@ -0,0 +1,97 @@
+# coding: utf-8
+
+"""
+FastAPI
+
+No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 0.1.0
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+
+import json
+import pprint
+import re  # noqa: F401
+from typing import Optional
+
+from truefoundry.pydantic_v1 import (
+    BaseModel,
+    Field,
+    StrictStr,
+    conlist,
+    constr,
+    validator,
+)
+
+
+class ModelVersionEnvironment(BaseModel):
+    """
+    +label=ModelVersionEnvironment  # noqa: E501
+    """
+
+    python_version: Optional[constr(strict=True)] = Field(
+        default=None,
+        description="+label=Python Version +usage=Python version for the model version",
+    )
+    pip_packages: Optional[conlist(StrictStr)] = Field(
+        default=None,
+        description="+label=PIP Packages +usage=PIP packages for the model version",
+    )
+    __properties = ["python_version", "pip_packages"]
+
+    @validator("python_version")
+    def python_version_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if value is None:
+            return value
+
+        if not re.match(r"^\d+(\.\d+){1,2}([\-\.a-z0-9]+)?$", value):
+            raise ValueError(
+                r"must validate the regular expression /^\d+(\.\d+){1,2}([\-\.a-z0-9]+)?$/"
+            )
+        return value
+
+    class Config:
+        """Pydantic configuration"""
+
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> ModelVersionEnvironment:
+        """Create an instance of ModelVersionEnvironment from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True, exclude={}, exclude_none=True)
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> ModelVersionEnvironment:
+        """Create an instance of ModelVersionEnvironment from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return ModelVersionEnvironment.parse_obj(obj)
+
+        _obj = ModelVersionEnvironment.parse_obj(
+            {
+                "python_version": obj.get("python_version"),
+                "pip_packages": obj.get("pip_packages"),
+            }
+        )
+        return _obj

{truefoundry-0.5.0rc6 → truefoundry-0.5.0rc7}/truefoundry/ml/autogen/client/models/model_version_manifest.py

@@ -19,6 +19,9 @@ import re  # noqa: F401
 from typing import Any, Dict, Optional
 
 from truefoundry.ml.autogen.client.models.framework import Framework
+from truefoundry.ml.autogen.client.models.model_version_environment import (
+    ModelVersionEnvironment,
+)
 from truefoundry.ml.autogen.client.models.source1 import Source1
 from truefoundry.pydantic_v1 import (
     BaseModel,
@@ -46,6 +49,7 @@ class ModelVersionManifest(BaseModel):
     type: Optional[StrictStr] = "model-version"
     source: Source1 = Field(...)
     framework: Optional[Framework] = None
+    environment: Optional[ModelVersionEnvironment] = None
     step: Optional[conint(strict=True, ge=0)] = Field(
         default=0, description="+label=Step"
     )
@@ -59,6 +63,7 @@ class ModelVersionManifest(BaseModel):
         "type",
         "source",
         "framework",
+        "environment",
         "step",
         "model_schema",
     ]
@@ -101,6 +106,9 @@ class ModelVersionManifest(BaseModel):
         # override the default output from truefoundry.pydantic_v1 by calling `to_dict()` of framework
         if self.framework:
             _dict["framework"] = self.framework.to_dict()
+        # override the default output from truefoundry.pydantic_v1 by calling `to_dict()` of environment
+        if self.environment:
+            _dict["environment"] = self.environment.to_dict()
         return _dict
 
     @classmethod
@@ -125,6 +133,9 @@ class ModelVersionManifest(BaseModel):
                 "framework": Framework.from_dict(obj.get("framework"))
                 if obj.get("framework") is not None
                 else None,
+                "environment": ModelVersionEnvironment.from_dict(obj.get("environment"))
+                if obj.get("environment") is not None
+                else None,
                 "step": obj.get("step") if obj.get("step") is not None else 0,
                 "model_schema": obj.get("model_schema"),
             }

truefoundry-0.5.0rc7/truefoundry/ml/autogen/client/models/serialization_format.py

@@ -0,0 +1,35 @@
+# coding: utf-8
+
+"""
+FastAPI
+
+No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 0.1.0
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+import json
+import re  # noqa: F401
+
+from aenum import Enum
+
+
+class SerializationFormat(str, Enum):
+    """
+    +label=Serialization format +usage=Serialization format used for the model
+    """
+
+    """
+    allowed enum values
+    """
+    CLOUDPICKLE = "cloudpickle"
+    JOBLIB = "joblib"
+    PICKLE = "pickle"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> SerializationFormat:
+        """Create an instance of SerializationFormat from a JSON string"""
+        return SerializationFormat(json.loads(json_str))

{truefoundry-0.5.0rc6 → truefoundry-0.5.0rc7}/truefoundry/ml/autogen/client/models/sklearn_framework.py

@@ -16,7 +16,11 @@ from __future__ import annotations
 import json
 import pprint
 import re  # noqa: F401
+from typing import Optional
 
+from truefoundry.ml.autogen.client.models.serialization_format import (
+    SerializationFormat,
+)
 from truefoundry.pydantic_v1 import BaseModel, Field, StrictStr, validator
 
 
@@ -29,7 +33,11 @@ class SklearnFramework(BaseModel):
         default=...,
         description="+label=Type +usage=Type of the framework +value=sklearn",
     )
-    __properties = ["type"]
+    serialization_format: Optional[SerializationFormat] = Field(
+        default=None,
+        description="+label=Serialization format +usage=Serialization format used for the model",
+    )
+    __properties = ["type", "serialization_format"]
 
     @validator("type")
     def type_validate_enum(cls, value):
@@ -71,5 +79,10 @@ class SklearnFramework(BaseModel):
         if not isinstance(obj, dict):
             return SklearnFramework.parse_obj(obj)
 
-        _obj = SklearnFramework.parse_obj({"type": obj.get("type")})
+        _obj = SklearnFramework.parse_obj(
+            {
+                "type": obj.get("type"),
+                "serialization_format": obj.get("serialization_format"),
+            }
+        )
         return _obj

{truefoundry-0.5.0rc6 → truefoundry-0.5.0rc7}/truefoundry/ml/autogen/client/models/xg_boost_framework.py

@@ -16,7 +16,11 @@ from __future__ import annotations
 import json
 import pprint
 import re  # noqa: F401
+from typing import Optional
 
+from truefoundry.ml.autogen.client.models.serialization_format import (
+    SerializationFormat,
+)
 from truefoundry.pydantic_v1 import BaseModel, Field, StrictStr, validator
 
 
@@ -29,7 +33,11 @@ class XGBoostFramework(BaseModel):
         default=...,
         description="+label=Type +usage=Type of the framework +value=xgboost",
     )
-    __properties = ["type"]
+    serialization_format: Optional[SerializationFormat] = Field(
+        default=None,
+        description="+label=Serialization format +usage=Serialization format used for the model",
+    )
+    __properties = ["type", "serialization_format"]
 
     @validator("type")
     def type_validate_enum(cls, value):
@@ -71,5 +79,10 @@ class XGBoostFramework(BaseModel):
         if not isinstance(obj, dict):
             return XGBoostFramework.parse_obj(obj)
 
-        _obj = XGBoostFramework.parse_obj({"type": obj.get("type")})
+        _obj = XGBoostFramework.parse_obj(
+            {
+                "type": obj.get("type"),
+                "serialization_format": obj.get("serialization_format"),
+            }
+        )
         return _obj

{truefoundry-0.5.0rc6 → truefoundry-0.5.0rc7}/truefoundry/ml/autogen/client_README.md

@@ -271,6 +271,7 @@ Class | Method | HTTP request | Description
  - [ModelDto](truefoundry/ml/autogen/client/docs/ModelDto.md)
  - [ModelResponseDto](truefoundry/ml/autogen/client/docs/ModelResponseDto.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)
@@ -294,6 +295,7 @@ Class | Method | HTTP request | Description
  - [RunTagDto](truefoundry/ml/autogen/client/docs/RunTagDto.md)
  - [SearchRunsRequestDto](truefoundry/ml/autogen/client/docs/SearchRunsRequestDto.md)
  - [SearchRunsResponseDto](truefoundry/ml/autogen/client/docs/SearchRunsResponseDto.md)
+ - [SerializationFormat](truefoundry/ml/autogen/client/docs/SerializationFormat.md)
  - [SetExperimentTagRequestDto](truefoundry/ml/autogen/client/docs/SetExperimentTagRequestDto.md)
  - [SetTagRequestDto](truefoundry/ml/autogen/client/docs/SetTagRequestDto.md)
  - [SignedURLDto](truefoundry/ml/autogen/client/docs/SignedURLDto.md)

{truefoundry-0.5.0rc6 → truefoundry-0.5.0rc7}/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-11-28T08:27:16+00:00
 
 from __future__ import annotations
 
@@ -226,6 +226,23 @@ class ModelConfiguration(BaseModel):
     )
 
 
+class ModelVersionEnvironment(BaseModel):
+    """
+    +label=ModelVersionEnvironment
+    """
+
+    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,6 +276,17 @@ class PyTorchFramework(BaseModel):
     )
 
 
+class SerializationFormat(str, Enum):
+    """
+    +label=Serialization format
+    +usage=Serialization format used for the model
+    """
+
+    cloudpickle = "cloudpickle"
+    joblib = "joblib"
+    pickle = "pickle"
+
+
 class SklearnFramework(BaseModel):
     """
     +docs=Scikit-learn framework for the model version
@@ -268,6 +296,10 @@ class SklearnFramework(BaseModel):
     type: Literal["sklearn"] = Field(
         ..., description="+label=Type\n+usage=Type of the framework\n+value=sklearn"
     )
+    serialization_format: Optional[SerializationFormat] = Field(
+        None,
+        description="+label=Serialization format\n+usage=Serialization format used for the model",
+    )
 
 
 class SpaCyFramework(BaseModel):
@@ -410,6 +442,10 @@ class XGBoostFramework(BaseModel):
     type: Literal["xgboost"] = Field(
         ..., description="+label=Type\n+usage=Type of the framework\n+value=xgboost"
     )
+    serialization_format: Optional[SerializationFormat] = Field(
+        None,
+        description="+label=Serialization format\n+usage=Serialization format used for the model",
+    )
 
 
 class AgentOpenAPITool(BaseModel):
@@ -533,6 +569,7 @@ 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,

{truefoundry-0.5.0rc6 → truefoundry-0.5.0rc7}/truefoundry/ml/log_types/artifacts/model.py

@@ -25,6 +25,7 @@ from truefoundry.ml.autogen.client import (  # type: ignore[attr-defined]
     MlfoundryArtifactsApi,
     ModelDto,
     ModelVersionDto,
+    ModelVersionEnvironment,
     ModelVersionManifest,
     NotifyArtifactVersionFailureDto,
     TrueFoundryArtifactSource,
@@ -472,6 +473,7 @@ def _log_model_version(  # noqa: C901
     step: Optional[int] = 0,
     progress: Optional[bool] = None,
     framework: Optional[Union[str, ModelFramework, "ModelFrameworkType"]] = None,
+    environment: Optional[ModelVersionEnvironment] = None,
     model_schema: Optional[Dict[str, Any]] = None,
 ) -> ModelVersion:
     if (run and mlfoundry_artifacts_api) or (not run and not mlfoundry_artifacts_api):
@@ -585,6 +587,7 @@ def _log_model_version(  # noqa: C901
         metadata=metadata,
         source=_source_cls.from_dict(source.dict()),
         framework=Framework.from_dict(_framework.dict()) if _framework else None,
+        environment=environment,
         step=step,
         model_schema=model_schema,
     )

{truefoundry-0.5.0rc6 → truefoundry-0.5.0rc7}/truefoundry/ml/mlfoundry_api.py

@@ -18,7 +18,7 @@ import coolname
 import pandas as pd
 
 from truefoundry.common.utils import relogin_error_message
-from truefoundry.ml import constants
+from truefoundry.ml import ModelVersionEnvironment, constants
 from truefoundry.ml.autogen.client import (  # type: ignore[attr-defined]
     ArtifactDto,
     ArtifactType,
@@ -1232,6 +1232,7 @@ class MlFoundry:
         metadata: Optional[Dict[str, Any]] = None,
         progress: Optional[bool] = None,
         framework: Optional[Union[str, ModelFramework, "ModelFrameworkType"]] = None,
+        environment: Optional[ModelVersionEnvironment] = None,
         model_schema: Optional[Dict[str, Any]] = None,
     ) -> ModelVersion:
         """
@@ -1392,6 +1393,7 @@ class MlFoundry:
             step=None,
             progress=progress,
             framework=framework,
+            environment=environment,
             model_schema=model_schema,
         )
         logger.info(f"Logged model successfully with fqn {model_version.fqn!r}")

{truefoundry-0.5.0rc6 → truefoundry-0.5.0rc7}/truefoundry/ml/mlfoundry_run.py

@@ -20,7 +20,7 @@ from urllib.parse import urljoin, urlsplit
 
 from truefoundry import version
 from truefoundry.common.utils import relogin_error_message
-from truefoundry.ml import constants
+from truefoundry.ml import ModelVersionEnvironment, constants
 from truefoundry.ml.autogen.client import (  # type: ignore[attr-defined]
     ArtifactType,
     DeleteRunRequest,
@@ -936,6 +936,7 @@ class MlFoundryRun:
         step: int = 0,
         progress: Optional[bool] = None,
         framework: Optional[Union[str, ModelFramework, "ModelFrameworkType"]] = None,
+        environment: Optional[ModelVersionEnvironment] = None,
         model_schema: Optional[Dict[str, Any]] = None,
     ) -> ModelVersion:
         # TODO (chiragjn): Document mapping of framework to list of valid model save kwargs
@@ -1089,6 +1090,7 @@ class MlFoundryRun:
             step=step,
             progress=progress,
             framework=framework,
+            environment=environment,
             model_schema=model_schema,
         )
         logger.info(f"Logged model successfully with fqn {model_version.fqn!r}")