Cloud AI Platform v1 API - Class RaySpec (3.0.0)

public sealed class RaySpec : IMessage<RaySpec>, IEquatable<RaySpec>, IDeepCloneable<RaySpec>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud AI Platform v1 API 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.

Inheritance

object > RaySpec

Implements

IMessage RaySpec, IEquatable RaySpec, IDeepCloneable RaySpec, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

RaySpec()

public RaySpec()

RaySpec(RaySpec)

public RaySpec(RaySpec other)

Parameter
Name	Description
`other`	`RaySpec`

Properties

HeadNodeResourcePoolId

public string HeadNodeResourcePoolId { get; set; }

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.

Property Value
Type	Description
`string`

ImageUri

public string ImageUri { get; set; }

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.

Property Value
Type	Description
`string`

RayMetricSpec

public RayMetricSpec RayMetricSpec { get; set; }

Optional. Ray metrics configurations.

Property Value
Type	Description
`RayMetricSpec`

ResourcePoolImages

public MapField<string, string> ResourcePoolImages { get; }

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

Property Value
Type	Description
`MapFieldstringstring`