RScriptStep Klass

Anteckning

Det här är en experimentell klass och kan ändras när som helst. Mer information finns i https://aka.ms/azuremlexperimental.

Skapar ett Azure ML Pipeline-steg som kör R-skript.

Skapa ett Azure ML Pipeline-steg som kör R-skript.

DEPRECATED. CommandStep Använd i stället. Ett exempel finns i Köra R-skript i pipelines med CommandStep.

Arv

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)

Parametrar

Name	Description
script_name Obligatorisk	str [Krävs] Namnet på ett R-skript i förhållande till source_directory.
name Obligatorisk	str Namnet på steget. Om det är ospecificerat script_name används.
arguments Obligatorisk	list Kommandoradsargument för R-skriptfilen. Argumenten skickas till beräkning via parametern arguments i RunConfiguration. Mer information om hur du hanterar argument som specialsymboler finns i RunConfiguration.
compute_target Obligatorisk	Union[DsvmCompute, AmlCompute, RemoteCompute, HDInsightCompute, str, tuple] [Krävs] Beräkningsmålet som ska användas. Om det är ospecificerat används målet från runconfig . Den här parametern kan anges som ett beräkningsmålobjekt eller strängnamnet för ett beräkningsmål på arbetsytan. Om beräkningsmålet inte är tillgängligt när pipelinen skapas kan du ange en tupplar med ("beräkningsmålnamn", "beräkningsmåltyp") för att undvika att hämta beräkningsmålobjektet (AmlCompute-typen är "AmlCompute" och RemoteCompute-typen är "VirtualMachine").
runconfig Obligatorisk	RunConfiguration [Krävs] Kör konfigurationen som kapslar in den information som krävs för att skicka en träningskörning i ett experiment. Detta krävs för att definiera R-körningskonfigurationer som kan definieras i RSection. RSection krävs för det här steget.
runconfig_pipeline_params Obligatorisk	dict[str, PipelineParameter] Åsidosättningar av runconfig-egenskaper vid körning med nyckel/värde-par var och en med namnet på egenskapen runconfig och PipelineParameter för den egenskapen. Värden som stöds: NodeCount, MpiProcessCountPerNode, TensorflowWorkerCount, TensorflowParameterServerCount
inputs Obligatorisk	list[Union[InputPortBinding, DataReference, PortDataReference, PipelineData, PipelineOutputFileDataset, PipelineOutputTabularDataset, DatasetConsumptionConfig]] En lista över indataportbindningar.
outputs Obligatorisk	list[Union[PipelineData, OutputDatasetConfig, PipelineOutputAbstractDataset, OutputPortBinding]] En lista över portbindningar för utdata.
params Obligatorisk	dict En ordlista med namn/värde-par som registrerats som miljövariabler med "AML_PARAMETER_".
source_directory Obligatorisk	str En mapp som innehåller R-skript, conda env och andra resurser som används i steget.
use_gpu Obligatorisk	bool Anger om miljön som ska köra experimentet ska ha stöd för GPU:er. Om det är sant används en GPU-baserad Docker-standard avbildning i miljön. Om det är falskt används en CPU-baserad avbildning. Standard docker-avbildningar (CPU eller GPU) används endast om en användare inte anger både base_image parametrar och base_dockerfile parametrar. Den här inställningen används endast i Docker-aktiverade beräkningsmål. Mer https://docs.microsoft.com/en-us/python/api/azureml-core/azureml.core.environment.dockersection information om finns i base_image.
custom_docker_image Obligatorisk	str Namnet på den Docker-avbildning som avbildningen ska använda för träning kommer att skapas. Om den inte har angetts används en cpu-baserad standardavbildning som basavbildning. Detta har blivit inaktuellt och kommer att tas bort i en framtida version. Använd base_image i DockerSection i stället.
cran_packages Obligatorisk	list CRAN-paket som ska installeras. Detta har blivit inaktuellt och kommer att tas bort i en framtida version. Använd RSection.cran_packages i stället.
github_packages Obligatorisk	list GitHub-paket som ska installeras. Detta har blivit inaktuellt och kommer att tas bort i en framtida version. Använd RSection.github_packages i stället.
custom_url_packages Obligatorisk	list Paket som ska installeras från lokal, katalog eller anpassad URL. Detta har blivit inaktuellt och kommer att tas bort i en framtida version. Använd RSection.custom_url_packages i stället.
allow_reuse Obligatorisk	bool Anger om steget ska återanvända tidigare resultat när det körs igen med samma inställningar. Återanvändning är aktiverat som standard. Om steginnehållet (skript/beroenden) samt indata och parametrar förblir oförändrade återanvänds utdata från föregående körning av det här steget. När du återanvänder steget, i stället för att skicka jobbet för beräkning, görs resultaten från den föregående körningen omedelbart tillgängliga för efterföljande steg. Om du använder Azure Machine Learning-datauppsättningar som indata bestäms återanvändningen av om datauppsättningens definition har ändrats, inte av om underliggande data har ändrats.
version Obligatorisk	str En valfri versionstagg som anger en funktionsändring för steget.
script_name Obligatorisk	str [Krävs] Namnet på ett R-skript i förhållande till source_directory.
name Obligatorisk	str Namnet på steget. Om det är ospecificerat script_name används.
arguments Obligatorisk	list Kommandoradsargument för R-skriptfilen. Argumenten skickas till beräkning via parametern arguments i RunConfiguration. Mer information om hur du hanterar argument som specialsymboler finns i RunConfiguration.
compute_target Obligatorisk	Union[DsvmCompute, AmlCompute, RemoteCompute, HDInsightCompute, str, tuple] [Krävs] Beräkningsmålet som ska användas. Om det är ospecificerat används målet från runconfig . Den här parametern kan anges som ett beräkningsmålobjekt eller strängnamnet för ett beräkningsmål på arbetsytan. Om beräkningsmålet inte är tillgängligt när pipelinen skapas kan du ange en tupplar med ("beräkningsmålnamn", "beräkningsmåltyp") för att undvika att hämta beräkningsmålobjektet (AmlCompute-typen är "AmlCompute" och RemoteCompute-typen är "VirtualMachine").
runconfig Obligatorisk	RunConfiguration [Krävs] Kör konfigurationen som kapslar in den information som krävs för att skicka en träningskörning i ett experiment. Detta krävs för att definiera R-körningskonfigurationer som kan definieras i RSection. RSection krävs för det här steget.
runconfig_pipeline_params Obligatorisk	dict[str, PipelineParameter] Åsidosättningar av runconfig-egenskaper vid körning med nyckel/värde-par var och en med namnet på egenskapen runconfig och PipelineParameter för den egenskapen. Värden som stöds: NodeCount, MpiProcessCountPerNode, TensorflowWorkerCount, TensorflowParameterServerCount
inputs Obligatorisk	list[Union[InputPortBinding, DataReference, PortDataReference, PipelineData, PipelineOutputFileDataset, PipelineOutputTabularDataset, DatasetConsumptionConfig]] En lista över indataportbindningar.
outputs Obligatorisk	list[Union[PipelineData, PipelineOutputAbstractDataset, OutputPortBinding]] En lista över portbindningar för utdata.
params Obligatorisk	dict En ordlista med namn/värde-par som registrerats som miljövariabler med "AML_PARAMETER_".
source_directory Obligatorisk	str En mapp som innehåller R-skript, conda env och andra resurser som används i steget.
use_gpu Obligatorisk	bool Anger om miljön som ska köra experimentet ska ha stöd för GPU:er. Om det är sant används en GPU-baserad Docker-standard avbildning i miljön. Om det är falskt används en CPU-baserad avbildning. Standard docker-avbildningar (CPU eller GPU) används endast om en användare inte anger både base_image parametrar och base_dockerfile parametrar. Den här inställningen används endast i Docker-aktiverade beräkningsmål. Mer https://docs.microsoft.com/en-us/python/api/azureml-core/azureml.core.environment.dockersection information om finns i base_image.
custom_docker_image Obligatorisk	str Namnet på den Docker-avbildning som avbildningen ska använda för träning kommer att skapas. Om den inte har angetts används en cpu-baserad standardavbildning som basavbildning. Detta har blivit inaktuellt och kommer att tas bort i en framtida version. Använd base_image i DockerSection i stället.
cran_packages Obligatorisk	list CRAN-paket som ska installeras. Detta har blivit inaktuellt och kommer att tas bort i en framtida version. Använd RSection.cran_packages i stället.
github_packages Obligatorisk	list GitHub-paket som ska installeras. Detta har blivit inaktuellt och kommer att tas bort i en framtida version. Använd RSection.github_packages i stället.
custom_url_packages Obligatorisk	list Paket som ska installeras från lokal url, katalog eller anpassad URL. Detta har blivit inaktuellt och kommer att tas bort i en framtida version. Använd RSection.custom_url_packages i stället.
allow_reuse Obligatorisk	bool Anger om steget ska återanvända tidigare resultat när det körs igen med samma inställningar. Återanvändning är aktiverat som standard. Om steginnehållet (skript/beroenden) samt indata och parametrar förblir oförändrade återanvänds utdata från föregående körning av det här steget. När du återanvänder steget görs resultaten från den föregående körningen omedelbart tillgängliga för efterföljande steg i stället för att skicka jobbet för beräkning. Om du använder Azure Machine Learning-datauppsättningar som indata bestäms återanvändning av om datauppsättningens definition har ändrats, inte av om underliggande data har ändrats.
version Obligatorisk	str En valfri versionstagg som anger en funktionsändring för steget.

