Docker

class torchx.schedulers.docker_scheduler.DockerScheduler(session_name: str)

基础： DockerWorkspaceMixin, Scheduler[DockerOpts]

DockerScheduler 是 TorchX 的 Docker 调度接口。

这是通过调度器local_docker暴露的。

此调度程序通过本地 Docker 运行时运行提供的应用程序，使用 AppDef 中指定的镜像。必须安装并运行 Docker。这为与本机使用 Docker 的调度程序（如 Kubernetes）提供了最接近的环境。

注意

Docker 没有提供批调度机制。如果一个作业中的某个副本失败，只有那个副本会被重启。

配置选项

    usage:
        [copy_env=COPY_ENV],[env=ENV],[privileged=PRIVILEGED],[image_repo=IMAGE_REPO],[quiet=QUIET]

    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_*
        env=ENV (typing.Dict[str, str], None)
            environment variables to be passed to the run. The separator sign can be eiher comma or semicolon
            (e.g. ENV1:v1,ENV2:v2,ENV3:v3 or ENV1:V1;ENV2:V2). Environment variables from env will be applied on top
            of the ones from copy_env
        privileged=PRIVILEGED (bool, False)
            If true runs the container with elevated permissions. Equivalent to running with `docker run --privileged`.
        image_repo=IMAGE_REPO (str, None)
            (remote jobs) the image repository to use when pushing patched images, must have push access. Ex: example.com/your/container
        quiet=QUIET (bool, False)
            whether to suppress verbose output for image building. Defaults to ``False``.

挂载

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

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

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

• devices: type=device,src=<name>[,dst=<container path>][,permissions=rwm]

参见 torchx.specs.parse_mounts() 以获取更多信息。

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

describe(app_id: str) → Optional[DescribeAppResponse]

描述指定的应用程序。

Returns:

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

list() → List[ListAppResponse]

对于调度器上发布的应用，此 API 返回一个 ListAppResponse 对象列表，每个对象包含应用 ID 及其状态。 注意：此 API 处于原型阶段，可能会发生变化。

log_iter(app_id: str, role_name: str, k: int = 0, regex: Optional[str] = None, since: Optional[datetime] = None, until: Optional[datetime] = None, should_tail: bool = False, streams: Optional[Stream] = None) → Iterable[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 parameter.

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 – 如果调度器不支持日志迭代

schedule(dryrun_info: AppDryRunInfo[DockerJob]) → str

与 submit 相同，只是它接受一个 AppDryRunInfo。 实现者被鼓励实现此方法而不是直接实现 submit，因为 submit 可以通过以下方式简单实现：

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

class 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) → DockerScheduler

class torchx.schedulers.docker_scheduler.DockerContainer(image: str, command: List[str], kwargs: Dict[str, object])

torchx.schedulers.docker_scheduler.has_docker() → bool