自定义示例插件脚本的行为

Parallel Computing Toolbox™ 使用一组插件脚本来定义客户端与您的第三方调度器之间的通信方式。您可以通过使用 AdditionalProperties 为第三方内置或通用集群配置文件或对象设置额外属性，来修改插件脚本的行为。

其他属性

示例插件脚本允许您设置这些属性。

所有调度器的属性

属性	描述	数据类型
`AdditionalSubmitArgs`	用于作业提交的附加调度器参量。示例插件脚本将此属性的值添加到调度器提交字符串。	`String`
`AuthenticationMode`	用于指示您连接到集群时如何进行身份验证的选项，指定为以下之一： `"Agent"` - 客户端与运行在客户端计算机上的 SSH 代理进行接口。SSH 代理身份验证不支持 PPK 格式的密钥。仅支持 OpenSSH 格式的密钥。 `"IdentityFile"` - 客户端使用由 `IdentityFile` 附加属性指定的身份文件。 `"Multifactor"` - 客户端会提示您输入一次或多次。例如，如果客户端上启用了双因素身份验证 (2FA)，则客户端会请求您的密码和第二个身份验证因素的响应。 `"Password"` - 客户端提示您输入 SSH 密码。您的用户名由 `Username` 附加属性指定。	`String` `String array`
`ClusterHost`	具有用于提交作业的调度器实用程序的集群计算机的主机名。如果您的集群无法直接向调度器提交作业，请使用此功能。集群计算机必须运行 Linux。	`String`
`DisplaySubmitArgs`	用于显示提交作业时传递给调度器的作业提交标志和选项的选项。标志和选项显示在命令行上。	`Logical`
`FileTransferProtocol` (自 R2026a 起)	在 MATLAB^® 客户端与远程集群主机之间传输文件时使用的文件传输协议，可选以下选项之一： `"SFTP"`（默认）- 使用安全文件传输协议 (SFTP) 传输文件。MATLAB 默认使用 SFTP 与远程集群主机进行身份验证并加密文件传输。您的集群主机必须已启用 SFTP。 `"SCP"` - 使用安全复制协议 (SCP) 传输文件。如果您的集群未启用 SFTP，请使用 SCP。	`String`
`FileArchiveType` (自 R2026a 起)	在 MATLAB 客户端与远程集群主机之间传输文件时使用的文件归档类型，应指定为以下选项之一： `"Tar"`（默认）- 使用 TAR 格式对文件进行归档。MATLAB 默认使用此选项，在传输前对文件进行打包。 `"None"` - 不进行归档即可传输文件。如果集群主机上未安装 TAR 实用工具，请使用此选项。	`String`
`IdentityFile`	在集群主机上识别您的 SSH 身份文件的客户端计算机计算机的位置。	`String` `String array`
`IdentityFileHasPassphrase`	使用密码作为身份文件的选项。如果 `IdentityFile` 需要密码，则将此属性设置为 `true`。	`Logical`
`MPIImplementation` (自 R2025a 起)	将 Linux^® 集群上作业使用的消息传递接口 (MPI) 实施更改为以下选项之一： `"MPICH"` - 使用 MPICH 版 `mpiexec` 命令运行作业。默认情况下，Parallel Computing Toolbox 使用 MPI 的 MPICH 实现来运行作业。 `"IntelMPI"` - 使用 MPI 的 Intel^® 实现运行作业。	`String`
`RemoteJobStorageLocation`	在集群上存储作业文件的位置。如果您的客户端和集群节点没有共享文件系统，请使用此属性。	`String`
`SSHPort`	SSH 连接的集群主机端口号。使用此属性设置通过 SSH 连接的集群主机上的端口。	`Double`
`UseIdentityFile`	使用身份文件的选项。如果您想使用 SSH 身份文件登录到集群主机，请将此属性设置为 `true`。如果设置此属性，则也设置 `IdentityFile` 和 `IdentityFileHasPassphrase`。	`Logical`
`Username`	登录集群主机的用户名。	`String`
`UseUniqueSubfolders`	使用唯一子文件夹的选项。如果您希望 MATLAB 根据用户名和 MATLAB 版本将作业文件存储在不同的子文件夹下，请将此属性设置为 `true`这样做有助于防止不同用户和 MATLAB 版本提交的作业之间发生冲突。	`Logical`

每个调度器的特定属性

仅适用于 Slurm 的属性

属性	描述	数据类型
`AccountName`	调度器对所使用的资源收费的帐户名称。	`String`
`Constraint`	运行作业所需的节点特性。	`String`
`MemPerCPU`	每个 CPU 所需的最小内存。	`String`
`Partition`	对作业资源分配进行分区。	`String`
`RequireExclusiveNode`	与其他正在运行的作业共享节点的选项。如果该作业不能与其他正在运行的作业共享节点，则将此属性设置为 `true`。	`Logical`
`Reservation`	调度器可以根据此预留名称为该作业分配资源。	`String`
`WallTime`	限制该作业的总运行时间。	`String`
`EmailAddress`	接收来自调度器通知的电子邮件地址。	`String`

仅适用于 LSF 的属性

