parallel.Cluster

クラスターのプロパティおよび動作にアクセスする

コンストラクター

parcluster

getCurrentCluster (MATLAB ワーカーのワークスペース内)

コンテナー階層

親	なし
子	`parallel.Job`, `parallel.Pool`

説明

parallel.Cluster オブジェクトはジョブキューを制御するクラスターへのアクセスを提供し、実行のためにタスクをワーカーに分散します。

タイプ

クラスターには MATLAB^® ジョブスケジューラと一般的なジョブスケジューラ (CJS) の 2 つのカテゴリがあります。MATLAB ジョブスケジューラは、MATLAB Parallel Server™ で使用できます。CJS クラスターにはローカル、汎用、サードパーティのスケジューラを含む、他すべてのタイプが含まれます。

MATLAB Parallel Server for Amazon EC2^® クラスターと交信するには、MJSComputeCloud オブジェクトを使用します。

以下の表では、使用可能なタイプのクラスターオブジェクトについて説明します。

クラスタータイプ	説明
`parallel.cluster.MJS`	内部設置型の MATLAB ジョブスケジューラクラスターと交信
`parallel.cluster.MJSComputeCloud`	MATLAB Parallel Server for Amazon EC2 クラスターと交信
`parallel.cluster.Local`	クライアントマシンでローカルに実行されている CJS クラスターと交信
`parallel.cluster.HPCServer`	Windows Microsoft HPC Server を実行している CJS クラスターと交信
`parallel.cluster.LSF`	LSF を実行している CJS クラスターと交信
`parallel.cluster.PBSPro`	Altair PBS Pro または OpenPBS を実行している CJS クラスターと交信
`parallel.cluster.Torque`	TORQUE を実行している CJS クラスターと交信
`parallel.cluster.Slurm`	Slurm を実行している CJS クラスターと交信
`parallel.cluster.Generic`	汎用インターフェイスを使用している CJS クラスターと交信

メソッド

全クラスタータイプ共通

batch	Run MATLAB script or function on worker
createCommunicatingJob	Create communicating job on cluster
createJob	Create independent job on cluster
findJob	Find job objects in cluster
isequal	True if clusters have same property values
parpool	Create parallel pool on cluster
saveAsProfile	Save cluster properties to specified profile
saveProfile	Save modified cluster properties to its current profile

MATLAB ジョブスケジューラ

changePassword	Prompt MATLAB Job Scheduler password change
demote	Demote job in cluster queue
logout	Log out of MATLAB Job Scheduler cluster
promote	Promote job in MATLAB Job Scheduler cluster queue
resume	Resume processing queue in MATLAB Job Scheduler

MJSComputeCloud

shutdown	Shut down cloud cluster
start	Start cloud cluster
wait (cluster)	Wait for cloud cluster to change state

HPC Server、PBS Pro、LSF、TORQUE、Slurm およびローカルクラスター

getDebugLog	Read output messages from job run in CJS cluster
getJobClusterData	Get specific user data for job on third-party cluster
getJobFolder	Folder on client where jobs are stored
getJobFolderOnCluster	Folder on cluster where jobs are stored
getLogLocation	Log location for job or task
setJobClusterData	Set specific user data for job on third-party cluster

Generic

getDebugLog	Read output messages from job run in CJS cluster
getJobClusterData	Get specific user data for job on third-party cluster
getJobFolder	Folder on client where jobs are stored
getJobFolderOnCluster	Folder on cluster where jobs are stored
getLogLocation	Log location for job or task
setJobClusterData	Set specific user data for job on third-party cluster

プロパティ

全クラスタータイプ共通

以下のプロパティはすべてのクラスターオブジェクトタイプに共通です。

プロパティ	説明
`ClusterMatlabRoot`	ワーカーが使用する MATLAB へのパスを指定
`Host`	クラスターヘッドノードのホスト名
`JobStorageLocation`	クラスターがジョブおよびタスク情報を格納する場所
`Jobs`	このクラスターに含まれるジョブのリスト
`LicenseNumber`	このクラスターでのジョブの実行時に使用するライセンス番号
`Modified`	このクラスターのいずれかのプロパティが変更されている場合は true
`NumThreads`	ワーカーの計算スレッド数
`NumWorkers`	このクラスターで使用可能なワーカーの数
`OperatingSystem`	クラスターで使用されるノードのオペレーティングシステム
`PreferredPoolNumWorkers`	並列プールでの推奨されるワーカー数
`Profile`	このクラスターの構築に使用するプロファイル
`RequiresOnlineLicensing`	クラスターがオンラインライセンスを使用している場合は true
`Type`	このクラスターのタイプ
`UserData`	クライアントセッション内でクラスターオブジェクトに関連付けられている情報

次のいずれかとして JobStorageLocation プロパティを指定します。

