Ray

class torchx.schedulers.ray_scheduler.RayScheduler(session_name: str)

Bases: torchx.schedulers.api.Scheduler

配置选项

    usage:
        [cluster_config_file=CLUSTER_CONFIG_FILE],[cluster_name=CLUSTER_NAME],[dashboard_address=DASHBOARD_ADDRESS],[working_dir=WORKING_DIR],[requirements=REQUIREMENTS]

    optional arguments:
        cluster_config_file=CLUSTER_CONFIG_FILE (str, None)
            Use CLUSTER_CONFIG_FILE to access or create the Ray cluster.
        cluster_name=CLUSTER_NAME (str, None)
            Override the configured cluster name.
        dashboard_address=DASHBOARD_ADDRESS (str, 127.0.0.1:8265)
            Use ray status to get the dashboard address you will submit jobs against
        working_dir=WORKING_DIR (str, None)
            Copy the the working directory containing the Python scripts to the cluster.
        requirements=REQUIREMENTS (str, None)
            Path to requirements.txt

兼容性

功能	调度程序支持
获取日志	✔️
分布式作业	✔️
取消任务	✔️
描述工作	部分支持。RayScheduler 将返回作业状态，但不提供完整的原始 AppSpec。
工作区 / 补丁修复	❌
挂载	❌

describe(app_id: str) → Optional[torchx.schedulers.api.DescribeAppResponse]

描述指定的应用程序。

Returns

应用程序定义描述或 None 如果应用程序不存在。

log_iter(app_id: str, role_name: Optional[str] = None, k: int = 0, regex: Optional[str] = None, since: Optional[datetime.datetime] = None, until: Optional[datetime.datetime] = None, should_tail: bool = False, streams: Optional[torchx.schedulers.api.Stream] = None) → List[str]

返回一个迭代器，用于获取满足条件的日志行。k``th replica of the ``role。 迭代器在所有符合条件的日志行都被读取后结束。

如果调度程序支持基于时间指针获取日志行，则since，until字段会被遵循，否则会被忽略。不指定since和until相当于获取所有可用的日志行。如果until为空，则迭代器的行为就像tail -f一样，跟随日志输出直到作业达到终端状态。

日志的确切定义取决于调度程序的具体设置。有些调度程序可能会将标准错误或标准输出视为日志，而其他调度程序则可能从日志文件中读取日志。

行为和假设：

1. 如果在不存在的应用程序上调用此方法，会产生未定义行为。 调用者应在调用此方法之前使用exists(app_id)检查应用程序是否存在。

2. 不是有状态的，用相同的参数调用此方法两次 会返回一个新的迭代器。之前的迭代 进度会丢失。

3. 不一定始终支持日志追尾功能。并非所有调度器都支持实时日志迭代（例如，在应用程序运行时追尾日志）。有关迭代器的行为，请参阅特定调度器的文档。

3.1 If the scheduler supports log-tailing, it should be controlled

by``should_tail``参数。

4. 不保证日志保留。调用此方法时，底层调度程序可能已经清除了该应用程序的日志记录。如果是这样的话，此方法将引发任意异常。

5. 如果 should_tail 为 True，该方法仅在可访问的日志行已完全耗尽且应用程序达到最终状态时抛出 StopIteration 异常。 例如，如果应用程序卡住且没有生成任何日志行，则迭代器会阻塞直到应用程序最终被终止（通过超时或手动操作），此时它会抛出一个 StopIteration 异常。

   如果 should_tail 是 False，该方法在没有更多日志时抛出 StopIteration。

6. 不一定由所有调度器支持。

7. 某些调度器可能通过支持 __getitem__ （例如，iter[50] 寻找第 50 行日志）来支持行光标。

8. Whitespace is preserved, each new line should include \n. To

   支持交互式进度条，返回的行不需要包含 \n，但应该在不换行的情况下打印，以正确处理 \r 回车符。

Parameters

流 – 要选择的IO输出流。 选项之一：combined、stdout、stderr。 如果所选流不被调度程序支持，它将抛出一个ValueError异常。

Returns

一个指定角色副本的日志行上的 Iterator

Raises

NotImplementedError – 如果调度器不支持日志迭代

run_opts() → torchx.specs.api.runopts

返回调度程序所期望的运行配置选项。 基本上是--help的run API。

schedule(dryrun_info: torchx.specs.api.AppDryRunInfo[torchx.schedulers.ray_scheduler.RayJob]) → str

与 submit 相同，但接受一个 AppDryRunInfo。 建议实现者实现此方法而不是直接实现 submit，因为 submit 可以通过以下方式简单地实现：

dryrun_info = self.submit_dryrun(app, cfg)
return schedule(dryrun_info)

wait_until_finish(app_id: str, timeout: int = 30) → None

wait_until_finish 等待指定的任务完成 给定的超时时间内。此功能用于测试。程序化使用应使用运行器等待方法。

torchx.schedulers.ray_scheduler.create_scheduler(session_name: str, **kwargs: Any) → torchx.schedulers.ray_scheduler.RayScheduler

torchx.schedulers.ray_scheduler.has_ray() → bool

指示当前 Python 环境中是否安装了 Ray。

torchx.schedulers.ray_scheduler.serialize(actors: List[torchx.schedulers.ray.ray_common.RayActor], dirpath: str, output_filename: str = 'actors.json') → None

class torchx.schedulers.ray_scheduler.RayJob(app_id: str, cluster_config_file: Optional[str] = None, cluster_name: Optional[str] = None, dashboard_address: Optional[str] = None, working_dir: Optional[str] = None, requirements: Optional[str] = None, actors: List[torchx.schedulers.ray.ray_common.RayActor] = <factory>)

表示应在 Ray 集群上运行的一个作业。

Variables

• ~RayJob.app_id (str) – 该应用程序的唯一ID（又称任务）。

• ~RayJob.cluster_config_file (Optional[str]) – The Ray cluster configuration file.

• ~RayJob.cluster_name (Optional[str]) – 使用的集群名称。

• ~RayJob.dashboard_address (Optional[str]) – 用于连接的现有仪表板IP地址

• ~RayJob.working_dir (Optional[str]) –

• 工作目录复制到集群 (The) –

• ~RayJob.requirements (Optional[str]) – 集群上按 requirements.txt 安装的库

• ~RayJob.actors (List[torchx.schedulers.ray.ray_common.RayActor]) – 代表要运行的作业的Ray代理。此属性被 dump到JSON文件并复制到使用ray_main.py启动作业的集群中。