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

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=Environment  # 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/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,
@@ -37,30 +40,27 @@ class ModelVersionManifest(BaseModel):
 
     description: Optional[constr(strict=True, max_length=512)] = Field(
         default=None,
-        description="+label=Description +docs=Description of the artifact version",
+        description="+label=Description +usage=Description of the artifact or model version +docs=Description of the artifact or model version",
     )
     metadata: Dict[str, Any] = Field(
         default=...,
-        description="+label=Metadata +docs=Metadata for the model version +usage=Metadata for the model version +uiType=JsonInput",
+        description="+label=Metadata +docs=Metadata for the artifact or model version +usage=Metadata for the artifact or model version +uiType=JsonInput",
     )
     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"
     )
-    model_schema: Optional[Dict[str, Any]] = Field(
-        default=None,
-        description="+label=Model Schema +usage=Schema of the model +uiType=Hidden",
-    )
     __properties = [
         "description",
         "metadata",
         "type",
         "source",
         "framework",
+        "environment",
         "step",
-        "model_schema",
     ]
 
     @validator("type")
@@ -101,6 +101,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,8 +128,10 @@ 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"),
             }
         )
         return _obj

truefoundry/ml/autogen/client/models/sklearn_framework.py

@@ -16,7 +16,12 @@ from __future__ import annotations
 import json
 import pprint
 import re  # noqa: F401
+from typing import Optional
 
+from truefoundry.ml.autogen.client.models.sklearn_model_schema import SklearnModelSchema
+from truefoundry.ml.autogen.client.models.sklearn_serialization_format import (
+    SklearnSerializationFormat,
+)
 from truefoundry.pydantic_v1 import BaseModel, Field, StrictStr, validator
 
 
@@ -29,7 +34,13 @@ class SklearnFramework(BaseModel):
         default=...,
         description="+label=Type +usage=Type of the framework +value=sklearn",
     )
-    __properties = ["type"]
+    model_filepath: Optional[StrictStr] = Field(
+        default=None,
+        description="+label=Model file path +usage=Relative path to the model file",
+    )
+    serialization_format: Optional[SklearnSerializationFormat] = None
+    model_schema: Optional[SklearnModelSchema] = None
+    __properties = ["type", "model_filepath", "serialization_format", "model_schema"]
 
     @validator("type")
     def type_validate_enum(cls, value):
@@ -60,6 +71,9 @@ class SklearnFramework(BaseModel):
     def to_dict(self):
         """Returns the dictionary representation of the model using alias"""
         _dict = self.dict(by_alias=True, exclude={}, exclude_none=True)
+        # override the default output from truefoundry.pydantic_v1 by calling `to_dict()` of model_schema
+        if self.model_schema:
+            _dict["model_schema"] = self.model_schema.to_dict()
         return _dict
 
     @classmethod
@@ -71,5 +85,14 @@ 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"),
+                "model_filepath": obj.get("model_filepath"),
+                "serialization_format": obj.get("serialization_format"),
+                "model_schema": SklearnModelSchema.from_dict(obj.get("model_schema"))
+                if obj.get("model_schema") is not None
+                else None,
+            }
+        )
         return _obj

truefoundry/ml/autogen/client/models/sklearn_model_schema.py

@@ -0,0 +1,82 @@
+# 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 Any, Dict
+
+from truefoundry.ml.autogen.client.models.infer_method_name import InferMethodName
+from truefoundry.pydantic_v1 import BaseModel, Field, conlist
+
+
+class SklearnModelSchema(BaseModel):
+    """
+    +label=Sklearn Model Schema  # noqa: E501
+    """
+
+    infer_method_name: InferMethodName = Field(
+        default=...,
+        description="+label=Inference Method Name +usage=Name of the method used for inference",
+    )
+    inputs: conlist(Dict[str, Any]) = Field(
+        default=..., description="+label= Input Schema +usage=Schema of the input"
+    )
+    outputs: conlist(Dict[str, Any]) = Field(
+        default=..., description="+label= Output Schema +usage=Schema of the output"
+    )
+    __properties = ["infer_method_name", "inputs", "outputs"]
+
+    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) -> SklearnModelSchema:
+        """Create an instance of SklearnModelSchema 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) -> SklearnModelSchema:
+        """Create an instance of SklearnModelSchema from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return SklearnModelSchema.parse_obj(obj)
+
+        _obj = SklearnModelSchema.parse_obj(
+            {
+                "infer_method_name": obj.get("infer_method_name"),
+                "inputs": obj.get("inputs"),
+                "outputs": obj.get("outputs"),
+            }
+        )
+        return _obj

