Документация

Сценарии обертки

Примеры сценариев плагинов используют сценарии обертки для упрощения реализации independentSubmitFcn.m и communicatingSubmitFcn.m. Эти сценарии не требуются, однако их использование является хорошей практикой, чтобы сделать код более читаемым. В этой таблице описаны следующие сценарии:

independentSubmitFcn

При отправке независимого задания в общий кластер independentSubmitFcn.m выполняется в клиентском сеансе MATLAB.

Строка объявления этой функции должна быть:

function independentSubmitFcn(cluster,job,environmentProperties)

Каждая задача в независимом задании MATLAB соответствует одному заданию в планировщике. Цель этой функции - отправить N задания стороннему планировщику, где N - количество задач в независимом задании. Каждое из этих заданий должно:

Настройте рабочую среду.  В этой таблице указаны пять переменных среды и значений, которые должны быть заданы для рабочего MATLAB для выполнения отдельной задачи:

Многие планировщики поддерживают копирование среды клиента как часть команды отправки. Если это так, можно задать предыдущие переменные среды в клиенте, чтобы планировщик мог скопировать их в рабочую среду. В противном случае для пересылки этих переменных необходимо изменить команду отправки.

Отправка заданий планировщика для запуска работников MATLAB.  После определения пяти обязательных параметров для данного задания и задачи на работнике задача запускается путем вызова исполняемого файла MATLAB с подходящими аргументами. Исполняемый файл MATLAB для вызова определен в environmentProperties.MatlabExecutable. Передаваемые аргументы определяются в environmentProperties.MatlabArguments.

Пример сценария для планировщика SLUM.  Этот сценарий показывает базовую функцию отправки для планировщика SLUM с общей файловой системой. Более полный пример см. в разделе Примеры сценариев подключаемых модулей.

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 для выполнения задачи связанного задания:

Многие планировщики поддерживают копирование среды клиента как часть команды отправки. Если это так, можно задать предыдущие переменные среды в клиенте, чтобы планировщик мог скопировать их в рабочую среду. В противном случае для пересылки этих переменных необходимо изменить команду отправки.

Отправить задание планировщика для запуска процесса MPI.  После определения четырех обязательных параметров для данного задания запустите задание. N рабочие процессы MATLAB с использованием mpiexec. mpiexec поставляется с Toolbox™ параллельных вычислений, который реализует стандарт интерфейса передачи сообщений (MPI) для обеспечения связи между рабочими процессами MATLAB. Для получения дополнительной информации о mpiexec, см. домашнюю страницу MPICH.

Чтобы запустить задание, необходимо отправить задание в планировщик, который выполняет следующие шаги. Обратите внимание, что matlabroot относится к расположению установки MATLAB на рабочих узлах.

Пример сценария для планировщика SLUM.  Следующий сценарий показывает базовую функцию отправки для планировщика SLUM с общей файловой системой.

Отправленное задание содержится в сценарии bash, communicatingJobWrapper.sh. Этот сценарий реализует соответствующие шаги в задании Submit scheduler для запуска процесса MPI для планировщика SLUM. Более полный пример см. в разделе Примеры сценариев подключаемых модулей.

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)

При использовании стороннего планировщика возможно, что планировщик может иметь больше актуальной информации о заданиях, чем та, которая доступна для панели инструментов из локального хранилища заданий. Эта ситуация особенно актуальна при использовании файловой системы без общего доступа, в которой удаленная файловая система может медленно распространять большие файлы данных обратно в локальное местоположение данных.

Чтобы получить эту информацию из планировщика, добавьте функцию с именем getJobStateFcn.m в расположение PluginTalkedLocation кластера.

Состояние, переданное в эту функцию, является состоянием, полученным из локального хранилища заданий. Тело этой функции затем может запросить планировщик, чтобы определить более точное состояние для задания и вернуть его вместо сохраненного состояния. Функция, записанная для этой цели, должна возвращать допустимое значение для состояния объекта задания. Допустимые значения: ‘pending’, ‘queued’, ‘running’, ‘finished’, или ‘failed’.

Инструкции по сопряжению задач MATLAB с соответствующим идентификатором задания планировщика см. в разделе Управление заданиями с помощью общего планировщика.

cancelJobFcn

При отмене задания, созданного с универсальным кластером, cancelJobFcn.m выполняется в клиентском сеансе MATLAB. Строка объявления этой функции должна быть:

function OK = cancelJobFcn(cluster,job)

При отмене задания, созданного с помощью общего интерфейса планировщика, это действие по умолчанию влияет только на данные задания в хранилище. Чтобы отменить соответствующие задания в планировщике, необходимо предоставить инструкции о том, что делать и когда делать с планировщиком. Для этого добавьте функцию с именем cancelJobFcn.m в расположение PluginTalkedLocation кластера.

