Removing ODSC_MODEL_COMPARTMENT_OCID

Author: kumar-shivam-ranjan

ads/aqua/__init__.py

@@ -38,7 +38,3 @@ def set_log_level(log_level: str):
 
 if OCI_RESOURCE_PRINCIPAL_VERSION:
     set_auth("resource_principal")
-
-ODSC_MODEL_COMPARTMENT_OCID = (
-    os.environ.get("ODSC_MODEL_COMPARTMENT_OCID") or "ODSC_MODEL_COMPARTMENT_OCID"
-)

ads/aqua/cli.py

@@ -1,23 +1,20 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*--
 
-# Copyright (c) 2024 Oracle and/or its affiliates.
+# Copyright (c) 2024, 2025 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 import os
 
 from ads.aqua import (
     ENV_VAR_LOG_LEVEL,
-    ODSC_MODEL_COMPARTMENT_OCID,
     logger,
     set_log_level,
 )
-from ads.aqua.common.errors import AquaCLIError, AquaConfigError
+from ads.aqua.common.errors import AquaCLIError
 from ads.aqua.evaluation import AquaEvaluationApp
 from ads.aqua.finetuning import AquaFineTuningApp
 from ads.aqua.model import AquaModelApp
 from ads.aqua.modeldeployment import AquaDeploymentApp
 from ads.common.utils import LOG_LEVELS
-from ads.config import NB_SESSION_OCID
 
 
 class AquaCommand:
