oracle-ads 2.11.17__py3-none-any.whl → 2.11.19__py3-none-any.whl

ads/aqua/extension/utils.py

@@ -1,12 +1,15 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 # Copyright (c) 2024 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 from dataclasses import fields
+from datetime import datetime, timedelta
 from typing import Dict, Optional
 
+from cachetools import TTLCache, cached
 from tornado.web import HTTPError
 
+from ads.aqua import ODSC_MODEL_COMPARTMENT_OCID
+from ads.aqua.common.utils import fetch_service_compartment
 from ads.aqua.extension.errors import Errors
 
 
@@ -21,3 +24,11 @@ def validate_function_parameters(data_class, input_data: Dict):
             raise HTTPError(
                 400, Errors.MISSING_REQUIRED_PARAMETER.format(required_parameter)
             )
+
+
+@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 or fetch_service_compartment()

ads/aqua/modeldeployment/deployment.py

@@ -146,7 +146,7 @@ class AquaDeploymentApp(AquaApp):
         env_var : dict, optional
             Environment variable for the deployment, by default None.
         container_family: str
-            The image family of model deployment container runtime. Required for unverified Aqua models.
+            The image family of model deployment container runtime.
         memory_in_gbs: float
             The memory in gbs for the shape selected.
         ocpus: float
@@ -230,41 +230,14 @@ class AquaDeploymentApp(AquaApp):
 
             env_var.update({"FT_MODEL": f"{fine_tune_output_path}"})
 
-        is_custom_container = False
-        try:
-            container_type_key = aqua_model.custom_metadata_list.get(
-                AQUA_DEPLOYMENT_CONTAINER_METADATA_NAME
-            ).value
-        except ValueError as err:
-            message = (
-                f"{AQUA_DEPLOYMENT_CONTAINER_METADATA_NAME} key is not available in the custom metadata field "
-                f"for model {aqua_model.id}."
-            )
-            logger.debug(message)
-            if not container_family:
-                raise AquaValueError(
-                    f"{message}. For unverified Aqua models, container_family parameter should be "
-                    f"set and value can be one of {', '.join(InferenceContainerTypeFamily.values())}."
-                ) from err
-            container_type_key = container_family
-        try:
-            # Check if the container override flag is set. If set, then the user has chosen custom image
-            if aqua_model.custom_metadata_list.get(
-                    AQUA_DEPLOYMENT_CONTAINER_OVERRIDE_FLAG_METADATA_NAME
-            ).value:
-                is_custom_container = True
-        except Exception:
-            pass
+        container_type_key = self._get_container_type_key(
+            model=aqua_model,
+            container_family=container_family
+        )
 
         # fetch image name from config
-        # If the image is of type custom, then `container_type_key` is the inference image
-        container_image = (
-            get_container_image(
-                container_type=container_type_key,
-            )
-            if not is_custom_container
-            else container_type_key
-        )
+        container_image = get_container_image(container_type=container_type_key)
+
         logging.info(
             f"Aqua Image used for deploying {aqua_model.id} : {container_image}"
         )
@@ -433,6 +406,26 @@ class AquaDeploymentApp(AquaApp):
             deployment.dsc_model_deployment, self.region
         )
 
