Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RaySpec

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1beta1/classes.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1RaySpec

Returns a new instance of GoogleCloudAiplatformV1beta1RaySpec.



14608
14609
14610
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 14608

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#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 is not set. Corresponds to the JSON property headNodeResourcePoolId

Returns:

  • (String) 


14587
14588
14589
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 14587

def head_node_resource_pool_id
  @head_node_resource_pool_id
end

#image_uri ⇒ String

Optional. Default image for user to choose a preferred ML framework(e.g. tensorflow or Pytorch) by choosing from Vertex prebuild images(https://cloud. google.com/vertex-ai/docs/training/pre-built-containers). 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. Corresponds to the JSON property imageUri

Returns:

  • (String) 


14597
14598
14599
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 14597

def image_uri
  @image_uri
end

#resource_pool_images ⇒ Hash<String,String>

Optional. Required if image_uri is not 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" Corresponds to the JSON property resourcePoolImages

Returns:

  • (Hash<String,String>) 


14606
14607
14608
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 14606

def resource_pool_images
  @resource_pool_images
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



14613
14614
14615
14616
14617
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 14613

def update!(**args)
  @head_node_resource_pool_id = args[:head_node_resource_pool_id] if args.key?(:head_node_resource_pool_id)
  @image_uri = args[:image_uri] if args.key?(:image_uri)
  @resource_pool_images = args[:resource_pool_images] if args.key?(:resource_pool_images)
end