Added methods for aqua-model store apis change

Author: vikasray0208

ads/model/datascience_model.py

@@ -10,8 +10,10 @@
 import os
 import shutil
 import tempfile
+import uuid
 from copy import deepcopy
 from typing import Dict, List, Optional, Tuple, Union
+from zipfile import ZipFile
 
 import pandas
 import yaml
@@ -1571,7 +1573,7 @@ def delete(
 
  @classmethod
  def list(
- cls, compartment_id: str = None, project_id: str = None, **kwargs
+  cls, compartment_id: str = None, project_id: str = None,category: str = "USER", **kwargs
  ) -> List["DataScienceModel"]:
  """Lists datascience models in a given compartment.
 
@@ -1581,6 +1583,8 @@ def list(
  The compartment OCID.
  project_id: (str, optional). Defaults to `None`.
  The project OCID.
+ category: (str, optional). Defaults to `USER`.
+ The category of Model.
  kwargs
  Additional keyword arguments for filtering models.
 
@@ -1592,13 +1596,13 @@ def list(
  return [
  cls()._update_from_oci_dsc_model(model)
  for model in OCIDataScienceModel.list_resource(
- compartment_id, project_id=project_id, **kwargs
+ compartment_id, project_id=project_id, category=category, **kwargs
  )
  ]
 
  @classmethod
  def list_df(
- cls, compartment_id: str = None, project_id: str = None, **kwargs
+  cls, compartment_id: str = None, project_id: str = None, category: str = "USER", **kwargs
  ) -> "pandas.DataFrame":
  """Lists datascience models in a given compartment.
 
@@ -1608,6 +1612,8 @@ def list_df(
  The compartment OCID.
  project_id: (str, optional). Defaults to `None`.
  The project OCID.
+ category: (str, optional). Defaults to `None`.
+ The category of Model.
  kwargs
  Additional keyword arguments for filtering models.
 
@@ -1618,7 +1624,7 @@ def list_df(
  """
  records = []
  for model in OCIDataScienceModel.list_resource(
- compartment_id, project_id=project_id, **kwargs
+  compartment_id, project_id=project_id, category=category, **kwargs
  ):
  records.append(
  {
@@ -2193,3 +2199,249 @@ def find_model_idx():
  else:
  # model found case
  self.model_file_description["models"].pop(modelSearchIdx)
+
+ def create_custom_metadata_artifact(self, model_ocid: str, metadata_key_name: str, artifact_path: str) -> dict:
+ """Creates model custom metadata artifact for specified model.
+
+ Parameters
+ ----------
+ model_ocid: str
+ The `OCID`__ of the model.
+ __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+ metadata_key_name: str
+ The name of the model metadatum in the metadata.
+
+ artifact_path: str
+ The model custom metadata artifact path to be upload.
+ Returns
+ -------
+ Dict
+ The model custom metadata artifact creation info.
+ Example:
+ {
+ 'Date': 'Mon, 02 Dec 2024 06:38:24 GMT',
+ 'opc-request-id': 'E4F7',
+ 'ETag': '77156317-8bb9-4c4a-882b-0d85f8140d93',
+ 'X-Content-Type-Options': 'nosniff',
+ 'Content-Length': '4029958',
+ 'Vary': 'Origin',
+ 'Strict-Transport-Security': 'max-age=31536000; includeSubDomains',
+ 'status': 204
+ }
+
+ """
+ return self.dsc_model.create_custom_metadata_artifact(model_ocid=model_ocid, metadata_key_name=metadata_key_name,
+ artifact_path=artifact_path)
+
+
+ def create_defined_metadata_artifact(self, model_ocid: str, metadata_key_name: str, artifact_path: str) -> dict:
+ """Creates model defined metadata artifact for specified model.
+
+ Parameters
+ ----------
+ model_ocid: str
+ The `OCID`__ of the model.
+ __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+ metadata_key_name: str
+ The name of the model metadatum in the metadata.
+
+ artifact_path: str
+ The model custom metadata artifact path to be upload.
+ Returns
+ -------
+ The model defined metadata artifact creation info.
+ Example:
+ {
+ 'Date': 'Mon, 02 Dec 2024 06:38:24 GMT',
+ 'opc-request-id': 'E4F7',
+ 'ETag': '77156317-8bb9-4c4a-882b-0d85f8140d93',
+ 'X-Content-Type-Options': 'nosniff',
+ 'Content-Length': '4029958',
+ 'Vary': 'Origin',
+ 'Strict-Transport-Security': 'max-age=31536000; includeSubDomains',
+ 'status': 204
+ }
+
+ """
+ return self.dsc_model.create_defined_metadata_artifact(model_ocid=model_ocid, metadata_key_name=metadata_key_name,
+ artifact_path=artifact_path)
+
+
+ def update_custom_metadata_artifact(self, model_ocid: str, metadata_key_name: str, artifact_path: str) -> dict:
+ """Update model custom metadata artifact for specified model.
+
+ Parameters
+ ----------
+ model_ocid: str
+ The `OCID`__ of the model.
+ __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+ metadata_key_name: str
+ The name of the model metadatum in the metadata.
+
+ artifact_path: str
+ The model custom metadata artifact path to be upload.
+ Returns
+ -------
+ Dict
+ The model custom metadata artifact update info.
+ Example:
+ {
+ 'Date': 'Mon, 02 Dec 2024 06:38:24 GMT',
+ 'opc-request-id': 'E4F7',
+ 'ETag': '77156317-8bb9-4c4a-882b-0d85f8140d93',
+ 'X-Content-Type-Options': 'nosniff',
+ 'Content-Length': '4029958',
+ 'Vary': 'Origin',
+ 'Strict-Transport-Security': 'max-age=31536000; includeSubDomains',
+ 'status': 204
+ }
+
+ """
+ return self.dsc_model.update_custom_metadata_artifact(model_ocid=model_ocid, metadata_key_name=metadata_key_name,
+ artifact_path=artifact_path)
+
+
+ def update_defined_metadata_artifact(self, model_ocid: str, metadata_key_name: str, artifact_path: str) -> dict:
+ """Update model defined metadata artifact for specified model.
+
+ Parameters
+ ----------
+ model_ocid: str
+ The `OCID`__ of the model.
+ __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+ metadata_key_name: str
+ The name of the model metadatum in the metadata.
+
+ artifact_path: str
+ The model defined metadata artifact path to be upload.
+ Returns
+ -------
+ Dict
+ The model defined metadata artifact update info.
+ Example:
+ {
+ 'Date': 'Mon, 02 Dec 2024 06:38:24 GMT',
+ 'opc-request-id': 'E4F7',
+ 'ETag': '77156317-8bb9-4c4a-882b-0d85f8140d93',
+ 'X-Content-Type-Options': 'nosniff',
+ 'Content-Length': '4029958',
+ 'Vary': 'Origin',
+ 'Strict-Transport-Security': 'max-age=31536000; includeSubDomains',
+ 'status': 204
+ }
+
+ """
+ return self.dsc_model.update_defined_metadata_artifact(model_ocid=model_ocid, metadata_key_name=metadata_key_name,
+ artifact_path=artifact_path)
+
+ def get_custom_metadata_artifact(self, model_ocid: str, metadata_key_name: str, target_dir: str) -> None:
+ """Downloads model custom metadata artifact content for specified model metadata key.
+
+ Parameters
+ ----------
+ model_ocid: str
+ The `OCID`__ of the model.
+ __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+ metadata_key_name: str
+ The name of the model metadatum in the metadata.
+ Returns
+ -------
+ BytesIO
+ custom metadata artifact content
+
+ """
+ file_content = self.dsc_model.get_custom_metadata_artifact(model_ocid=model_ocid,
+ metadata_key_name=metadata_key_name)
+ artifact_file_path = os.path.join(
+ target_dir, f"{metadata_key_name}"
+ )
+ with open(artifact_file_path, "wb") as _file:
+ _file.write(file_content)
+ print(f"Artifact downloaded to location - {artifact_file_path}")
+
+ def get_defined_metadata_artifact(self, model_ocid: str, metadata_key_name: str, target_dir: str) -> None:
+ """Downloads model defined metadata artifact content for specified model metadata key.
+
+ Parameters
+ ----------
+ model_ocid: str
+ The `OCID`__ of the model.
+ __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+ metadata_key_name: str
+ The name of the model metadatum in the metadata.
+ Returns
+ -------
+ BytesIO
+ Defined metadata artifact content
+
+ """
+ file_content = self.dsc_model.get_defined_metadata_artifact(model_ocid=model_ocid,
+ metadata_key_name=metadata_key_name)
+ artifact_file_path = os.path.join(
+ target_dir, f"{metadata_key_name}"
+ )
+ with open(artifact_file_path, "wb") as _file:
+ _file.write(file_content)
+ print(f"Artifact downloaded to location - {artifact_file_path}")
+
+ def delete_custom_metadata_artifact(self, model_ocid: str, metadata_key_name: str) -> dict:
+ """Deletes model custom metadata artifact for specified model metadata key.
+
+ Parameters
+ ----------
+ model_ocid: str
+ The `OCID`__ of the model.
+ __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+ metadata_key_name: str
+ The name of the model metadatum in the metadata.
+ Returns
+ -------
+ Dict
+ The model custom metadata artifact delete call info.
+ Example:
+ {
+ 'Date': 'Mon, 02 Dec 2024 06:38:24 GMT',
+ 'opc-request-id': 'E4F7',
+ 'X-Content-Type-Options': 'nosniff',
+ 'Vary': 'Origin',
+ 'Strict-Transport-Security': 'max-age=31536000; includeSubDomains',
+ 'status': 204
+ }
+
+ """
+ return self.dsc_model.delete_custom_metadata_artifact(model_ocid=model_ocid, metadata_key_name=metadata_key_name)
+
+ def delete_defined_metadata_artifact(self, model_ocid: str, metadata_key_name: str) -> dict:
+ """Deletes model defined metadata artifact for specified model metadata key.
+
+ Parameters
+ ----------
+ model_ocid: str
+ The `OCID`__ of the model.
+ __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
+ metadata_key_name: str
+ The name of the model metadatum in the metadata.
+ Returns
+ -------
+ Dict
+ The model defined metadata artifact delete call info.
+ Example:
+ {
+ 'Date': 'Mon, 02 Dec 2024 06:38:24 GMT',
+ 'opc-request-id': 'E4F7',
+ 'X-Content-Type-Options': 'nosniff',
+ 'Vary': 'Origin',
+ 'Strict-Transport-Security': 'max-age=31536000; includeSubDomains',
+ 'status': 204
+ }
+
+ """
+ return self.dsc_model.delete_defined_metadata_artifact(model_ocid=model_ocid, metadata_key_name=metadata_key_name)

ads/model/model_version_set.py

@@ -454,7 +454,7 @@ def kind(self) -> str:
  return "modelVersionSet"
 
  @classmethod
- def list(cls, compartment_id: str = None, **kwargs) -> List["ModelVersionSet"]:
+ def list(cls, compartment_id: str = None, category: Optional[str] = "USER", **kwargs) -> List["ModelVersionSet"]:
  """
  List model version sets in a given compartment.
 
@@ -473,7 +473,7 @@ def list(cls, compartment_id: str = None, **kwargs) -> List["ModelVersionSet"]:
  return [
  cls.from_dsc_model_version_set(model_version_set)
  for model_version_set in DataScienceModelVersionSet.list_resource(
- compartment_id, **kwargs
+ compartment_id, category, **kwargs
  )
  ]