truefoundry/ml/autogen/client/models/sklearn_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 SklearnSerializationFormat(str, Enum):
+    """
+    +label=Serialization format +usage=Serialization format used for sklearn models
+    """
+
+    """
+    allowed enum values
+    """
+    CLOUDPICKLE = "cloudpickle"
+    JOBLIB = "joblib"
+    PICKLE = "pickle"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> SklearnSerializationFormat:
+        """Create an instance of SklearnSerializationFormat from a JSON string"""
+        return SklearnSerializationFormat(json.loads(json_str))

truefoundry/ml/autogen/client/models/transformers_framework.py

@@ -37,11 +37,11 @@ class TransformersFramework(BaseModel):
     )
     pipeline_tag: Optional[StrictStr] = Field(
         default=None,
-        description="+label=Pipeline Tag +usage=Pipeline tag +docs=Pipeline tag for the framework",
+        description="+label=Pipeline Tag +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 +docs=Pipeline tag for the framework",
     )
     base_model: Optional[StrictStr] = Field(
         default=None,
-        description="+label=Base Model +usage=Base model +docs=Base model Id. If this is a finetuned model, this points to the base model used for finetuning",
+        description="+label=Base Model +usage=Base model Id. If this is a finetuned model, this points to the base model used for finetuning +docs=Base model Id. If this is a finetuned model, this points to the base model used for finetuning",
     )
     __properties = ["type", "library_name", "pipeline_tag", "base_model"]
 

truefoundry/ml/autogen/client/models/validate_external_storage_root_request_dto.py

@@ -0,0 +1,71 @@
+# 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 truefoundry.pydantic_v1 import BaseModel, Field, StrictStr
+
+
+class ValidateExternalStorageRootRequestDto(BaseModel):
+    """
+    ValidateExternalStorageRootRequestDto
+    """
+
+    storage_root_uri: StrictStr = Field(...)
+    experiment_id: StrictStr = Field(...)
+    __properties = ["storage_root_uri", "experiment_id"]
+
+    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) -> ValidateExternalStorageRootRequestDto:
+        """Create an instance of ValidateExternalStorageRootRequestDto 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) -> ValidateExternalStorageRootRequestDto:
+        """Create an instance of ValidateExternalStorageRootRequestDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return ValidateExternalStorageRootRequestDto.parse_obj(obj)
+
+        _obj = ValidateExternalStorageRootRequestDto.parse_obj(
+            {
+                "storage_root_uri": obj.get("storage_root_uri"),
+                "experiment_id": obj.get("experiment_id"),
+            }
+        )
+        return _obj

truefoundry/ml/autogen/client/models/validate_external_storage_root_response_dto.py

@@ -0,0 +1,69 @@
+# 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, StrictBool, StrictStr
+
+
+class ValidateExternalStorageRootResponseDto(BaseModel):
+    """
+    ValidateExternalStorageRootResponseDto
+    """
+
+    is_valid: StrictBool = Field(...)
+    message: Optional[StrictStr] = None
+    __properties = ["is_valid", "message"]
+
+    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) -> ValidateExternalStorageRootResponseDto:
+        """Create an instance of ValidateExternalStorageRootResponseDto 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) -> ValidateExternalStorageRootResponseDto:
+        """Create an instance of ValidateExternalStorageRootResponseDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return ValidateExternalStorageRootResponseDto.parse_obj(obj)
+
+        _obj = ValidateExternalStorageRootResponseDto.parse_obj(
+            {"is_valid": obj.get("is_valid"), "message": obj.get("message")}
+        )
+        return _obj

truefoundry/ml/autogen/client/models/xg_boost_framework.py

