RScriptStep Osztály

Megjegyzés

Ez egy kísérleti osztály, és bármikor változhat. További információ: https://aka.ms/azuremlexperimental.

Létrehoz egy R-szkriptet futtató Azure ML-folyamatlépést.

Hozzon létre egy R-szkriptet futtató Azure ML-folyamatlépést.

ELAVULT. Használja helyette az parancsot CommandStep . Példa: R-szkriptek futtatása folyamatokban a CommandStep használatával.

Öröklődés

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)

Paraméterek

Name	Description
script_name Kötelező	str [Kötelező] Az R-szkript neve a következőhöz source_directoryviszonyítva: .
name Kötelező	str A lépés neve. Ha nincs meghatározva, script_name akkor a függvényt használja.
arguments Kötelező	list Az R-szkriptfájl parancssori argumentumai. Az argumentumok a RunConfiguration paraméteren keresztül lesznek átadva a arguments számításnak. Az argumentumok, például a speciális szimbólumok kezelésének további részleteiért lásd: RunConfiguration.
compute_target Kötelező	Union[DsvmCompute, AmlCompute, RemoteCompute, HDInsightCompute, str, tuple] [Kötelező] A használni kívánt számítási cél. Ha nincs meghatározva, a rendszer az elemből származó runconfig célértéket használja. Ez a paraméter megadható számítási célobjektumként vagy egy számítási cél sztringneveként a munkaterületen. Ha a számítási cél nem érhető el a folyamat létrehozásakor, megadhat egy rekordot (számítási célnév, "számítási céltípus") a számítási célobjektum lekérésének elkerülése érdekében (az AmlCompute típusa "AmlCompute", a RemoteCompute típusa pedig "VirtualMachine").
runconfig Kötelező	RunConfiguration [Kötelező] Futtassa a konfigurációt, amely tartalmazza a kísérlet betanítási futtatásának elküldéséhez szükséges információkat. Ez az R-futtatási konfigurációk definiálásához szükséges, amelyek a következőben definiálhatók: RSection. Ehhez a lépéshez az RSection szükséges.
runconfig_pipeline_params Kötelező	dict[str, PipelineParameter] A futtatókörnyezeti runconfig tulajdonságok felülbírálása kulcs-érték párok használatával, amelyek mindegyike a runconfig tulajdonság nevével és a PipelineParameter tulajdonsággal rendelkezik. Támogatott értékek: "NodeCount", "MpiProcessCountPerNode", "TensorflowWorkerCount", "TensorflowParameterServerCount"
inputs Kötelező	list[Union[InputPortBinding, DataReference, PortDataReference, PipelineData, PipelineOutputFileDataset, PipelineOutputTabularDataset, DatasetConsumptionConfig]] A bemenetiport-kötések listája.
outputs Kötelező	list[Union[PipelineData, OutputDatasetConfig, PipelineOutputAbstractDataset, OutputPortBinding]] A kimeneti portkötések listája.
params Kötelező	dict A "AML_PARAMETER_" környezeti változóként regisztrált név-érték párok szótára.
source_directory Kötelező	str A lépésben használt R-szkriptet, conda env-t és egyéb erőforrásokat tartalmazó mappa.
use_gpu Kötelező	bool Azt jelzi, hogy a kísérlet futtatásához használandó környezet támogatja-e a GPU-kat. Ha igaz, a rendszer GPU-alapú alapértelmezett Docker-rendszerképet használ a környezetben. Ha Hamis, a rendszer processzoralapú rendszerképet használ. Az alapértelmezett Docker-rendszerképek (CPU vagy GPU) csak akkor lesznek használatban, ha a felhasználó nem állítja be mindkettőt base_image és base_dockerfile paramétert. Ez a beállítás csak Docker-kompatibilis számítási célokban használható. További részletekért lásd https://docs.microsoft.com/en-us/python/api/azureml-core/azureml.core.environment.dockersection : base_image.
custom_docker_image Kötelező	str Annak a Docker-rendszerképnek a neve, amelyből a betanításhoz használni kívánt rendszerkép létrejön. Ha nincs beállítva, a rendszer egy alapértelmezett cpu-alapú rendszerképet használ alaprendszerképként. Ez elavult, és egy későbbi kiadásban el lesz távolítva. Használja inkább a base_image a DockerSectionben.
cran_packages Kötelező	list A telepíteni kívánt CRAN-csomagok. Ez elavult, és egy későbbi kiadásban el lesz távolítva. Használja inkább a RSection.cran_packages.
github_packages Kötelező	list Telepíteni kívánt GitHub-csomagok. Ez elavult, és egy későbbi kiadásban el lesz távolítva. Használja inkább a RSection.github_packages.
custom_url_packages Kötelező	list A helyi, címtárból vagy egyéni URL-címről telepíteni kívánt csomagok. Ez elavult, és egy későbbi kiadásban el lesz távolítva. Használja inkább a RSection.custom_url_packages.
allow_reuse Kötelező	bool Azt jelzi, hogy a lépés újra felhasználja-e a korábbi eredményeket, amikor ugyanazokat a beállításokat használja újra. Az újrafelhasználás alapértelmezés szerint engedélyezve van. Ha a lépés tartalma (szkriptek/függőségek), valamint a bemenetek és paraméterek változatlanok maradnak, a lépés előző futtatásából származó kimenet újra felhasználva lesz. A lépés újbóli használata esetén a feladat számítási feladatként való elküldése helyett az előző futtatás eredményei azonnal elérhetővé válnak a további lépésekhez. Ha az Azure Machine Learning-adathalmazokat használja bemenetként, az újrafelhasználást az határozza meg, hogy az adathalmaz definíciója megváltozott-e, nem pedig az, hogy a mögöttes adatok megváltoztak-e.
version Kötelező	str Választható verziócímke, amely a lépés funkcióváltozását jelzi.
script_name Kötelező	str [Kötelező] Az R-szkript neve a következőhöz source_directoryviszonyítva: .
name Kötelező	str A lépés neve. Ha nincs meghatározva, script_name akkor a függvényt használja.
arguments Kötelező	list Az R-szkriptfájl parancssori argumentumai. Az argumentumok a RunConfiguration paraméteren keresztül lesznek átadva a arguments számításnak. Az argumentumok, például a speciális szimbólumok kezelésének további részleteiért lásd: RunConfiguration.
compute_target Kötelező	Union[DsvmCompute, AmlCompute, RemoteCompute, HDInsightCompute, str, tuple] [Kötelező] A használni kívánt számítási cél. Ha nincs meghatározva, a rendszer a célértéket runconfig fogja használni. Ez a paraméter megadható számítási célobjektumként vagy egy számítási cél sztringneveként a munkaterületen. Ha a számítási cél nem érhető el a folyamat létrehozásakor, megadhat egy rekordot (számítási célnév, "számítási céltípus") a számítási célobjektum lekérésének elkerülése érdekében (az AmlCompute típusa "AmlCompute", a RemoteCompute típusa pedig "VirtualMachine").
runconfig Kötelező	RunConfiguration [Kötelező] Futtassa a konfigurációt, amely tartalmazza a kísérlet betanítási futtatásának elküldéséhez szükséges információkat. Ez az R-futtatási konfigurációk definiálásához szükséges, amelyek a következőben definiálhatók: RSection. Ehhez a lépéshez az RSection szükséges.
runconfig_pipeline_params Kötelező	dict[str, PipelineParameter] A futtatókörnyezeti runconfig tulajdonságok felülbírálása kulcs-érték párok használatával, amelyek mindegyike a runconfig tulajdonság nevével és a PipelineParameter tulajdonsággal rendelkezik. Támogatott értékek: "NodeCount", "MpiProcessCountPerNode", "TensorflowWorkerCount", "TensorflowParameterServerCount"
inputs Kötelező	list[Union[InputPortBinding, DataReference, PortDataReference, PipelineData, PipelineOutputFileDataset, PipelineOutputTabularDataset, DatasetConsumptionConfig]] A bemenetiport-kötések listája.
outputs Kötelező	list[Union[PipelineData, PipelineOutputAbstractDataset, OutputPortBinding]] A kimeneti portkötések listája.
params Kötelező	dict A "AML_PARAMETER_" környezeti változóként regisztrált név-érték párok szótára.
source_directory Kötelező	str A lépésben használt R-szkriptet, conda env-t és egyéb erőforrásokat tartalmazó mappa.
use_gpu Kötelező	bool Azt jelzi, hogy a kísérlet futtatásához használandó környezet támogatja-e a GPU-kat. Ha igaz, a rendszer GPU-alapú alapértelmezett Docker-rendszerképet használ a környezetben. Ha Hamis, a rendszer processzoralapú rendszerképet használ. Az alapértelmezett Docker-rendszerképek (CPU vagy GPU) csak akkor lesznek használatban, ha a felhasználó nem állítja be mindkettőt base_image és base_dockerfile paramétert. Ez a beállítás csak Docker-kompatibilis számítási célokban használható. További részletekért lásd https://docs.microsoft.com/en-us/python/api/azureml-core/azureml.core.environment.dockersection : base_image.
custom_docker_image Kötelező	str Annak a Docker-rendszerképnek a neve, amelyből a betanításhoz használni kívánt rendszerkép létrejön. Ha nincs beállítva, a rendszer egy alapértelmezett cpu-alapú rendszerképet használ alaprendszerképként. Ez elavult, és egy későbbi kiadásban el lesz távolítva. Használja inkább a base_image a DockerSectionben.
cran_packages Kötelező	list A telepíteni kívánt CRAN-csomagok. Ez elavult, és egy későbbi kiadásban el lesz távolítva. Használja inkább a RSection.cran_packages.
github_packages Kötelező	list Telepíteni kívánt GitHub-csomagok. Ez elavult, és egy későbbi kiadásban el lesz távolítva. Használja inkább a RSection.github_packages.
custom_url_packages Kötelező	list A helyi, címtárból vagy egyéni URL-címről telepíteni kívánt csomagok. Ez elavult, és egy későbbi kiadásban el lesz távolítva. Használja inkább a RSection.custom_url_packages.
allow_reuse Kötelező	bool Azt jelzi, hogy a lépés újra felhasználja-e a korábbi eredményeket, amikor ugyanazokkal a beállításokkal fut újra. Az újrafelhasználás alapértelmezés szerint engedélyezve van. Ha a lépés tartalma (szkriptek/függőségek), valamint a bemenetek és paraméterek változatlanok maradnak, a rendszer újra felhasználja a lépés előző futtatásának kimenetét. A lépés újrahasználásakor a feladat számítási feladatként való elküldése helyett az előző futtatás eredményei azonnal elérhetővé válnak a további lépésekhez. Ha az Azure Machine Learning-adatkészleteket használja bemenetként, az újrafelhasználást az határozza meg, hogy az adathalmaz definíciója megváltozott-e, nem pedig az, hogy az alapul szolgáló adatok megváltoztak-e.
version Kötelező	str Nem kötelező verziócímke, amely a lépés funkcióváltozását jelzi.