+    @staticmethod
+    def _get_container_type_key(model: DataScienceModel, container_family: str) -> str:
+        container_type_key = UNKNOWN
+        if container_family:
+            container_type_key = container_family
+        else:
+            try:
+                container_type_key = model.custom_metadata_list.get(
+                    AQUA_DEPLOYMENT_CONTAINER_METADATA_NAME
+                ).value
+            except ValueError as err:
+                raise AquaValueError(
+                    f"{AQUA_DEPLOYMENT_CONTAINER_METADATA_NAME} key is not available in the custom metadata field "
+                    f"for model {model.id}. For unverified Aqua models, {AQUA_DEPLOYMENT_CONTAINER_METADATA_NAME} should be"
+                    f"set and value can be one of {', '.join(InferenceContainerTypeFamily.values())}."
+                ) from err
+            
+        return container_type_key
+        
+
     @telemetry(entry_point="plugin=deployment&action=list", name="aqua")
     def list(self, **kwargs) -> List["AquaDeployment"]:
         """List Aqua model deployments in a given compartment and under certain project.
@@ -672,23 +665,10 @@ class AquaDeploymentApp(AquaApp):
         restricted_params = []
         if params:
             model = DataScienceModel.from_id(model_id)
-            try:
-                container_type_key = model.custom_metadata_list.get(
-                    AQUA_DEPLOYMENT_CONTAINER_METADATA_NAME
-                ).value
-            except ValueError as err:
-                message = (
-                    f"{AQUA_DEPLOYMENT_CONTAINER_METADATA_NAME} key is not available in the custom metadata field "
-                    f"for model {model_id}."
-                )
-                logger.debug(message)
-
-                if not container_family:
-                    raise AquaValueError(
-                        f"{message}. For unverified Aqua models, container_family parameter should be "
-                        f"set and value can be one of {', '.join(InferenceContainerTypeFamily.values())}."
-                    ) from err
-                container_type_key = container_family
+            container_type_key = self._get_container_type_key(
+                model=model,
+                container_family=container_family
+            )
 
             container_config = get_container_config()
             container_spec = container_config.get(ContainerSpec.CONTAINER_SPEC, {}).get(

ads/aqua/ui.py

@@ -84,9 +84,6 @@ class AquaContainerConfigSpec(DataClassSerializable):
     health_check_port: str = None
     env_vars: List[dict] = None
     restricted_params: List[str] = None
-    evaluation_configuration: AquaContainerEvaluationConfig = field(
-        default_factory=AquaContainerEvaluationConfig
-    )
 
 
 @dataclass(repr=False)
@@ -184,32 +181,37 @@ class AquaContainerConfig(DataClassSerializable):
                         family=container_type,
                         platforms=platforms,
                         model_formats=model_formats,
-                        spec=AquaContainerConfigSpec(
-                            cli_param=container_spec.get(ContainerSpec.CLI_PARM, ""),
-                            server_port=container_spec.get(
-                                ContainerSpec.SERVER_PORT, ""
-                            ),
-                            health_check_port=container_spec.get(
-                                ContainerSpec.HEALTH_CHECK_PORT, ""
-                            ),
-                            env_vars=container_spec.get(ContainerSpec.ENV_VARS, []),
-                            restricted_params=container_spec.get(
-                                ContainerSpec.RESTRICTED_PARAMS, []
-                            ),
-                            evaluation_configuration=AquaContainerEvaluationConfig.from_config(
-                                container_spec.get(
-                                    ContainerSpec.EVALUATION_CONFIGURATION, {}
-                                )
-                            ),
-                        )
-                        if container_spec
-                        else None,
+                        spec=(
+                            AquaContainerConfigSpec(
+                                cli_param=container_spec.get(
+                                    ContainerSpec.CLI_PARM, ""
+                                ),
+                                server_port=container_spec.get(
+                                    ContainerSpec.SERVER_PORT, ""
+                                ),
+                                health_check_port=container_spec.get(
+                                    ContainerSpec.HEALTH_CHECK_PORT, ""
+                                ),
+                                env_vars=container_spec.get(ContainerSpec.ENV_VARS, []),
+                                restricted_params=container_spec.get(
+                                    ContainerSpec.RESTRICTED_PARAMS, []
+                                ),
+                            )
+                            if container_spec
+                            else None
+                        ),
                     )
                     if container.get("type") == "inference":
                         inference_items[container_type] = container_item
-                    elif container_type == "odsc-llm-fine-tuning":
+                    elif (
+                        container.get("type") == "fine-tune"
+                        or container_type == "odsc-llm-fine-tuning"
+                    ):
                         finetune_items[container_type] = container_item
-                    elif container_type == "odsc-llm-evaluate":
+                    elif (
+                        container.get("type") == "evaluate"
+                        or container_type == "odsc-llm-evaluate"
+                    ):
                         evaluate_items[container_type] = container_item
 
         return AquaContainerConfig(

ads/common/auth.py

@@ -73,7 +73,7 @@ class AuthState(metaclass=SingletonMeta):
         self.oci_key_profile = self.oci_key_profile or os.environ.get(
             "OCI_CONFIG_PROFILE", DEFAULT_PROFILE
         )
-        self.oci_config = self.oci_config or {}
+        self.oci_config = self.oci_config or {"region": os.environ["OCI_RESOURCE_REGION"]} if os.environ.get("OCI_RESOURCE_REGION") else {}
         self.oci_signer_kwargs = self.oci_signer_kwargs or {}
         self.oci_client_kwargs = self.oci_client_kwargs or {}
 
@@ -82,7 +82,7 @@ def set_auth(
     auth: Optional[str] = AuthType.API_KEY,
     oci_config_location: Optional[str] = DEFAULT_LOCATION,
     profile: Optional[str] = DEFAULT_PROFILE,
-    config: Optional[Dict] = {},
+    config: Optional[Dict] = {"region": os.environ["OCI_RESOURCE_REGION"]} if os.environ.get("OCI_RESOURCE_REGION") else {},
     signer: Optional[Any] = None,
     signer_callable: Optional[Callable] = None,
     signer_kwargs: Optional[Dict] = {},
@@ -678,7 +678,7 @@ class ResourcePrincipal(AuthSignerGenerator):
         >>> signer_generator = AuthFactory().signerGenerator(AuthType.RESOURCE_PRINCIPAL)
         >>> signer_generator(signer_args).create_signer()
         """
