汎用スケジューラのプラグインスクリプト

汎用スケジューラインターフェイスは MATLAB^® クライアント、MATLAB ワーカー、サードパーティ製スケジューラの相互作用を構成するための非常に高い柔軟性を提供します。プラグインスクリプトは、使用している設定と MATLAB との相互作用を定義します。

次の表は、サポートされているプラグインスクリプト関数とそれらが評価される段階を示します。

ファイル名	段階
`independentSubmitFcn.m`	個別のジョブの投入
`communicatingSubmitFcn.m`	通信ジョブの投入
`getJobStateFcn.m`	ジョブの状態のクエリ
`cancelJobFcn.m`	ジョブのキャンセル
`cancelTaskFcn.m`	タスクのキャンセル
`deleteJobFcn.m`	ジョブの削除
`deleteTaskFcn.m`	タスクの削除
`postConstructFcn.m`	`parallel.cluster.Generic` インスタンスの作成後

これらのプラグインスクリプトは、予期されるファイル名をもち、かつクラスターの [PluginScriptsLocation] プロパティで指定されたフォルダーにある場合にのみ評価されます。汎用クラスタープロファイルの設定方法の詳細については、汎用スケジューラインターフェイスを使用した構成 (MATLAB Parallel Server)を参照してください。

メモ

独立ジョブを投入するには independentSubmitFcn.m が存在していなければならず、通信ジョブを投入するには communicatingSubmitFcn.m が存在していなければなりません。

サンプルのプラグインスクリプト

汎用スケジューラインターフェイスの使用をサポートするため、次のサードパーティ製スケジューラ向けのプラグインスクリプトを GitHub^® リポジトリからダウンロードできます。

MATLAB クライアントがジョブをスケジューラに直接投入できない場合、MATLAB では、コマンドをリモートクラスターに送信するために ssh プロトコルの使用がサポートされます。

クライアントとクラスターノードに共有ファイルシステムがない場合、MATLAB では、コンピューターとクラスター間でジョブおよびタスクファイルをコピーするために sftp (SSH ファイル転送プロトコル) の使用がサポートされます。

プラグインスクリプトの動作をカスタマイズする場合は、AdditionalSubmitArgs などの追加のプロパティを設定できます。詳細については、サンプルプラグインスクリプトの動作のカスタマイズ (MATLAB Parallel Server)を参照してください。

リポジトリのいずれかでスケジューラまたはクラスター構成がサポートされていない場合、いずれかのパッケージのスクリプトを変更することを推奨します。汎用スケジューラ用の一連のプラグインスクリプトを記述する方法の詳細については、汎用スケジューラのプラグインスクリプトを参照してください。

ラッパースクリプト

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

ファイル名	説明
`independentJobWrapper.sh`	適切な引数を指定して MATLAB 実行可能ファイルの呼び出しを組み込むために `independentSubmitFcn.m` で使用されます。実行可能ファイルの場所とその引数に環境変数を使用します。使用例は、SLURM スケジューラ用サンプルスクリプトを参照してください。
`communicatingJobWrapper.sh`	クラスターに通信ジョブを分配するために `communicatingSubmitFcn.m` で使用されます。このスクリプトはスケジューラジョブを投入して MPI プロセスを起動の手順を実装します。使用例は、SLURM スケジューラ用サンプルスクリプトを参照してください。

カスタムプラグインスクリプトの記述

メモ

独自のプラグインスクリプトを記述する場合、お使いの設定に最も近いサンプルプラグインスクリプトを変更することから始めることをお勧めします (サンプルのプラグインスクリプトを参照)。

independentSubmitFcn

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

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

function independentSubmitFcn(cluster,job,environmentProperties)

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

実行する個別のタスクを識別するために MATLAB ワーカーに必須の 5 つの環境変数を設定する。詳細については、ワーカー環境の構成を参照してください。
MATLAB ワーカーを起動してタスクを実行するための適切な MATLAB 実行可能ファイルを呼び出す。詳細については、スケジューラジョブを投入して MATLAB ワーカーを実行を参照してください。

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

環境変数の名前	環境変数の値
`PARALLEL_SERVER_DECODE_FUNCTION`	`'parallel.cluster.generic.independentDecodeFcn'`
`PARALLEL_SERVER_STORAGE_CONSTRUCTOR`	`environmentProperties.StorageConstructor`
`PARALLEL_SERVER_STORAGE_LOCATION`	クライアントとクラスターノード間に共有ファイルシステムがある場合は `environmentProperties.StorageLocation` を使用します。クライアントとクラスターノード間に共有ファイルシステムがない場合は、すべてのクラスターノードからアクセスできるフォルダーを選択します。クライアントノードとクラスターノード間でジョブやタスクファイルをコピーする手順については、共有ファイルシステムなしでの送信を参照してください。
`PARALLEL_SERVER_JOB_LOCATION`	`environmentProperties.JobLocation`
`PARALLEL_SERVER_TASK_LOCATION`	`environmentProperties.TaskLocations{n}`、`nth` 番目のタスク

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

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

メモ

クライアントマシンからスケジューラに直接送信できない場合は、リモートホストからの送信の ssh を使用した送信方法の説明を参照してください。

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 を呼び出してジョブを N 個の MATLAB ワーカーに分散する。N は MATLAB ジョブの NumWorkersRange プロパティに指定されている最大値に対応します。詳細については、スケジューラジョブを投入して MPI プロセスを起動を参照してください。

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

環境変数の名前	環境変数の値
`PARALLEL_SERVER_DECODE_FUNCTION`	`'parallel.cluster.generic.communicatingDecodeFcn'`
`PARALLEL_SERVER_STORAGE_CONSTRUCTOR`	`environmentProperties.StorageConstructor`
`PARALLEL_SERVER_STORAGE_LOCATION`	クライアントとクラスターノード間に共有ファイルシステムがある場合は `environmentProperties.StorageLocation` を使用します。クライアントとクラスターノード間に共有ファイルシステムがない場合は、すべてのクラスターノードに存在するフォルダーを選択します。クライアントノードとクラスターノード間でジョブやタスクファイルをコピーする手順については、共有ファイルシステムなしでの送信を参照してください。
`PARALLEL_SERVER_JOB_LOCATION`	`environmentProperties.JobLocation`

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

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

スケジューラから N 個のプロセスを要求します。N は MATLAB ジョブの NumWorkersRange プロパティに指定された最大値に対応します。
mpiexec を呼び出し、ワーカーの MATLAB プロセスを起動します。各ホストで起動するワーカーの MATLAB プロセスの数は、スケジューラによって割り当てられたプロセス数と一致していなければなりません。mpiexec 実行可能ファイルは matlabroot/bin/mw_mpiexec にあります。
mpiexec コマンドは、起動したプロセスに環境変数を自動的に転送します。そのため、mpiexec を実行する前に、ワーカー環境の構成にリストされた環境変数が設定されていることを確認してください。
mpiexec のオプションの詳細については、Using the Hydra Process Manager を参照してください。

メモ

前述の手順の詳細な例については、サンプルのプラグインスクリプトのすべてのサンプルプラグインスクリプトと共に提供されている communicatingJobWrapper.sh スクリプトを参照してください。独自のスクリプトを記述する必要がある場合は、このスクリプトを開始点として使用してください。

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’ です。