search

ray-project / ray

Ray is an AI compute engine. Ray consists of a core distributed runtime and a set of AI Libraries for accelerating ML workloads.
https://ray.io
Apache License 2.0
33.87k stars 5.76k forks source link

[Ray clusters][docs] Improve the docs for manual setup #24491

Open DmitriGekhtman opened 2 years ago

DmitriGekhtman commented 2 years ago

Description

Ray should make sure to have good docs on manual cluster setup. Quoting a colleague, we "need a section that explains about port & network related information in a visible place within [the] cluster deployment" section of the docs. Could just use a bit of fleshing out here: https://docs.ray.io/en/latest/cluster/vms/user-guides/launching-clusters/on-premises.html#manual-setup-cluster

Use case

Being able to set up a Ray cluster manually (or writing custom automation that doesn't use the Ray Cluster Launcher code) is important for many users.

DmitriGekhtman commented 2 years ago

cc @jjyao @rkooo567

mirekphd commented 2 years ago

This link is currently the least dead: https://docs.ray.io/en/releases-2.0.0rc0/cluster/cluster_under_construction/ray-clusters-on-vms/user-guides/manual-cluster-setup.html

Could just use a bit of fleshing out here: https://docs.ray.io/en/master/cluster/cloud.html#manual-ray-cluster-setup

DmitriGekhtman commented 2 years ago

That link is also quite dead now.

We just finished a major documentation revamp.

Here's the correct link: https://docs.ray.io/en/latest/cluster/vms/user-guides/launching-clusters/on-premises.html#manual-setup-cluster

I will update the issue description.