汎用スケジューラインターフェイスをリモートモードで使用してサードパーティ製スケジューラと交信し、かつクライアントとワーカーが異なるオペレーティングシステムを使用している場合は、構造体を指定します。構造体には 'windows' と 'unix' のフィールドが必要です。これらのフィールドは、クラスターがジョブとタスクの情報を保存するフォルダーに対応する Windows と Unix のパスです。次の構造体は、Windows UNC パス ('\\organization\some\path') と Unix パス ('/organization/some/path') を使用して同じフォルダーを指定します。
```
struct('windows', '\\organization\some\path', 'unix', '/organization/some/path')
```
それ以外の場合は、文字ベクトルまたは string を使用して、クラスターがジョブとタスクの情報を保存するフォルダーを指定します。

MATLAB ジョブスケジューラ

MJS クラスターオブジェクトには、共通のプロパティに加えて以下のプロパティがあります。

プロパティ	説明
`AllHostAddresses`	クラスターホストの IP アドレス
`BusyWorkers`	タスクを現在実行しているワーカー
`IdleWorkers`	現時点でタスクの実行に使用可能なワーカー
`HasSecureCommunication`	クラスターがセキュリティで保護された通信を使用している場合は True
`MaxNumWorkers`	このクラスターがもつことのできるワーカーの最大数。自動的にサイズが変更されないクラスターを使用する場合、この値はクラスターのワーカー数です。自動的にサイズが変更されるクラスターを使用する場合、必要に応じて、ワーカーが最大値まで自動的に追加されます。自動的なサイズ変更の詳細については、MATLAB ジョブスケジューラクラスターの自動サイズ変更の設定 (MATLAB Parallel Server)を参照してください。
`Name`	このクラスターの名前
`NumBusyWorkers`	タスクを現在実行しているワーカーの数
`NumIdleWorkers`	タスクの実行に使用可能なワーカーの数
`PromptForPassword`	ユーザーを認証するときにパスワードを要求する場合は True
`SecurityLevel`	クラスターとそのジョブに適用されるセキュリティレベル。セキュリティレベルについては、MATLAB ジョブスケジューラクラスターのセキュリティの設定 (MATLAB Parallel Server)を参照してください。
`State`	クラスターの現在の状態
`Username`	クラスターにアクセスしているユーザー

MJSComputeCloud

MJSComputeCloud クラスターオブジェクトには、共通のプロパティに加えて以下のプロパティがあります。

プロパティ	説明
`BusyWorkers`	タスクを現在実行しているワーカー
`Certificate`	クラスターの SSL 証明書
`HasSecureCommunication`	クラスターがセキュリティで保護された通信を使用している場合は True
`Identifier`	一意のクラスター識別子
`IdleWorkers`	現時点でタスクの実行に使用可能なワーカー
`MatlabVersion`	ワーカー上で実行されている MATLAB のバージョン
`MaxNumWorkers`	このクラスターがもつことのできるワーカーの最大数。自動的にサイズが変更されないクラスターを使用する場合、この値はクラスターの開始時のワーカー数です。自動的にサイズが変更されるクラスターを使用する場合、必要に応じて、ワーカーが最大値まで自動的に追加されます。自動的なサイズ変更の詳細については、Resize Clusters Automatically を参照してください。
`Name`	このクラスターの名前
`NumBusyWorkers`	タスクを現在実行しているワーカーの数
`NumIdleWorkers`	タスクの実行に使用可能なワーカーの数
`NumWorkersRequested`	このクラスターに対して要求されたワーカー数。この数に達するように、クラスターは可能な限り速やかにワーカーの追加または削除を行います。
`SharedState`	クラスターの共有状態。次のいずれかになります。個人用 – 作成者のみがこのクラスターを使用できます。共有可能 – 誰でもこのクラスターを使用できます。
`ShutdownAt`	シャットダウンの時刻またはイベント
`State`	クラスターの現在の状態
`Username`	クラスターにアクセスしているユーザー

ローカル

Local クラスターオブジェクトには、すべてのクラスターに共通のプロパティ以外に編集可能なプロパティはありません。

HPC Server

HPCServer クラスターオブジェクトは、Windows を実行するクライアントでサポートされます。

HPCServer クラスターオブジェクトには、共通のプロパティに加えて以下のプロパティがあります。

プロパティ	説明
`ClusterVersion`	クラスター上で実行されている Microsoft Windows HPC Server のバージョン
`HasSharedFilesystem`	クライアントとクラスターのノードが JobStorageLocation を共有するかどうかを指定
`JobDescriptionFile`	ジョブの作成時に使用する XML ジョブ記述ファイルの名前
`JobTemplate`	HPC Server に投入するジョブに使用するジョブテンプレートの名前
`Name`	このクラスターの名前
`UseSOAJobSubmission`	HPC Server でのサービス指向アーキテクチャ (SOA) の送信を許可

