码头工人

torchx.schedulers.docker_scheduler 类。DockerScheduler（session_name： str）

基地：torchx.schedulers.api.Scheduler[torchx.schedulers.docker_scheduler.DockerOpts],torchx.workspace.docker_workspace.DockerWorkspace

DockerScheduler 是 Docker 的 TorchX 调度接口。

这是通过 scheduler local_docker 公开的。

此调度程序使用本地 docker 运行时使用 AppDef 中的指定镜像。必须安装并运行 Docker。这 提供最接近原生使用 Docker 的调度程序的环境，例如 作为 Kubernetes。

注意

Docker 不提供 Gang 调度机制。如果一个副本 如果作业失败，则只会重新启动该副本。

配置选项

    usage:
        [copy_env=COPY_ENV]

    optional arguments:
        copy_env=COPY_ENV (typing.List[str], None)
            list of glob patterns of environment variables to copy if not set in AppDef. Ex: FOO_*

坐骑

此类支持绑定挂载目录和命名卷。

• 绑定挂载：type=bind,src=<host path>,dst=<container path>[,readonly]

• 命名卷：type=volume,src=<name>,dst=<container path>[,readonly]

• 设备：type=device,src=<name>[,dst=<container path>][,permissions=rwm]

看torchx.specs.parse_mounts()了解更多信息。

特征	计划程序支持
获取日志	✔️
分布式作业	✔️
取消作业	✔️
描述任务	部分支持。DockerScheduler 将返回 job 和 replica 状态，但不提供完整的原始 AppSpec。
工作区 / 修补	✔️
坐骑	✔️

describe（app_id： str） → 可选[torchx.schedulers.api.DescribeAppResponse]

描述指定的应用程序。

返回

AppDef 描述，或者应用程序不存在。None

log_iter（app_id： str， role_name： str， k： int = 0， regex： 可选[str] = 无，因为：可选[datetime.datetime] = 无，直到：可选[datetime.datetime] = 无，should_tail：bool = False，流：可选[torchx.schedulers.api.Stream] = None） → Iterable[str]

返回 . 迭代器 ends end 所有符合条件的日志行都已读取。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 – 如果调度程序不支持日志迭代

run_opts（） → torchx.specs.api.runopts

返回计划程序所需的运行配置选项。 基本上是 API 的。--helprun

schedule（dryrun_info 的 - ： torchx.specs.api.AppDryRunInfo[torchx.schedulers.docker_scheduler.DockerJob]） → str

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

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

torchx.schedulers.docker_scheduler 类。DockerJob（app_id： str， containers： List[torchx.schedulers.docker_scheduler.DockerContainer]）

参考

torchx.schedulers.docker_scheduler。create_scheduler（session_name： str， **kwargs： Any） → torchx.schedulers.docker_scheduler。DockerScheduler

torchx.schedulers.docker_scheduler 类。DockerContainer（image： str， command： List[str]， kwargs： Dict[str， object]）

torchx.schedulers.docker_scheduler。has_docker（） → bool