AWS Batch¶

这包含 TorchX AWS Batch 调度器，可用于直接在 AWS Batch 上运行 TorchX 组件。

此调度器处于原型阶段，如有更改，恕不另行通知。

先决条件¶

您需要创建一个为多节点并行作业配置的 AWS Batch 队列。

有关如何设置作业队列和计算环境，请参阅 https://docs.aws.amazon.com/batch/latest/userguide/Batch_GetStarted.html。它需要由 EC2 支持多节点并行作业。

有关分布式作业的更多信息，请参阅 https://docs.aws.amazon.com/batch/latest/userguide/multi-node-parallel-jobs.html。

如果要使用工作空间和容器修补，您还需要配置一个 Docker 注册表来存储包含您更改的修补容器，例如 AWS ECR。

有关如何创建映像存储库，请参阅 https://docs.aws.amazon.com/AmazonECR/latest/userguide/getting-started-cli.html#cli-create-repository。

class torchx.schedulers.aws_batch_scheduler.AWSBatchScheduler(session_name: str, client: Optional[Any] = None, log_client: Optional[Any] = None, docker_client: Optional[DockerClient] = None)[source]¶

基类： DockerWorkspaceMixin, Scheduler[AWSBatchOpts]

AWSBatchScheduler 是一个 TorchX 调度接口，用于连接 AWS Batch。

$ pip install torchx[kubernetes]
$ torchx run --scheduler aws_batch --scheduler_args queue=torchx utils.echo --image alpine:latest --msg hello
aws_batch://torchx_user/1234
$ torchx status aws_batch://torchx_user/1234
...

使用 boto3 凭证处理从环境中加载身份验证。

配置选项

    usage:
        queue=QUEUE,[user=USER],[privileged=PRIVILEGED],[share_id=SHARE_ID],[priority=PRIORITY],[job_role_arn=JOB_ROLE_ARN],[execution_role_arn=EXECUTION_ROLE_ARN],[image_repo=IMAGE_REPO],[quiet=QUIET]

    required arguments:
        queue=QUEUE (str)
            queue to schedule job in

    optional arguments:
        user=USER (str, ec2-user)
            The username to tag the job with. `getpass.getuser()` if not specified.
        privileged=PRIVILEGED (bool, False)
            If true runs the container with elevated permissions. Equivalent to running with `docker run --privileged`.
        share_id=SHARE_ID (str, None)
            The share identifier for the job. This must be set if and only if the job queue has a scheduling policy.
        priority=PRIORITY (int, 0)
            The scheduling priority for the job within the context of share_id. Higher number (between 0 and 9999) means higher priority. This will only take effect if the job queue has a scheduling policy.
        job_role_arn=JOB_ROLE_ARN (str, None)
            The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
        execution_role_arn=EXECUTION_ROLE_ARN (str, None)
            The Amazon Resource Name (ARN) of the IAM role that the ECS agent can assume for AWS permissions.
        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``.

挂载

此类支持绑定挂载主机目录、efs 卷和主机设备。

绑定挂载： type=bind,src=<主机路径>,dst=<容器路径>[,readonly]
efs 卷： type=volume,src=<efs id>,dst=<容器路径>[,readonly]
设备： type=device,src=/dev/infiniband/uverbs0,[dst=<容器路径>][,perm=rwm]

有关更多信息，请参阅 torchx.specs.parse_mounts()。

对于其他文件系统（如 FSx），您可以将它们挂载到主机上，然后将它们绑定挂载到您的作业中： https://repost.aws/knowledge-center/batch-fsx-lustre-file-system-mount

对于弹性结构适配器 (EFA)，您需要使用设备挂载将它们挂载到容器中： https://docs.aws.amazon.com/batch/latest/userguide/efa.html

兼容性

特性	调度器支持
获取日志	✔️
分布式作业	✔️
取消作业	✔️
描述作业	部分支持。AWSBatchScheduler 将返回作业和副本状态，但不提供完整的原始 AppSpec。
工作空间/修补	✔️
挂载	✔️
弹性	❌

describe(app_id: str) → Optional[DescribeAppResponse][source]¶

描述指定的应用程序。

返回:: AppDef 描述，如果应用程序不存在，则返回 None。

list() → List[ListAppResponse][source]¶: 对于在调度器上启动的应用程序，此 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][源代码]¶

返回一个迭代器，指向 ``role`` 的第 ``k`` 个副本的日志行。当所有符合条件的日志行都被读取后，迭代器结束。

如果调度器支持基于时间的游标来获取自定义时间范围内的日志行，则会遵循 since 和 until 字段，否则将忽略它们。不指定 since 和 until 等效于获取所有可用的日志行。如果 until 为空，则迭代器的行为类似于 tail -f，跟随日志输出，直到作业达到最终状态。

构成日志的确切定义取决于调度器。一些调度器可能将 stderr 或 stdout 视为日志，而其他调度器可能从日志文件中读取日志。

行为和假设

如果对不存在的应用程序调用，则会产生未定义的行为。调用者应在调用此方法之前使用 exists(app_id) 检查应用程序是否存在。
不是有状态的，使用相同的参数两次调用此方法将返回一个新的迭代器。之前的迭代进度将丢失。
并不总是支持日志跟踪。并非所有调度器都支持实时日志迭代（例如，在应用程序运行时跟踪日志）。有关迭代器行为的详细信息，请参阅特定调度器的文档。

3.1 如果调度器支持日志跟踪，则应由: should_tail 参数控制。

不保证日志保留。在调用此方法时，底层调度器可能已经清除了此应用程序的日志记录。如果是这样，此方法将引发任意异常。
如果 should_tail 为 True，则该方法仅在可访问的日志行已完全耗尽且应用程序已达到最终状态时才会引发 StopIteration 异常。例如，如果应用程序卡住并且不生成任何日志行，则迭代器将阻塞，直到应用程序最终被终止（通过超时或手动终止），此时它将引发 StopIteration。

如果 should_tail 为 False，则该方法在没有更多日志时引发 StopIteration。
并非所有调度器都需要支持。
一些调度器可以通过支持 __getitem__ 来支持行游标（例如，iter[50] 查找第 50 行日志）。
保留空格，每行新行都应包含 \n。为了
支持交互式进度条，返回的行不需要包含 \n，但应该在不带换行符的情况下打印，以便正确处理 \r 回车符。

参数：: streams – 要选择的 IO 输出流。选项之一：combined、stdout、stderr。如果调度器不支持所选流，则会引发 ValueError。
返回:: 指定角色副本的日志行的 Iterator
引发：: NotImplementedError – 如果调度器不支持日志迭代

schedule(dryrun_info: AppDryRunInfo[BatchJob]) → str[源代码]¶

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

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

class torchx.schedulers.aws_batch_scheduler.BatchJob(name: str, queue: str, share_id: Union[str, NoneType], job_def: Dict[str, object], images_to_push: Dict[str, Tuple[str, str]])[源代码]¶

参考¶

torchx.schedulers.aws_batch_scheduler.create_scheduler(session_name: str, client: Optional[Any] = None, log_client: Optional[Any] = None, docker_client: Optional[DockerClient] = None, **kwargs: object) → AWSBatchScheduler[source]¶

AWS Batch¶

先决条件¶

参考¶

文档

教程

资源