ScriptRunConfig Třída

  • Reference

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

ScriptRunConfig sbalí dohromady konfigurační informace potřebné k odeslání spuštění v Azure ML, včetně skriptu, cílového výpočetního prostředí, prostředí a všech konfigurací specifických pro distribuované úlohy.

Jakmile je spuštění skriptu nakonfigurováno a odesláno pomocí submitpříkazu , vrátí se příkaz .ScriptRun

Třída ScriptRunConfig konstruktor.

Dědičnost
azureml._logging.chained_identity.ChainedIdentity
ScriptRunConfig

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

source_directory
str
Vyžadováno

Místní adresář obsahující soubory kódu potřebné pro spuštění.

script
str
Vyžadováno

Cesta k souboru vzhledem k source_directory skriptu, který se má spustit.

arguments
list nebo str
Vyžadováno

Volitelné argumenty příkazového řádku, které se mají předat do trénovacího skriptu. Argumenty se předávají ve dvojicích, například [-arg1', arg1_val, '-arg2', arg2_val].

run_config
RunConfiguration
Vyžadováno

Volitelná konfigurace spuštění, která se má použít.

_telemetry_values
dict
Vyžadováno

Pouze interní použití.

compute_target
AbstractComputeTarget nebo str
Vyžadováno

Cílový výpočetní objekt, ve kterém bude probíhat trénování. Může to být objekt ComputeTarget, název existujícího ComputeTarget nebo řetězec "local". Pokud není zadaný žádný cíl výpočetních prostředků, použije se váš místní počítač.

environment
Environment
Vyžadováno

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
TensorflowConfiguration, MpiConfiguration nebo PyTorchConfiguration
Vyžadováno

Pro úlohy, které vyžadují další konfigurace specifické pro distribuovanou úlohu.

resume_from
DataPath
Vyžadováno

Cesta data obsahující kontrolní bod nebo soubory modelu, ze kterých se má experiment pokračovat.

max_run_duration_seconds
Vyžadováno

Maximální čas povolený pro spuštění. Systém se pokusí automaticky zrušit spuštění, pokud trvalo déle než tato hodnota. :type max_run_duration_seconds: int

command
list[str] nebo str
Vyžadováno

Příkaz, který se má odeslat pro spuštění. Vlastnost command lze použít také místo skriptů nebo argumentů. Vlastnosti příkazu a skriptu/argumentu nelze použít společně k odeslání spuštění. 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
DockerConfiguration
Vyžadováno

Pro úlohy, které vyžadují konfigurace specifické pro modul runtime Dockeru.

source_directory
str
Vyžadováno

Místní adresář obsahující soubory kódu potřebné pro spuštění.

script
str
Vyžadováno

Cesta k souboru vzhledem k source_directory skriptu, který se má spustit.

arguments
list[str]
Vyžadováno

Volitelné argumenty příkazového řádku, které se mají předat do trénovacího skriptu. Argumenty se předávají ve dvojicích, například [-arg1', arg1_val, '-arg2', arg2_val].

run_config
RunConfiguration
Vyžadováno

Volitelná konfigurace spuštění, která se má použít.

_telemetry_values
dict
Vyžadováno

Pouze interní použití.

compute_target
AbstractComputeTarget nebo str
Vyžadováno

Cílový výpočetní objekt, ve kterém bude probíhat trénování. Může to být objekt ComputeTarget, název existujícího ComputeTarget nebo řetězec "local". Pokud není zadaný žádný cíl výpočetních prostředků, použije se váš místní počítač.

environment
Environment
Vyžadováno

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
TensorflowConfiguration nebo MpiConfiguration nebo PyTorchConfiguration
Vyžadováno

Pro úlohy, které vyžadují další konfigurace specifické pro distribuovanou úlohu.

resume_from
DataPath
Vyžadováno

Cesta data obsahující kontrolní bod nebo soubory modelu, ze kterých se má experiment pokračovat.

max_run_duration_seconds
int
Vyžadováno

Maximální čas povolený pro spuštění. Systém se pokusí automaticky zrušit spuštění, pokud trvalo déle než tato hodnota.

command
list[str] nebo str
Vyžadováno

Příkaz, který se má odeslat pro spuštění. Vlastnost command lze použít také místo skriptů nebo argumentů. Vlastnosti příkazu a skriptu/argumentu nelze použít společně k odeslání spuštění. 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
DockerConfiguration
Vyžadováno

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ší.

Pro Experiment tato trénovací spuštění funguje jako logický kontejner. Objekt ScriptRunConfig se používá ke konfiguraci informací potřebných pro odeslání trénovacího spuštění v rámci experimentu. Při odeslání spuštění pomocí objektu ScriptRunConfig vrátí metoda submit 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 třídy Run.

Klíčovým konceptem, který je třeba si zapamatovat, je, že existují různé objekty konfigurace, které se používají k odeslání experimentu, na základě 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. Při předání objektu ScriptRunConfig ve volání metody odeslání experimentu získáte zpět objekt ScriptRun. Mezi příklady dalších vrácených objektů spuštění patří AutoMLRun (vráceno pro spuštění automatizovaného strojového učení) a PipelineRun (vráceno 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 command 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, které ukazují, jak pracovat se ScriptRunConfig, najdete tady:

Atributy

MAX_DURATION_SECONDS_DEFAULT 

MAX_DURATION_SECONDS_DEFAULT = 2592000