Google Cloud Ai Platform V1 Client - Class RaySpec (1.2.0)

Version 1.2.0

• 1.13.1 (latest)
• 1.13.0
• 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 RaySpec.

Configuration information for the Ray cluster.

For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ image_uri	string Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from Vertex prebuilt images. Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field.
↳ resource_pool_images	array|Google\Protobuf\Internal\MapField Optional. Required if image_uri isn't set. A map of resource_pool_id to prebuild Ray image if user need to use different images for different head/worker pools. This map needs to cover all the resource pool ids. Example: { "ray_head_node_pool": "head image" "ray_worker_node_pool1": "worker image" "ray_worker_node_pool2": "another worker image" }
↳ head_node_resource_pool_id	string Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set.
↳ ray_metric_spec	Google\Cloud\AIPlatform\V1\RayMetricSpec Optional. Ray metrics configurations.
↳ ray_logs_spec	Google\Cloud\AIPlatform\V1\RayLogsSpec Optional. OSS Ray logging configurations.

getImageUri

Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from Vertex prebuilt images.

Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field.

Returns
Type	Description
string

setImageUri

Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from Vertex prebuilt images.

Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getResourcePoolImages

Optional. Required if image_uri isn't set. A map of resource_pool_id to prebuild Ray image if user need to use different images for different head/worker pools. This map needs to cover all the resource pool ids.

Example: { "ray_head_node_pool": "head image" "ray_worker_node_pool1": "worker image" "ray_worker_node_pool2": "another worker image" }

Returns
Type	Description
Google\Protobuf\Internal\MapField

setResourcePoolImages

Optional. Required if image_uri isn't set. A map of resource_pool_id to prebuild Ray image if user need to use different images for different head/worker pools. This map needs to cover all the resource pool ids.

Example: { "ray_head_node_pool": "head image" "ray_worker_node_pool1": "worker image" "ray_worker_node_pool2": "another worker image" }

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this

getHeadNodeResourcePoolId

Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set.

Returns
Type	Description
string

setHeadNodeResourcePoolId

Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getRayMetricSpec

Optional. Ray metrics configurations.

Returns
Type	Description
Google\Cloud\AIPlatform\V1\RayMetricSpec|null

hasRayMetricSpec

clearRayMetricSpec

setRayMetricSpec

Optional. Ray metrics configurations.

Parameter
Name	Description
var	Google\Cloud\AIPlatform\V1\RayMetricSpec

Returns
Type	Description
$this

getRayLogsSpec

Optional. OSS Ray logging configurations.

Returns
Type	Description
Google\Cloud\AIPlatform\V1\RayLogsSpec|null

hasRayLogsSpec

clearRayLogsSpec

setRayLogsSpec

Optional. OSS Ray logging configurations.

Parameter
Name	Description
var	Google\Cloud\AIPlatform\V1\RayLogsSpec

Returns
Type	Description
$this