truefoundry 0.5.0rc5__py3-none-any.whl → 0.5.0rc7__py3-none-any.whl

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/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/ml/autogen/client/__init__.py

@@ -176,8 +176,6 @@ from truefoundry.ml.autogen.client.models.external_artifact_source import (
     ExternalArtifactSource,
 )
 from truefoundry.ml.autogen.client.models.fast_ai_framework import FastAIFramework
-from truefoundry.ml.autogen.client.models.feature_dto import FeatureDto
-from truefoundry.ml.autogen.client.models.feature_value_type import FeatureValueType
 from truefoundry.ml.autogen.client.models.file_info_dto import FileInfoDto
 from truefoundry.ml.autogen.client.models.finalize_artifact_version_request_dto import (
     FinalizeArtifactVersionRequestDto,
@@ -313,8 +311,10 @@ from truefoundry.ml.autogen.client.models.mime_type import MimeType
 from truefoundry.ml.autogen.client.models.model_configuration import ModelConfiguration
 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_schema_dto import ModelSchemaDto
 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,
 )
@@ -338,7 +338,6 @@ from truefoundry.ml.autogen.client.models.openapi_spec import OpenapiSpec
 from truefoundry.ml.autogen.client.models.paddle_framework import PaddleFramework
 from truefoundry.ml.autogen.client.models.param_dto import ParamDto
 from truefoundry.ml.autogen.client.models.parameters import Parameters
