ラッパー スクリプト

サンプルのプラグイン スクリプトでは "ラッパー" スクリプトを使用して independentSubmitFcn.m と communicatingSubmitFcn.m の実装を簡略化しています。これらのスクリプトは必須ではありませんが、コードを読みやすくするためにこれらの使用を推奨します。この表ではこれらのスクリプトを説明します。

independentSubmitFcn

独立ジョブを汎用クラスターに投入すると、関数 independentSubmitFcn.m が MATLAB クライアント セッションで実行されます。

この関数の宣言行は次のとおりでなければなりません。

function independentSubmitFcn(cluster,job,environmentProperties)

MATLAB の独立ジョブの各タスクはスケジューラの 1 つのジョブに対応します。この関数の目的は N 個のジョブをサードパーティ製スケジューラに投入することです。ここで、N は独立ジョブ内のタスクの数です。これらの各ジョブは次を満たさなければなりません:

ワーカー環境の構成.  この表に、個々のタスクを実行するために、ワーカーの MATLAB に設定しなければならない 5 つの環境変数と値を示します。

多くのスケジューラは投入コマンドの一部としてクライアント環境をコピーすることをサポートしています。サポートしている場合、クライアントに以前の環境変数を設定できるため、スケジューラは設定をワーカー環境にコピーできます。サポートしていない場合は、これらの変数を転送するように投入コマンドを変更しなければなりません。

スケジューラ ジョブを投入して MATLAB ワーカーを実行.  ジョブおよびタスクに必須の 5 つのパラメーターがワーカー上で定義されると、適切な引数を指定して MATLAB 実行可能ファイルを呼び出すことにより、タスクが実行されます。呼び出す MATLAB 実行可能ファイルは environmentProperties.MatlabExecutable に定義されます。渡す引数は environmentProperties.MatlabArguments に定義されます。

SLURM スケジューラ用サンプル スクリプト.  このスクリプトは、共有ファイル システムをもつ SLURM スケジューラ用の基本的な投入関数を示します。より詳細な例については、サンプルのプラグイン スクリプトを参照してください。

function independentSubmitFcn(cluster,job,environmentProperties)
    % Specify the required environment variables.
    setenv('PARALLEL_SERVER_DECODE_FUNCTION', 'parallel.cluster.generic.independentDecodeFcn');
    setenv('PARALLEL_SERVER_STORAGE_CONSTRUCTOR', environmentProperties.StorageConstructor);
    setenv('PARALLEL_SERVER_STORAGE_LOCATION', environmentProperties.StorageLocation);
    setenv('PARALLEL_SERVER_JOB_LOCATION', environmentProperties.JobLocation);
    
    % Specify the MATLAB executable and arguments to run on the worker.
    % These are used in the independentJobWrapper.sh script.
    setenv('PARALLEL_SERVER_MATLAB_EXE', environmentProperties.MatlabExecutable);
    setenv('PARALLEL_SERVER_MATLAB_ARGS', environmentProperties.MatlabArguments);
    
    for ii = 1:environmentProperties.NumberOfTasks
        % Specify the environment variable required to identify which task to run.
        setenv('PARALLEL_SERVER_TASK_LOCATION', environmentProperties.TaskLocations{ii});
        % Specify the command to submit the job to the SLURM scheduler.
        % SLURM will automatically copy environment variables to workers.
        commandToRun = 'sbatch --ntasks=1 independentJobWrapper.sh';
        [cmdFailed, cmdOut] = system(commandToRun);
    end
end
 

前述の例はシンプルな bash スクリプト independentJobWrapper.sh をスケジューラに送信します。independentJobWrapper.sh スクリプトは次の環境変数を使用して MATLAB 実行可能ファイルと引数を埋め込みます。

#!/bin/sh
# PARALLEL_SERVER_MATLAB_EXE - the MATLAB executable to use
# PARALLEL_SERVER_MATLAB_ARGS - the MATLAB args to use
exec "${PARALLEL_SERVER_MATLAB_EXE}" ${PARALLEL_SERVER_MATLAB_ARGS}

communicatingSubmitFcn