Тело этой функции может затем послать команду планировщику, например, удалить соответствующие задания из очереди. Функция должна возвращать логический скаляр, указывающий на успех или неудачу отмены заданий в планировщике.

Инструкции по сопряжению задач MATLAB с соответствующим идентификатором задания планировщика см. в разделе Управление заданиями с помощью общего планировщика.

cancelTaskFcn

При отмене задачи, созданной с универсальным кластером, cancelTaskFcn.m выполняется в клиентском сеансе MATLAB. Строка объявления этой функции должна быть:

function OK = cancelTaskFcn(cluster,task)

При отмене задачи, созданной с помощью общего интерфейса планировщика, по умолчанию это влияет только на данные задачи в хранилище. Для отмены соответствующего задания в планировщике необходимо предоставить инструкции о том, что делать и когда делать с планировщиком. Для этого добавьте функцию с именем cancelTaskFcn.m в расположение PluginTalkedLocation кластера.

Тело этой функции может затем послать команду планировщику, например, удалить соответствующее задание из очереди планировщика. Функция должна возвращать логический скаляр, указывающий на успех или неудачу отмены задания в планировщике.

Инструкции по сопряжению задач MATLAB с соответствующим идентификатором задания планировщика см. в разделе Управление заданиями с помощью общего планировщика.

deleteJobFcn

При удалении задания, созданного с универсальным кластером, deleteJobFcn.m выполняется в клиентском сеансе MATLAB. Строка объявления этой функции должна быть:

function deleteTaskFcn(cluster,task)

При удалении задания, созданного с помощью общего интерфейса планировщика, по умолчанию это влияет только на данные задания в хранилище. Чтобы удалить соответствующие задания в планировщике, необходимо предоставить инструкции о том, что делать и когда делать с планировщиком. Для этого добавьте функцию с именем deleteJobFcn.m в расположение PluginTalkedLocation кластера.

Тело этой функции может затем послать команду планировщику, например, удалить соответствующие задания из очереди планировщика.

Инструкции по сопряжению задач MATLAB с соответствующим идентификатором задания планировщика см. в разделе Управление заданиями с помощью общего планировщика.

deleteTaskFcn

При удалении задачи, созданной с универсальным кластером, deleteTaskFcn.m выполняется в клиентском сеансе MATLAB. Строка объявления этой функции должна быть:

function deleteTaskFcn(cluster,task)

При удалении задачи, созданной с помощью общего интерфейса планировщика, по умолчанию это влияет только на данные задачи в хранилище. Чтобы удалить соответствующее задание в планировщике, необходимо предоставить инструкции о том, что делать и когда делать с планировщиком. Для этого добавьте функцию с именем deleteTaskFcn.m в расположение PluginTalkedLocation кластера.

Тело этой функции может затем послать команду планировщику, например, удалить соответствующее задание из очереди планировщика.

Инструкции по сопряжению задач MATLAB с соответствующим идентификатором задания планировщика см. в разделе Управление заданиями с помощью общего планировщика.

postConstructFcn

После создания экземпляра кластера в MATLAB, postConstructFcn.m выполняется в клиентском сеансе MATLAB. Например, следующая строка кода создает экземпляр кластера и запускает postConstructFcn функция, связанная с ‘myProfile’ профиль кластера:

c = parcluster('myProfile');

Строка объявления postConstructFcn функция должна быть:

function postConstructFcn(cluster)

Если необходимо выполнить пользовательскую настройку кластера перед его использованием, добавьте функцию с именем postConstructFcn.m в PluginScriptsLocation вашего кластера. Тело этой функции может содержать любые необходимые дополнительные шаги настройки.

Установка свойств AdditiveProperties из диспетчера профилей кластера

С помощью изменения сценариев в предыдущем примере можно добавить запись AdditiveProperties в общий профиль кластера, чтобы указать список узлов для использования. Это обеспечивает метод документирования настроек, добавленных в сценарии плагина для всех, с кем вы используете профиль кластера.

Для добавления NodeList свойство профиля кластера:

Установка свойств-адресов из командной строки MATLAB

Изменяя сценарии в разделе Добавление пользовательской настройки, можно изменить список узлов из командной строки 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 функция для синтаксического анализа выходных данных каждой команды, переданной планировщику SLUM. Можно использовать регулярные выражения, чтобы извлечь идентификатор задания планировщика для каждой задачи, а затем сохранить его с помощью 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 для отмены соответствующих заданий в планировщике SLUM. В примере используется 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;