属性	描述	数据类型
`MemPerCPU`	每个 CPU 所需的最小内存。	`String`
`Project`	调度器分配该作业的工程。	`String`
`QueueName`	调度器在其上运行作业的集群队列名称。	`String`
`RequireExclusiveNode`	与其他正在运行的作业共享节点的选项。如果该作业不能与其他正在运行的作业共享节点，则将此属性设置为 `true`。	`Logical`
`WallTime`	限制该作业的总运行时间。	`String`
`EmailAddress`	接收来自调度器通知的电子邮件地址。	`String`

仅适用于 Grid Engine 系列的属性

属性	描述	数据类型
`AccountName`	调度器运行作业的帐户名。	`String`
`MemPerCPU`	每个 CPU 所需的最小内存。	`String`
`Project`	调度器分配该作业的工程。	`String`
`QueueName`	运行该作业的集群队列名称。	`String`
`WallTime`	限制该作业的总运行时间。	`String`
`EmailAddress`	接收来自调度器通知的电子邮件地址。	`String`

仅适用于 PBS 的属性

属性	描述	数据类型
`AccountName`	调度器对所使用的资源收费的帐户名称。	`String`
`Priority`	该作业相对于集群中其他作业的优先级。	`Double`
`ProcsPerNode`	每个节点的处理器数量，指定为有限正整数标量。当您向集群提交作业时，MATLAB 请求的每个节点的核数保证小于或等于 `ProcsPerNode`。将 `ProcsPerNode` 设置为您希望 MATLAB 从每个集群节点请求的最大处理器数量。 MATLAB 请求运行作业所需的每个节点的最小核数。如果集群的 `NumThreads` 属性小于或等于 `ProcsPerNode`，MATLAB 将为每个工作单元请求 `NumThreads` 个处理器，然后最大化每个节点的工作单元数量。例如，如果 `ProcsPerNode` 为 `16` 且 `NumThreads` 为 `5`，则 MATLAB 请求 `15` 核，即小于 `ProcsPerNode` 的 `5` 的最大倍数。如果集群的 `NumThreads` 大于 `ProcsPerNode`，则 MATLAB 会向每个节点请求 `ProcsPerNode` 处理器。当 `NumThreads` 大于 `ProcsPerNode` 时，您可能会遇到性能问题。作为最佳做法，请将 `NumThreads` 设置为小于或等于 `ProcsPerNode`。有关详细信息，请参阅编辑工作单元数量和集群设置 (Parallel Computing Toolbox)。	`Positive integer scalar`
`QueueName`	运行该作业的集群队列或服务器名称。	`String`
`WallTime`	限制该作业的总运行时间。	`String`
`EmailAddress`	接收来自调度器通知的电子邮件地址。	`String`

仅适用于 HTCondor 的属性

属性	描述	数据类型
`AccountingGroup`	调度器作业所依据的会计组名称。	`String`
`AccountingGroupUsername`	资源使用核算的用户名。	`String`
`RequestDisk`	该作业对磁盘空间的要求。	`String`
`RequestMemory`	该作业对内存的要求。	`String`
`Priority`	该作业相对于集群中其他作业的优先级。	`Double`
`Requirements`	运行作业所需的节点特性。	`String`
`EmailAddress`	接收来自调度器通知的电子邮件地址。	`String`

仅适用于 AWS Batch 的属性

属性	描述	数据类型
`IndependentJobDefinition`	AWS^® 的定义独立 MATLAB 作业的批处理作业。	`String`
`JobQueue`	集群的 AWS Batch 作业队列	`String`
`LicenseServer`	运行网络许可证管理器的计算机的端口号和主机名。以 `port@hostname` 格式指定此属性。	`String`
`S3Bucket`	Amazon S3™ 桶用于客户端与 MATLAB Parallel Server™ 工作单元之间的数据传输	`String`

设置其他属性

您可以使用集群配置文件管理器或以编程方式在集群配置文件中设置其他属性。

在集群配置文件中设置属性

当您在集群配置文件中设置附加属性时，每次使用集群时都会应用这些属性。

在 MATLAB 工具条的主页选项卡上的环境区域中，选择并行 > 创建和管理集群。
在集群配置文件管理器中，点击要修改的集群配置文件。
点击右下角的编辑。
转到 AdditionalProperties 表。
要添加新属性，请点击添加。要修改现有属性，请点击该属性。

下图显示在 Slurm 集群配置文件上设置 AdditionalSubmitArgs 附加属性的示例，以便插件脚本为作业添加注释。

Cluster Profile Manager with the Slurm profile selected. The properties for the cluster are shown in the right panel. The Additional Properties entry is being edited.

以编程方式设置属性

您可以通过访问集群对象的 AdditionalProperties 以编程方式设置其他属性。请注意，此操作不会更新集群配置文件，并且属性仅适用于该特定集群对象。以下是如何为 Slurm 集群设置 AdditionalSubmitArgs 的示例。

首先，使用 parcluster 函数创建一个集群对象。在以下代码中，将 MySlurmCluster 更改为您的集群配置文件的名称。

c = parcluster("MySlurmCluster");

接下来，设置 AdditionalSubmitArgs，以便插件脚本为该作业附加注释。

c.AdditionalProperties.AdditionalSubmitArgs = '--comment="my test job"';

通过此更改，当您提交作业时，MATLAB 会将附加参量传递给调度器。例如提交批处理作业。

job = batch(c,"myScript");

有关使用 AdditionalProperties 属性在运行时修改插件脚本功能的其他示例，请参阅添加用户自定义。