Kommentarer

Ett RScriptStep är ett grundläggande, inbyggt steg för att köra R-skript på ett beräkningsmål. Det tar ett skriptnamn och andra valfria parametrar som argument för skriptet, beräkningsmål, indata och utdata. Du bör använda en RunConfiguration för att ange krav för RScriptStep, till exempel anpassad docker-avbildning, nödvändiga cran/github-paket.

Det bästa sättet att arbeta med RScriptStep är att använda en separat mapp för skript och eventuella beroende filer som är associerade med steget och ange mappen med parametern source_directory . Att följa den här bästa metoden har två fördelar. För det första hjälper det till att minska storleken på ögonblicksbilden som skapats för steget eftersom endast det som behövs för steget ögonblicksbilderas. För det andra kan stegets utdata från en tidigare körning återanvändas om det inte finns några ändringar i source_directory som skulle utlösa en omuppladdning av ögonblicksbilden.

Följande kodexempel visar hur du använder ett RScriptStep i ett maskininlärningsträningsscenario.

   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)

Mer https://aka.ms/pl-first-pipeline information om hur du skapar pipelines finns i allmänhet. Mer https://docs.microsoft.com/en-us/python/api/azureml-core/azureml.core.environment.rsection information om RSection finns i.

Metoder

create_node

