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
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.
Generated from protobuf field string executor_image_uri = 1 [(.google.api.field_behavior) = REQUIRED];
| 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.
Generated from protobuf field string executor_image_uri = 1 [(.google.api.field_behavior) = REQUIRED];
| 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.
Generated from protobuf field repeated string package_uris = 2 [(.google.api.field_behavior) = REQUIRED];
| 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.
Generated from protobuf field repeated string package_uris = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPythonModule
Required. The Python module name to run after installing the packages.
Generated from protobuf field string python_module = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setPythonModule
Required. The Python module name to run after installing the packages.
Generated from protobuf field string python_module = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getArgs
Command line arguments to be passed to the Python task.
Generated from protobuf field repeated string args = 4;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setArgs
Command line arguments to be passed to the Python task.
Generated from protobuf field repeated string args = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEnv
Environment variables to be passed to the python module.
Maximum limit is 100.
Generated from protobuf field repeated .google.cloud.aiplatform.v1.EnvVar env = 5;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setEnv
Environment variables to be passed to the python module.
Maximum limit is 100.
Generated from protobuf field repeated .google.cloud.aiplatform.v1.EnvVar env = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\AIPlatform\V1\EnvVar>
|
| Returns | |
|---|---|
| Type | Description |
$this | |