adding code for model

Author: Ziqun Ye

ads/opctl/model/__init__.py

@@ -0,0 +1,5 @@
+#!/usr/bin/env python
+# -*- coding: utf-8; -*-
+
+# Copyright (c) 2023 Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/

ads/opctl/model/cli.py

@@ -0,0 +1,36 @@
+#!/usr/bin/env python
+# -*- coding: utf-8; -*-
+
+# Copyright (c) 2023 Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
+
+import click
+from ads.common.auth import AuthType
+from ads.opctl.utils import suppress_traceback
+from ads.opctl.model.cmds import download_model as download_model_cmd
+from ads.opctl.backend.local import DEFAULT_MODEL_FOLDER
+
+
+@click.group("model")
+@click.help_option("--help", "-h")
+def commands():
+    pass
+
+
+@commands.command()
+@click.argument("ocid", required=True)
+@click.option("--model-save-folder", "-mf", nargs=1, required=False, default=DEFAULT_MODEL_FOLDER, help="Which location to store model artifact folders. Defaults to ~/.ads_ops/models. This is only used when model id is passed to `ocid` and a local predict is conducted.")
+@click.option(
+    "--auth",
+    "-a",
+    help="authentication method",
+    type=click.Choice(AuthType.values()),
+    default=None,
+)
+@click.option("--bucket-uri", nargs=1, required=False, help="The OCI Object Storage URI where model artifacts will be copied to. The `bucket_uri` is only necessary for uploading large artifacts which size is greater than 2GB. Example: `oci://<bucket_name>@<namespace>/prefix/`. This is only used when the model id is passed.")
+@click.option("--region", nargs=1, required=False, help="The destination Object Storage bucket region. By default the value will be extracted from the `OCI_REGION_METADATA` environment variables. This is only used when the model id is passed.")
+@click.option("--timeout", nargs=1, required=False, help="The connection timeout in seconds for the client. This is only used when the model id is passed.")
+@click.option("--force-overwrite", "-f", help="Overwrite existing model.", is_flag=True, default=False)
+@click.option("--debug", "-d", help="set debug mode", is_flag=True, default=False)
+def download(**kwargs):
+    suppress_traceback(kwargs["debug"])(download_model_cmd)(**kwargs)

ads/opctl/model/cmds.py

@@ -0,0 +1,58 @@
+import os
+import shutil
+
+from ads.common.auth import create_signer
+from ads.model.datascience_model import DataScienceModel
+from ads.opctl import logger
+from ads.opctl.backend.local import DEFAULT_MODEL_FOLDER
+from ads.opctl.config.base import ConfigProcessor
+from ads.opctl.config.merger import ConfigMerger
+
+
+def download_model(**kwargs):
+    p = ConfigProcessor().step(ConfigMerger, **kwargs)
+    ocid = p.config["execution"]["ocid"]
+
+    auth_type = p.config["execution"].get("auth")
+    profile = p.config["execution"].get("oci_profile", None)
+    oci_config = p.config["execution"].get("oci_config", None)
+    oci_auth = create_signer(
+        auth_type,
+        oci_config,
+        profile ,
+    )
+    model_folder = os.path.expanduser(p.config["execution"].get("model_save_folder", DEFAULT_MODEL_FOLDER))
+    force_overwrite = p.config["execution"].get("force_overwrite", False)
+    
+    artifact_directory = os.path.join(model_folder, str(ocid))
+    if (not os.path.exists(artifact_directory) or len(os.listdir(artifact_directory)) == 0) or force_overwrite:
+
+        region = p.config["execution"].get("region", None)
+        bucket_uri = p.config["execution"].get("bucket_uri", None)
+        timeout = p.config["execution"].get("timeout", None)
+        logger.info(f"No cached model found. Downloading the model {ocid} to {artifact_directory}. If you already have a copy of the model, specify `artifact_directory` instead of `ocid`. You can specify `model_save_folder` to decide where to store the model artifacts.")
+        _download_model(ocid=ocid, artifact_directory=artifact_directory, region=region, bucket_uri=bucket_uri, timeout=timeout, force_overwrite=force_overwrite, oci_auth=oci_auth)
+    else:
+        logger.error(f"Model already exists. Set `force_overwrite=True` to overwrite.")
+        raise ValueError(f"Model already exists. Set `force_overwrite=True` to overwrite.")
+
+
+def _download_model(ocid, artifact_directory, oci_auth, region, bucket_uri, timeout, force_overwrite):
+    os.makedirs(artifact_directory, exist_ok=True)
+    os.chmod(artifact_directory, 777)
+    
+    try:
+        dsc_model = DataScienceModel.from_id(ocid)
+        dsc_model.download_artifact(
+        target_dir=artifact_directory,
+        force_overwrite=force_overwrite,
+        overwrite_existing_artifact=True,
+        remove_existing_artifact=True,
+        auth=oci_auth,
+        region=region,
+        timeout=timeout,
+        bucket_uri=bucket_uri,
+        )
+    except Exception as e:
+        print(str(e))
+        shutil.rmtree(artifact_directory, ignore_errors=True)