File tree Expand file tree Collapse file tree 1 file changed +30
-0
lines changed Expand file tree Collapse file tree 1 file changed +30
-0
lines changed Original file line number Diff line number Diff line change @@ -1404,6 +1404,36 @@ def download_artifact(
14041404 remove_existing_artifact : Optional [bool ] = True ,
14051405 ** kwargs ,
14061406 ) -> "GenericModel" :
1407+ """Downloads model artifacts from the model catalog.
1408+
1409+ Parameters
1410+ ----------
1411+ artifact_dir: (str, optional). Defaults to `None`.
1412+ The artifact directory to store the files needed for deployment.
1413+ Will be created if not exists.
1414+ auth: (Dict, optional). Defaults to None.
1415+ The default authentication is set using `ads.set_auth` API. If you need to override the
1416+ default, use the `ads.common.auth.api_keys` or `ads.common.auth.resource_principal` to create appropriate
1417+ authentication signer and kwargs required to instantiate IdentityClient object.
1418+ force_overwrite: (bool, optional). Defaults to False.
1419+ Whether to overwrite existing files or not.
1420+ bucket_uri: (str, optional). Defaults to None.
1421+ The OCI Object Storage URI where model artifacts will be copied to.
1422+ The `bucket_uri` is only necessary for downloading large artifacts with
1423+ size is greater than 2GB. Example: `oci://<bucket_name>@<namespace>/prefix/`.
1424+ remove_existing_artifact: (bool, optional). Defaults to `True`.
1425+ Whether artifacts uploaded to object storage bucket need to be removed or not.
1426+
1427+ Returns
1428+ -------
1429+ Self
1430+ An instance of `GenericModel` class.
1431+
1432+ Raises
1433+ ------
1434+ ValueError
1435+ If `model_id` is not available in the GenericModel object.
1436+ """
14071437 model_id = self .model_id
14081438 if not model_id :
14091439 raise ValueError (
You can’t perform that action at this time.
0 commit comments