Ray interface

Ray distribution configuration. A class for managing the configuration for a distributed Ray job.

Extends

Properties

address

The address of Ray head node.

dashboardPort

The port to bind the dashboard server to.

distributionType

[Required] Specifies the type of distribution framework.

headNodeAdditionalArgs

Additional arguments passed to ray start in head node.

includeDashboard

Provide this argument to start the Ray dashboard GUI.

port

The port of the head ray process.

workerNodeAdditionalArgs

Additional arguments passed to ray start in worker node.

Property Details

address

The address of Ray head node.

address?: string

Property Value

string

dashboardPort

The port to bind the dashboard server to.

dashboardPort?: number

Property Value

number

distributionType

[Required] Specifies the type of distribution framework.

distributionType: "Ray"

Property Value

"Ray"

headNodeAdditionalArgs

Additional arguments passed to ray start in head node.

headNodeAdditionalArgs?: string

Property Value

string

includeDashboard

Provide this argument to start the Ray dashboard GUI.

includeDashboard?: boolean

Property Value

boolean

port

The port of the head ray process.

port?: number

Property Value

number

workerNodeAdditionalArgs

Additional arguments passed to ray start in worker node.

workerNodeAdditionalArgs?: string

Property Value

string