ドキュメンテーション

最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

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.MJSComputeCloudMATLAB Parallel Server for Amazon EC2 クラスターと交信
parallel.cluster.Localクライアント マシンでローカルに実行されている CJS クラスターと交信
parallel.cluster.HPCServerWindows Microsoft HPC Server を実行している CJS クラスターと交信
parallel.cluster.LSFPlatform LSF を実行している CJS クラスターと交信
parallel.cluster.PBSProAltair PBS Pro を実行している CJS クラスターと交信
parallel.cluster.TorqueTORQUE を実行している CJS クラスターと交信
parallel.cluster.SlurmSlurm を実行している CJS クラスターと交信
parallel.cluster.Generic汎用インターフェイスを使用している CJS クラスターと交信

メソッド

全クラスター タイプ共通

batchワーカー上で MATLAB スクリプトまたは関数を実行する
createCommunicatingJobクラスターに通信ジョブを作成する
createJobクラスターに独立ジョブを作成する
findJobクラスターに保存されているジョブ オブジェクトを検索する
isequalクラスター間に同じプロパティ値がある場合に true を返す
isequalTrue if clusters have same property values
parpoolクラスターでの並列プールの作成
saveAsProfileクラスターのプロパティを指定されたプロファイルに保存する
saveProfileクラスターの変更済みプロパティを現在のプロファイルに保存する

MATLAB ジョブ スケジューラ

changePasswordMATLAB ジョブ スケジューラのパスワード変更をユーザーに要求
demoteクラスター キューでジョブを降格する
logoutMATLAB ジョブ スケジューラ クラスターからログアウトする
pauseMATLAB ジョブ スケジューラのキューを一時停止
promoteMATLAB ジョブ スケジューラ クラスターのキュー内でジョブを昇格
resumeMATLAB ジョブ スケジューラのキューの処理を再開

MJSComputeCloud

shutdown クラウド クラスターのシャットダウン
startクラウド クラスターの開始
wait (cluster)クラウド クラスターが状態を変更するまで待機

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

getDebugLogCJS クラスターで実行されたジョブからの出力メッセージを読み取る

Generic

getDebugLogCJS クラスターで実行されたジョブからの出力メッセージを読み取る
getJobClusterData汎用クラスターのジョブの特定ユーザー データを取得する
getJobFolderジョブが保存されているクライアントのフォルダー
getJobFolderOnClusterジョブが保存されているクラスターのフォルダー
getLogLocationジョブまたはタスクのログの場所
setJobClusterData汎用クラスターのジョブに特定のユーザー データを設定する

プロパティ

全クラスター タイプ共通

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

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

MATLAB ジョブ スケジューラ

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

プロパティ説明
AllHostAddressesクラスター ホストの IP アドレス
BusyWorkersタスクを現在実行しているワーカー
IdleWorkers現時点でタスクの実行に使用可能なワーカー
HasSecureCommunicationクラスターがセキュリティで保護された通信を使用している場合は True
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このクラスターに対して要求されたワーカー数。この数に達するように、クラスターは可能な限り速やかにワーカーの追加または削除を行います。
ShutdownAtシャットダウンの時刻またはイベント
Stateクラスターの現在の状態
Usernameクラスターにアクセスしているユーザー

ローカル

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

HPC Server

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

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

PBS Pro と TORQUE

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

プロパティ説明
CommunicatingJobWrapperワーカーを起動するためにクラスターが実行するスクリプト
RcpCommandクライアントから、またクライアントにファイルをコピーするコマンド
ResourceTemplateジョブ投入時にリソースを要求する場合は、qsub のオプションを指定
RshCommand通信ジョブ中にワーカー ノードで使用するリモート実行コマンド
HasSharedFilesystemクライアントとクラスターのノードが JobStorageLocation を共有するかどうかを指定
SubmitArgumentsジョブの投入時に使用する追加の引数を指定

LSF

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

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

Slurm

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

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

Generic

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

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

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

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

ヘルプ

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

help parallel.Cluster

R2012a で導入