Megjegyzések

Az RScriptStep egy alapszintű, beépített lépés az R-szkript számítási célon való futtatásához. A szkript nevét és egyéb opcionális paramétereket (például a szkript, a számítási cél, a bemenetek és kimenetek argumentumait) használja. A használatával RunConfiguration megadhatja az RScriptStep követelményeit, például az egyéni Docker-rendszerképet, a szükséges cran/github-csomagokat.

Az RScriptStep használatához ajánlott egy külön mappát használni a szkriptekhez és a lépéshez társított függő fájlokhoz, és meg kell adni a mappát a source_directory paraméterrel. Ennek az ajánlott eljárásnak a követése két előnnyel jár. Először is segít csökkenteni a lépéshez létrehozott pillanatkép méretét, mert csak a lépéshez szükséges pillanatkép készül. Másodszor, a lépés előző futtatásból származó kimenete újra felhasználható, ha nincsenek olyan módosítások, source_directory amelyek elindítanák a pillanatkép újrafeltöltését.

Az alábbi példakód bemutatja, hogyan használhat RScriptStepet gépi tanulási betanítási forgatókönyvben.

   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)

A folyamatok létrehozásával kapcsolatos további részletekért tekintse meg https://aka.ms/pl-first-pipeline az általános tudnivalókat. Az https://docs.microsoft.com/en-us/python/api/azureml-core/azureml.core.environment.rsection RSectionről további információt az RSection című témakörben talál.

