Sdílet prostřednictvím


RScriptStep Třída

Poznámka:

Jedná se o experimentální třídu a může se kdykoli změnit. Další informace najdete tady: https://aka.ms/acr/connected-registry.

Vytvoří krok kanálu Azure ML, který spouští skript jazyka R.

Vytvořte krok kanálu Azure ML, který spouští skript jazyka R.

ZAVRHOVANÝ. Použijte místo toho CommandStep . Příklad najdete v tématu Spouštění skriptů jazyka R v kanálech pomocí commandStep.

Konstruktor

RScriptStep(script_name, name=None, arguments=None, compute_target=None, runconfig=None, runconfig_pipeline_params=None, inputs=None, outputs=None, params=None, source_directory=None, use_gpu=False, custom_docker_image=None, cran_packages=None, github_packages=None, custom_url_packages=None, allow_reuse=True, version=None)

Parametry

Name Description
script_name
Vyžadováno
str

[Povinné] Název skriptu jazyka R vzhledem k source_directory.

name
Vyžadováno
str

Název kroku. Pokud není zadáno, script_name použije se.

arguments
Vyžadováno

Argumenty příkazového řádku pro soubor skriptu jazyka R Argumenty se předají výpočetním prostředkům prostřednictvím parametru arguments v RunConfiguration. Další podrobnosti o zpracování argumentů, jako jsou speciální symboly, naleznete v tématu RunConfiguration.

compute_target
Vyžadováno

[Povinné] Cílový výpočetní objekt, který se má použít. Pokud není zadaný, použije se cíl z objektu runconfig . Tento parametr může být zadán jako cílový objekt výpočetního objektu nebo jako název řetězce cílového výpočetního objektu v pracovním prostoru. Volitelně pokud výpočetní cíl není k dispozici v době vytvoření kanálu, můžete zadat řazenou kolekci členů ("název cílového výpočetního objektu", "cílový typ výpočetního objektu"), abyste se vyhnuli načtení cílového objektu výpočetního objektu (typ AmlCompute je AmlCompute a typ RemoteCompute je VirtualMachine).

runconfig
Vyžadováno

[Povinné] Spusťte konfiguraci, která zapouzdřuje informace potřebné k odeslání trénovacího spuštění v experimentu. To je nutné k definování konfigurací spuštění jazyka R, které lze definovat v RSection. Pro tento krok se vyžaduje RSection.

runconfig_pipeline_params
Vyžadováno

Přepsání vlastností runconfig za běhu pomocí párů klíč-hodnota každý s názvem vlastnosti runconfig a PipelineParameter pro danou vlastnost.

Podporované hodnoty: NodeCount, MpiProcessCountPerNode, TensorflowWorkerCount, TensorflowParameterServerCount

inputs
Vyžadováno

Seznam vstupních vazeb portů

outputs
Vyžadováno

Seznam výstupních vazeb portů

params
Vyžadováno

Slovník párů name-value registrovaných jako proměnné prostředí s "AML_PARAMETER_".

source_directory
Vyžadováno
str

Složka, která obsahuje skript jazyka R, env conda a další prostředky použité v kroku.

use_gpu
Vyžadováno

Určuje, jestli má prostředí pro spuštění experimentu podporovat gpu. Pokud ano, použije se v prostředí výchozí image Dockeru založená na GPU. Pokud je false, použije se image založená na procesoru. Výchozí image Dockeru (CPU nebo GPU) se použijí jenom v případě, že uživatel nenastaví oba base_image parametry.base_dockerfile Toto nastavení se používá jenom v cílových výpočetních objektech s podporou Dockeru. Další https://docs.microsoft.com/en-us/python/api/azureml-core/azureml.core.environment.dockersection podrobnosti najdete v tématu base_image.

custom_docker_image
Vyžadováno
str

Vytvoří se název image Dockeru, ze které se má image použít pro trénování. Pokud není nastavená, jako základní image se použije výchozí image založená na procesoru. Tato verze je zastaralá a bude odebrána v budoucí verzi. Místo toho použijte base_image v DockerSection.

cran_packages
Vyžadováno

Balíčky CRAN, které se mají nainstalovat. Tato verze je zastaralá a bude odebrána v budoucí verzi. Místo toho použijte RSection.cran_packages.

github_packages
Vyžadováno

Balíčky GitHubu, které se mají nainstalovat. Tato verze je zastaralá a bude odebrána v budoucí verzi. Místo toho použijte RSection.github_packages.

custom_url_packages
Vyžadováno

