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

Обертка Скриптов

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

independentSubmitFcn

Когда вы отправляете независимое задание в типовой кластер, independentSubmitFcn.m функция выполняется в сеансе клиента MATLAB.

Объявление линии этой функции должно быть следующим:

function independentSubmitFcn(cluster,job,environmentProperties)

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

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

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

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

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

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, в планировщик. The 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, чтобы запустить задачу коммуникационного задания:

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

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

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

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

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

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 к PluginScriptsLocation вашего кластера.

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

Инструкции по соединению задач MATLAB с соответствующим идентификатором задания планировщика см. в разделе Управление заданиями с Типовым Планировщиком.

cancelJobFcn

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

function OK = cancelJobFcn(cluster,job)

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

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

Инструкции по соединению задач MATLAB с соответствующим идентификатором задания планировщика см. в разделе Управление заданиями с Типовым Планировщиком.

cancelTaskFcn

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

function OK = cancelTaskFcn(cluster,task)

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

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

Инструкции по соединению задач MATLAB с соответствующим идентификатором задания планировщика см. в разделе Управление заданиями с Типовым Планировщиком.

deleteJobFcn

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

function deleteTaskFcn(cluster,task)

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

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

Инструкции по соединению задач MATLAB с соответствующим идентификатором задания планировщика см. в разделе Управление заданиями с Типовым Планировщиком.

deleteTaskFcn

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

function deleteTaskFcn(cluster,task)

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

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

Инструкции по соединению задач MATLAB с соответствующим идентификатором задания планировщика см. в разделе Управление заданиями с Типовым Планировщиком.

postConstructFcn

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

c = parcluster('myProfile');

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

function postConstructFcn(cluster)

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

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

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

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