Struct RaySpec

#[non_exhaustive]
pub struct RaySpec {
    pub image_uri: String,
    pub resource_pool_images: HashMap<String, String>,
    pub head_node_resource_pool_id: String,
    pub ray_metric_spec: Option<RayMetricSpec>,
    pub ray_logs_spec: Option<RayLogsSpec>,
    /* private fields */
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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: HashMap<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” }

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: Option<RayMetricSpec>

Optional. Ray metrics configurations.

ray_logs_spec: Option<RayLogsSpec>

Optional. OSS Ray logging configurations.

Implementations

impl RaySpec

pub fn new() -> Self

pub fn set_image_uri<T: Into<String>>(self, v: T) -> Self

Sets the value of image_uri.

pub fn set_resource_pool_images<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of resource_pool_images.

pub fn set_head_node_resource_pool_id<T: Into<String>>(self, v: T) -> Self

Sets the value of head_node_resource_pool_id.

pub fn set_ray_metric_spec<T: Into<Option<RayMetricSpec>>>(self, v: T) -> Self

Sets the value of ray_metric_spec.

pub fn set_ray_logs_spec<T: Into<Option<RayLogsSpec>>>(self, v: T) -> Self

Sets the value of ray_logs_spec.

Trait Implementations

impl Clone for RaySpec

fn clone(&self) -> RaySpec

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RaySpec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RaySpec

fn default() -> RaySpec

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RaySpec

where RaySpec: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for RaySpec

fn typename() -> &'static str

The typename of this message.

impl PartialEq for RaySpec

fn eq(&self, other: &RaySpec) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RaySpec

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RaySpec