IBM Spectrum LSF

这包含可用于运行 TorchX 的 TorchX LSF 调度程序 组件。

此调度程序处于原型阶段，如有更改，恕不另行通知。如果您运行 如有任何疑问或有反馈，请提交问题。

先决条件

您需要一个现有的 LSF 集群来运行您的作业或用于个人 您可以安装 LSF 社区版。

有关更多详细信息，请参阅 LSF 文档：https://www.ibm.com/support/pages/where-do-i-download-lsf-community-edition

torchx.schedulers.lsf_scheduler 类。LsfScheduler（session_name： str）

基地：Scheduler[LsfOpts]

示例：hello_world

$ torchx run -s lsf -cfg jobdir=/mnt/data/torchx utils.echo --image alpine:latest --msg hello_world --num_replicas 3
...

示例：Gloo

$ cp dist_app.py /mnt/data/dist/
$ torchx run -s lsf -cfg "jobdir=/mnt/data/torchx,host_network=True" dist.ddp -j 2x2 --gpu 2           --script /data/dist_app.py --mount "type=bind,src=/mnt/data/dist,dst=/data"
...

配置选项

    usage:
        [lsf_queue=LSF_QUEUE],[jobdir=JOBDIR],[container_workdir=CONTAINER_WORKDIR],[host_network=HOST_NETWORK],[shm_size=SHM_SIZE]

    optional arguments:
        lsf_queue=LSF_QUEUE (str, None)
            queue name to submit jobs
        jobdir=JOBDIR (str, None)
            The directory to place the job code and outputs. The directory must not exist and will be created.
        container_workdir=CONTAINER_WORKDIR (str, None)
            working directory in container jobs
        host_network=HOST_NETWORK (bool, False)
            True if using the host network for jobs
        shm_size=SHM_SIZE (str, 64m)
            size of shared memory (/dev/shm) for jobs

兼容性

特征	计划程序支持
获取日志	✔️
分布式作业	✔️
取消作业	✔️
描述任务	LsfScheduler 将返回 job.
工作区 / 修补	❌
坐骑	✔️
弹性	❌

TOFIX

• 在 host_network=False 时，任务无法替换静态名称，例如 /etc/hosts（如果没有主机网络，容器无法访问它）

• 图片下载应单独进行

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， 正则表达式： 可选[str] = 无，因为： 可选[日期时间] = 无，直到：可选[日期时间] = 无，should_tail：bool = False，流： 可选[stream] = None） → Iterable[str]

返回 . 当读取了所有符合条件的 log 行时，迭代器结束。k``th replica of the ``role

如果调度程序支持基于时间的游标获取日志行 对于自定义时间范围，则 ， 字段为 honored，否则将被忽略。未指定 ，相当于获取所有可用的日志行。如果 是 empty，则迭代器的行为类似于 ，跟在日志输出之后 直到作业达到 END 状态。sinceuntilsinceuntiluntiltail -f

构成日志的确切定义特定于计划程序。一些 调度器可能会将 stderr 或 stdout 视为日志，其他人可能会读取日志 从日志文件中。

行为和假设：

1. 如果在不存在的应用程序上调用，则生成 undefined-behavior 调用方应在调用此方法之前检查应用是否存在 using。exists(app_id)

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

3. 并不总是支持对数拖尾。并非所有调度程序都支持 live 日志迭代（例如，在应用程序运行时跟踪日志）。指 Iterator 行为的特定 scheduler 文档。

3.1 如果调度器支持 log-tailing，应该对其进行控制

by 参数。should_tail

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

5. 如果为 True，则该方法仅引发异常 当可访问的日志行已完全耗尽并且应用程序已达到 最终状态。例如，如果应用程序卡住并且没有产生任何日志行， 然后 iterator 会阻塞，直到应用程序最终被杀死（通过 timeout 或手动），此时它会引发一个 .should_tailStopIterationStopIteration

   如果为 False，则当没有更多日志时，该方法将引发。should_tailStopIteration

6. 不需要所有调度程序都支持。

7. 一些调度器可能通过支持 line cursor（例如 寻找第 50 个对数行）。__getitem__iter[50]

8. 保留空格，每个新行应包含 。自\n

   支持交互式进度条返回的行不需要 include 的 m，但随后应打印时不带换行符 正确处理回车。\n\r

参数

streams – 要选择的 IO 输出流。 其中之一： combined， stdout， stderr. 如果调度程序不支持所选流，它将 throw 一个 ValueError 的 Error。

结果

指定角色副本的 over log linesIterator

提升：

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

schedule（dryrun_info： AppDryRunInfo[LsfBsub]） → str

相同，只是它需要一个 . 鼓励实现者实现此方法，而不是 直接实现 since 可以很简单 实施者：submitAppDryRunInfosubmitsubmit

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

torchx.schedulers.lsf_scheduler 类。LsfBsub（jobdir： Union[str， NoneType]， app_id： str， app： torchx.specs.api.AppDef 的 ff 格式，cfg： torchx.schedulers.lsf_scheduler。LsfOpts，cmd：List[str]）

参考

torchx.schedulers.lsf_scheduler。create_scheduler（session_name： str， **kwargs： Any） → LsfScheduler