Balíčky, které se mají nainstalovat z místního adresáře nebo vlastní adresy URL. Tato verze je zastaralá a bude odebrána v budoucí verzi. Místo toho použijte RSection.custom_url_packages.

allow_reuse
Vyžadováno

Určuje, jestli má krok znovu použít předchozí výsledky při opětovném spuštění se stejným nastavením. Opakované použití je ve výchozím nastavení povolené. Pokud obsah kroku (skripty/závislosti) a vstupy a parametry zůstanou beze změny, výstup z předchozího spuštění tohoto kroku se znovu použije. Při opětovném použití kroku místo odeslání úlohy k výpočtu se výsledky předchozího spuštění okamžitě zpřístupní pro všechny následné kroky. Pokud jako vstupy používáte datové sady Azure Machine Learning, určuje se opakované použití podle toho, jestli se definice datové sady změnila, a ne tím, jestli se podkladová data změnila.

version
Vyžadováno
str

Volitelná značka verze, která označuje změnu funkčnosti kroku.

script_name
Vyžadováno
str

[Povinné] Název skriptu jazyka R vzhledem k source_directory.

name
Vyžadováno
str

Název kroku. Pokud není zadáno, script_name použije se.

arguments
Vyžadováno

Argumenty příkazového řádku pro soubor skriptu jazyka R Argumenty se předají výpočetním prostředkům prostřednictvím parametru arguments v RunConfiguration. Další podrobnosti o zpracování argumentů, jako jsou speciální symboly, naleznete v tématu RunConfiguration.

compute_target
Vyžadováno

[Povinné] Cílový výpočetní objekt, který se má použít. Pokud není zadaný, použije se cíl z objektu runconfig . Tento parametr může být zadán jako cílový objekt výpočetního objektu nebo jako název řetězce cílového výpočetního objektu v pracovním prostoru. Volitelně pokud výpočetní cíl není k dispozici v době vytvoření kanálu, můžete zadat řazenou kolekci členů ("název cílového výpočetního objektu", "cílový typ výpočetního objektu"), abyste se vyhnuli načtení cílového objektu výpočetního objektu (typ AmlCompute je AmlCompute a typ RemoteCompute je VirtualMachine).

runconfig
Vyžadováno

[Povinné] Spusťte konfiguraci, která zapouzdřuje informace potřebné k odeslání trénovacího spuštění v experimentu. To je nutné k definování konfigurací spuštění jazyka R, které lze definovat v RSection. Pro tento krok se vyžaduje RSection.

runconfig_pipeline_params
Vyžadováno

Přepsání vlastností runconfig za běhu pomocí párů klíč-hodnota každý s názvem vlastnosti runconfig a PipelineParameter pro danou vlastnost.

Podporované hodnoty: NodeCount, MpiProcessCountPerNode, TensorflowWorkerCount, TensorflowParameterServerCount

inputs
Vyžadováno

Seznam vstupních vazeb portů

outputs
Vyžadováno

Seznam výstupních vazeb portů

params
Vyžadováno

Slovník párů name-value registrovaných jako proměnné prostředí s "AML_PARAMETER_".

source_directory
Vyžadováno
str

Složka, která obsahuje skript jazyka R, env conda a další prostředky použité v kroku.

use_gpu
Vyžadováno

Určuje, jestli má prostředí pro spuštění experimentu podporovat gpu. Pokud ano, použije se v prostředí výchozí image Dockeru založená na GPU. Pokud je false, použije se image založená na procesoru. Výchozí image Dockeru (CPU nebo GPU) se použijí jenom v případě, že uživatel nenastaví oba base_image parametry.base_dockerfile Toto nastavení se používá jenom v cílových výpočetních objektech s podporou Dockeru. Další https://docs.microsoft.com/en-us/python/api/azureml-core/azureml.core.environment.dockersection podrobnosti najdete v tématu base_image.

custom_docker_image
Vyžadováno
str

Vytvoří se název image Dockeru, ze které se má image použít pro trénování. Pokud není nastavená, jako základní image se použije výchozí image založená na procesoru. Tato verze je zastaralá a bude odebrána v budoucí verzi. Místo toho použijte base_image v DockerSection.

cran_packages
Vyžadováno

Balíčky CRAN, které se mají nainstalovat. Tato verze je zastaralá a bude odebrána v budoucí verzi. Místo toho použijte RSection.cran_packages.

github_packages
Vyžadováno

Balíčky GitHubu, které se mají nainstalovat. Tato verze je zastaralá a bude odebrána v budoucí verzi. Místo toho použijte RSection.github_packages.

custom_url_packages
Vyžadováno

