开始使用 Ray#
本页介绍如何在单机或集群上启动 Ray。
小技巧
在按照本页面的说明操作之前，请确保已 安装 Ray。
什么是 Ray 运行时？#
Ray 程序能够通过利用底层的 Ray 运行时 来实现并行化和分布式处理。Ray 运行时由多个在后台启动的服务/进程组成，用于通信、数据传输、调度等。Ray 运行时可以在笔记本电脑、单个服务器或多个服务器上启动。
启动 Ray 运行时有三种方式：
通过
ray.init()隐式启动 (启动-ray-init)通过CLI显式启动 (通过CLI启动Ray（ray start）)
通过集群启动器显式启动 (启动Ray-up)
在所有情况下，ray.init() 都会尝试自动找到一个 Ray 实例进行连接。它会按顺序检查：1. RAY_ADDRESS 操作系统环境变量。2. 传递给 ray.init(address=<address>) 的具体地址。3. 如果没有提供地址，则检查使用 ray start 在同一台机器上启动的最新 Ray 实例。
在单台机器上启动 Ray#
调用 ray.init() 会在你的笔记本电脑/机器上启动一个本地 Ray 实例。这台笔记本电脑/机器成为“头节点”。
备注
在Ray的最新版本（>=1.5）中，ray.init() 将在首次使用Ray远程API时自动调用。
import ray
# Other Ray APIs will not work until `ray.init()` is called.
ray.init()
import io.ray.api.Ray;
public class MyRayApp {
public static void main(String[] args) {
// Other Ray APIs will not work until `Ray.init()` is called.
Ray.init();
...
}
}
#include <ray/api.h>
// Other Ray APIs will not work until `ray::Init()` is called.
ray::Init()
当调用 ray.init() 的进程终止时，Ray 运行时也会终止。要显式停止或重启 Ray，请使用 shutdown API。
import ray
ray.init()
... # ray program
ray.shutdown()
import io.ray.api.Ray;
public class MyRayApp {
public static void main(String[] args) {
Ray.init();
... // ray program
Ray.shutdown();
}
}
#include <ray/api.h>
ray::Init()
... // ray program
ray::Shutdown()
要检查 Ray 是否已初始化，请使用 is_initialized API。
import ray
ray.init()
assert ray.is_initialized()
ray.shutdown()
assert not ray.is_initialized()
import io.ray.api.Ray;
public class MyRayApp {
public static void main(String[] args) {
Ray.init();
Assert.assertTrue(Ray.isInitialized());
Ray.shutdown();
Assert.assertFalse(Ray.isInitialized());
}
}
#include <ray/api.h>
int main(int argc, char **argv) {
ray::Init();
assert(ray::IsInitialized());
ray::Shutdown();
assert(!ray::IsInitialized());
}
请参阅 配置 文档，了解配置 Ray 的各种方式。
通过CLI启动Ray（ray start）#
使用 CLI 中的 ray start 在一台机器上启动一个单节点的 Ray 运行时。这台机器成为“头节点”。
$ ray start --head --port=6379
Local node IP: 192.123.1.123
2020-09-20 10:38:54,193 INFO services.py:1166 -- View the Ray dashboard at http://localhost:8265
--------------------
Ray runtime started.
--------------------
...
你可以通过在运行 ray start 的同一节点上启动一个驱动程序进程来连接到这个 Ray 实例。ray.init() 现在会自动连接到最新的 Ray 实例。
import ray
ray.init()
import io.ray.api.Ray;
public class MyRayApp {
public static void main(String[] args) {
Ray.init();
...
}
}
java -classpath <classpath> \
-Dray.address=<address> \
<classname> <args>
#include <ray/api.h>
int main(int argc, char **argv) {
ray::Init();
...
}
RAY_ADDRESS=<address> ./<binary> <args>
你可以将其他节点连接到头节点，通过在这些节点上调用 ray start 来创建一个 Ray 集群。更多详情请参见 启动一个本地集群。在集群的任何机器上调用 ray.init() 将连接到同一个 Ray 集群。
启动一个 Ray 集群 (ray up)#
Ray 集群可以通过 集群启动器 启动。ray up 命令使用 Ray 集群启动器在云上启动一个集群，创建一个指定的“头节点”和工作节点。在底层，它会自动调用 ray start 来创建一个 Ray 集群。
你的代码**只**需要在集群中的一台机器上执行（通常是头节点）。了解更多关于 在Ray集群上运行程序 的信息。
要连接到 Ray 集群，请从集群中的某台机器调用 ray.init。这将连接到最新的 Ray 集群：
ray.init()
需要注意的是，调用 ray up 的机器不会被视为 Ray 集群的一部分，因此在同一台机器上调用 ray.init 不会连接到集群。
接下来是什么？#
查看我们的 部署部分 以获取更多关于在不同环境中部署 Ray 的信息，包括 Kubernetes、YARN 和 SLURM。