通信ジョブを汎用クラスターに投入すると、関数 communicatingSubmitFcn.m が MATLAB クライアント セッションで実行されます。

この関数の宣言行は次のとおりでなければなりません。

function communicatingSubmitFcn(cluster,job,environmentProperties)

この関数の目的はスケジューラに単一のジョブを投入することです。このジョブは次を満たさなければなりません。

ワーカー環境の構成.  この表に、通信ジョブのタスクを実行するためにワーカーの MATLAB に設定しなければならない 4 つの環境変数と値を示します。

多くのスケジューラは投入コマンドの一部としてクライアント環境をコピーすることをサポートしています。サポートしている場合、クライアントに以前の環境変数を設定できるため、スケジューラは設定をワーカー環境にコピーできます。サポートしていない場合は、これらの変数を転送するように投入コマンドを変更しなければなりません。

スケジューラ ジョブを投入して MPI プロセスを起動.  ジョブの 4 つの必須パラメーターを定義した後、mpiexec を使用して N 個のワーカー MATLAB プロセスを起動し、ジョブを実行します。mpiexec は Parallel Computing Toolbox™ に付属のソフトウェアで、ワーカーの MATLAB プロセス間の通信を可能にするメッセージ パッシング インターフェイス (MPI) 規格を実装しています。mpiexec の詳細については、MPICH のホーム ページを参照してください。

ジョブを実行するには、ジョブをスケジューラに投入しなければなりません。スケジューラは次の手順を実行します。matlabroot はワーカー ノード上の MATLAB インストールの場所を指す点に注意してください。

SLURM スケジューラ用サンプル スクリプト.  次のスクリプトは、共有ファイル システムをもつ SLURM スケジューラ用の基本的な投入関数を示します。

投入されるジョブは bash スクリプト communicatingJobWrapper.sh に含まれています。このスクリプトは、スケジューラ ジョブを投入して MPI プロセスを起動の SLURM スケジューラに関連するステップを実装します。より詳細な例については、サンプルのプラグイン スクリプトを参照してください。

function communicatingSubmitFcn(cluster,job,environmentProperties)
    % Specify the four required environment variables.
    setenv('PARALLEL_SERVER_DECODE_FUNCTION', 'parallel.cluster.generic.communicatingDecodeFcn');
    setenv('PARALLEL_SERVER_STORAGE_CONSTRUCTOR', environmentProperties.StorageConstructor);
    setenv('PARALLEL_SERVER_STORAGE_LOCATION', environmentProperties.StorageLocation);
    setenv('PARALLEL_SERVER_JOB_LOCATION', environmentProperties.JobLocation);
    
    % Specify the MATLAB executable and arguments to run on the worker.
    % Specify the location of the MATLAB install on the cluster nodes.
    % These are used in the communicatingJobWrapper.sh script.
    setenv('PARALLEL_SERVER_MATLAB_EXE', environmentProperties.MatlabExecutable);
    setenv('PARALLEL_SERVER_MATLAB_ARGS', environmentProperties.MatlabArguments);
    setenv('PARALLEL_SERVER_CMR', cluster.ClusterMatlabRoot);
    
    numberOfTasks = environmentProperties.NumberOfTasks;
    
    % Specify the command to submit a job to the SLURM scheduler which
    % requests as many processes as tasks in the job.
    % SLURM will automatically copy environment variables to workers.
    commandToRun = sprintf('sbatch --ntasks=%d communicatingJobWrapper.sh', numberOfTasks);
    [cmdFailed, cmdOut] = system(commandToRun);
end

getJobStateFcn

汎用クラスターで作成されたジョブの状態をクエリすると、関数 getJobStateFcn.m が MATLAB クライアント セッションで実行されます。この関数の宣言行は次のとおりでなければなりません。

function state = getJobStateFcn(cluster,job,state)

サードパーティ製スケジューラを使用している場合、スケジューラは、ローカル ジョブ ストレージからツールボックスが使用できる情報よりも新しいジョブ関連情報をもつ可能性があります。この状況は特に、非共有のファイル システムを使用している場合 (リモート ファイル システムがローカル データの場所への大規模データ ファイルの伝播が遅い可能性がある場合) に当てはまります。

