ScriptRunConfig Třída

Představuje konfigurační informace pro odeslání trénovacího spuštění ve službě Azure Machine Learning.

A ScriptRunConfig packages together the configuration information needed to submit a run in Azure ML, including the script, compute target, environment, and any distributed job-specific configs.

Jakmile se skript nakonfiguruje a odešle pomocí příkazu submit, ScriptRun vrátí se hodnota.

Třída ScriptRunConfig konstruktor.

Konstruktor

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)

Parametry

Name	Description
source_directory Vyžadováno	str Místní adresář obsahující soubory kódu potřebné ke spuštění.
script Vyžadováno	str Cesta k souboru vzhledem ke source_directory skriptu, který se má spustit.
arguments Vyžadováno	list nebo str Volitelné argumenty příkazového řádku, které se předávají trénovacímu skriptu. Argumenty se předávají ve dvojicích, například ['-arg1', arg1_val, '-arg2', arg2_val].
run_config Vyžadováno	RunConfiguration Volitelná konfigurace spuštění, která se má použít.
_telemetry_values Vyžadováno	dict Pouze interní použití.
compute_target Vyžadováno	AbstractComputeTarget nebo str Cílový výpočetní objekt, ve kterém bude trénování probíhat. Může se jednat o objekt ComputeTarget, název existujícího ComputeTargetu nebo řetězec "local". Pokud není zadaný žádný cílový výpočetní objekt, použije se místní počítač.
environment Vyžadováno	Environment Prostředí, které se má použít pro spuštění. Pokud není zadané žádné prostředí, azureml.core.runconfig.DEFAULT_CPU_IMAGE se použije jako image Dockeru pro spuštění.
distributed_job_config Vyžadováno	TensorflowConfiguration, MpiConfiguration nebo PyTorchConfiguration Pro úlohy, které vyžadují další konfigurace specifické pro distribuovanou úlohu.
resume_from Vyžadováno	DataPath DataPath obsahující soubory kontrolního bodu nebo modelu, ze kterých chcete experiment obnovit.
max_run_duration_seconds Vyžadováno	Maximální povolená doba spuštění. Systém se pokusí spuštění automaticky zrušit, pokud trvalo déle, než je tato hodnota. :type max_run_duration_seconds: int
command Vyžadováno	list[str] nebo str Příkaz, který se má odeslat pro spuštění. Vlastnost příkazu lze použít také místo skriptu nebo argumentů. Ke společnému odeslání spuštění nelze použít vlastnosti příkazu i skriptu nebo argumentu. Odeslání souboru skriptu pomocí vlastnosti příkazu – ['python', 'train.py', '-arg1', arg1_val] Spuštění skutečného příkazu – ['ls']
docker_runtime_config Vyžadováno	DockerConfiguration Pro úlohy, které vyžadují konfigurace specifické pro modul runtime Dockeru.
source_directory Vyžadováno	str Místní adresář obsahující soubory kódu potřebné ke spuštění.
script Vyžadováno	str Cesta k souboru vzhledem ke source_directory skriptu, který se má spustit.
arguments Vyžadováno	list[str] Volitelné argumenty příkazového řádku, které se předávají trénovacímu skriptu. Argumenty se předávají ve dvojicích, například ['-arg1', arg1_val, '-arg2', arg2_val].
run_config Vyžadováno	RunConfiguration Volitelná konfigurace spuštění, která se má použít.
_telemetry_values Vyžadováno	dict Pouze interní použití.
compute_target Vyžadováno	AbstractComputeTarget nebo str Cílový výpočetní objekt, ve kterém bude trénování probíhat. Může se jednat o objekt ComputeTarget, název existujícího ComputeTargetu nebo řetězec "local". Pokud není zadaný žádný cílový výpočetní objekt, použije se místní počítač.
environment Vyžadováno	Environment Prostředí, které se má použít pro spuštění. Pokud není zadané žádné prostředí, azureml.core.runconfig.DEFAULT_CPU_IMAGE se použije jako image Dockeru pro spuštění.
distributed_job_config Vyžadováno	TensorflowConfiguration nebo MpiConfiguration nebo PyTorchConfiguration Pro úlohy, které vyžadují další konfigurace specifické pro distribuovanou úlohu.
resume_from Vyžadováno	DataPath DataPath obsahující soubory kontrolního bodu nebo modelu, ze kterých chcete experiment obnovit.
max_run_duration_seconds Vyžadováno	int Maximální povolená doba spuštění. Systém se pokusí spuštění automaticky zrušit, pokud trvalo déle, než je tato hodnota.
command Vyžadováno	list[str] nebo str Příkaz, který se má odeslat pro spuštění. Vlastnost příkazu lze použít také místo skriptu nebo argumentů. Ke společnému odeslání spuštění nelze použít vlastnosti příkazu i skriptu nebo argumentu. Odeslání souboru skriptu pomocí vlastnosti příkazu – ['python', 'train.py', '-arg1', arg1_val] Spuštění skutečného příkazu – ['ls']
docker_runtime_config Vyžadováno	DockerConfiguration Pro úlohy, které vyžadují konfigurace specifické pro modul runtime Dockeru.

Poznámky

Sada Azure Machine Learning SDK poskytuje řadu vzájemně propojených tříd, které jsou navržené tak, aby vám pomohly trénovat a porovnávat modely strojového učení, které souvisejí se sdíleným problémem, který řeší.

Funguje Experiment jako logický kontejner pro tato trénovací spuštění. Objekt ScriptRunConfig slouží ke konfiguraci informací potřebných k odeslání trénovacího spuštění jako součásti experimentu. Při spuštění je odeslán pomocí ScriptRunConfig objektu, metoda submit vrátí objekt typu ScriptRun. Vrácený objekt ScriptRun vám poskytne programový přístup k informacím o trénovacím spuštění. ScriptRun je podřízená třída Runtřídy .

Klíčovým konceptem je, že existují různé objekty konfigurace, které se používají k odeslání experimentu podle toho, jaký druh spuštění chcete aktivovat. Typ objektu konfigurace pak informuje, jakou podřízenou třídu Run získáte zpět z metody submit. Když předáte ScriptRunConfig objekt ve volání metody experimentu odeslání, získáte zpět ScriptRun objektu. Mezi příklady vrácených objektů spuštění patří AutoMLRun (vráceny pro spuštění AutoML) a PipelineRun (vráceny pro spuštění kanálu).

Následující ukázka ukazuje, jak odeslat trénovací skript na místním počítači.

   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)

Následující příklad ukazuje, jak odeslat trénovací skript do clusteru pomocí vlastnosti příkazu místo skriptu a argumentů.

   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)

Následující ukázka ukazuje, jak spustit příkaz v clusteru.

   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)

Další příklady ukazující, jak pracovat s ScriptRunConfig, najdete tady:

• článek Výběr a použití cílového výpočetního objektu k trénování modelu

• tyto školicí poznámkové bloky

Atributy

MAX_DURATION_SECONDS_DEFAULT

MAX_DURATION_SECONDS_DEFAULT = 2592000