parallel.Job
访问作业属性和行为
容器层次结构
父 | parallel.Cluster |
子 | parallel.Task |
描述
parallel.Job 对象提供对您创建、定义并提交执行的作业的访问。
类型
下表描述了可用的作业对象类型。作业类型由集群的类型决定，以及任务在执行过程中是否必须相互通信。
| 作业类型 | 描述 |
|---|---|
parallel.job.MJSIndependentJob | MATLAB® 作业调度器集群上的独立任务作业 |
parallel.job.MJSCommunicatingJob | MATLAB 作业调度器集群上的通信任务作业 |
parallel.job.CJSIndependentJob | CJS 集群上独立任务的作业 |
parallel.job.CJSCommunicatingJob | CJS 集群上通信任务的作业 |
方法
适用于所有作业类型
以下方法适用于所有作业对象类型。
cancel | 取消作业或任务 |
createTask | 在作业中创建新任务 |
delete | 从集群和内存中删除作业或任务对象 |
diary | 显示或保存批处理作业的命令行窗口文本 |
fetchOutputs | 从作业中的所有任务中检索输出参量 |
findTask | 在作业中查找任务 |
listAutoAttachedFiles | 自动附加到作业、任务或并行池的文件列表 |
load | 从批处理作业加载工作区变量 |
recreate | 从现有作业创建新作业 |
submit | 在调度器中排队作业 |
wait | 等待作业改变状态 |
属性
适用于所有作业类型
以下属性是所有作业对象类型所共有的。
| 属性 | 描述 |
|---|---|
AdditionalPaths | 要添加到 MATLAB 工作单元搜索路径的文件夹，指定为字符向量、字符串或字符串数组或字符向量元胞数组 |
AttachedFiles | 发送给工作单元的文件和文件夹，指定为字符向量、字符串或字符串数组，或字符向量元胞数组 |
AutoAddClientPath | 指定客户端路径上的用户添加的条目是否自动添加到每个工作单元的路径中 |
AutoAttachFiles | 指定是否自动将相关代码文件发送给工作单元 |
CreateDateTime | 创建作业的日期和时间 |
EnvironmentVariables | 发送给工作单元的环境变量的名称 |
FileStore | 作业的文件存储，即使作业仍在运行时也可以访问，指定为 FileStore 对象 |
FinishDateTime | 作业完成运行的日期和时间 |
ID | 作业的数值标识符 |
JobData | 向所有工作单元提供有关工作任务的信息 |
Name | 作业名称 |
Parent | 包含该作业的集群对象 |
RunningDuration | 当前作业持续时间，指定为 duration 对象 |
StartDateTime | 作业开始运行的日期和时间 |
State | 作业状态：'pending'、'queued'、'running'、'finished' 或 'failed' |
StorageBytes | 此作业的数据在作业存储位置中占用的字节数 |
SubmitDateTime | 作业提交到队列的日期和时间 |
Tag | 与作业相关的标签 |
Tasks | 作业中包含的任务对象数组 |
Type | 作业类型：'independent'、'pool' 或 'spmd' |
UserData | 与作业对象相关的信息 |
Username | 拥有作业的用户名 |
ValueStore | 作业的数据存储，即使作业仍在运行时也可以访问，指定为 ValueStore 对象 |
当您将计算任务卸载到工作单元时，客户端进行计算所需的任何文件也必须在工作单元上可用。默认情况下，客户端会尝试检测并附加这些文件。要关闭自动检测，请将 AutoAttachFiles 属性设置为 false。如果软件无法找到所有文件，或者从客户端向工作单元发送文件的速度很慢，请使用以下选项之一。
如果文件位于工作单元无法访问的文件夹中，请设置
AttachedFiles属性。集群将您指定的每个文件从客户端复制到工作单元。如果文件位于工作单元可访问的文件夹中，则可以设置
AdditionalPaths属性。使用AdditionalPaths属性将路径添加到每个工作单元的 MATLAB 搜索路径，并避免不必要地从客户端复制到工作单元。
MATLAB 作业调度器作业
MATLAB 作业调度器独立作业对象和 MATLAB 作业调度器通信作业对象除了具有共同属性外，还具有以下属性：
| 属性 | 描述 |
|---|---|
AuthorizedUsers | 授权访问作业的用户 |
FinishedFcn | 此作业完成时在客户端执行的回调函数 |
NumWorkersRange | 运行作业的工作单元数量的最小和最大限制 |
QueuedFcn | 当此作业提交到队列时在客户端执行的回调函数 |
RestartWorker | 如果在评估此作业的第一个任务之前重新启动工作单元，则为 True |
RunningFcn | 当此作业开始运行时在客户端执行的回调函数 |
Timeout | 完成作业的时间限制（以秒为单位） |
CJS 作业
CJS 独立作业对象除了所有作业类型共有的属性之外，没有任何属性。
CJS 通信作业对象除了具有公共属性外，还具有以下属性：
| 属性 | 描述 |
|---|---|
NumWorkersRange | 运行作业的工作单元数量的最小和最大限制 |
通信作业
MATLAB 作业调度器通信作业对象和 CJS 通信作业对象除了具有公共属性外，还具有此属性：
| 属性 | 描述 |
|---|---|
SpmdEnabled | 指示池类型作业是否可以运行 spmd 代码 (自 R2024a 起) |
帮助
要获取有关特定类型的 parallel.Job 对象的更多帮助，包括其属性的帮助链接列表，请输入 help parallel.job.<job-type>。例如：
help parallel.job.MJSIndependentJob
版本历史记录
在 R2012a 中推出
