Partilhar via


ScriptRunConfig Classe

Representa informações de configuração para submeter uma execução de preparação no Azure Machine Learning.

Um ScriptRunConfig reúne as informações de configuração necessárias para submeter uma execução no Azure ML, incluindo o script, o destino de computação, o ambiente e quaisquer configurações específicas da tarefa distribuída.

Assim que uma execução de script for configurada e submetida com o submit, é devolvido um ScriptRun .

Construtor De Classes ScriptRunConfig.

Herança
azureml._logging.chained_identity.ChainedIdentity
ScriptRunConfig

Construtor

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)

Parâmetros

Name Description
source_directory
Necessário
str

Um diretório local com ficheiros de código necessários para uma execução.

script
Necessário
str

O caminho do ficheiro relativo à source_directory do script a ser executado.

arguments
Necessário
list ou str

Argumentos opcionais da linha de comandos para passar para o script de preparação. Os argumentos são transmitidos em pares, por exemplo, ['–arg1', arg1_val, '–arg2', arg2_val].

run_config
Necessário

Configuração de execução opcional a utilizar.

_telemetry_values
Necessário

Apenas utilização interna.

compute_target
Necessário

O destino de computação onde a preparação vai acontecer. Pode ser um objeto ComputeTarget, o nome de um ComputeTarget existente ou a cadeia "local". Se não for especificado nenhum destino de computação, será utilizado o computador local.

environment
Necessário

O ambiente a utilizar para a execução. Se não for especificado nenhum ambiente, azureml.core.runconfig.DEFAULT_CPU_IMAGE serão utilizadas como a imagem do Docker para a execução.

distributed_job_config
Necessário

Para tarefas que requerem configurações específicas de tarefas distribuídas adicionais.

resume_from
Necessário

O DataPath que contém o ponto de verificação ou os ficheiros de modelo a partir dos quais pretende retomar a experimentação.

max_run_duration_seconds
Necessário

O tempo máximo permitido para a execução. O sistema tentará cancelar automaticamente a execução se demorar mais tempo do que este valor. :type max_run_duration_seconds: int

command
Necessário
list[str] ou str

O comando a submeter para a execução. A propriedade de comando também pode ser utilizada em vez de script/argumentos. As propriedades de comando e script/argumento não podem ser utilizadas em conjunto para submeter uma execução. Para submeter um ficheiro de script com a propriedade de comando - ['python', 'train.py', '–arg1', arg1_val] Para executar um comando real - ['ls']

docker_runtime_config
Necessário

Para tarefas que requerem configurações específicas do runtime do Docker.

source_directory
Necessário
str

Um diretório local com ficheiros de código necessários para uma execução.

script
Necessário
str

O caminho do ficheiro relativo à source_directory do script a ser executado.

arguments
Necessário

Argumentos opcionais da linha de comandos para passar para o script de preparação. Os argumentos são transmitidos em pares, por exemplo, ['–arg1', arg1_val, '–arg2', arg2_val].

run_config
Necessário

Configuração de execução opcional a utilizar.

_telemetry_values
Necessário

Apenas utilização interna.

compute_target
Necessário

O destino de computação onde a preparação vai acontecer. Pode ser um objeto ComputeTarget, o nome de um ComputeTarget existente ou a cadeia "local". Se não for especificado nenhum destino de computação, será utilizado o computador local.

environment
Necessário

O ambiente a utilizar para a execução. Se não for especificado nenhum ambiente, azureml.core.runconfig.DEFAULT_CPU_IMAGE serão utilizadas como a imagem do Docker para a execução.

distributed_job_config
Necessário

Para tarefas que requerem configurações específicas de tarefas distribuídas adicionais.

resume_from
Necessário

O DataPath que contém o ponto de verificação ou os ficheiros de modelo a partir dos quais pretende retomar a experimentação.

max_run_duration_seconds
Necessário
int

O tempo máximo permitido para a execução. O sistema tentará cancelar automaticamente a execução se demorar mais tempo do que este valor.

command
Necessário
list[str] ou str

O comando a submeter para a execução. A propriedade de comando também pode ser utilizada em vez de script/argumentos. As propriedades de comando e script/argumento não podem ser utilizadas em conjunto para submeter uma execução. Para submeter um ficheiro de script com a propriedade de comando - ['python', 'train.py', '–arg1', arg1_val] Para executar um comando real - ['ls']

docker_runtime_config
Necessário

Para tarefas que requerem configurações específicas do runtime do Docker.

Observações

O SDK do Azure Machine Learning fornece-lhe uma série de classes interligadas, concebidas para o ajudar a preparar e comparar modelos de machine learning relacionados com o problema partilhado que estão a resolver.

Um Experiment atua como um contentor lógico para estas execuções de preparação. Um objeto ScriptRunConfig é utilizado para configurar as informações necessárias para submeter uma execução de preparação como parte de uma Experimentação. Quando uma execução é submetida com um objeto ScriptRunConfig, o método de submissão devolve um objeto do tipo ScriptRun. Em seguida, o objeto ScriptRun devolvido dá-lhe acesso programático a informações sobre a execução de preparação. ScriptRun é uma classe subordinada de Run.

O principal conceito a ter em conta é que existem objetos de configuração diferentes que são utilizados para submeter uma experimentação, com base no tipo de execução que pretende acionar. Em seguida, o tipo do objeto de configuração informa que classe subordinada de Executar obtém do método de submissão. Quando transmite um objeto ScriptRunConfig numa chamada para o método de submissão da Experimentação, obtém um objeto ScriptRun. Os exemplos de outros objetos de execução devolvidos incluem AutoMLRun (devolvidos para uma execução de AutoML) e PipelineRun (devolvidos para uma execução de Pipeline).

O exemplo seguinte mostra como submeter um script de preparação no seu computador local.


   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)

O exemplo seguinte mostra como submeter um script de preparação no cluster com a propriedade de comando em vez de script e argumentos.


   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)

O exemplo seguinte mostra como executar um comando no cluster.


   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)

Para obter mais exemplos que mostram como trabalhar com ScriptRunConfig, consulte:

Atributos

MAX_DURATION_SECONDS_DEFAULT

MAX_DURATION_SECONDS_DEFAULT = 2592000