From 33064b8b68f3b4666a3037d0d8bf95bf2bf37a64 Mon Sep 17 00:00:00 2001 From: Googler Date: Mon, 11 Mar 2024 13:17:15 -0700 Subject: [PATCH] docs(components): Modify the GetModel documentation PiperOrigin-RevId: 614771557 --- components/google-cloud/RELEASE.md | 1 + .../v1/model/get_model/component.py | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/components/google-cloud/RELEASE.md b/components/google-cloud/RELEASE.md index 35fc80e9d38..a32dacbe55f 100644 --- a/components/google-cloud/RELEASE.md +++ b/components/google-cloud/RELEASE.md @@ -4,6 +4,7 @@ * Fix issue where AutoSxS was not propagating location to all sub-components. * Add CMEK support to `preview.llm.infer_pipeline`. * Use `eval_dataset` for train-time evalutation when training a reward model. Requires `eval_dataset` to contain the same fields as the [preference dataset](https://cloud.google.com/vertex-ai/docs/generative-ai/models/tune-text-models-rlhf#human-preference-dataset). +* Update the documentation of `GetModel`. ## Release 2.10.0 * Fix the missing output of pipeline remote runner. `AutoMLImageTrainingJobRunOp` now passes the model artifacts correctly to downstream components. diff --git a/components/google-cloud/google_cloud_pipeline_components/v1/model/get_model/component.py b/components/google-cloud/google_cloud_pipeline_components/v1/model/get_model/component.py index 5583664c0a2..2bc24b93d28 100644 --- a/components/google-cloud/google_cloud_pipeline_components/v1/model/get_model/component.py +++ b/components/google-cloud/google_cloud_pipeline_components/v1/model/get_model/component.py @@ -30,7 +30,7 @@ def model_get( Args: project: Project from which to get the VertexModel. Defaults to the project in which the PipelineJob is run. - model_name: Vertex model resource name in the format of `projects/{project}/locations/{location}/models/{model}` or `projects/{project}/locations/{location}/models/{model}@{model_version_id or model_version_alias}`. If no version ID or alias is specified, the "default" version will be returned. + model_name: Specify the model name in one of the following formats: {model}: Fetches the default model version. {model}@{model_version_id}: Fetches the model version specified by its ID. {model}@{model_version_alias}: Fetches the model version specified by its alias. location: Location from which to get the VertexModel. Defaults to `us-central1`. Returns: