Skip to content

Feature/multi model artifact handler #869

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Changes from 14 commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
6d9fa4a
Initial commit
YashPandit4u May 27, 2024
6a930f1
rename in main module file
YashPandit4u May 27, 2024
5f3b316
Logger used for prints, error handling improved, one extra file creat…
YashPandit4u Jun 1, 2024
802e438
Merge branch 'oracle:main' into feature/multi-model-artifact-handler
YashPandit4u Jun 1, 2024
35e8464
Reformatted using black.
YashPandit4u Jun 1, 2024
e625107
Merge branch 'feature/multi-model-artifact-handler' of https://github…
YashPandit4u Jun 1, 2024
74a235e
Separate logger used.
YashPandit4u Jun 1, 2024
848972e
Added python docs for all methods.
YashPandit4u Jun 1, 2024
d35b917
Added class DataScienceModelCollection that extends from DataScienceM…
YashPandit4u Jun 5, 2024
3ac5338
removed old model description class
YashPandit4u Jun 5, 2024
822c7e8
formatted using black
YashPandit4u Jun 5, 2024
3d4d950
black formatter used and one return type added.
YashPandit4u Jun 5, 2024
d4ef023
Added add_artifact and remove_artifact method in main DataScienceMode…
YashPandit4u Jun 11, 2024
c40ea8b
Removed new added class.
YashPandit4u Jun 11, 2024
d0309f4
Added uri based approach
YashPandit4u Jun 13, 2024
19ec921
Added unit tests.
YashPandit4u Jun 13, 2024
9089028
Changed the pydocs according to ads specifications
YashPandit4u Jun 13, 2024
464cb37
Merge branch 'main' into feature/multi-model-artifact-handler
YashPandit4u Jun 13, 2024
49be8f8
replaces regex with normal splitting for uri
YashPandit4u Jun 13, 2024
a2894a5
Merge branch 'feature/multi-model-artifact-handler' of https://github…
YashPandit4u Jun 13, 2024
5d327cd
removed default_signer
YashPandit4u Jun 13, 2024
b7e7d74
Used ObjectStorageDetails.from_path(uri) for url decoding.
YashPandit4u Jun 13, 2024
4418bf8
namespace, bucket, prefix way added again.
YashPandit4u Jun 14, 2024
e2e7099
Merge branch 'main' into feature/multi-model-artifact-handler
YashPandit4u Jun 14, 2024
4cc8823
Given options for both uri and (namespace, bucket) in add_artifact, r…
YashPandit4u Jun 15, 2024
7f3cc7f
Updated python docs
YashPandit4u Jun 15, 2024
32f4826
Ran black formatter.
YashPandit4u Jun 15, 2024
9f69e35
Ran black formatter of UTs.
YashPandit4u Jun 15, 2024
ad0ce2e
Added uri UTs.
YashPandit4u Jun 15, 2024
eec2b4d
Prefix null check added.
YashPandit4u Jun 15, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
158 changes: 158 additions & 0 deletions ads/model/datascience_model.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@
ModelProvenanceNotFoundError,
OCIDataScienceModel,
)
from ads.common import oci_client as oc
from ads.common.auth import default_signer

logger = logging.getLogger(__name__)

