Google Cloud Ai Platform V1 Client - Class PythonPackageSpec (1.6.0)

Version 1.6.0

• 1.18.0 (latest)
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.1
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.39.0
• 0.38.0
• 0.37.1
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.2
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.0

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class PythonPackageSpec.

The spec of a Python packaged code.

Generated from protobuf message google.cloud.aiplatform.v1.PythonPackageSpec

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ executor_image_uri	string Required. The URI of a container image in Artifact Registry that will run the provided Python package. Vertex AI provides a wide range of executor images with pre-installed packages to meet users' various use cases. See the list of pre-built containers for training. You must use an image from this list.
↳ package_uris	array Required. The Google Cloud Storage location of the Python package files which are the training program and its dependent packages. The maximum number of package URIs is 100.
↳ python_module	string Required. The Python module name to run after installing the packages.
↳ args	array Command line arguments to be passed to the Python task.
↳ env	array<Google\Cloud\AIPlatform\V1\EnvVar> Environment variables to be passed to the python module. Maximum limit is 100.

getExecutorImageUri

Required. The URI of a container image in Artifact Registry that will run the provided Python package. Vertex AI provides a wide range of executor images with pre-installed packages to meet users' various use cases. See the list of pre-built containers for training.

You must use an image from this list.

Returns
Type	Description
string

setExecutorImageUri

Required. The URI of a container image in Artifact Registry that will run the provided Python package. Vertex AI provides a wide range of executor images with pre-installed packages to meet users' various use cases. See the list of pre-built containers for training.

You must use an image from this list.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPackageUris

Required. The Google Cloud Storage location of the Python package files which are the training program and its dependent packages. The maximum number of package URIs is 100.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setPackageUris

Required. The Google Cloud Storage location of the Python package files which are the training program and its dependent packages. The maximum number of package URIs is 100.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getPythonModule

Required. The Python module name to run after installing the packages.

Returns
Type	Description
string

setPythonModule

Required. The Python module name to run after installing the packages.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getArgs

Command line arguments to be passed to the Python task.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setArgs

Command line arguments to be passed to the Python task.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getEnv

Environment variables to be passed to the python module.

Maximum limit is 100.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setEnv

Environment variables to be passed to the python module.

Maximum limit is 100.

Parameter
Name	Description
var	array<Google\Cloud\AIPlatform\V1\EnvVar>

Returns
Type	Description
$this