本地化

这包含 TorchX 本地调度程序，可以通过子进程在本地运行 TorchX 组件。

class torchx.schedulers.local_scheduler.LocalScheduler(session_name: str, image_provider_class: Callable[[LocalOpts], ImageProvider], cache_size: int = 100, extra_paths: Optional[List[str]] = None)

基础： Scheduler[LocalOpts]

在本地主机上的调度。容器被建模为进程，对于本地主机运行而言不相关或无法强制执行的某些容器属性将被忽略。被忽略的属性包括：

1. 资源要求

2. 资源限制强制措施

3. 重试策略

4. 重试次数（不支持重试）

5. 部署偏好

调度程序在接收到 SIGTERM 或 SIGINT 信号时支持清理孤儿进程。 调度程序将终止生成的进程。

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

• local_cwd 在当前工作目录下运行提供的应用程序，并忽略图像字段，以便更快地进行迭代和测试。

注意

孤悬对象清理仅在LocalScheduler从主线程实例化时生效。

配置选项

    usage:
        [log_dir=LOG_DIR],[prepend_cwd=PREPEND_CWD],[auto_set_cuda_visible_devices=AUTO_SET_CUDA_VISIBLE_DEVICES]

    optional arguments:
        log_dir=LOG_DIR (str, None)
            dir to write stdout/stderr log files of replicas
        prepend_cwd=PREPEND_CWD (bool, False)
            if set, prepends CWD to replica's PATH env var making any binaries in CWD take precedence over those in PATH
        auto_set_cuda_visible_devices=AUTO_SET_CUDA_VISIBLE_DEVICES (bool, False)
            sets the `CUDA_AVAILABLE_DEVICES` for roles that request GPU resources. Each role replica will be assigned one GPU. Does nothing if the device count is less than replicas.

兼容性

注意

由于调度器的差异，本地运行的任务在使用不同的调度器时可能无法工作，这可能是由于网络或软件依赖关系所致。

功能	调度程序支持
获取日志	✔️
分布式作业	LocalScheduler 支持多个副本，但所有副本将在本地主机上执行。
取消任务	✔️
描述工作	✔️
工作区 / 补丁修复	部分支持。LocalScheduler 从本地目录运行应用程序，但不支持程序化工作区。
挂载	❌

close() → None

仅适用于具有本地状态的调度器！关闭调度器，释放任何分配的资源。一旦关闭，调度器对象被认为不再有效，对该对象调用的任何方法都会导致未定义行为。

此方法不应抛出异常，并且允许对同一对象多次调用。

注意

仅针对具有本地状态的调度程序实现进行重写 (torchx/schedulers/local_scheduler.py). 简单地封装远程调度程序客户端的调度程序无需实现此方法。

describe(app_id: str) → Optional[DescribeAppResponse]

描述指定的应用程序。

Returns:

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

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``参数。

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

run_opts() → runopts

返回调度程序所期望的运行配置选项。 基本上是--help的run API。

schedule(dryrun_info: AppDryRunInfo[PopenRequest]) → str

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

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

图像提供者

class torchx.schedulers.local_scheduler.ImageProvider

管理本地主机上的下载和设置。这仅在LocalhostScheduler时需要，因为通常调度器会为用户自动完成此操作。

abstract fetch(image: str) → str

拉取指定的镜像并返回本地主机上拉取的镜像路径，如果没有则返回空字符串。

fetch_role(role: Role) → str

与fetch(image)相同，它获取角色的图像并返回图像根路径，不同之处在于它允许此提供程序更新角色。在需要在角色上设置额外的环境变量以符合图像提供程序在本地主机上获取和管理图像的方式时非常有用。默认情况下，此方法简单地委托给fetch(role.image)。如有必要，请重写。

get_cwd(image: str) → Optional[str]

返回挂载的 img 目录的绝对路径。用作启动子进程的工作目录。

get_entrypoint(img_root: str, role: Role) → str

返回入口点的位置。

get_replica_param(img_root: str, role: Role, stdout: Optional[str] = None, stderr: Optional[str] = None, combined: Optional[str] = None) → ReplicaParam

根据角色副本的规格返回 ReplicaParam 持有者 该持有者包含最终传递给 subprocess.Popen 的参数 以实际调用并运行每个角色的副本。预期 img_root 是 self.fetch(role.image) 的返回值。 由于角色的镜像只需获取一次（而不是为每个副本获取） 因此期望调用者对每个角色调用 fetch 方法一次 并对每个 role.num_replicas 调用此方法。

class torchx.schedulers.local_scheduler.CWDImageProvider(cfg: LocalOpts)

类似于 LocalDirectoryImageProvider，但它忽略图像名称，而将当前工作目录用作图像路径。

Example:

1. fetch(Image(name="/tmp/foobar")) 返回 os.getcwd()

2. fetch(Image(name="foobar:latest")) 返回 os.getcwd()

fetch(image: str) → str

拉取指定的镜像并返回本地主机上拉取的镜像路径，如果没有则返回空字符串。

get_cwd(image: str) → Optional[str]

返回挂载的 img 目录的绝对路径。用作启动子进程的工作目录。

get_entrypoint(img_root: str, role: Role) → str

返回入口点的位置。

class torchx.schedulers.local_scheduler.LocalDirectoryImageProvider(cfg: LocalOpts)

将图像名称解释为本地主机上的目录路径。不会“获取”（例如下载）任何内容。与LocalScheduler结合使用以运行本地二进制文件。

图像名称必须是绝对路径，并且必须存在。

Example:

1. fetch(Image(name="/tmp/foobar")) 返回 /tmp/foobar

2. fetch(Image(name="foobar")) 的 ValueError 次方

3. fetch(Image(name="/tmp/dir/that/does/not_exist")) 的 ValueError 次方

fetch(image: str) → str

Raises:

ValueError – 如果图像名称不是一个绝对目录，并且如果它不存在或不是一个目录

get_cwd(image: str) → Optional[str]

返回绝对工作目录。用作子进程的工作目录。

get_entrypoint(img_root: str, role: Role) → str

返回角色入口点。当本地调度器以 image_type=dir 执行时，子进程的工作目录将被设置为 img_root。如果role.entrypoint是相对路径，它会被解析为img_root/role.entrypoint；如果role.entrypoint是绝对路径，则会按提供的方式执行。

参考

torchx.schedulers.local_scheduler.create_cwd_scheduler(session_name: str, **kwargs: Any) → LocalScheduler

class torchx.schedulers.local_scheduler.LogIterator(app_id: str, regex: str, log_file: str, scheduler: Scheduler, should_tail: bool = True)

class torchx.schedulers.local_scheduler.PopenRequest(app_id: str, log_dir: str, role_params: Dict[str, List[ReplicaParam]], role_log_dirs: Dict[str, List[str]])

保存每个应用程序角色的每个副本创建子进程所需的参数。

class torchx.schedulers.local_scheduler.ReplicaParam(args: List[str], env: Dict[str, str], stdout: Optional[str] = None, stderr: Optional[str] = None, combined: Optional[str] = None, cwd: Optional[str] = None)

为每个角色的副本持有 LocalScheduler._popen() 个参数。

class torchx.schedulers.local_scheduler.SignalException(msg: str, sigval: Signals)

在运行时，当 torchx 本地调度程序进程收到终止信号时会引发异常。