射线¶
- torchx.schedulers.ray_scheduler 类。RayScheduler（session_name： str， ray_client： 可选 [JobSubmissionClient] = 无）[来源]¶
基地：
TmpDirWorkspaceMixinScheduler[RayOpts]RayScheduler 是 Ray 的 TorchX 调度接口。工作定义 worker 将作为 Ray actor 启动
作业环境由 TorchX 工作区指定。中的任何文件 除非在 中指定，否则工作区将出现在 Ray 作业中。Python 依赖项将从位于工作区根目录中的文件读取，除非 它被 .
.torchxignorerequirements.txt-c ...,requirements=foo/requirements.txt配置选项
usage: [cluster_config_file=CLUSTER_CONFIG_FILE],[cluster_name=CLUSTER_NAME],[dashboard_address=DASHBOARD_ADDRESS],[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 requirements=REQUIREMENTS (str, None) Path to requirements.txt
兼容性
特征
计划程序支持
获取日志
部分支持。Ray 仅支持单个日志流，因此 仅支持虚拟 “ray/0” 组合对数角色。 不支持拖尾和时间查找。
分布式作业
✔️
取消作业
✔️
描述任务
部分支持。RayScheduler 将返回作业状态，但 未提供完整的原始 AppSpec。
工作区 / 修补
✔️
坐骑
❌
弹性
部分支持。不支持多角色作业。
- describe（app_id： str） 可选[DescribeAppResponse][来源]¶
描述指定的应用程序。
- 结果
AppDef 描述，或者应用程序不存在。
None
- list（） List[ListAppResponse][来源]¶
对于在调度程序上启动的应用程序，此 API 返回 ListAppResponse 列表 对象，每个对象都有 App ID 及其 Status。 注意：此 API 处于原型阶段，可能会发生更改。
- log_iter（app_id： str， role_name： 可选[str] = 无， k： int = 0， regex： Optional[str] = None，因为： 可选 [datetime] = 无，直到：可选 [datetime] = 无，should_tail：bool = False，streams：可选[Stream] = None） Iterable[str][来源]¶
返回 . 当读取所有符合条件的 log 行时，迭代器结束。
k``th replica of the ``role如果调度程序支持基于时间的游标获取日志行 对于自定义时间范围，则 ， 字段为 honored，否则将被忽略。未指定 ，相当于获取所有可用的日志行。如果 是 empty，则迭代器的行为类似于 ，跟在日志输出之后 直到作业达到 END 状态。
sinceuntilsinceuntiluntiltail -f构成日志的确切定义特定于计划程序。一些 调度器可能会将 stderr 或 stdout 视为日志，其他人可能会读取日志 从日志文件中。
行为和假设：
如果在不存在的应用程序上调用，则生成 undefined-behavior 调用方应在调用此方法之前检查应用是否存在 using。
exists(app_id)不是有状态的，使用相同的参数调用此方法两次 返回一个新的迭代器。先前迭代 进度丢失。
并不总是支持对数拖尾。并非所有调度程序都支持 live 日志迭代（例如，在应用程序运行时跟踪日志）。指 Iterator 行为的特定 scheduler 文档。
- 3.1 如果调度器支持 log-tailing，应该对其进行控制
by 参数。
should_tail
不保证日志保留。有可能到这个 方法调用时，底层调度程序可能已经清除了日志记录 对于此应用程序。如果是这样，此方法将引发任意异常。
如果为 True，则该方法仅引发异常 当可访问的日志行已完全耗尽并且应用程序已达到 最终状态。例如，如果应用程序卡住并且没有产生任何日志行， 然后 iterator 会阻塞，直到应用程序最终被杀死（通过 timeout 或手动），此时它会引发一个 .
should_tailStopIterationStopIteration如果为 False，则当没有更多日志时，该方法将引发。
should_tailStopIteration不需要所有调度程序都支持。
一些调度器可能通过支持 line cursor（例如 寻找第 50 个对数行）。
__getitem__iter[50]- 保留空格，每个新行应包含 。自
\n 支持交互式进度条返回的行不需要 include 的 m，但随后应打印时不带换行符 正确处理回车。
\n\r
- 保留空格，每个新行应包含 。自
- 参数
streams – 要选择的 IO 输出流。 其中之一： combined， stdout， stderr. 如果调度程序不支持所选流，它将 throw 一个 ValueError 的 Error。
- 结果
指定角色副本的 over log lines
Iterator- 提升：
NotImplementedError – 如果调度程序不支持日志迭代
- torchx.schedulers.ray_scheduler。create_scheduler（session_name： str， ray_client： 可选[JobSubmissionClient] = 无， **kwargs： Any） RayScheduler[来源]¶
- torchx.schedulers.ray_scheduler。serialize（actors： List[RayActor]， dirpath： str， output_filename： str = 'actors.json'） 无[来源]¶
- torchx.schedulers.ray_scheduler 类。RayJob（app_id： str， working_dir： str， cluster_config_file： ~typing.可选[str] = None，cluster_name： ~typing。可选[str] = None，dashboard_address： ~typing。可选[str] = None，要求：~typing。可选[str] = None， actors： ~typing.列表[~torchx.schedulers.ray.ray_common.RayActor] = <factory>）[来源]¶
表示应在 Ray 集群上运行的作业。
- 变量：
app_id （str） – 应用程序 （也称为 job） 的唯一 ID。
cluster_config_file （Optional[str]） – Ray 集群配置文件。
cluster_name （Optional[str]） – 要使用的集群名称。
dashboard_address （Optional[str]） – 要连接到的现有控制面板 IP 地址
working_dir （str） – 要复制到集群的工作目录
requirements （Optional[str]） – 每个requirements.txt要在集群上安装的库
演员 （List[torchx.schedulers.ray.ray_common.RayActor]） – 表示要运行的作业的 Ray 角色。此属性为 转储到 JSON 文件并复制到 ray_main.py 使用它来启动作业的集群。