ScriptRunConfig Класс
Представляет сведения о конфигурации для отправки обучающего запуска в Машинном обучении Azure.
СкриптRunConfig объединяет сведения о конфигурации, необходимые для отправки запуска в Машинном обучении Azure, включая скрипт, целевой объект вычислений, среду и любые конфигурации для распределенных заданий.
После настройки и отправки скрипта с помощью возвращаемого submitScriptRun значения возвращается.
Конструктор ScriptRunConfig класса.
Конструктор
ScriptRunConfig(source_directory, script=None, arguments=None, run_config=None, _telemetry_values=None, compute_target=None, environment=None, distributed_job_config=None, resume_from=None, max_run_duration_seconds=2592000, command=None, docker_runtime_config=None)Параметры
| Имя | Описание |
|---|---|
|
source_directory
Обязательно
|
Локальный каталог, содержащий файлы кода, необходимые для выполнения. |
|
script
Обязательно
|
Путь к файлу относительно source_directory выполняемого скрипта. |
|
arguments
Обязательно
|
Необязательные аргументы командной строки для передачи в скрипт обучения. Аргументы передаются в парах, например ['–arg1', arg1_val, '–arg2', arg2_val]. |
|
run_config
Обязательно
|
Необязательная конфигурация запуска для использования. |
|
_telemetry_values
Обязательно
|
Только для внутреннего применения. |
|
compute_target
Обязательно
|
Целевой объект вычислений, в котором будет выполняться обучение. Это может быть объект ComputeTarget, имя существующего ComputeTarget или строка "local". Если целевой объект вычислений не указан, будет использоваться локальный компьютер. |
|
environment
Обязательно
|
Среда, используемая для выполнения. Если среда не указана, azureml.core.runconfig.DEFAULT_CPU_IMAGE будет использоваться в качестве образа Docker для выполнения. |
|
distributed_job_config
Обязательно
|
Для заданий, требующих дополнительных конфигураций распределенных заданий. |
|
resume_from
Обязательно
|
DataPath, содержащий файлы контрольных точек или моделей, из которых необходимо возобновить эксперимент. |
|
max_run_duration_seconds
Обязательно
|
Максимально допустимое время выполнения. Система попытается автоматически отменить выполнение, если оно заняло больше времени, чем это значение. :type max_run_duration_seconds: int |
|
command
Обязательно
|
Команда, отправленная для выполнения. Свойство команды также можно использовать вместо скриптов и аргументов. Свойства команды и скрипта или аргумента нельзя использовать вместе для отправки выполнения. Чтобы отправить файл скрипта с помощью свойства команды ['python', 'train.py', '–arg1', arg1_val] Для выполнения фактической команды — ['ls'] |
|
docker_runtime_config
Обязательно
|
Для заданий, требующих конфигураций среды выполнения Docker. |
|
source_directory
Обязательно
|
Локальный каталог, содержащий файлы кода, необходимые для выполнения. |
|
script
Обязательно
|
Путь к файлу относительно source_directory выполняемого скрипта. |
|
arguments
Обязательно
|
Необязательные аргументы командной строки для передачи в скрипт обучения. Аргументы передаются в парах, например ['–arg1', arg1_val, '–arg2', arg2_val]. |
|
run_config
Обязательно
|
Необязательная конфигурация запуска для использования. |
|
_telemetry_values
Обязательно
|
Только для внутреннего применения. |
|
compute_target
Обязательно
|
Целевой объект вычислений, в котором будет выполняться обучение. Это может быть объект ComputeTarget, имя существующего ComputeTarget или строка "local". Если целевой объект вычислений не указан, будет использоваться локальный компьютер. |
|
environment
Обязательно
|
Среда, используемая для выполнения. Если среда не указана, azureml.core.runconfig.DEFAULT_CPU_IMAGE будет использоваться в качестве образа Docker для выполнения. |
|
distributed_job_config
Обязательно
|
Для заданий, требующих дополнительных конфигураций распределенных заданий. |
|
resume_from
Обязательно
|
DataPath, содержащий файлы контрольных точек или моделей, из которых необходимо возобновить эксперимент. |
|
max_run_duration_seconds
Обязательно
|
Максимально допустимое время выполнения. Система попытается автоматически отменить выполнение, если оно заняло больше времени, чем это значение. |
|
command
Обязательно
|
Команда, отправленная для выполнения. Свойство команды также можно использовать вместо скриптов и аргументов. Свойства команды и скрипта или аргумента нельзя использовать вместе для отправки выполнения. Чтобы отправить файл скрипта с помощью свойства команды ['python', 'train.py', '–arg1', arg1_val] Для выполнения фактической команды — ['ls'] |
|
docker_runtime_config
Обязательно
|
Для заданий, требующих конфигураций среды выполнения Docker. |
Комментарии
Пакет SDK машинного обучения Azure предоставляет ряд взаимосвязанных классов, которые помогают обучать и сравнивать модели машинного обучения, связанные с общей проблемой, которую они решают.
Он Experiment выступает в качестве логического контейнера для этих запусков обучения. Объект ScriptRunConfig используется для настройки сведений, необходимых для отправки обучающего запуска в рамках эксперимента. При отправке выполнения с помощью объекта ScriptRunConfig метод отправки возвращает объект типа ScriptRun. Затем возвращенный объект ScriptRun предоставляет программный доступ к сведениям о выполнении обучения. ScriptRun — это дочерний класс Run.
Важно помнить, что для отправки эксперимента используются различные объекты конфигурации, основанные на том, какой запуск требуется активировать. Затем тип объекта конфигурации сообщает, какой дочерний класс Run вы вернетесь из метода отправки. При передаче объекта ScriptRunConfig в вызове метода отправки Experiment возвращается объект ScriptRun. Примеры других возвращаемых объектов запуска включают AutoMLRun (возвращенные для запуска AutoML) и PipelineRun (возвращенные для выполнения конвейера).
В следующем примере показано, как отправить обучающий скрипт на локальном компьютере.
from azureml.core import ScriptRunConfig, Experiment
# create or load an experiment
experiment = Experiment(workspace, 'MyExperiment')
# create or retrieve a compute target
cluster = workspace.compute_targets['MyCluster']
# create or retrieve an environment
env = Environment.get(ws, name='MyEnvironment')
# configure and submit your training run
config = ScriptRunConfig(source_directory='.',
script='train.py',
arguments=['--arg1', arg1_val, '--arg2', arg2_val],
compute_target=cluster,
environment=env)
script_run = experiment.submit(config)
В следующем примере показано, как отправить обучающий скрипт в кластере с помощью свойства команды вместо скриптов и аргументов.
from azureml.core import ScriptRunConfig, Experiment
# create or load an experiment
experiment = Experiment(workspace, 'MyExperiment')
# create or retrieve a compute target
cluster = workspace.compute_targets['MyCluster']
# create or retrieve an environment
env = Environment.get(ws, name='MyEnvironment')
# configure and submit your training run
config = ScriptRunConfig(source_directory='.',
command=['python', 'train.py', '--arg1', arg1_val],
compute_target=cluster,
environment=env)
script_run = experiment.submit(config)
В следующем примере показано, как выполнить команду в кластере.
from azureml.core import ScriptRunConfig, Experiment
# create or load an experiment
experiment = Experiment(workspace, 'MyExperiment')
# create or retrieve a compute target
cluster = workspace.compute_targets['MyCluster']
# create or retrieve an environment
env = Environment.get(ws, name='MyEnvironment')
# configure and submit your training run
config = ScriptRunConfig(source_directory='.',
command=['ls', '-l'],
compute_target=cluster,
environment=env)
script_run = experiment.submit(config)
Дополнительные примеры работы с ScriptRunConfig см. в следующих примерах:
Атрибуты
MAX_DURATION_SECONDS_DEFAULT
MAX_DURATION_SECONDS_DEFAULT = 2592000