Metódusok

create_node

Hozzon létre egy csomópontot az RScriptStep számára, és adja hozzá a megadott gráfhoz. ELAVULT. Használja helyette az parancsot CommandStep . Példa: R-szkriptek futtatása folyamatokban a CommandStep használatával. Ezt a módszert nem közvetlenül kell használni. Ha ezzel a lépéssel példányosít egy folyamatot, az Azure ML automatikusan átadja a szükséges paramétereket ezen a módszeren keresztül, hogy a lépés hozzáadható legyen a munkafolyamatot képviselő folyamatgráfhoz.

create_node

Hozzon létre egy csomópontot az RScriptStep számára, és adja hozzá a megadott gráfhoz.

ELAVULT. Használja helyette az parancsot CommandStep . Példa: R-szkriptek futtatása folyamatokban a CommandStep használatával.

Ezt a módszert nem közvetlenül kell használni. Ha ezzel a lépéssel példányosít egy folyamatot, az Azure ML automatikusan átadja a szükséges paramétereket ezen a módszeren keresztül, hogy a lépés hozzáadható legyen a munkafolyamatot képviselő folyamatgráfhoz.

create_node(graph, default_datastore, context)

Paraméterek

Name	Description
graph Kötelező	Graph A csomópontot hozzáadni kívánt gráfobjektum.
default_datastore Kötelező	Union[AbstractAzureStorageDatastore, AzureDataLakeDatastore] Az alapértelmezett adattár.
context Kötelező	<xref:azureml.pipeline.core._GraphContext> A gráfkörnyezet.

Válaszok

Típus	Description
Node	A létrehozott csomópont.