-        configuration = ads.telemetry.update_oci_client_config()
+        configuration = ads.telemetry.update_oci_client_config(AuthState().oci_config)
         signer_dict = {
             "config": configuration,
             "signer": oci.auth.signers.get_resource_principals_signer(),
@@ -739,7 +739,7 @@ class InstancePrincipal(AuthSignerGenerator):
         >>> signer_generator = AuthFactory().signerGenerator(AuthType.INSTANCE_PRINCIPAL)
         >>> signer_generator(signer_args).create_signer()
         """
-        configuration = ads.telemetry.update_oci_client_config()
+        configuration = ads.telemetry.update_oci_client_config(AuthState().oci_config)
         signer_dict = {
             "config": configuration,
             "signer": oci.auth.signers.InstancePrincipalsSecurityTokenSigner(

ads/jobs/builders/infrastructure/dsc_job.py

@@ -312,7 +312,7 @@ class DSCJob(OCIDataScienceMixin, oci.data_science.models.Job):
         logger.debug(oci_model)
         res = self.client.create_job(oci_model)
         self.update_from_oci_model(res.data)
-        if self.lifecycle_state == "ACTIVE":
+        if not self.artifact:
             return
         try:
             if issubclass(self.artifact.__class__, Artifact):
@@ -487,7 +487,9 @@ class DSCJob(OCIDataScienceMixin, oci.data_science.models.Job):
             oci.data_science.models.DefaultJobConfigurationDetails().swagger_types.keys()
         )
         env_config_swagger_types = {}
-        if hasattr(oci.data_science.models, "OcirContainerJobEnvironmentConfigurationDetails"):
+        if hasattr(
+            oci.data_science.models, "OcirContainerJobEnvironmentConfigurationDetails"
+        ):
             env_config_swagger_types = (
                 oci.data_science.models.OcirContainerJobEnvironmentConfigurationDetails().swagger_types.keys()
             )
@@ -501,7 +503,7 @@ class DSCJob(OCIDataScienceMixin, oci.data_science.models.Job):
                 value = kwargs.pop(key)
                 if key in [
                     ContainerRuntime.CONST_CMD,
-                    ContainerRuntime.CONST_ENTRYPOINT
+                    ContainerRuntime.CONST_ENTRYPOINT,
                 ] and isinstance(value, str):
                     value = ContainerRuntimeHandler.split_args(value)
                 env_config_kwargs[key] = value
@@ -535,9 +537,13 @@ class DSCJob(OCIDataScienceMixin, oci.data_science.models.Job):
 
         if env_config_kwargs:
             env_config_kwargs["jobEnvironmentType"] = "OCIR_CONTAINER"
-            env_config_override = kwargs.get("job_environment_configuration_override_details", {})
+            env_config_override = kwargs.get(
+                "job_environment_configuration_override_details", {}
+            )
             env_config_override.update(env_config_kwargs)
-            kwargs["job_environment_configuration_override_details"] = env_config_override
+            kwargs["job_environment_configuration_override_details"] = (
+                env_config_override
+            )
 
         wait = kwargs.pop("wait", False)
         run = DataScienceJobRun(**kwargs, **self.auth).create()

ads/jobs/builders/infrastructure/dsc_job_runtime.py

@@ -181,9 +181,9 @@ class RuntimeHandler:
             "jobType": self.data_science_job.job_type,
         }
         if runtime.maximum_runtime_in_minutes:
-            job_configuration_details[
-                "maximum_runtime_in_minutes"
-            ] = runtime.maximum_runtime_in_minutes
+            job_configuration_details["maximum_runtime_in_minutes"] = (
+                runtime.maximum_runtime_in_minutes
+            )
         job_configuration_details["environment_variables"] = self._translate_env(
             runtime
         )
@@ -310,7 +310,7 @@ class RuntimeHandler:
         for extraction in extractions:
             runtime_spec.update(extraction(dsc_job))
         return self.RUNTIME_CLASS(self._format_env_var(runtime_spec))
-    
+
     def _extract_properties(self, dsc_job) -> dict:
         """Extract the job runtime properties from data science job.
 
@@ -968,23 +968,10 @@ class ContainerRuntimeHandler(RuntimeHandler):
         payload["job_environment_configuration_details"] = job_env_config
         return payload
 
-    def _translate_artifact(self, runtime: Runtime):
-        """Specifies a dummy script as the job artifact.
-        runtime is not used in this method.
-
-        Parameters
-        ----------
-        runtime : Runtime
-            This is not used.
-
-        Returns
-        -------
-        str
-            Path to the dummy script.
-        """
-        return os.path.join(
-            os.path.dirname(__file__), "../../templates", "container.py"
-        )
+    def _translate_artifact(self, runtime: ContainerRuntime):
+        """Additional artifact for the container"""
+        if runtime.artifact_uri:
+            return ScriptArtifact(runtime.artifact_uri, runtime)
 
     def _translate_env_config(self, runtime: Runtime) -> dict:
         """Converts runtime properties to ``OcirContainerJobEnvironmentConfigurationDetails`` payload required by OCI Data Science job.
@@ -1007,7 +994,7 @@ class ContainerRuntimeHandler(RuntimeHandler):
             property = runtime.get_spec(key, None)
             if key in [
                 ContainerRuntime.CONST_CMD,
-                ContainerRuntime.CONST_ENTRYPOINT
+                ContainerRuntime.CONST_ENTRYPOINT,
             ] and isinstance(property, str):
                 property = self.split_args(property)
             if property is not None:
@@ -1063,7 +1050,7 @@ class ContainerRuntimeHandler(RuntimeHandler):
             spec[ContainerRuntime.CONST_ENV_VAR] = envs
 
         return spec
-    
+
     def _extract_properties(self, dsc_job) -> dict:
         """Extract the runtime properties from data science job.
 
@@ -1078,10 +1065,10 @@ class ContainerRuntimeHandler(RuntimeHandler):
             A runtime specification dictionary for initializing a runtime.
         """
         spec = super()._extract_envs(dsc_job)
-        
+
         job_env_config = getattr(dsc_job, "job_environment_configuration_details", None)
         job_env_type = getattr(job_env_config, "job_environment_type", None)
-        
+
         if not (job_env_config and job_env_type == "OCIR_CONTAINER"):
             raise IncompatibleRuntime()
 

ads/jobs/builders/runtimes/artifact.py

@@ -183,11 +183,6 @@ class ScriptArtifact(Artifact):
         if os.path.isdir(source):
             basename = os.path.basename(str(source).rstrip("/"))
             source = str(source).rstrip("/")
-            # Runtime must have entrypoint if the source is a directory
-            if self.runtime and not self.runtime.entrypoint:
-                raise ValueError(
-                    "Please specify entrypoint when script source is a directory."
-                )
             output = os.path.join(self.temp_dir.name, basename)
             shutil.make_archive(
                 output, "zip", os.path.dirname(source), base_dir=basename

ads/jobs/builders/runtimes/container_runtime.py

@@ -56,6 +56,7 @@ class ContainerRuntime(MultiNodeRuntime):
     CONST_CMD = "cmd"
     CONST_IMAGE_DIGEST = "imageDigest"
     CONST_IMAGE_SIGNATURE_ID = "imageSignatureId"
+    CONST_SCRIPT_PATH = "scriptPathURI"
     attribute_map = {
         CONST_IMAGE: CONST_IMAGE,
         CONST_ENTRYPOINT: CONST_ENTRYPOINT,
@@ -121,7 +122,7 @@ class ContainerRuntime(MultiNodeRuntime):
     def image_digest(self) -> str:
         """The container image digest."""
         return self.get_spec(self.CONST_IMAGE_DIGEST)
-    
+
     def with_image_digest(self, image_digest: str) -> "ContainerRuntime":
         """Sets the digest of custom image.
 
@@ -136,12 +137,12 @@ class ContainerRuntime(MultiNodeRuntime):
             The runtime instance.
         """
         return self.set_spec(self.CONST_IMAGE_DIGEST, image_digest)
-    
+
     @property
     def image_signature_id(self) -> str:
         """The container image signature id."""
         return self.get_spec(self.CONST_IMAGE_SIGNATURE_ID)
-    
+
     def with_image_signature_id(self, image_signature_id: str) -> "ContainerRuntime":
         """Sets the signature id of custom image.
 
@@ -217,3 +218,25 @@ class ContainerRuntime(MultiNodeRuntime):
             entrypoint=["bash", "--login", "-c"],
             cmd="{Container CMD. For MLflow and Operator will be auto generated}",
         )
+
+    @property
+    def artifact_uri(self) -> str:
+        """The URI of the source code"""
+        return self.get_spec(self.CONST_SCRIPT_PATH)
+
+    def with_artifact(self, uri: str):
+        """Specifies the artifact to be added to the container.
+
+        Parameters
+        ----------
+        uri : str
+            URI to the source code script, which can be any URI supported by fsspec,
+            including http://, https:// and OCI object storage.
+            For example: oci://your_bucket@your_namespace/path/to/script.py
+
+        Returns
+        -------
+        self
+            The runtime instance.
+        """
+        return self.set_spec(self.CONST_SCRIPT_PATH, uri)