Balíčky, které se mají nainstalovat z místního adresáře nebo vlastní adresy URL. Tato verze je zastaralá a bude odebrána v budoucí verzi. Místo toho použijte RSection.custom_url_packages.

allow_reuse
Vyžadováno

Určuje, jestli má krok znovu použít předchozí výsledky při opětovném spuštění se stejným nastavením. Opakované použití je ve výchozím nastavení povolené. Pokud obsah kroku (skripty/závislosti) a vstupy a parametry zůstanou beze změny, výstup z předchozího spuštění tohoto kroku se znovu použije. Při opětovném použití kroku místo odeslání úlohy k výpočtu se výsledky předchozího spuštění okamžitě zpřístupní pro všechny následné kroky. Pokud jako vstupy používáte datové sady Azure Machine Learning, určuje se opakované použití podle toho, jestli se definice datové sady změnila, a ne tím, jestli se podkladová data změnila.

version
Vyžadováno
str

Volitelná značka verze, která označuje změnu funkčnosti kroku.

Poznámky

RScriptStep je základní integrovaný krok pro spuštění skriptu jazyka R na cílovém výpočetním objektu. Vezme název skriptu a další volitelné parametry, jako jsou argumenty pro skript, cílový výpočetní objekt, vstupy a výstupy. Měli byste použít RunConfiguration k určení požadavků pro RScriptStep, například vlastní image Dockeru, požadované balíčky cran/github.

Osvědčeným postupem pro práci s jazykem RScriptStep je použít samostatnou složku pro skripty a všechny závislé soubory přidružené k kroku a určit tuto složku s parametrem source_directory . Následující osvědčený postup má dvě výhody. Za prvé pomáhá zmenšit velikost snímku vytvořeného pro tento krok, protože se snímek vyžaduje jenom v případě, že se tento krok potřebuje. Za druhé, výstup kroku z předchozího spuštění lze znovu použít, pokud nedojde k source_directory žádným změnám, které by aktivovaly opětovné nahrání snímku.

Následující příklad kódu ukazuje, jak použít RScriptStep ve scénáři trénování strojového učení.


   from azureml.core.runconfig import RunConfiguration
   from azureml.core.environment import Environment, RSection, RCranPackage
   from azureml.pipeline.steps import RScriptStep

   rc = RunConfiguration()
   rc.framework='R'
   rc.environment.r = RSection()                            # R details with required packages
   rc.environment.docker.enabled = True                     # to enable docker image
   rc.environment.docker.base_image = '<custom user image>' # to use custom image

   cran_package1 = RCranPackage()
   cran_package1.name = "ggplot2"
   cran_package1.repository = "www.customurl.com"
   cran_package1.version = "2.1"
   rc.environment.r.cran_packages = [cran_package1]

   trainStep = RScriptStep(script_name="train.R",
                           arguments=["--input", blob_input_data, "--output", output_data1],
                           inputs=[blob_input_data],
                           outputs=[output_data1],
                           compute_target=compute_target,
                           use_gpu=False,
                           runconfig=rc,
                           source_directory=project_folder)

https://aka.ms/pl-first-pipeline Další podrobnosti o vytváření kanálů najdete obecně. Další https://docs.microsoft.com/en-us/python/api/azureml-core/azureml.core.environment.rsection podrobnosti o RSection.

Metody

create_node

Vytvořte uzel pro RScriptStep a přidejte ho do zadaného grafu.

ZAVRHOVANÝ. Použijte místo toho CommandStep . Příklad najdete v tématu Spouštění skriptů jazyka R v kanálech pomocí commandStep.

Tato metoda není určena k přímému použití. Když se vytvoří instance kanálu pomocí tohoto kroku, Azure ML automaticky předá parametry požadované touto metodou, aby se tento krok mohl přidat do grafu kanálu, který představuje pracovní postup.

create_node

Vytvořte uzel pro RScriptStep a přidejte ho do zadaného grafu.

ZAVRHOVANÝ. Použijte místo toho CommandStep . Příklad najdete v tématu Spouštění skriptů jazyka R v kanálech pomocí commandStep.

Tato metoda není určena k přímému použití. Když se vytvoří instance kanálu pomocí tohoto kroku, Azure ML automaticky předá parametry požadované touto metodou, aby se tento krok mohl přidat do grafu kanálu, který představuje pracovní postup.

create_node(graph, default_datastore, context)

Parametry

Name Description
graph
Vyžadováno

Objekt grafu pro přidání uzlu.

default_datastore
Vyžadováno

Výchozí úložiště dat.

context
Vyžadováno
<xref:azureml.pipeline.core._GraphContext>

Kontext grafu

Návraty

Typ Description

Vytvořený uzel.