-from truefoundry.ml.autogen.client.models.prediction_type import PredictionType
 from truefoundry.ml.autogen.client.models.py_torch_framework import PyTorchFramework
 from truefoundry.ml.autogen.client.models.resolve_agent_app_response_dto import (
     ResolveAgentAppResponseDto,
@@ -359,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/ml/autogen/client/api/deprecated_api.py

@@ -21,12 +21,21 @@ from truefoundry.ml.autogen.client.exceptions import (  # noqa: F401
     ApiTypeError,
     ApiValueError,
 )
+from truefoundry.ml.autogen.client.models.add_custom_metrics_to_model_version_request_dto import (
+    AddCustomMetricsToModelVersionRequestDto,
+)
+from truefoundry.ml.autogen.client.models.add_features_to_model_version_request_dto import (
+    AddFeaturesToModelVersionRequestDto,
+)
 from truefoundry.ml.autogen.client.models.body_get_search_runs_get import (
     BodyGetSearchRunsGet,
 )
 from truefoundry.ml.autogen.client.models.get_signed_urls_for_dataset_write_response_dto import (
     GetSignedURLsForDatasetWriteResponseDto,
 )
+from truefoundry.ml.autogen.client.models.model_version_response_dto import (
+    ModelVersionResponseDto,
+)
 from truefoundry.ml.autogen.client.models.run_response_dto import RunResponseDto
 from truefoundry.ml.autogen.client.models.search_runs_response_dto import (
     SearchRunsResponseDto,
@@ -52,7 +61,331 @@ class DeprecatedApi:
         self.api_client = api_client
 
     @validate_arguments
-    def get_run_by_name_get_0(
+    def add_custom_metrics_to_model_version_post(
+        self,
+        add_custom_metrics_to_model_version_request_dto: AddCustomMetricsToModelVersionRequestDto,
+        **kwargs,
+    ) -> ModelVersionResponseDto:  # noqa: E501
+        """(Deprecated) Add Custom Metrics To Model Version  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.add_custom_metrics_to_model_version_post(add_custom_metrics_to_model_version_request_dto, async_req=True)
+        >>> result = thread.get()
+
+        :param add_custom_metrics_to_model_version_request_dto: (required)
+        :type add_custom_metrics_to_model_version_request_dto: AddCustomMetricsToModelVersionRequestDto
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :param _request_timeout: timeout setting for this request.
+               If one number provided, it will be total request
+               timeout. It can also be a pair (tuple) of
+               (connection, read) timeouts.
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: ModelVersionResponseDto
+        """
+        kwargs["_return_http_data_only"] = True
+        if "_preload_content" in kwargs:
+            message = "Error! Please call the add_custom_metrics_to_model_version_post_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data"  # noqa: E501
+            raise ValueError(message)
+        return self.add_custom_metrics_to_model_version_post_with_http_info(
+            add_custom_metrics_to_model_version_request_dto, **kwargs
+        )  # noqa: E501
+
+    @validate_arguments
+    def add_custom_metrics_to_model_version_post_with_http_info(
+        self,
+        add_custom_metrics_to_model_version_request_dto: AddCustomMetricsToModelVersionRequestDto,
+        **kwargs,
+    ) -> ApiResponse:  # noqa: E501
+        """(Deprecated) Add Custom Metrics To Model Version  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.add_custom_metrics_to_model_version_post_with_http_info(add_custom_metrics_to_model_version_request_dto, async_req=True)
+        >>> result = thread.get()
+
+        :param add_custom_metrics_to_model_version_request_dto: (required)
+        :type add_custom_metrics_to_model_version_request_dto: AddCustomMetricsToModelVersionRequestDto
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :param _preload_content: if False, the ApiResponse.data will
+                                 be set to none and raw_data will store the
+                                 HTTP response body without reading/decoding.
+                                 Default is True.
+        :type _preload_content: bool, optional
+        :param _return_http_data_only: response data instead of ApiResponse
+                                       object with status code, headers, etc
+        :type _return_http_data_only: bool, optional
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the authentication
+                              in the spec for a single request.
+        :type _request_auth: dict, optional
+        :type _content_type: string, optional: force content-type for the request
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: tuple(ModelVersionResponseDto, status_code(int), headers(HTTPHeaderDict))
+        """
+
+        warnings.warn(
+            "POST /model-versions/custom-metrics/add is deprecated.", DeprecationWarning
+        )
+
+        _params = locals()
+
+        _all_params = ["add_custom_metrics_to_model_version_request_dto"]
+        _all_params.extend(
+            [
+                "async_req",
+                "_return_http_data_only",
+                "_preload_content",
+                "_request_timeout",
+                "_request_auth",
+                "_content_type",
+                "_headers",
+            ]
+        )
+
+        # validate the arguments
+        for _key, _val in _params["kwargs"].items():
+            if _key not in _all_params:
+                raise ApiTypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method add_custom_metrics_to_model_version_post" % _key
+                )
+            _params[_key] = _val
+        del _params["kwargs"]
+
+        _collection_formats = {}
+
+        # process the path parameters
+        _path_params = {}
+
+        # process the query parameters
+        _query_params = []
+        # process the header parameters
+        _header_params = dict(_params.get("_headers", {}))
+        # process the form parameters
+        _form_params = []
+        _files = {}
+        # process the body parameter
+        _body_params = None
+        if _params["add_custom_metrics_to_model_version_request_dto"] is not None:
+            _body_params = _params["add_custom_metrics_to_model_version_request_dto"]
+
+        # set the HTTP header `Accept`
+        _header_params["Accept"] = self.api_client.select_header_accept(
+            ["application/json"]
+        )  # noqa: E501
+
+        # set the HTTP header `Content-Type`
+        _content_types_list = _params.get(
+            "_content_type",
+            self.api_client.select_header_content_type(["application/json"]),
+        )
+        if _content_types_list:
+            _header_params["Content-Type"] = _content_types_list
+
+        # authentication setting
+        _auth_settings = ["HTTPBearer", "APIKeyCookie"]  # noqa: E501
+
+        _response_types_map = {
+            "200": "ModelVersionResponseDto",
+            "422": "HTTPValidationError",
+        }
+
+        return self.api_client.call_api(
+            "/model-versions/custom-metrics/add",
+            "POST",
+            _path_params,
+            _query_params,
+            _header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            response_types_map=_response_types_map,
+            auth_settings=_auth_settings,
+            async_req=_params.get("async_req"),
+            _return_http_data_only=_params.get("_return_http_data_only"),  # noqa: E501
+            _preload_content=_params.get("_preload_content", True),
+            _request_timeout=_params.get("_request_timeout"),
+            collection_formats=_collection_formats,
+            _request_auth=_params.get("_request_auth"),
+        )
+
+    @validate_arguments
+    def add_features_to_model_version_post(
+        self,
+        add_features_to_model_version_request_dto: AddFeaturesToModelVersionRequestDto,
+        **kwargs,
+    ) -> ModelVersionResponseDto:  # noqa: E501
+        """(Deprecated) Add Features To Model Version  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.add_features_to_model_version_post(add_features_to_model_version_request_dto, async_req=True)
+        >>> result = thread.get()
+
+        :param add_features_to_model_version_request_dto: (required)
+        :type add_features_to_model_version_request_dto: AddFeaturesToModelVersionRequestDto
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :param _request_timeout: timeout setting for this request.
+               If one number provided, it will be total request
+               timeout. It can also be a pair (tuple) of
+               (connection, read) timeouts.
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: ModelVersionResponseDto
+        """
+        kwargs["_return_http_data_only"] = True
+        if "_preload_content" in kwargs:
+            message = "Error! Please call the add_features_to_model_version_post_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data"  # noqa: E501
+            raise ValueError(message)
+        return self.add_features_to_model_version_post_with_http_info(
+            add_features_to_model_version_request_dto, **kwargs
+        )  # noqa: E501
+
+    @validate_arguments
+    def add_features_to_model_version_post_with_http_info(
+        self,
+        add_features_to_model_version_request_dto: AddFeaturesToModelVersionRequestDto,
+        **kwargs,
+    ) -> ApiResponse:  # noqa: E501
+        """(Deprecated) Add Features To Model Version  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.add_features_to_model_version_post_with_http_info(add_features_to_model_version_request_dto, async_req=True)
+        >>> result = thread.get()
+
+        :param add_features_to_model_version_request_dto: (required)
+        :type add_features_to_model_version_request_dto: AddFeaturesToModelVersionRequestDto
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :param _preload_content: if False, the ApiResponse.data will
+                                 be set to none and raw_data will store the
+                                 HTTP response body without reading/decoding.
+                                 Default is True.
+        :type _preload_content: bool, optional
+        :param _return_http_data_only: response data instead of ApiResponse
+                                       object with status code, headers, etc
+        :type _return_http_data_only: bool, optional
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the authentication
+                              in the spec for a single request.
+        :type _request_auth: dict, optional
+        :type _content_type: string, optional: force content-type for the request
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: tuple(ModelVersionResponseDto, status_code(int), headers(HTTPHeaderDict))
+        """
+
+        warnings.warn(
+            "POST /model-versions/features/add is deprecated.", DeprecationWarning
+        )
+
+        _params = locals()
+
+        _all_params = ["add_features_to_model_version_request_dto"]
+        _all_params.extend(
+            [
+                "async_req",
+                "_return_http_data_only",
+                "_preload_content",
+                "_request_timeout",
+                "_request_auth",
+                "_content_type",
+                "_headers",
+            ]
+        )
+
+        # validate the arguments
+        for _key, _val in _params["kwargs"].items():
+            if _key not in _all_params:
+                raise ApiTypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method add_features_to_model_version_post" % _key
+                )
+            _params[_key] = _val
+        del _params["kwargs"]
+
+        _collection_formats = {}
+
+        # process the path parameters
+        _path_params = {}
+
+        # process the query parameters
+        _query_params = []
+        # process the header parameters
+        _header_params = dict(_params.get("_headers", {}))
+        # process the form parameters
+        _form_params = []
+        _files = {}
+        # process the body parameter
+        _body_params = None
+        if _params["add_features_to_model_version_request_dto"] is not None:
+            _body_params = _params["add_features_to_model_version_request_dto"]
+
+        # set the HTTP header `Accept`
+        _header_params["Accept"] = self.api_client.select_header_accept(
+            ["application/json"]
+        )  # noqa: E501
+
+        # set the HTTP header `Content-Type`
+        _content_types_list = _params.get(
+            "_content_type",
+            self.api_client.select_header_content_type(["application/json"]),
+        )
+        if _content_types_list:
+            _header_params["Content-Type"] = _content_types_list
+
+        # authentication setting
+        _auth_settings = ["HTTPBearer", "APIKeyCookie"]  # noqa: E501
+
+        _response_types_map = {
+            "200": "ModelVersionResponseDto",
+            "422": "HTTPValidationError",
+        }
+
+        return self.api_client.call_api(
+            "/model-versions/features/add",
+            "POST",
+            _path_params,
+            _query_params,
+            _header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            response_types_map=_response_types_map,
+            auth_settings=_auth_settings,
+            async_req=_params.get("async_req"),
+            _return_http_data_only=_params.get("_return_http_data_only"),  # noqa: E501
+            _preload_content=_params.get("_preload_content", True),
+            _request_timeout=_params.get("_request_timeout"),
+            collection_formats=_collection_formats,
+            _request_auth=_params.get("_request_auth"),
+        )
+
+    @validate_arguments
+    def get_run_by_name_get(
         self,
         run_name: StrictStr,
         experiment_id: Optional[StrictStr] = None,
@@ -65,7 +398,7 @@ class DeprecatedApi:
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.get_run_by_name_get_0(run_name, experiment_id, experiment_name, async_req=True)
+        >>> thread = api.get_run_by_name_get(run_name, experiment_id, experiment_name, async_req=True)
         >>> result = thread.get()
 
         :param run_name: (required)
@@ -87,14 +420,14 @@ class DeprecatedApi:
         """
         kwargs["_return_http_data_only"] = True
         if "_preload_content" in kwargs:
-            message = "Error! Please call the get_run_by_name_get_0_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data"  # noqa: E501
+            message = "Error! Please call the get_run_by_name_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data"  # noqa: E501
             raise ValueError(message)
-        return self.get_run_by_name_get_0_with_http_info(
+        return self.get_run_by_name_get_with_http_info(
             run_name, experiment_id, experiment_name, **kwargs
         )  # noqa: E501
 
     @validate_arguments
-    def get_run_by_name_get_0_with_http_info(
+    def get_run_by_name_get_with_http_info(
         self,
         run_name: StrictStr,
         experiment_id: Optional[StrictStr] = None,
@@ -107,7 +440,7 @@ class DeprecatedApi:
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.get_run_by_name_get_0_with_http_info(run_name, experiment_id, experiment_name, async_req=True)
+        >>> thread = api.get_run_by_name_get_with_http_info(run_name, experiment_id, experiment_name, async_req=True)
         >>> result = thread.get()
 
         :param run_name: (required)
@@ -165,7 +498,7 @@ class DeprecatedApi:
             if _key not in _all_params:
                 raise ApiTypeError(
                     "Got an unexpected keyword argument '%s'"
-                    " to method get_run_by_name_get_0" % _key
+                    " to method get_run_by_name_get" % _key
                 )
             _params[_key] = _val
         del _params["kwargs"]