Skip to content

Commit ead6753

Browse files
Updating doc
1 parent 1a0484e commit ead6753

File tree

2 files changed

+59
-16
lines changed

2 files changed

+59
-16
lines changed

ads/model/datascience_model.py

Lines changed: 43 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2240,10 +2240,16 @@ def create_custom_metadata_artifact(
22402240
Parameters
22412241
----------
22422242
metadata_key_name: str
2243-
The name of the model metadatum in the metadata.
2243+
The name of the model custom metadata key
2244+
2245+
artifact_path_or_content: str
2246+
The model custom metadata artifact path to be upload. It can also be the actual content of the custom metadata
2247+
2248+
path_type: str
2249+
Can be either of utils.MetadataArtifactPathType.LOCAL , utils.MetadataArtifactPathType.OSS , utils.MetadataArtifactPathType.CONTENT
2250+
Specifies what type of path is to be provided for metadata artifact.
2251+
Can be either local , oss or the actual content itself
22442252
2245-
artifact_path: str
2246-
The model custom metadata artifact local file path to be upload.
22472253
Returns
22482254
-------
22492255
Dict
@@ -2278,10 +2284,16 @@ def create_defined_metadata_artifact(
22782284
Parameters
22792285
----------
22802286
metadata_key_name: str
2281-
The name of the model metadatum in the metadata.
2287+
The name of the model defined metadata key
2288+
2289+
artifact_path_or_content: str
2290+
The model defined metadata artifact path to be upload. It can also be the actual content of the defined metadata
2291+
2292+
path_type: str
2293+
Can be either of utils.MetadataArtifactPathType.LOCAL , utils.MetadataArtifactPathType.OSS , utils.MetadataArtifactPathType.CONTENT
2294+
Specifies what type of path is to be provided for metadata artifact.
2295+
Can be either local , oss or the actual content itself
22822296
2283-
artifact_path: str
2284-
The model defined metadata artifact local file path to be upload.
22852297
Returns
22862298
-------
22872299
The model defined metadata artifact creation info.
@@ -2315,10 +2327,16 @@ def update_custom_metadata_artifact(
23152327
Parameters
23162328
----------
23172329
metadata_key_name: str
2318-
The name of the model metadatum in the metadata.
2330+
The name of the model custom metadata key
2331+
2332+
artifact_path_or_content: str
2333+
The model custom metadata artifact path. It can also be the actual content of the custom metadata
2334+
2335+
path_type: str
2336+
Can be either of utils.MetadataArtifactPathType.LOCAL , utils.MetadataArtifactPathType.OSS , utils.MetadataArtifactPathType.CONTENT
2337+
Specifies what type of path is to be provided for metadata artifact.
2338+
Can be either local , oss or the actual content itself
23192339
2320-
artifact_path: str
2321-
The model custom metadata artifact local file path to be upload.
23222340
Returns
23232341
-------
23242342
Dict
@@ -2353,10 +2371,16 @@ def update_defined_metadata_artifact(
23532371
Parameters
23542372
----------
23552373
metadata_key_name: str
2356-
The name of the model metadatum in the metadata.
2374+
The name of the model defined metadata key
2375+
2376+
artifact_path_or_content: str
2377+
The model defined metadata artifact path. It can also be the actual content of the defined metadata
2378+
2379+
path_type: str
2380+
Can be either of utils.MetadataArtifactPathType.LOCAL , utils.MetadataArtifactPathType.OSS , utils.MetadataArtifactPathType.CONTENT
2381+
Specifies what type of path is to be provided for metadata artifact.
2382+
Can be either local , oss or the actual content itself
23572383
2358-
artifact_path: str
2359-
The model defined metadata artifact local file path to be upload.
23602384
Returns
23612385
-------
23622386
Dict
@@ -2388,9 +2412,11 @@ def get_custom_metadata_artifact(
23882412
Parameters
23892413
----------
23902414
metadata_key_name: str
2391-
The name of the model metadatum in the metadata.
2415+
The name of the custom metadata key of the model
2416+
23922417
target_dir: str
2393-
The local file path where downloaded model custom metadata artifact saved.
2418+
The local file path where downloaded model custom metadata artifact will be saved.
2419+
23942420
override: bool
23952421
A boolean flag that controls downloaded metadata artifact file overwriting
23962422
- If True, overwrites the file if it already exists.
@@ -2422,8 +2448,10 @@ def get_defined_metadata_artifact(
24222448
----------
24232449
metadata_key_name: str
24242450
The name of the model metadatum in the metadata.
2451+
24252452
target_dir: str
2426-
The local file path where downloaded model defined metadata artifact saved.
2453+
The local file path where downloaded model defined metadata artifact will be saved.
2454+
24272455
override: bool
24282456
A boolean flag that controls downloaded metadata artifact file overwriting
24292457
- If True, overwrites the file if it already exists.

ads/model/service/oci_datascience_model.py

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -630,7 +630,7 @@ def get_metadata_content(self, artifact_path_or_content: str, path_type):
630630
artifact_path_or_content: str
631631
The path of the file (local or oss) containing metadata artifact or content.
632632
path_type: str
633-
can be one of local , oss or content
633+
can be one of local , oss or actual content itself
634634
635635
Returns
636636
-------
@@ -680,6 +680,10 @@ def create_custom_metadata_artifact(
680680
681681
artifact_path: str
682682
The model custom metadata artifact path to be upload.
683+
684+
path_type: str
685+
can be one of local , oss or actual content itself
686+
683687
Returns
684688
-------
685689
ModelMetadataArtifactDetails
@@ -726,6 +730,10 @@ def create_defined_metadata_artifact(
726730
727731
artifact_path: str
728732
The model custom metadata artifact path to be upload.
733+
734+
path_type: str
735+
can be one of local , oss or actual content itself.
736+
729737
Returns
730738
-------
731739
ModelMetadataArtifactDetails
@@ -772,6 +780,9 @@ def update_defined_metadata_artifact(
772780
773781
artifact_path: str
774782
The model defined metadata artifact path to be upload.
783+
784+
path_type:str
785+
can be one of local , oss or actual content itself.
775786
Returns
776787
-------
777788
ModelMetadataArtifactDetails
@@ -818,6 +829,10 @@ def update_custom_metadata_artifact(
818829
819830
artifact_path: str
820831
The model custom metadata artifact path to be upload.
832+
833+
path_type: str
834+
can be one of local , oss or actual content itself.
835+
821836
Returns
822837
-------
823838
ModelMetadataArtifactDetails

0 commit comments

Comments
 (0)