Skip to content

Commit a3179c2

Browse files
yinghsienwucopybara-github
authored andcommitted
docs: Update product name from "Vertex AI" to "Gemini Enterprise Agent Platform" in README, and add a note to rename Agent Engine to Agent Runtime in upcoming major release
PiperOrigin-RevId: 949622032
1 parent c74e996 commit a3179c2

1 file changed

Lines changed: 42 additions & 34 deletions

File tree

README.rst

Lines changed: 42 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,16 @@
1-
Vertex AI SDK for Python
2-
=================================================
1+
Google Gemini Enterprise Agent Platform SDK for Python
2+
======================================================
33

44
|GA| |pypi| |versions| |unit-tests| |system-tests| |sample-tests|
55

6-
`Vertex AI`_: Google Vertex AI is an integrated suite of machine learning tools and services for building and using ML models with AutoML or custom code. It offers both novices and experts the best workbench for the entire machine learning development lifecycle.
6+
> **Note:** The Gemini Enterprise Agent Platform was formerly known as
7+
> Vertex AI.
8+
9+
> **Note:** The **agent_engines** module will be rebranded as **runtimes** in
10+
> an upcoming major release (not before 7/31/2026). See [Agent Runtime](https://docs.cloud.google.com/gemini-enterprise-agent-platform/scale#agent-runtime) for details.
11+
12+
13+
`Gemini Enterprise Agent Platform`_: Gemini Enterprise Agent Platform is Google Cloud's comprehensive platform for developers to build, scale, govern and optimize agents.
714

815
- `Client Library Documentation`_
916
- `Product Documentation`_
@@ -20,7 +27,7 @@ Vertex AI SDK for Python
2027
:target: https://storage.googleapis.com/cloud-devrel-public/python-aiplatform/badges/sdk-system-tests.html
2128
.. |sample-tests| image:: https://storage.googleapis.com/cloud-devrel-public/python-aiplatform/badges/sdk-sample-tests.svg
2229
:target: https://storage.googleapis.com/cloud-devrel-public/python-aiplatform/badges/sdk-sample-tests.html
23-
.. _Vertex AI: https://cloud.google.com/vertex-ai/docs
30+
.. _Gemini Enterprise Agent Platform: https://cloud.google.com/vertex-ai/docs
2431
.. _Client Library Documentation: https://cloud.google.com/python/docs/reference/aiplatform/latest
2532
.. _Product Documentation: https://cloud.google.com/vertex-ai/docs
2633

@@ -38,10 +45,10 @@ With :code:`uv`:
3845
3946
uv pip install google-cloud-aiplatform
4047
41-
Generative AI in the Vertex AI SDK
48+
Generative AI in the Gemini Enterprise Agent Platform SDK
4249
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4350

44-
To use Gen AI features from the Vertex AI SDK, you can instantiate a Vertex SDK client with the following:
51+
To use Gen AI features from the Gemini Enterprise Agent Platform SDK, you can instantiate a Vertex SDK client with the following:
4552

4653
.. code-block:: Python
4754
@@ -134,7 +141,7 @@ Next, define an ADK Agent:
134141
from vertexai.agent_engines import AdkApp
135142
136143
app = AdkApp(agent=Agent(
137-
model="gemini-2.0-flash", # Required.
144+
model="gemini-3.5-flash", # Required.
138145
name='currency_exchange_agent', # Required.
139146
tools=[get_exchange_rate], # Optional.
140147
))
@@ -153,6 +160,7 @@ To deploy the agent to Agent Engine:
153160

154161
.. code-block:: Python
155162
163+
# Replace with client.runtimes.create in a future major release.
156164
remote_app = client.agent_engines.create(
157165
agent=app,
158166
config={
@@ -185,7 +193,7 @@ method.
185193
print(response.parsed_response.suggested_prompt)
186194
187195
To call the data-driven prompt optimization, call the `launch_optimization_job` method.
188-
In this case however, we need to provide a VAPO (Vertex AI Prompt Optimizer) config. This config needs to
196+
In this case however, we need to provide a VAPO (Gemini Enterprise Agent Platform Prompt Optimizer) config. This config needs to
189197
have either service account or project **number** and the config path.
190198
Please refer to this [tutorial](https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/data-driven-optimizer)
191199
for more details on config parameter.
@@ -368,11 +376,11 @@ Delete a skill when it is no longer required.
368376

369377
.. note::
370378

371-
The following Generative AI modules in the Vertex AI SDK are deprecated as of June 24, 2025 and will be removed on June 24, 2026:
379+
The following Generative AI modules in the Gemini Enterprise Agent Platform SDK are deprecated as of June 24, 2025 and will be removed on June 24, 2026:
372380
`vertexai.generative_models`, `vertexai.language_models`, `vertexai.vision_models`, `vertexai.tuning`, `vertexai.caching`. Please use the
373381
[Google Gen AI SDK](https://pypi.org/project/google-genai/) to access these features. See
374382
[the migration guide](https://cloud.google.com/vertex-ai/generative-ai/docs/deprecations/genai-vertexai-sdk) for details.
375-
You can continue using all other Vertex AI SDK modules, as they are the recommended way to use the API.
383+
You can continue using all other Gemini Enterprise Agent Platform SDK modules, as they are the recommended way to use the API.
376384

377385
Quick Start
378386
-----------
@@ -381,12 +389,12 @@ In order to use this library, you first need to go through the following steps:
381389

382390
1. `Select or create a Cloud Platform project.`_
383391
2. `Enable billing for your project.`_
384-
3. `Enable the Vertex AI API.`_
392+
3. `Enable the Gemini Enterprise Agent Platform API.`_
385393
4. `Setup Authentication.`_
386394

387395
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
388396
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
389-
.. _Enable the Vertex AI API.: https://cloud.google.com/vertex-ai/docs/start/use-vertex-ai-python-sdk
397+
.. _Enable the Gemini Enterprise Agent Platform API.: https://cloud.google.com/vertex-ai/docs/start/use-vertex-ai-python-sdk
390398
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
391399

392400

@@ -406,7 +414,7 @@ The last version of this library compatible with Python 3.6 is google-cloud-aipl
406414

407415
Overview
408416
~~~~~~~~
409-
This section provides a brief overview of the Vertex AI SDK for Python. You can also reference the notebooks in `vertex-ai-samples`_ for examples.
417+
This section provides a brief overview of the Gemini Enterprise Agent Platform SDK for Python. You can also reference the notebooks in `vertex-ai-samples`_ for examples.
410418

411419
.. _vertex-ai-samples: https://github.com/GoogleCloudPlatform/vertex-ai-samples/tree/main/notebooks/community/sdk
412420

@@ -425,7 +433,7 @@ If none of the above scenarios could help you find the right tools for your task
425433

426434
Importing
427435
^^^^^^^^^
428-
Vertex AI SDK resource based functionality can be used by importing the following namespace:
436+
Gemini Enterprise Agent Platform SDK resource based functionality can be used by importing the following namespace:
429437

430438
.. code-block:: Python
431439
@@ -442,7 +450,7 @@ Initialize the SDK to store common configurations that you use with the SDK.
442450
# environment default used is not set
443451
project='my-project',
444452
445-
# the Vertex AI region you will use
453+
# the Gemini Enterprise Agent Platform region you will use
446454
# defaults to us-central1
447455
location='us-central1',
448456
@@ -455,7 +463,7 @@ Initialize the SDK to store common configurations that you use with the SDK.
455463
credentials=my_credentials,
456464
457465
# customer managed encryption key resource name
458-
# will be applied to all Vertex AI resources if set
466+
# will be applied to all Gemini Enterprise Agent Platform resources if set
459467
encryption_spec_key_name=my_encryption_key_name,
460468
461469
# the name of the experiment to use to track
@@ -468,7 +476,7 @@ Initialize the SDK to store common configurations that you use with the SDK.
468476
469477
Datasets
470478
^^^^^^^^
471-
Vertex AI provides managed tabular, text, image, and video datasets. In the SDK, datasets can be used downstream to
479+
Gemini Enterprise Agent Platform provides managed tabular, text, image, and video datasets. In the SDK, datasets can be used downstream to
472480
train models.
473481

474482
To create a tabular dataset:
@@ -498,21 +506,21 @@ To get a previously created Dataset:
498506
499507
dataset = aiplatform.ImageDataset('projects/my-project/location/us-central1/datasets/{DATASET_ID}')
500508
501-
Vertex AI supports a variety of dataset schemas. References to these schemas are available under the
509+
Gemini Enterprise Agent Platform supports a variety of dataset schemas. References to these schemas are available under the
502510
:code:`aiplatform.schema.dataset` namespace. For more information on the supported dataset schemas please refer to the
503511
`Preparing data docs`_.
504512

505513
.. _Preparing data docs: https://cloud.google.com/ai-platform-unified/docs/datasets/prepare
506514

507515
Training
508516
^^^^^^^^
509-
The Vertex AI SDK for Python allows you train Custom and AutoML Models.
517+
The Gemini Enterprise Agent Platform SDK for Python allows you train Custom and AutoML Models.
510518

511519
You can train custom models using a custom Python script, custom Python package, or container.
512520

513521
**Preparing Your Custom Code**
514522

515-
Vertex AI custom training enables you to train on Vertex AI datasets and produce Vertex AI models. To do so your
523+
Gemini Enterprise Agent Platform custom training enables you to train on Gemini Enterprise Agent Platform datasets and produce Gemini Enterprise Agent Platform models. To do so your
516524
script must adhere to the following contract:
517525

518526
It must read datasets from the environment variables populated by the training service:
@@ -552,12 +560,12 @@ It must write the model artifact to the environment variable populated by the tr
552560
accelerator_type='NVIDIA_TESLA_K80',
553561
accelerator_count=1)
554562
555-
In the code block above `my_dataset` is managed dataset created in the `Dataset` section above. The `model` variable is a managed Vertex AI model that can be deployed or exported.
563+
In the code block above `my_dataset` is managed dataset created in the `Dataset` section above. The `model` variable is a managed Gemini Enterprise Agent Platform model that can be deployed or exported.
556564

557565

558566
AutoMLs
559567
-------
560-
The Vertex AI SDK for Python supports AutoML tabular, image, text, video, and forecasting.
568+
The Gemini Enterprise Agent Platform SDK for Python supports AutoML tabular, image, text, video, and forecasting.
561569

562570
To train an AutoML tabular model:
563571

@@ -619,14 +627,14 @@ To deploy a model:
619627
accelerator_count=1)
620628
621629
622-
Please visit `Importing models to Vertex AI`_ for a detailed overview:
630+
Please visit `Importing models to Gemini Enterprise Agent Platform`_ for a detailed overview:
623631

624-
.. _Importing models to Vertex AI: https://cloud.google.com/vertex-ai/docs/general/import-model
632+
.. _Importing models to Gemini Enterprise Agent Platform: https://cloud.google.com/vertex-ai/docs/general/import-model
625633

626634
Model Evaluation
627635
----------------
628636

629-
The Vertex AI SDK for Python currently supports getting model evaluation metrics for all AutoML models.
637+
The Gemini Enterprise Agent Platform SDK for Python currently supports getting model evaluation metrics for all AutoML models.
630638

631639
To list all model evaluations for a model:
632640

@@ -743,7 +751,7 @@ To delete an endpoint:
743751
Pipelines
744752
---------
745753

746-
To create a Vertex AI Pipeline run and monitor until completion:
754+
To create a Gemini Enterprise Agent Platform Pipeline run and monitor until completion:
747755

748756
.. code-block:: Python
749757
@@ -767,7 +775,7 @@ To create a Vertex AI Pipeline run and monitor until completion:
767775
pipeline_root=pipeline_root,
768776
)
769777
770-
# Execute pipeline in Vertex AI and monitor until completion
778+
# Execute pipeline in Gemini Enterprise Agent Platform and monitor until completion
771779
pl.run(
772780
# Email address of service account to use for the pipeline run
773781
# You must have iam.serviceAccounts.actAs permission on the service account to use it
@@ -778,7 +786,7 @@ To create a Vertex AI Pipeline run and monitor until completion:
778786
sync=True
779787
)
780788
781-
To create a Vertex AI Pipeline without monitoring until completion, use `submit` instead of `run`:
789+
To create a Gemini Enterprise Agent Platform Pipeline without monitoring until completion, use `submit` instead of `run`:
782790

783791
.. code-block:: Python
784792
@@ -802,7 +810,7 @@ To create a Vertex AI Pipeline without monitoring until completion, use `submit`
802810
pipeline_root=pipeline_root,
803811
)
804812
805-
# Submit the Pipeline to Vertex AI
813+
# Submit the Pipeline to Gemini Enterprise Agent Platform
806814
pl.submit(
807815
# Email address of service account to use for the pipeline run
808816
# You must have iam.serviceAccounts.actAs permission on the service account to use it
@@ -852,7 +860,7 @@ To use Explanation Metadata in endpoint deployment and model upload:
852860
Cloud Profiler
853861
----------------------------
854862

855-
Cloud Profiler allows you to profile your remote Vertex AI Training jobs on demand and visualize the results in Vertex AI Tensorboard.
863+
Cloud Profiler allows you to profile your remote Gemini Enterprise Agent Platform Training jobs on demand and visualize the results in Gemini Enterprise Agent Platform Tensorboard.
856864

857865
To start using the profiler with TensorFlow, update your training script to include the following:
858866

@@ -862,20 +870,20 @@ To start using the profiler with TensorFlow, update your training script to incl
862870
...
863871
cloud_profiler.init()
864872
865-
Next, run the job with with a Vertex AI TensorBoard instance. For full details on how to do this, visit https://cloud.google.com/vertex-ai/docs/experiments/tensorboard-overview
873+
Next, run the job with with a Gemini Enterprise Agent Platform TensorBoard instance. For full details on how to do this, visit https://cloud.google.com/vertex-ai/docs/experiments/tensorboard-overview
866874

867875
Finally, visit your TensorBoard in your Google Cloud Console, navigate to the "Profile" tab, and click the `Capture Profile` button. This will allow users to capture profiling statistics for the running jobs.
868876

869877

870878
Next Steps
871879
~~~~~~~~~~
872880

873-
- Read the `Client Library Documentation`_ for Vertex AI
881+
- Read the `Client Library Documentation`_ for Gemini Enterprise Agent Platform
874882
API to see other available methods on the client.
875-
- Read the `Vertex AI API Product documentation`_ to learn
883+
- Read the `Gemini Enterprise Agent Platform API Product documentation`_ to learn
876884
more about the product and see How-to Guides.
877885
- View this `README`_ to see the full list of Cloud
878886
APIs that we cover.
879887

880-
.. _Vertex AI API Product documentation: https://cloud.google.com/vertex-ai/docs
888+
.. _Gemini Enterprise Agent Platform API Product documentation: https://cloud.google.com/vertex-ai/docs
881889
.. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst

0 commit comments

Comments
 (0)