Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::RaySpec (v0.51.0)

Version 0.51.0

• 0.58.0 (latest)
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 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.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.1
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::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.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#head_node_resource_pool_id

def head_node_resource_pool_id() -> ::String

Returns

• (::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.

#head_node_resource_pool_id=

def head_node_resource_pool_id=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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.

#image_uri

def image_uri() -> ::String

Returns

• (::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.

#image_uri=

def image_uri=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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.

#ray_logs_spec

def ray_logs_spec() -> ::Google::Cloud::AIPlatform::V1::RayLogsSpec

Returns

• (::Google::Cloud::AIPlatform::V1::RayLogsSpec) — Optional. OSS Ray logging configurations.

#ray_logs_spec=

def ray_logs_spec=(value) -> ::Google::Cloud::AIPlatform::V1::RayLogsSpec

Parameter

• value (::Google::Cloud::AIPlatform::V1::RayLogsSpec) — Optional. OSS Ray logging configurations.

Returns

• (::Google::Cloud::AIPlatform::V1::RayLogsSpec) — Optional. OSS Ray logging configurations.

#ray_metric_spec

def ray_metric_spec() -> ::Google::Cloud::AIPlatform::V1::RayMetricSpec

Returns

• (::Google::Cloud::AIPlatform::V1::RayMetricSpec) — Optional. Ray metrics configurations.

#ray_metric_spec=

def ray_metric_spec=(value) -> ::Google::Cloud::AIPlatform::V1::RayMetricSpec

Parameter

• value (::Google::Cloud::AIPlatform::V1::RayMetricSpec) — Optional. Ray metrics configurations.

Returns

• (::Google::Cloud::AIPlatform::V1::RayMetricSpec) — Optional. Ray metrics configurations.

#resource_pool_images

def resource_pool_images() -> ::Google::Protobuf::Map{::String => ::String}

Returns

• (::Google::Protobuf::Map{::String => ::String}) — 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" }

#resource_pool_images=

def resource_pool_images=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

• value (::Google::Protobuf::Map{::String => ::String}) — 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

• (::Google::Protobuf::Map{::String => ::String}) — 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" }