スケジューラから情報を取得するには、クラスターの [PluginScriptsLocation] に関数 getJobStateFcn.m を追加します。

この関数に渡される状態は、ローカル ジョブ ストレージから派生した状態です。これにより、この関数の本体がスケジューラをクエリしてジョブのより正確な状態を判定し、保存された状態の代わりに返すことができます。この目的で作成された関数は、ジョブ オブジェクトの状態の有効な値を返さなければなりません。使用できる値は ‘pending’、‘queued’、‘running’、‘finished’、または ‘failed’ です。

MATLAB タスクを対応するスケジューラ ジョブ ID とペアにする手順については、汎用スケジューラによるジョブの管理を参照してください。

cancelJobFcn

汎用クラスターで作成されたジョブをキャンセルすると、MATLAB クライアント セッションで関数 cancelJobFcn.m が実行されます。この関数の宣言行は次のとおりでなければなりません。

function OK = cancelJobFcn(cluster,job)

汎用スケジューラ インターフェイスを使用して作成されたジョブをキャンセルすると、既定でこのアクションはストレージ内のジョブ データにのみ影響します。スケジューラ上の対応するジョブをキャンセルするには、いつ何を実行するかに関する命令をスケジューラに指示しなければなりません。このためには、クラスターの [PluginScriptsLocation] に関数 cancelJobFcn.m を追加します。

これにより、この関数の本体がスケジューラにコマンド (キューから対応するジョブを削除する、など) を送信できます。この関数は、スケジューラのジョブのキャンセルの成功または失敗を示す logical スカラーを返さなければなりません。

MATLAB タスクを対応するスケジューラ ジョブ ID とペアにする手順については、汎用スケジューラによるジョブの管理を参照してください。

cancelTaskFcn

汎用クラスターで作成されたタスクをキャンセルすると、関数 cancelTaskFcn.m が MATLAB クライアント セッションで実行されます。この関数の宣言行は次のとおりでなければなりません。

function OK = cancelTaskFcn(cluster,task)

汎用スケジューラ インターフェイスを使用して作成されたタスクをキャンセルすると、既定でストレージ内のタスク データのみが影響を受けます。スケジューラ上の対応するジョブをキャンセルするには、いつ何を実行するかに関する命令をスケジューラに指示しなければなりません。このためには、クラスターの [PluginScriptsLocation] に関数 cancelTaskFcn.m を追加します。

これにより、この関数の本体がスケジューラにコマンド (スケジューラのキューから対応するジョブを削除する、など) を送信できます。この関数は、スケジューラのジョブのキャンセルの成功または失敗を示す logical スカラーを返さなければなりません。

MATLAB タスクを対応するスケジューラ ジョブ ID とペアにする手順については、汎用スケジューラによるジョブの管理を参照してください。

deleteJobFcn

汎用クラスターを使用して作成されたジョブを削除すると、deleteJobFcn.m 関数が MATLAB クライアント セッションで実行されます。この関数の宣言行は次のとおりでなければなりません。

function deleteTaskFcn(cluster,task)

汎用スケジューラ インターフェイスを使用して作成されたジョブを削除すると、既定でストレージ内のジョブ データのみが影響を受けます。スケジューラ上の対応するジョブを削除するには、いつ何を実行するかに関する命令をスケジューラに指示しなければなりません。このためには、クラスターの [PluginScriptsLocation] に関数 deleteJobFcn.m を追加します。

これにより、この関数の本体がスケジューラにコマンド (キューから対応するジョブを削除する、など) を送信できます。

MATLAB タスクを対応するスケジューラ ジョブ ID とペアにする手順については、汎用スケジューラによるジョブの管理を参照してください。

deleteTaskFcn

汎用クラスターを使用して作成されたタスクを削除すると、MATLAB クライアント セッションで関数 deleteTaskFcn.m が実行されます。この関数の宣言行は次のとおりでなければなりません。

function deleteTaskFcn(cluster,task)