Expand Down Expand Up @@ -1466,3 +1468,159 @@ def _download_file_description_artifact(self) -> Tuple[Union[str, List[str]], in
bucket_uri.append(uri)

return bucket_uri[0] if len(bucket_uri) == 1 else bucket_uri, artifact_size

def add_artifact(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NIT: Could you please add an examples section for the add and delete artifacts feature?

self,
namespace: str,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For consistency it would be better to accept OCIFS "oci://" path.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have changed both functions add_artifact and remove_artifact with this uri type input.

bucket: str,
prefix: Optional[str] = None,
files: Optional[List[str]] = None,
):
"""
Adds information about objects in a specified bucket to the model description JSON.

Parameters:
- namespace (str): The namespace of the object storage.
- bucket (str): The name of the bucket containing the objects.
- prefix (str, optional): The prefix used to filter objects within the bucket. Defaults to None.
- files (list of str, optional): A list of file names to include in the model description.
If provided, only objects with matching file names will be included. Defaults to None.

Returns:
- None

Raises:
- ValueError: If no files are found to add to the model description.

Note:
- If `files` is not provided, it retrieves information about all objects in the bucket.
If `files` is provided, it only retrieves information about objects with matching file names.
- If no objects are found to add to the model description, a ValueError is raised.
"""
if self.model_file_description == None:
self.empty_json = {
"version": "1.0",
"type": "modelOSSReferenceDescription",
"models": [],
}
self.set_spec(self.CONST_MODEL_FILE_DESCRIPTION, self.empty_json)

# Get object storage client
authData = default_signer()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically the auth object is already constructed and accessible by

self.dsc_model.auth

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, using this now.

self.object_storage_client = oc.OCIClientFactory(**authData).object_storage

# Remove if the model already exists
self.remove_artifact(namespace, bucket, prefix)

def check_if_file_exists(fileName):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NIT: I would not recommend to create nested functions, it would be hard to write unit tests for such methods. I would rather recommend to move such methods into utils or outside the class.

isExists = False
try:
headResponse = self.object_storage_client.head_object(
namespace, bucket, object_name=fileName
)
if headResponse.status == 200:
isExists = True
except Exception as e:
if hasattr(e, "status") and e.status == 404:
logger.error(f"File not found in bucket: {fileName}")
else:
logger.error(f"An error occured: {e}")
return isExists

# Function to un-paginate the api call with while loop
def list_obj_versions_unpaginated():
objectStorageList = []
has_next_page, opc_next_page = True, None
while has_next_page:
response = self.object_storage_client.list_object_versions(
namespace_name=namespace,
bucket_name=bucket,
prefix=prefix,
fields="name,size",
page=opc_next_page,
)
objectStorageList.extend(response.data.items)
has_next_page = response.has_next_page
opc_next_page = response.next_page
return objectStorageList

# Fetch object details and put it into the objects variable
objectStorageList = []
if files == None:
objectStorageList = list_obj_versions_unpaginated()
else:
for fileName in files:
if check_if_file_exists(fileName=fileName):
objectStorageList.append(
self.object_storage_client.list_object_versions(
namespace_name=namespace,
bucket_name=bucket,
prefix=fileName,
fields="name,size",
).data.items[0]
)

objects = [
{"name": obj.name, "version": obj.version_id, "sizeInBytes": obj.size}
for obj in objectStorageList
if obj.size > 0
]

if len(objects) == 0:
error_message = (
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NIT:

error_message = (
        f"No files found to add in the bucket '{bucket}' within the namespace '{namespace}' "
        f"and prefix '{prefix}'. Expected file names: {files}"
    )

f"No files to add in the bucket: {bucket} with namespace: {namespace} "
f"and prefix: {prefix}. File names: {files}"
)
logger.error(error_message)
raise ValueError(error_message)

tmp_model_file_description = self.model_file_description
tmp_model_file_description["models"].append(
{
"namespace": namespace,
"bucketName": bucket,
"prefix": prefix,
"objects": objects,
}
)
self.set_spec(self.CONST_MODEL_FILE_DESCRIPTION, tmp_model_file_description)

def remove_artifact(self, namespace: str, bucket: str, prefix: Optional[str] = None):
"""
Removes information about objects in a specified bucket from the model description JSON.

Parameters:
- namespace (str): The namespace of the object storage.
- bucket (str): The name of the bucket containing the objects.
- prefix (str, optional): The prefix used to filter objects within the bucket. Defaults to None.

Returns:
- None

Note:
- This method removes information about objects in the specified bucket from the
instance of the ModelDescription.
- If a matching model (with the specified namespace, bucket name, and prefix) is found
in the model description JSON, it is removed.
- If no matching model is found, the method returns without making any changes.
"""

def findModelIdx():
for idx, model in enumerate(self.model_file_description["models"]):
if (
model["namespace"],
model["bucketName"],
(model["prefix"] if ("prefix" in model) else None),
) == (namespace, bucket, prefix):
return idx
return -1

if self.model_file_description == None:
return

modelSearchIdx = findModelIdx()
if modelSearchIdx == -1:
return
else:
# model found case
self.model_file_description["models"].pop(modelSearchIdx)
Loading