@@ -82,16 +79,6 @@ def __init__(
 
         set_log_level(aqua_log_level)
 
-        if not ODSC_MODEL_COMPARTMENT_OCID:
-            if NB_SESSION_OCID:
-                raise AquaConfigError(
-                    f"Aqua is not available for the notebook session {NB_SESSION_OCID}. For more information, "
-                    f"please refer to the documentation."
-                )
-            raise AquaConfigError(
-                "ODSC_MODEL_COMPARTMENT_OCID environment variable is not set for Aqua."
-            )
-
     @staticmethod
     def _validate_value(flag, value):
         """Check if the given value for bool flag is valid.

ads/aqua/extension/common_ws_msg_handler.py

@@ -1,22 +1,19 @@
 #!/usr/bin/env python
 
-# Copyright (c) 2024 Oracle and/or its affiliates.
+# Copyright (c) 2024, 2025 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 
 import json
 from importlib import metadata
 from typing import List, Union
 
 from ads.aqua.common.decorator import handle_exceptions
-from ads.aqua.common.errors import AquaResourceAccessError
-from ads.aqua.common.utils import known_realm
 from ads.aqua.extension.aqua_ws_msg_handler import AquaWSMsgHandler
 from ads.aqua.extension.models.ws_models import (
     AdsVersionResponse,
     CompatibilityCheckResponse,
     RequestResponseType,
 )
-from ads.aqua.extension.utils import ui_compatability_check
 
 
 class AquaCommonWsMsgHandler(AquaWSMsgHandler):
@@ -39,19 +36,8 @@ def process(self) -> Union[AdsVersionResponse, CompatibilityCheckResponse]:
             )
             return response
         if request.get("kind") == "CompatibilityCheck":
-            if ui_compatability_check():
-                return CompatibilityCheckResponse(
-                    message_id=request.get("message_id"),
-                    kind=RequestResponseType.CompatibilityCheck,
-                    data={"status": "ok"},
-                )
-            elif known_realm():
-                return CompatibilityCheckResponse(
-                    message_id=request.get("message_id"),
-                    kind=RequestResponseType.CompatibilityCheck,
-                    data={"status": "compatible"},
-                )
-            else:
-                raise AquaResourceAccessError(
-                    "The AI Quick actions extension is not compatible in the given region."
-                )
+            return CompatibilityCheckResponse(
+                message_id=request.get("message_id"),
+                kind=RequestResponseType.CompatibilityCheck,
+                data={"status": "ok"},
+            )

ads/aqua/extension/utils.py

@@ -6,14 +6,12 @@
 import traceback
 import uuid
 from dataclasses import fields
-from datetime import datetime, timedelta
 from http.client import responses
 from typing import Dict, Optional
 
-from cachetools import TTLCache, cached
 from tornado.web import HTTPError
 
-from ads.aqua import ODSC_MODEL_COMPARTMENT_OCID, logger
+from ads.aqua import logger
 from ads.aqua.constants import (
     AQUA_TROUBLESHOOTING_LINK,
     OCI_OPERATION_FAILURES,
@@ -35,14 +33,6 @@ def validate_function_parameters(data_class, input_data: Dict):
             )
 
 
-@cached(cache=TTLCache(maxsize=1, ttl=timedelta(minutes=1), timer=datetime.now))
-def ui_compatability_check():
-    """This method caches the service compartment OCID details that is set by either the environment variable or if
-    fetched from the configuration. The cached result is returned when multiple calls are made in quick succession
-    from the UI to avoid multiple config file loads."""
-    return ODSC_MODEL_COMPARTMENT_OCID
-
-
 def get_default_error_messages(
     service_payload: dict,
     status_code: str,

ads/aqua/model/model.py

@@ -13,7 +13,7 @@
 from huggingface_hub import snapshot_download
 from oci.data_science.models import JobRun, Metadata, Model, UpdateModelDetails
 
-from ads.aqua import ODSC_MODEL_COMPARTMENT_OCID, logger
+from ads.aqua import logger
 from ads.aqua.app import AquaApp
 from ads.aqua.common.entities import AquaMultiModelRef
 from ads.aqua.common.enums import (
@@ -94,6 +94,7 @@
     AQUA_DEPLOYMENT_CONTAINER_URI_METADATA_NAME,
     AQUA_EVALUATION_CONTAINER_METADATA_NAME,
     AQUA_FINETUNING_CONTAINER_METADATA_NAME,
+    AQUA_SERVICE_MODELS,
     COMPARTMENT_OCID,
     PROJECT_OCID,
     SERVICE,
@@ -181,7 +182,9 @@ def create(
         service_model = DataScienceModel.from_id(model_id)
         target_project = project_id or PROJECT_OCID
         target_compartment = compartment_id or COMPARTMENT_OCID
-        if service_model.compartment_id != ODSC_MODEL_COMPARTMENT_OCID:
+
+        # Skip model copying if it is registered model
+        if service_model.freeform_tags.get(Tags.BASE_MODEL_CUSTOM) is not None:
             logger.info(
                 f"Aqua Model {model_id} already exists in the user's compartment."
                 "Skipped copying."
@@ -949,11 +952,11 @@ def list(
                 category="aqua/service/model", action="list"
             )
 
-            if ODSC_MODEL_COMPARTMENT_OCID in self._service_models_cache:
+            if AQUA_SERVICE_MODELS in self._service_models_cache:
                 logger.info(
-                    f"Returning service models list in {ODSC_MODEL_COMPARTMENT_OCID} from cache."
+                    f"Returning service models list in {AQUA_SERVICE_MODELS} from cache."
                 )
-                return self._service_models_cache.get(ODSC_MODEL_COMPARTMENT_OCID)
+                return self._service_models_cache.get(AQUA_SERVICE_MODELS)
             logger.info("Fetching service models.")
             lifecycle_state = kwargs.pop(
                 "lifecycle_state", Model.LIFECYCLE_STATE_ACTIVE
@@ -968,7 +971,7 @@ def list(
             )
 
         logger.info(
-            f"Fetched {len(models)} model in compartment_id={ODSC_MODEL_COMPARTMENT_OCID if category==SERVICE else compartment_id}."
+            f"Fetched {len(models)} models from {AQUA_SERVICE_MODELS if category==SERVICE else compartment_id}."
         )
         aqua_models = []
         inference_containers = self.get_container_config().to_dict().get("inference")
@@ -986,7 +989,7 @@ def list(
 
         if category == SERVICE:
             self._service_models_cache.__setitem__(
-                key=ODSC_MODEL_COMPARTMENT_OCID, value=aqua_models
+                key=AQUA_SERVICE_MODELS, value=aqua_models
             )
 
         return aqua_models
@@ -1002,15 +1005,10 @@ def clear_model_list_cache(
         """
         res = {}
         with self._cache_lock:
-            if ODSC_MODEL_COMPARTMENT_OCID in self._service_models_cache:
-                self._service_models_cache.pop(key=ODSC_MODEL_COMPARTMENT_OCID)
-                logger.info(
-                    f"Cleared models cache for service compartment {ODSC_MODEL_COMPARTMENT_OCID}."
-                )
+            if AQUA_SERVICE_MODELS in self._service_models_cache:
+                self._service_models_cache.pop(key=AQUA_SERVICE_MODELS)
+                logger.info("Cleared models cache for service compartment.")
                 res = {
-                    "key": {
-                        "compartment_id": ODSC_MODEL_COMPARTMENT_OCID,
-                    },
                     "cache_deleted": True,
                 }
         return res

ads/config.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 
-# Copyright (c) 2020, 2024 Oracle and/or its affiliates.
+# Copyright (c) 2020, 2025 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 
 import contextlib
@@ -56,6 +56,7 @@
 AQUA_CONTAINER_INDEX_CONFIG = os.environ.get(
     "AQUA_CONTAINER_INDEX_CONFIG", "container_index.json"
 )
+AQUA_SERVICE_MODELS = "aqua-service-models-compartment"
 AQUA_DEPLOYMENT_CONTAINER_METADATA_NAME = "deployment-container"
 AQUA_FINETUNING_CONTAINER_METADATA_NAME = "finetune-container"
 AQUA_EVALUATION_CONTAINER_METADATA_NAME = "evaluation-container"
@@ -84,7 +85,6 @@
 SERVICE = "SERVICE"
 
 
-
 THREADED_DEFAULT_TIMEOUT = 5
 try:
     THREADED_DEFAULT_TIMEOUT = int(

tests/unitary/with_extras/aqua/test_common_handler.py

@@ -13,9 +13,8 @@
 
 import ads.aqua
 import ads.config
-from ads.aqua.constants import AQUA_GA_LIST
+
 from ads.aqua.extension.common_handler import CompatibilityCheckHandler
-from ads.aqua.extension.utils import ui_compatability_check
 
 
 class TestDataset:
@@ -29,24 +28,17 @@ def setUp(self, ipython_init_mock) -> None:
         self.common_handler = CompatibilityCheckHandler(MagicMock(), MagicMock())
         self.common_handler.request = MagicMock()
 
-    def tearDown(self) -> None:
-        ui_compatability_check.cache_clear()
-
     def test_get_ok(self):
         """Test to check if ok is returned when ODSC_MODEL_COMPARTMENT_OCID is set."""
-        with patch.dict(
-            os.environ,
-            {"ODSC_MODEL_COMPARTMENT_OCID": TestDataset.SERVICE_COMPARTMENT_ID},
-        ):
-            reload(ads.config)
-            reload(ads.aqua)
-            reload(ads.aqua.extension.utils)
-            reload(ads.aqua.extension.common_handler)
-
-            with patch(
-                "ads.aqua.extension.base_handler.AquaAPIhandler.finish"
-            ) as mock_finish:
-                mock_finish.side_effect = lambda x: x
-                self.common_handler.request.path = "aqua/hello"
-                result = self.common_handler.get()
-                assert result["status"] == "ok"
+        reload(ads.config)
+        reload(ads.aqua)
+        reload(ads.aqua.extension.utils)
+        reload(ads.aqua.extension.common_handler)
+
+        with patch(
+            "ads.aqua.extension.base_handler.AquaAPIhandler.finish"
+        ) as mock_finish:
+            mock_finish.side_effect = lambda x: x
+            self.common_handler.request.path = "aqua/hello"
+            result = self.common_handler.get()
+            assert result["status"] == "ok"

tests/unitary/with_extras/aqua/test_model.py

@@ -25,7 +25,7 @@
 import ads.config
 
 from ads.aqua.common.entities import AquaMultiModelRef
-from ads.aqua.common.enums import ModelFormat
+from ads.aqua.common.enums import ModelFormat, Tags
 from ads.aqua.common.errors import (
     AquaFileNotFoundError,
     AquaRuntimeError,
@@ -307,6 +307,7 @@ def test_create_model(self, mock_from_id, mock_validate, mock_create):
             "organization": "test_organization",
             "task": "test_task",
             "ready_to_fine_tune": "true",
+            "aqua_custom_base_model": "true",
         }
         custom_metadata_list = ModelCustomMetadata()
         custom_metadata_list.add(
@@ -332,7 +333,7 @@ def test_create_model(self, mock_from_id, mock_validate, mock_create):
         mock_model.compartment_id = TestDataset.SERVICE_COMPARTMENT_ID
         mock_from_id.return_value = mock_model
         mock_create.return_value = mock_model
-
+        mock_model.freeform_tags.pop(Tags.BASE_MODEL_CUSTOM)
         # will copy service model
         model = self.app.create(
             model_id="test_model_id",