PBS Pro と TORQUE

PBSPro クラスターオブジェクトは、Windows または Linux を実行するクライアントでサポートされます。Torque クラスターオブジェクトは、Linux を実行するクライアントでサポートされます。

PBSPro および Torque クラスターオブジェクトには、共通のプロパティに加えて以下のプロパティがあります。

プロパティ	説明
`CommunicatingJobWrapper`	ワーカーを起動するためにクラスターが実行するスクリプト
`RcpCommand`	クライアントから、またクライアントにファイルをコピーするコマンド
`ResourceTemplate`	ジョブ投入時にリソースを要求する場合は、`qsub` のオプションを指定
`RshCommand`	通信ジョブ中にワーカーノードで使用するリモート実行コマンド
`HasSharedFilesystem`	クライアントとクラスターのノードが JobStorageLocation を共有するかどうかを指定
`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` 以下に設定してください。詳細については、ワーカー数とクラスター設定の編集を参照してください。
`SubmitArguments`	ジョブの投入時に使用する追加の引数を指定

LSF

LSF クラスターオブジェクトは、Windows、macOS、または Linux を実行するクライアントでサポートされます。

LSF クラスターオブジェクトには、共通のプロパティに加えて以下のプロパティがあります。

プロパティ	説明
`ClusterName`	LSF クラスターの名前
`CommunicatingJobWrapper`	ワーカーを起動するためにクラスターが実行するスクリプト
`HasSharedFilesystem`	クライアントとクラスターのノードが JobStorageLocation を共有するかどうかを指定
`ResourceTemplate`	ジョブ投入時にリソースを要求する場合は、`bsub` のオプションを指定
`SubmitArguments`	ジョブの投入時に使用する追加の引数を指定

Slurm

Slurm クラスターオブジェクトは、Linux を実行するクライアントでサポートされます。

Slurm クラスターオブジェクトには、共通のプロパティに加えて以下のプロパティがあります。

プロパティ	説明
`ClusterName`	Slurm クラスターの名前
`CommunicatingJobWrapper`	ワーカーを起動するためにクラスターが実行するスクリプト
`ResourceTemplate`	ジョブ投入時にリソースを要求する場合は、`sbatch` のオプションを指定
`SubmitArguments`	ジョブの投入時に使用する追加の引数を指定

Generic

Generic クラスターオブジェクトは、Windows、macOS、または Linux を実行するクライアントでサポートされます。

R2017a 以降のプロファイルから汎用クラスターオブジェクトを作成する場合、共通のプロパティに加えて以下のプロパティがあります。

プロパティ	説明
`AdditionalProperties`	プラグインスクリプト用の追加プロパティ
`HasSharedFilesystem`	クライアントとクラスターのノードが JobStorageLocation を共有するかどうかを指定
`PluginScriptsLocation`	スケジューラのプラグインスクリプトを格納するフォルダー

R2016b 以前のプロファイルから汎用クラスターオブジェクトを作成する場合、共通のプロパティに加えて以下のプロパティがあります。

プロパティ	説明
`CancelJobFcn`	ジョブをキャンセルするときに実行する関数
`CancelTaskFcn`	タスクをキャンセルするときに実行する関数
`CommunicatingSubmitFcn`	通信ジョブを投入するときに実行する関数
`DeleteJobFcn`	ジョブを削除するときに実行する関数
`DeleteTaskFcn`	タスクを削除するときに実行する関数
`GetJobStateFcn`	ジョブの状態をクエリするときに実行する関数
`HasSharedFilesystem`	クライアントとクラスターのノードが JobStorageLocation を共有するかどうかを指定
`IndependentSubmitFcn`	独立ジョブを投入するときに実行する関数

ヘルプ

クラスターオブジェクトのヘルプ (特定のクラスター型やオブジェクトのプロパティのヘルプへのリンクなど) を参照するには、以下のように入力します。

help parallel.Cluster

参考

parallel.Job, parallel.Task, parallel.Worker, parallel.Pool, parallel.cluster.Hadoop

バージョン履歴

R2012a で導入

parallel.Cluster

コンストラクター

コンテナー階層

説明

タイプ

メソッド

全クラスター タイプ共通

MATLAB ジョブ スケジューラ

MJSComputeCloud

HPC Server、PBS Pro、LSF、TORQUE、Slurm およびローカル クラスター

Generic

プロパティ

全クラスター タイプ共通

MATLAB ジョブ スケジューラ

MJSComputeCloud

ローカル

HPC Server

PBS Pro と TORQUE

LSF

Slurm

Generic

ヘルプ

参考

バージョン履歴

全クラスタータイプ共通

MATLAB ジョブスケジューラ

HPC Server、PBS Pro、LSF、TORQUE、Slurm およびローカルクラスター

全クラスタータイプ共通

MATLAB ジョブスケジューラ