RScriptStep Třída

Poznámka

Toto je experimentální třída, která se může kdykoli změnit. Další informace najdete tady: https://aka.ms/azuremlexperimental.

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

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

ZASTARALÉ. Místo toho CommandStep použijte. Příklad najdete v tématu Jak spouštět skripty jazyka R v kanálech pomocí CommandStep.

Dědičnost

azureml.pipeline.core._python_script_step_base._PythonScriptStepBase

RScriptStep

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án, script_name použije se.
arguments Vyžadováno	list 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, najdete v tématu RunConfiguration.
compute_target Vyžadováno	Union[DsvmCompute, AmlCompute, RemoteCompute, HDInsightCompute, str, tuple] [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 je možné zadat 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. Pokud cílový výpočetní objekt není při vytváření kanálu dostupný, můžete volitelně zadat řazenou kolekci členů ("cílový název výpočetních prostředků", "cílový typ výpočetních prostředků"), abyste se vyhnuli načítání cílového objektu výpočetního objektu (typ AmlCompute je AmlCompute a typ RemoteCompute je VirtualMachine).
runconfig Vyžadováno	RunConfiguration [Povinné] Spusťte konfiguraci, která zapouzdřuje informace potřebné k odeslání trénovacího běhu v experimentu. To se vyžaduje k definování konfigurací spuštění jazyka R, které lze definovat v RSectionnástroji . Pro tento krok se vyžaduje RSection.
runconfig_pipeline_params Vyžadováno	dict[str, PipelineParameter] Přepsání vlastností runconfig za běhu pomocí každého páru klíč-hodnota s názvem vlastnosti runconfig a PipelineParameter pro danou vlastnost. Podporované hodnoty: NodeCount, MpiProcessCountPerNode, TensorflowWorkerCount, TensorflowParameterServerCount
inputs Vyžadováno	list[Union[InputPortBinding, DataReference, PortDataReference, PipelineData, PipelineOutputFileDataset, PipelineOutputTabularDataset, DatasetConsumptionConfig]] Seznam vazeb vstupních portů.
outputs Vyžadováno	list[Union[PipelineData, OutputDatasetConfig, PipelineOutputAbstractDataset, OutputPortBinding]] Seznam výstupních vazeb portů.
params Vyžadováno	dict Slovník dvojic název-hodnota registrovaných jako proměnné prostředí s "AML_PARAMETER_".
source_directory Vyžadováno	str Složka, která obsahuje skript jazyka R, conda env a další prostředky použité v kroku.
use_gpu Vyžadováno	bool Určuje, jestli by prostředí pro spuštění experimentu mělo podporovat GPU. Pokud má hodnotu True, 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í parametry a base_imagebase_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 image použije pro trénování. Pokud není nastavená, jako základní image se použije výchozí image založená na procesoru. Tato funkce je zastaralá a v budoucí verzi se odebere. Místo toho použijte base_image v DockerSection.
cran_packages Vyžadováno	list Balíčky CRAN, které se mají nainstalovat. Tato funkce je zastaralá a v budoucí verzi se odebere. Místo toho použijte RSection.cran_packages.
github_packages Vyžadováno	list Balíčky GitHubu, které se mají nainstalovat. Tato funkce je zastaralá a v budoucí verzi se odebere. Použijte místo toho RSection.github_packages.
custom_url_packages Vyžadováno	list Balíčky, které se mají nainstalovat z místní adresy URL, adresáře nebo vlastní adresy URL. Tato funkce je zastaralá a v budoucí verzi se odebere. Místo toho použijte RSection.custom_url_packages.
allow_reuse Vyžadováno	bool Určuje, jestli má krok při opětovném spuštění se stejným nastavením znovu použít předchozí výsledky. 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, znovu se použije výstup z předchozího spuštění tohoto kroku. Při opakovaném použití kroku místo odeslání úlohy k výpočtu se výsledky z předchozího spuštění okamžitě zpřístupní všem dalším krokům. Pokud jako vstupy použijete datové sady Azure Machine Learning, opakované použití závisí na tom, jestli se změnila definice datové sady, nikoli na základě toho, jestli se změnila podkladová data.
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án, script_name použije se.
arguments Vyžadováno	list 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, najdete v tématu RunConfiguration.
compute_target Vyžadováno	Union[DsvmCompute, AmlCompute, RemoteCompute, HDInsightCompute, str, tuple] [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 je možné zadat 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. Pokud cílový výpočetní objekt není při vytváření kanálu dostupný, můžete volitelně zadat řazenou kolekci členů ("cílový název výpočetních prostředků", "cílový typ výpočetních prostředků"), abyste se vyhnuli načítání cílového objektu výpočetního objektu (typ AmlCompute je AmlCompute a typ RemoteCompute je VirtualMachine).
runconfig Vyžadováno	RunConfiguration [Povinné] Spusťte konfiguraci, která zapouzdřuje informace potřebné k odeslání trénovacího běhu v experimentu. To se vyžaduje k definování konfigurací spuštění jazyka R, které lze definovat v RSectionnástroji . Pro tento krok se vyžaduje RSection.
runconfig_pipeline_params Vyžadováno	dict[str, PipelineParameter] Přepsání vlastností runconfig za běhu pomocí každého páru klíč-hodnota s názvem vlastnosti runconfig a PipelineParameter pro danou vlastnost. Podporované hodnoty: NodeCount, MpiProcessCountPerNode, TensorflowWorkerCount, TensorflowParameterServerCount
inputs Vyžadováno	list[Union[InputPortBinding, DataReference, PortDataReference, PipelineData, PipelineOutputFileDataset, PipelineOutputTabularDataset, DatasetConsumptionConfig]] Seznam vazeb vstupních portů.
outputs Vyžadováno	list[Union[PipelineData, PipelineOutputAbstractDataset, OutputPortBinding]] Seznam výstupních vazeb portů.
params Vyžadováno	dict Slovník dvojic název-hodnota registrovaných jako proměnné prostředí s "AML_PARAMETER_".
source_directory Vyžadováno	str Složka, která obsahuje skript jazyka R, conda env a další prostředky použité v kroku.
use_gpu Vyžadováno	bool Určuje, jestli by prostředí pro spuštění experimentu mělo podporovat GPU. Pokud má hodnotu True, 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í parametry a base_imagebase_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 image použije pro trénování. Pokud není nastavená, jako základní image se použije výchozí image založená na procesoru. Tato funkce je zastaralá a v budoucí verzi se odebere. Místo toho použijte base_image v DockerSection.
cran_packages Vyžadováno	list Balíčky CRAN, které se mají nainstalovat. Tato funkce je zastaralá a v budoucí verzi se odebere. Místo toho použijte RSection.cran_packages.
github_packages Vyžadováno	list Balíčky GitHubu, které se mají nainstalovat. Tato funkce je zastaralá a v budoucí verzi se odebere. Místo toho použijte RSection.github_packages.
custom_url_packages Vyžadováno	list Balíčky, které se mají nainstalovat z místní adresy URL, adresáře nebo vlastní adresy URL. Tato funkce je zastaralá a v budoucí verzi se odebere. Místo toho použijte RSection.custom_url_packages.
allow_reuse Vyžadováno	bool 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) i 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 opakovaném použití kroku se místo odeslání úlohy k výpočtu okamžitě zpřístupní výsledky z předchozího spuštění všem dalším krokům. Pokud jako vstupy použijete datové sady Azure Machine Learning, opakované použití závisí na tom, jestli se změnila definice datové sady, a ne na tom, jestli se změnila podkladová data.
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. Přebírá 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 RScriptStep je použít samostatnou složku pro skripty a všechny závislé soubory přidružené k kroku a zadat tuto složku s parametrem source_directory . Dodržování tohoto osvědčeného postupu má dvě výhody. Za prvé to pomůže zmenšit velikost snímku vytvořeného pro krok, protože snímek se vytvoří jenom to, co je pro krok potřeba. Za druhé je možné znovu použít výstup kroku z předchozího spuštění, 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)

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

Metody

create_node

Vytvořte uzel pro RScriptStep a přidejte ho do zadaného grafu. ZASTARALÉ. Místo toho CommandStep použijte. Příklad najdete v tématu Jak spouštět skripty 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ává požadované parametry prostřednictvím této metody, 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.

ZASTARALÉ. Místo toho CommandStep použijte. Příklad najdete v tématu Jak spouštět skripty 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ává požadované parametry prostřednictvím této metody, 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	Graph Objekt grafu, do který se má uzel přidat.
default_datastore Vyžadováno	Union[AbstractAzureStorageDatastore, AzureDataLakeDatastore] Výchozí úložiště dat.
context Vyžadováno	<xref:azureml.pipeline.core._GraphContext> Kontext grafu.

Návraty

Typ	Description
Node	Vytvořený uzel.