Skapa en nod för RScriptStep och lägg till den i den angivna grafen. DEPRECATED. CommandStep Använd i stället. Ett exempel finns i Köra R-skript i pipelines med CommandStep. Den här metoden är inte avsedd att användas direkt. När en pipeline instansieras med det här steget skickar Azure ML automatiskt de parametrar som krävs via den här metoden så att steget kan läggas till i ett pipelinediagram som representerar arbetsflödet.

create_node

Skapa en nod för RScriptStep och lägg till den i den angivna grafen.

DEPRECATED. CommandStep Använd i stället. Ett exempel finns i Köra R-skript i pipelines med CommandStep.

Den här metoden är inte avsedd att användas direkt. När en pipeline instansieras med det här steget skickar Azure ML automatiskt de parametrar som krävs via den här metoden så att steget kan läggas till i ett pipelinediagram som representerar arbetsflödet.

create_node(graph, default_datastore, context)

Parametrar

Name	Description
graph Obligatorisk	Graph Grafobjektet som noden ska läggas till i.
default_datastore Obligatorisk	Union[AbstractAzureStorageDatastore, AzureDataLakeDatastore] Standarddatalager.
context Obligatorisk	<xref:azureml.pipeline.core._GraphContext> Grafkontexten.

Returer

Typ	Description
Node	Den skapade noden.