batch
在工作单元上运行 MATLAB 脚本或函数
语法
说明
j = batch(expression)expression 作为表达式。该函数返回 j，即运行表达式的作业对象的句柄。
默认情况下，当您运行 batch(expression) 时，工作区变量会从客户端复制到工作单元。作业和任务对象不会被复制到工作单元手中。
j = batch(myCluster,expression)batch(expression) 相同，只是表达式在集群对象 myCluster 指定的集群中的工作单元上运行。
j = batch(fcn,N,{x1,...,xn})fcn。该函数返回 j，即运行该函数的作业对象的句柄。该函数使用给定的参量 x1,...,xn 进行评估，并返回 N 输出参量。fcn 的函数文件被复制到了工作单元。（注意：不要在函数名称参量中包含 .m 文件扩展名。）
j = batch(myCluster,fcn,N,{x1,...,xn})batch(fcn,N,{x1,...,xn}) 相同，只是该函数在集群对象 myCluster 指定的集群中的工作单元上运行。
j = batch(___,Name,Value)
示例
此示例显示如何使用 batch 将工作卸载到在后台运行的 MATLAB® 工作单元会话。
您可以在计算过程中继续使用 MATLAB。
使用 batch函数将脚本作为批处理作业运行。默认情况下，batch 使用您的默认集群配置文件。在 MATLAB 主页选项卡的环境部分中的并行 > 选择并行环境中检查您的默认集群配置文件。或者，您可以使用 'Profile' 名称-值对参量指定集群配置文件文件。
job = batch('myScript');batch 不会阻止 MATLAB，您可以在进行计算时继续工作。
如果您想阻止 MATLAB 直到作业完成，请在作业对象上使用 wait 函数。
wait(job);
默认情况下，MATLAB 将批处理作业的命令行窗口输出保存到作业的日记中。要检索它，请使用 diary 函数。
diary(job)
--- Start Diary --- n = 100 --- End Diary ---
作业完成后，使用 load函数获取结果。
load(job,'x');
plot(x)
如果要加载批处理作业中的所有变量，请改用 load(job)。
加载所有必需的变量后，删除作业对象以清理其数据并避免不必要地消耗资源。
delete(job);
clear job请注意，如果您使用 batch 发送脚本文件，MATLAB 会将所有工作区变量传输到集群，即使您的脚本不使用它们。大型工作空间的数据传输时间可能相当长。最佳做法是将脚本转换为函数文件以避免这种通信开销。有关使用函数的示例，请参阅 运行批处理作业并从工作单元访问文件。
有关 batch 的更多高级选项，请参阅 运行批处理作业并从工作单元访问文件。
您可以使用 batch 卸载计算并在后台运行。
如果您的代码需要访问文件，您可以使用其他选项，例如 'AttachedFiles' 或 'AdditionalPaths'，来使数据可访问。在计算过程中，您可以继续在 MATLAB® 中工作。如果您将计算提交到远程集群，则可以关闭 MATLAB 并稍后恢复结果。
准备示例
使用支持函数 prepareSupportingFiles 将此示例所需的数据复制到当前工作文件夹。
prepareSupportingFiles;
您当前的工作文件夹现在包含 4 个文件：A.dat、B1.dat、B2.dat 和 B3.dat。
运行批处理作业
使用 parcluster 创建一个集群对象。默认情况下，parcluster 使用您的默认集群配置文件。在 MATLAB 主页选项卡上的环境部分中的并行 > 选择默认集群中检查您的默认集群配置文件。
c = parcluster();
将您的代码放在函数内，并使用 batch 将其作为批处理作业提交。有关自定义函数的示例，请参阅支持函数 divideData。指定预期的输出参量数量以及包含函数输入的元胞数组。
请注意，如果您使用批处理发送脚本文件，MATLAB 会将所有工作区变量传输到集群，即使您的脚本不使用它们。如果您的工作空间较大，则会对数据传输时间产生负面影响。最佳做法是将脚本转换为函数文件以避免这种通信开销。您只需在脚本开头添加一个函数行即可完成此操作。为了减少此示例中的开销，divideData 在此实时脚本之外的文件中定义。
如果您的代码使用并行池，请使用 'Pool' 名称-值对参量来创建具有您指定工作单元数量的并行池。batch 使用额外的工作单元来运行函数本身。
默认情况下，batch 将工作单元的初始工作文件夹更改为 MATLAB 客户端的当前文件夹。控制工作单元中的初始工作文件夹会很有用。例如，如果集群使用不同的文件系统，因此路径不同，您可能需要控制它，例如从 Windows® 客户端计算机提交到 Linux® 集群时。
为了保留工作单元的初始工作文件夹并使用其默认值，请将
'CurrentFolder'设置为'.'。要更改初始工作文件夹，请将
'CurrentFolder'设置为您选择的文件夹。
此示例使用具有三个工作单元的并行池，并为初始工作文件夹选择一个临时位置。使用 batch 来卸载 divideData 中的计算。
job = batch(c,@divideData,1,{}, ...
'Pool',3, ...
'CurrentFolder',tempdir);batch 在并行工作单元上运行 divideData，因此您可以在进行计算时继续在 MATLAB 中工作。
如果您想阻止 MATLAB 直到作业完成，请在作业对象上使用 wait 函数。
wait(job);
要检索结果，请在作业对象上使用 fetchOutputs。由于 divideData 依赖于工作单元无法找到的文件，因此 fetchOutputs 抛出错误。您可以通过在作业中 getReport 对象的 Error 属性上使用 Task 来访问错误信息。在这个示例中，代码依赖于工作单元无法找到的文件。
getReport(job.Tasks(1).Error)
ans =
'Error using divideData (line 4)
Unable to read file 'B2.dat'. No such file or directory.'
从工作单元访问文件
默认情况下，batch 会自动分析您的代码并将所需的文件传输给工作单元。在某些情况下，您必须明确传输这些文件 - 例如，当您在运行时确定文件的名称时。
在这个示例中，divideData 访问支持文件 A.dat，batch 自动检测并传输该文件。该函数也访问 B1.dat，但它在运行时解析文件的名称，因此自动依赖性分析不会检测到它。
type divideData.m function X = divideData()
A = load("A.dat");
X = zeros(flip(size(A)));
parfor i = 1:3
B = load("B" + i + ".dat");
X = X + A\B;
end
end
如果数据位于工作单元可以访问的位置，则可以使用名称-值对参量 'AdditionalPaths' 来指定位置。'AdditionalPaths' 将此路径添加到工作单元的 MATLAB 搜索路径，并使数据对它们可见。
pathToData = pwd;
job(2) = batch(c,@divideData,1,{}, ...
'Pool',3, ...
'CurrentFolder',tempdir, ...
'AdditionalPaths',pathToData);
wait(job(2));如果数据位于工作单元无法访问的位置，您可以使用 'AttachedFiles' 名称-值对参量将文件传输给工作单元。如果客户端和工作单元不共享相同的文件系统，或者您的集群在非共享模式下使用通用调度器接口，则需要传输文件。有关详细信息，请参阅使用通用调度器接口进行配置 (MATLAB Parallel Server)。
filenames = "B" + string(1:3) + ".dat"; job(3) = batch(c,@divideData,1,{}, ... 'Pool',3, ... 'CurrentFolder',tempdir, ... 'AttachedFiles',filenames);
查找现有作业
如果将作业提交到远程集群，可以在作业提交后关闭 MATLAB，稍后再检索结果。在关闭 MATLAB 之前，请记下作业 ID。
job3ID = job(3).ID
job3ID = 25
当您再次打开 MATLAB 时，您可以使用 findJob 函数找到该作业。
job(3) = findJob(c,'ID',job3ID);
wait(job(3));或者，您可以使用作业监控程序来跟踪您的作业。您可以从 MATLAB 主页选项卡的环境部分中的并行 > 监控作业中打开它。
检索结果并清理数据
要检索批处理作业的结果，请使用 fetchOutputs 函数。fetchOutputs 返回一个元胞数组，其中包含使用 batch 运行的函数的输出。
X = fetchOutputs(job(3))
X = 1×1 cell array
{40×207 double}
当您检索到所有必需的输出并且不再需要该作业对象时，请删除它以清理其数据并避免不必要地消耗资源。
delete(job)
clear job输入参数
名称-值参数
输出参量
提示
要查看批处理作业的状态或跟踪其进度，请使用作业监控程序，如作业监控程序中所述。您还可以使用作业监控程序检索在不同会话中创建的批处理作业的作业对象，或者检索未从
batch调用返回作业对象的批处理作业的作业对象。删除不再需要的批处理作业，以避免不必要地消耗集群存储资源。
为了开发和测试您的代码，您可以在客户端计算机上的本地集群上运行批处理作业。如果您关闭 MATLAB 会话，任何使用本地集群的批处理作业也会立即停止。
当您将工作卸载到远程集群时，您可以在作业处理时关闭 MATLAB 客户端会话，然后稍后从批处理作业中或在新的客户端会话中检索信息。