汎用スケジューラ インターフェイスを使用して作成されたタスクを削除すると、既定でストレージ内のタスク データのみが影響をうけます。スケジューラ上の対応するジョブを削除するには、いつ何を実行するかに関する命令をスケジューラに指示しなければなりません。このためには、クラスターの [PluginScriptsLocation] に関数 deleteTaskFcn.m を追加します。

これにより、この関数の本体がスケジューラにコマンド (スケジューラのキューから対応するジョブを削除する、など) を送信できます。

MATLAB タスクを対応するスケジューラ ジョブ ID とペアにする手順については、汎用スケジューラによるジョブの管理を参照してください。

postConstructFcn

MATLAB にクラスターのインスタンスを作成した後、MATLAB クライアント セッションで関数 postConstructFcn.m が実行されます。たとえば、次のコード行はクラスターのインスタンスを作成し、‘myProfile’ クラスター プロファイルに関連付けられた関数 postConstructFcn を実行します。

c = parcluster('myProfile');

関数 postConstructFcn の宣言行は次のとおりでなければなりません。

function postConstructFcn(cluster)

クラスターの使用前にそのカスタム構成を実行する必要がある場合は、クラスターの PluginScriptsLocation に関数 postConstructFcn.m を追加します。この関数の本体には、必要な任意の追加ステップを含めることができます。

クラスター プロファイル マネージャーからの AdditionalProperties の設定

前述の例のスクリプトを変更して、汎用クラスター プロファイルに AdditionalProperties のエントリを追加し、使用するノードのリストを指定できます。これにより、プラグイン スクリプトに追加されたカスタマイズをドキュメント化する方法が、クラスター プロファイルを共有するすべてのユーザーに提供されます。

NodeList プロパティをクラスター プロファイルに追加するには次を行います。

MATLAB コマンド ラインからの AdditionalProperties の設定

ユーザー カスタマイゼーションの追加のスクリプトを変更して、ジョブの投入前にクラスター オブジェクトの適切なプロパティを設定することで、MATLAB コマンド ラインからノードのリストを編集できます。

c = parcluster;
c.AdditionalProperties.NodeList = 'gpuNodeName';
j = c.batch('myScript'); 

AdditionalProperties オブジェクトを表示して、現在定義されているすべてのプロパティとその値を確認します。

>> c.AdditionalProperties
ans = 
  AdditionalProperties with properties:
                 ClusterHost: 'myClusterHost'
                    NodeList: 'gpuNodeName'
    RemoteJobStorageLocation: '/tmp/jobs'

ジョブ スケジューラ データの保存

この例では、関数 independentSubmitFcn.m を変更して、SLURM スケジューラに送信された各コマンドの出力を解析する方法を説明します。正規表現を使用して各タスクのスケジューラ ジョブ ID を抽出し、setJobClusterData を使用して保存できます。

% Pattern to extract scheduler job ID from SLURM sbatch output
searchPattern = '.*Submitted batch job ([0-9]+).*';
 
jobIDs = cell(numberOfTasks, 1);
for ii = 1:numberOfTasks
    setenv('PARALLEL_SERVER_TASK_LOCATION', environmentProperties.TaskLocations{ii});
    commandToRun = 'sbatch --ntasks=1 independentJobWrapper.sh';
    [cmdFailed, cmdOut] = system(commandToRun);
    jobIDs{ii} = regexp(cmdOut, searchPattern, 'tokens', 'once');
end
 
% set the job IDs on the job cluster data
cluster.setJobClusterData(job, struct('ClusterJobIDs', {jobIDs}));

ジョブ スケジューラ データの取得

この例では cancelJobFcn.m を変更して、SLURM スケジューラ上の対応するジョブをキャンセルします。この例では、getJobClusterData を使用してジョブ スケジューラ データを取得します。

function OK = cancelJobFcn(cluster, job)

% Get the scheduler information for this job
data = cluster.getJobClusterData(job);
jobIDs = data.ClusterJobIDs;

for ii = 1:length(jobIDs)
    % Tell the SLURM scheduler to cancel the job
    commandToRun = sprintf('scancel ''%s''', jobIDs{ii});
    [cmdFailed, cmdOut] = system(commandToRun);
end

OK = true;