Skip to content

Commit 847cec2

Browse files
authored
chore: docs clarification (googleapis#1236)
* chore: docs clarification * addressed comments
1 parent 80ecb8f commit 847cec2

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

README.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,19 @@ This section provides a brief overview of the Vertex AI SDK for Python. You can
9292

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

95+
All publicly available SDK features can be found in the :code:`google/cloud/aiplatform` directory.
96+
Under the hood, Vertex SDK builds on top of GAPIC, which stands for Google API CodeGen.
97+
The GAPIC library code sits in :code:`google/cloud/aiplatform_v1` and :code:`google/cloud/aiplatform_v1beta1`,
98+
and it is auto-generated from Google's service proto files.
99+
100+
For most developers' programmatic needs, they can follow these steps to figure out which libraries to import:
101+
102+
1. Look through :code:`google/cloud/aiplatform` first -- Vertex SDK's APIs will almost always be easier to use and more concise comparing with GAPIC
103+
2. If the feature that you are looking for cannot be found there, look through :code:`aiplatform_v1` to see if it's available in GAPIC
104+
3. If it is still in beta phase, it will be available in :code:`aiplatform_v1beta1`
105+
106+
If none of the above scenarios could help you find the right tools for your task, please feel free to open a github issue and send us a feature request.
107+
95108
Importing
96109
^^^^^^^^^
97110
SDK functionality can be used from the root of the package:

0 commit comments

Comments
 (0)