@@ -16,7 +16,14 @@ from __future__ import annotations
 import json
 import pprint
 import re  # noqa: F401
-
+from typing import Optional
+
+from truefoundry.ml.autogen.client.models.xg_boost_model_schema import (
+    XGBoostModelSchema,
+)
+from truefoundry.ml.autogen.client.models.xg_boost_serialization_format import (
+    XGBoostSerializationFormat,
+)
 from truefoundry.pydantic_v1 import BaseModel, Field, StrictStr, validator
 
 
@@ -29,7 +36,13 @@ class XGBoostFramework(BaseModel):
         default=...,
         description="+label=Type +usage=Type of the framework +value=xgboost",
     )
-    __properties = ["type"]
+    serialization_format: Optional[XGBoostSerializationFormat] = None
+    model_filepath: Optional[StrictStr] = Field(
+        default=None,
+        description="+label=Model file path +usage=Relative path to the model file",
+    )
+    model_schema: Optional[XGBoostModelSchema] = None
+    __properties = ["type", "serialization_format", "model_filepath", "model_schema"]
 
     @validator("type")
     def type_validate_enum(cls, value):
@@ -60,6 +73,9 @@ class XGBoostFramework(BaseModel):
     def to_dict(self):
         """Returns the dictionary representation of the model using alias"""
         _dict = self.dict(by_alias=True, exclude={}, exclude_none=True)
+        # override the default output from truefoundry.pydantic_v1 by calling `to_dict()` of model_schema
+        if self.model_schema:
+            _dict["model_schema"] = self.model_schema.to_dict()
         return _dict
 
     @classmethod
@@ -71,5 +87,14 @@ 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"),
+                "model_filepath": obj.get("model_filepath"),
+                "model_schema": XGBoostModelSchema.from_dict(obj.get("model_schema"))
+                if obj.get("model_schema") is not None
+                else None,
+            }
+        )
         return _obj

truefoundry/ml/autogen/client/models/xg_boost_model_schema.py

@@ -0,0 +1,88 @@
+# 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 Any, Dict
+
+from truefoundry.pydantic_v1 import BaseModel, Field, StrictStr, conlist, validator
+
+
+class XGBoostModelSchema(BaseModel):
+    """
+    +label=XGBoost Model Schema  # noqa: E501
+    """
+
+    infer_method_name: StrictStr = Field(
+        default=...,
+        description="+label=Inference Method Name +usage=Name of the method used for inference",
+    )
+    inputs: conlist(Dict[str, Any]) = Field(
+        default=..., description="+label= Input Schema +usage=Schema of the input"
+    )
+    outputs: conlist(Dict[str, Any]) = Field(
+        default=..., description="+label= Output Schema +usage=Schema of the output"
+    )
+    __properties = ["infer_method_name", "inputs", "outputs"]
+
+    @validator("infer_method_name")
+    def infer_method_name_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in ("predict",):
+            raise ValueError("must be one of enum values ('predict')")
+        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) -> XGBoostModelSchema:
+        """Create an instance of XGBoostModelSchema 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) -> XGBoostModelSchema:
+        """Create an instance of XGBoostModelSchema from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return XGBoostModelSchema.parse_obj(obj)
+
+        _obj = XGBoostModelSchema.parse_obj(
+            {
+                "infer_method_name": obj.get("infer_method_name"),
+                "inputs": obj.get("inputs"),
+                "outputs": obj.get("outputs"),
+            }
+        )
+        return _obj

truefoundry/ml/autogen/client/models/xg_boost_serialization_format.py

@@ -0,0 +1,36 @@
+# 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 XGBoostSerializationFormat(str, Enum):
+    """
+    +label=Serialization format +usage=Serialization format used for XGBoost models
+    """
+
+    """
+    allowed enum values
+    """
+    CLOUDPICKLE = "cloudpickle"
+    JOBLIB = "joblib"
+    PICKLE = "pickle"
+    JSON = "json"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> XGBoostSerializationFormat:
+        """Create an instance of XGBoostSerializationFormat from a JSON string"""
+        return XGBoostSerializationFormat(json.loads(json_str))