Class: Google::Cloud::AIPlatform::V1::RaySpec

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/persistent_resource.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.

Defined Under Namespace

Classes: ResourcePoolImagesEntry

Instance Attribute Summary collapse

Instance Attribute Details

#head_node_resource_pool_id ⇒ ::String

Returns 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.



247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'proto_docs/google/cloud/aiplatform/v1/persistent_resource.rb', line 247

class RaySpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ResourcePoolImagesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#image_uri ⇒ ::String

Returns 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.



247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'proto_docs/google/cloud/aiplatform/v1/persistent_resource.rb', line 247

class RaySpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ResourcePoolImagesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#ray_logs_spec ⇒ ::Google::Cloud::AIPlatform::V1::RayLogsSpec

Returns Optional. OSS Ray logging configurations.

Returns:



247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'proto_docs/google/cloud/aiplatform/v1/persistent_resource.rb', line 247

class RaySpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ResourcePoolImagesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#ray_metric_spec ⇒ ::Google::Cloud::AIPlatform::V1::RayMetricSpec

Returns Optional. Ray metrics configurations.

Returns:



247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'proto_docs/google/cloud/aiplatform/v1/persistent_resource.rb', line 247

class RaySpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ResourcePoolImagesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#resource_pool_images ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns 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" }



247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'proto_docs/google/cloud/aiplatform/v1/persistent_resource.rb', line 247

class RaySpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ResourcePoolImagesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end