Initial commit

Signed-off-by: Yash Pandit <yash.pandit@oracle.com>

Author: YashPandit4u

ads/model/model-description.py

@@ -0,0 +1,173 @@
+import json
+import ads.common
+import oci
+import pytz
+import datetime
+import os
+from oci.data_science.models import Metadata
+import ads
+
+class ModelDescription:
+
+    region = ''
+
+    empty_json = {
+        "version": "1.0",
+        "type": "modelOSSReferenceDescription",
+        "models": []
+    }
+    
+    def auth(self):        
+        authData = ads.common.auth.default_signer()
+        signer = authData['signer']
+        self.region = authData['config']['region']
+
+        # data science client
+        self.data_science_client = oci.data_science.DataScienceClient({'region': self.region}, signer=signer)
+        # oss client
+        self.object_storage_client = oci.object_storage.ObjectStorageClient({'region': self.region}, signer = signer)
+    
+    def __init__(self, model_ocid=None):
+
+        self.auth()
+
+        if model_ocid == None: 
+            # if no model given then start from scratch
+            self.modelDescriptionJson = self.empty_json
+        else:
+            # if model given then get that as the starting reference point
+            print("Getting model details from backend")
+            destination_file_path = "downloaded_artifact.json"
+            get_model_artifact_content_response = self.data_science_client.get_model_artifact_content(
+                model_id=model_ocid,
+            )
+            try:
+                with open(destination_file_path, "wb") as f:
+                    f.write(get_model_artifact_content_response.data.content)
+                with open(destination_file_path, 'r') as f:
+                    self.modelDescriptionJson = json.load(f)
+            except FileNotFoundError:
+                print(f"File '{destination_file_path}' not found.")
+            except IOError as e:
+                print(f"Error reading or writing to file: {e}")
+            except json.JSONDecodeError as e:
+                print(f"Error decoding JSON: {e}")
+            except Exception as e:
+                print(f"An unexpected error occurred: {e}")
+
+    def add(self, namespace, bucket, prefix=None, files=None):
+        # Remove if the model already exists
+        self.remove(namespace, bucket, prefix)
+
+        def checkIfFileExists(fileName):
+            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:
+                    print(f"File not found in bucket: {fileName}")
+                else:
+                    print(f"An error occured: {e}")
+            return isExists
+        
+        # Function to un-paginate the api call with while loop
+        def listObjectVersionsUnpaginated():
+            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 = listObjectVersionsUnpaginated()
+        else:
+            for fileName in files:
+                if checkIfFileExists(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:
+            print("No files to add in the bucket: ", bucket, " with namespace: ", namespace, " and prefix: ", prefix, " file names: ", files)
+            return
+        
+        self.modelDescriptionJson['models'].append({
+            "namespace": namespace,
+            "bucketName": bucket,
+            "prefix": prefix,
+            "objects": objects
+        })
+    
+    def remove(self, namespace, bucket, prefix=None):
+        def findModelIdx():
+            for idx, model in enumerate(self.modelDescriptionJson['models']):
+                if (model['namespace'], model['bucketName'], (model['prefix'] if ('prefix' in model) else None) ) == (namespace, bucket, prefix):
+                    return idx
+            return -1
+
+        modelSearchIdx = findModelIdx()
+        if modelSearchIdx == -1:
+            return
+        else:
+            # model found case
+            self.modelDescriptionJson['models'].pop(modelSearchIdx)
+
+    def show(self):
+        print(json.dumps(self.modelDescriptionJson, indent=4))
+
+    def build(self):
+        print("Building...")
+        file_path = "resultModelDescription.json"
+        try:
+            with open(file_path, "w") as json_file:
+                json.dump(self.modelDescriptionJson, json_file, indent=2)
+        except IOError as e:
+            print(f"Error writing to file '{file_path}': {e}")  # Handle the exception accordingly, e.g., log the error, retry writing, etc.
+        except Exception as e:
+            print(f"An unexpected error occurred: {e}")  # Handle other unexpected exceptions
+        print("Model Artifact stored at location: 'resultModelDescription.json'")
+        return os.path.abspath(file_path)
+    
+    def save(self, project_ocid, compartment_ocid, display_name=None):
+        display_name = 'Created by MMS SDK on ' + datetime.datetime.now(pytz.utc).strftime('%Y-%m-%d %H:%M:%S %Z') if (display_name == None) else display_name
+        customMetadataList = [
+            Metadata(key="modelDescription", value = "true")
+        ]
+        model_details = oci.data_science.models.CreateModelDetails(
+            compartment_id = compartment_ocid,
+            project_id = project_ocid,
+            display_name = display_name,
+            custom_metadata_list = customMetadataList
+        )
+        print("Created model details")
+        model = self.data_science_client.create_model(model_details)
+        print("Created model")
+        self.data_science_client.create_model_artifact(
+            model.data.id,
+            json.dumps(self.modelDescriptionJson),
+            content_disposition='attachment; filename="modelDescription.json"'
+        )
+        print('Successfully created model with OCID: ', model.data.id)
+        return model.data.id