ScriptRunConfig Класс

Представляет сведения о конфигурации для отправки обучающего выполнения в Машинном обучении Azure.

ScriptRunConfig добавляет в пакет сведения о конфигурации, необходимые для отправки запуска в Azure ML, включая скрипт, целевой объект вычислений, среду и все конфигурации, относящиеся к распределенному заданию.

После настройки и отправки запуска скрипта с помощью метода submit возвращается ScriptRun.

Конструктор Class ScriptRunConfig.

Наследование

azureml._logging.chained_identity.ChainedIdentity

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 Обязательно	str Локальный каталог, содержащий файлы кода, необходимые для выполнения.
script Обязательно	str Путь к файлу, касающийся каталога source_directory для запускаемого сценария.
arguments Обязательно	list или str Необязательные аргументы командной строки, которые передаются в сценарий обучения. Аргументы передаются парами, например ['–arg1', arg1_val, '–arg2', arg2_val].
run_config Обязательно	RunConfiguration Дополнительная конфигурация запуска.
_telemetry_values Обязательно	dict Только для внутреннего применения.
compute_target Обязательно	AbstractComputeTarget или str Целевой объект вычислений, в котором будет выполняться обучение. Это может быть объект ComputeTarget, имя существующего объекта ComputeTarget или строка local. Если целевой объект вычислений не указан, будет использоваться локальный компьютер.
environment Обязательно	Environment Среда, используемая для выполнения. Если среда не указана, azureml.core.runconfig.DEFAULT_CPU_IMAGE будет использоваться как образ Docker для выполнения.
distributed_job_config Обязательно	TensorflowConfiguration, MpiConfiguration или PyTorchConfiguration Для заданий, которым требуются дополнительные конфигурации, относящиеся к распределенному заданию.
resume_from Обязательно	DataPath Класс DataPath, содержащий файлы контрольной точки или модели, из которых возобновляется выполнение эксперимента.
max_run_duration_seconds Обязательно	Максимальное время, допустимое для выполнения. Система будет пытаться автоматически отменить выполнение, если оно длится дольше, чем указано в этом значении. :type max_run_duration_seconds: int
command Обязательно	list[str] или str Команда, которая будет отправлена для выполнения. Свойство Command можно также использовать вместо свойства Script/Argument. Для отправки выполнения не допускается одновременное использование свойств Command и Script/Argument. Для отправки файла сценария с помощью свойства Command — ['python', 'train.py', '–arg1', arg1_val]; для выполнения фактической команды — ['ls']
docker_runtime_config Обязательно	DockerConfiguration Для заданий, требующих конфигураций, относящихся к среде выполнения Docker.
source_directory Обязательно	str Локальный каталог, содержащий файлы кода, необходимые для выполнения.
script Обязательно	str Путь к файлу, касающийся каталога source_directory для запускаемого сценария.
arguments Обязательно	list[str] Необязательные аргументы командной строки, которые передаются в сценарий обучения. Аргументы передаются парами, например ['–arg1', arg1_val, '–arg2', arg2_val].
run_config Обязательно	RunConfiguration Дополнительная конфигурация запуска.
_telemetry_values Обязательно	dict Только для внутреннего применения.
compute_target Обязательно	AbstractComputeTarget или str Целевой объект вычислений, в котором будет выполняться обучение. Это может быть объект ComputeTarget, имя существующего объекта ComputeTarget или строка local. Если целевой объект вычислений не указан, будет использоваться локальный компьютер.
environment Обязательно	Environment Среда, используемая для выполнения. Если среда не указана, azureml.core.runconfig.DEFAULT_CPU_IMAGE будет использоваться как образ Docker для выполнения.
distributed_job_config Обязательно	TensorflowConfiguration или MpiConfiguration или PyTorchConfiguration Для заданий, которым требуются дополнительные конфигурации, относящиеся к распределенному заданию.
resume_from Обязательно	DataPath Класс DataPath, содержащий файлы контрольной точки или модели, из которых возобновляется выполнение эксперимента.
max_run_duration_seconds Обязательно	int Максимальное время, допустимое для выполнения. Система будет пытаться автоматически отменить выполнение, если оно длится дольше, чем указано в этом значении.
command Обязательно	list[str] или str Команда, которая будет отправлена для выполнения. Свойство Command можно также использовать вместо свойства Script/Argument. Для отправки выполнения не допускается одновременное использование свойств Command и Script/Argument. Для отправки файла сценария с помощью свойства Command — ['python', 'train.py', '–arg1', arg1_val]; для выполнения фактической команды — ['ls']
docker_runtime_config Обязательно	DockerConfiguration Для заданий, требующих конфигураций, относящихся к среде выполнения Docker.

Комментарии

Пакет SDK Машинного обучения Azure предоставляет ряд взаимосвязанных классов, которые предназначены для обучения и сравнения моделей машинного обучения, которые решают общую проблему.

Experiment выступает в роли логического контейнера для этих учебных запусков. Объект ScriptRunConfig используется для настройки сведений, необходимых для отправки обучающего выполнения в рамках эксперимента. Если выполнение отправляется с помощью объекта ScriptRunConfig, метод отправки возвращает объект типа ScriptRun. Возвращаемый объект ScriptRun предоставляет программный доступ к сведениям о ходе обучающего выполнения. ScriptRun — это дочерний класс класса Run.

Следует помнить, что есть различные объекты конфигурации, которые используются для отправки эксперимента. Они отличаются по типу выполнения, который необходимо активировать. Тип объекта конфигурации затем сообщает, какой дочерний класс выполнения вы получите от метода отправки. Если в вызове метода отправки эксперимента передается объект ScriptRunConfig, вы получаете объект 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)

В следующем примере показано, как отправить обучающий сценарий в кластер с помощью свойства Command вместо свойств Script и arguments.

   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