Skip to content

Commit bf91a55

Browse files
speedstorm1copybara-github
authored andcommitted
docs: streamline installation section in README and add uv package installation command
PiperOrigin-RevId: 808652100
1 parent d8de037 commit bf91a55

File tree

1 file changed

+14
-35
lines changed

1 file changed

+14
-35
lines changed

README.rst

Lines changed: 14 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,20 @@ Vertex AI SDK for Python
2424
.. _Client Library Documentation: https://cloud.google.com/python/docs/reference/aiplatform/latest
2525
.. _Product Documentation: https://cloud.google.com/vertex-ai/docs
2626

27+
Installation
28+
~~~~~~~~~~~~
29+
30+
.. code-block:: console
31+
32+
pip install google-cloud-aiplatform
33+
34+
35+
With :code:`uv`:
36+
37+
.. code-block:: console
38+
39+
uv pip install google-cloud-aiplatform
40+
2741
Generative AI in the Vertex AI SDK
2842
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2943

@@ -163,41 +177,6 @@ In order to use this library, you first need to go through the following steps:
163177
.. _Enable the Vertex AI API.: https://cloud.google.com/vertex-ai/docs/start/use-vertex-ai-python-sdk
164178
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
165179

166-
Installation
167-
~~~~~~~~~~~~
168-
169-
Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
170-
create isolated Python environments. The basic problem it addresses is one of
171-
dependencies and versions, and indirectly permissions.
172-
173-
With `virtualenv`_, it's possible to install this library without needing system
174-
install permissions, and without clashing with the installed system
175-
dependencies.
176-
177-
.. _virtualenv: https://virtualenv.pypa.io/en/latest/
178-
179-
180-
Mac/Linux
181-
^^^^^^^^^
182-
183-
.. code-block:: console
184-
185-
pip install virtualenv
186-
virtualenv <your-env>
187-
source <your-env>/bin/activate
188-
<your-env>/bin/pip install google-cloud-aiplatform
189-
190-
191-
Windows
192-
^^^^^^^
193-
194-
.. code-block:: console
195-
196-
pip install virtualenv
197-
virtualenv <your-env>
198-
<your-env>\Scripts\activate
199-
<your-env>\Scripts\pip.exe install google-cloud-aiplatform
200-
201180

202181
Supported Python Versions
203182
^^^^^^^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)