Aracılığıyla paylaş

RScriptStep Sınıf

  • Başvuru

Not

Bu deneysel bir sınıftır ve herhangi bir zamanda değişebilir. Daha fazla bilgi için lütfen bkz. https://aka.ms/azuremlexperimental.

R betiğini çalıştıran bir Azure ML İşlem Hattı adımı oluşturur.

R betiğini çalıştıran bir Azure ML İşlem Hattı adımı oluşturun.

KALDIRIL -MIŞ. Bunun yerine öğesini CommandStep kullanın. Örnek için bkz. CommandStep ile işlem hatlarında R betiklerini çalıştırma.

Devralma
azureml.pipeline.core._python_script_step_base._PythonScriptStepBase
RScriptStep

Oluşturucu

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)

Parametreler

Name Description
script_name
Gerekli
str

[Gerekli] ile ilgili R betiğinin source_directoryadı.
name
Gerekli
str

Adımın adı. Belirtilmemişse script_name kullanılır.
arguments
Gerekli
list

R betik dosyası için komut satırı bağımsız değişkenleri. Bağımsız değişkenler RunConfiguration içindeki parametresi aracılığıyla arguments hesaplamaya geçirilir. Özel simgeler gibi bağımsız değişkenleri işleme hakkında daha fazla ayrıntı için bkz RunConfiguration. .
compute_target
Gerekli
Union[DsvmCompute, AmlCompute, RemoteCompute, HDInsightCompute, str, tuple]

[Gerekli] Kullanılacak işlem hedefi. Belirtilmezse, hedeften runconfig kullanılır. Bu parametre, çalışma alanında işlem hedefi nesnesi veya işlem hedefinin dize adı olarak belirtilebilir. İsteğe bağlı olarak işlem hedefi işlem hattı oluşturma zamanında kullanılamıyorsa, işlem hedef nesnesinin getirilmesini önlemek için bir demet ('işlem hedefi adı', 'işlem hedefi türü') belirtebilirsiniz (AmlCompute türü 'AmlCompute' ve RemoteCompute türü 'VirtualMachine').
runconfig
Gerekli
RunConfiguration

[Gerekli] Denemede eğitim çalıştırması göndermek için gereken bilgileri kapsülleyen yapılandırmayı çalıştırın. Bu, içinde RSectiontanımlanabilir R çalıştırma yapılandırmalarını tanımlamak için gereklidir. Bu adım için RSection gereklidir.
runconfig_pipeline_params
Gerekli
dict[str, PipelineParameter]

Anahtar-değer kullanan çalışma zamanında runconfig özelliklerinin geçersiz kılmaları, her birini runconfig özelliğinin adıyla ve bu özellik için PipelineParameter ile eşler.

Desteklenen değerler: 'NodeCount', 'MpiProcessCountPerNode', 'TensorflowWorkerCount', 'TensorflowParameterServerCount'
inputs
Gerekli
list[Union[InputPortBinding, DataReference, PortDataReference, PipelineData, PipelineOutputFileDataset, PipelineOutputTabularDataset, DatasetConsumptionConfig]]

Giriş bağlantı noktası bağlamalarının listesi.
outputs
Gerekli
list[Union[PipelineData, OutputDatasetConfig, PipelineOutputAbstractDataset, OutputPortBinding]]

Çıkış bağlantı noktası bağlamalarının listesi.
params
Gerekli
dict

"AML_PARAMETER_" ile ortam değişkenleri olarak kaydedilen ad-değer çiftlerinin sözlüğü.
source_directory
Gerekli
str

R betiği, conda env ve adımda kullanılan diğer kaynakları içeren bir klasör.
use_gpu
Gerekli
bool

Denemeyi çalıştıracak ortamın GPU'ları desteklemesi gerekip gerekmediğini gösterir. True ise, ortamda GPU tabanlı varsayılan bir Docker görüntüsü kullanılır. False ise CPU tabanlı bir görüntü kullanılır. Varsayılan docker görüntüleri (CPU veya GPU) yalnızca bir kullanıcı hem base_dockerfile hem de base_image parametreleri ayarlamazsa kullanılır. Bu ayar yalnızca Docker özellikli işlem hedeflerinde kullanılır. hakkında daha fazla bilgi base_imageiçin bkzhttps://docs.microsoft.com/en-us/python/api/azureml-core/azureml.core.environment.dockersection. .
custom_docker_image
Gerekli
str

Eğitim için kullanılacak görüntünün oluşturulacağı Docker görüntüsünün adı. Ayarlanmadıysa, temel görüntü olarak varsayılan CPU tabanlı bir görüntü kullanılır. Bu kullanım dışı bırakıldı ve gelecek bir sürümde kaldırılacak. Lütfen bunun yerine DockerSection'da base_image kullanın.
cran_packages
Gerekli
list

Yüklenecek CRAN paketleri. Bu kullanım dışı bırakıldı ve gelecek bir sürümde kaldırılacak. Lütfen bunun yerine RSection.cran_packages kullanın.
github_packages
Gerekli
list

Yüklenecek GitHub paketleri. Bu kullanım dışı bırakıldı ve gelecek bir sürümde kaldırılacak. Lütfen bunun yerine RSection.github_packages kullanın.
custom_url_packages
Gerekli
list

Yerel, dizin veya özel URL'den yüklenecek paketler. Bu kullanım dışı bırakıldı ve gelecek bir sürümde kaldırılacak. Lütfen bunun yerine RSection.custom_url_packages kullanın.
allow_reuse
Gerekli
bool

Aynı ayarlarla yeniden çalıştırıldığında adımın önceki sonuçları yeniden kullanıp kullanmayacağını gösterir. Yeniden kullanma varsayılan olarak etkindir. Adım içeriği (betikler/bağımlılıklar) ve girişler ve parametreler değişmeden kalırsa, bu adımın önceki çalıştırmasından elde edilen çıkış yeniden kullanılır. Adımı yeniden kullanırken, işi işlem için göndermek yerine, önceki çalıştırmanın sonuçları hemen sonraki adımlarda kullanılabilir hale gelir. Giriş olarak Azure Machine Learning veri kümelerini kullanıyorsanız, yeniden kullanım, temel alınan verilerin değişip değişmediğine göre değil, veri kümesinin tanımının değişip değişmediğine göre belirlenir.
version
Gerekli
str

Adıma yönelik işlev değişikliğini belirtmek için isteğe bağlı bir sürüm etiketi.
script_name
Gerekli
str

[Gerekli] ile ilgili R betiğinin source_directoryadı.
name
Gerekli
str

Adımın adı. Belirtilmemişse script_name kullanılır.
arguments
Gerekli
list

R betik dosyası için komut satırı bağımsız değişkenleri. Bağımsız değişkenler RunConfiguration içindeki parametresi aracılığıyla arguments hesaplamaya geçirilir. Özel simgeler gibi bağımsız değişkenleri işleme hakkında daha fazla ayrıntı için bkz RunConfiguration. .
compute_target
Gerekli
Union[DsvmCompute, AmlCompute, RemoteCompute, HDInsightCompute, str, tuple]

[Gerekli] Kullanılacak işlem hedefi. Belirtilmezse, hedeften runconfig kullanılır. Bu parametre, çalışma alanında işlem hedefi nesnesi veya işlem hedefinin dize adı olarak belirtilebilir. İsteğe bağlı olarak işlem hedefi işlem hattı oluşturma zamanında kullanılamıyorsa, işlem hedef nesnesinin getirilmesini önlemek için bir demet ('işlem hedefi adı', 'işlem hedefi türü') belirtebilirsiniz (AmlCompute türü 'AmlCompute' ve RemoteCompute türü 'VirtualMachine').
runconfig
Gerekli
RunConfiguration

[Gerekli] Denemede eğitim çalıştırması göndermek için gereken bilgileri kapsülleyen yapılandırmayı çalıştırın. Bu, içinde RSectiontanımlanabilir R çalıştırma yapılandırmalarını tanımlamak için gereklidir. Bu adım için RSection gereklidir.
runconfig_pipeline_params
Gerekli
dict[str, PipelineParameter]

Anahtar-değer kullanan çalışma zamanında runconfig özelliklerinin geçersiz kılmaları, her birini runconfig özelliğinin adıyla ve bu özellik için PipelineParameter ile eşler.

Desteklenen değerler: 'NodeCount', 'MpiProcessCountPerNode', 'TensorflowWorkerCount', 'TensorflowParameterServerCount'
inputs
Gerekli
list[Union[InputPortBinding, DataReference, PortDataReference, PipelineData, PipelineOutputFileDataset, PipelineOutputTabularDataset, DatasetConsumptionConfig]]

Giriş bağlantı noktası bağlamalarının listesi.
outputs
Gerekli
list[Union[PipelineData, PipelineOutputAbstractDataset, OutputPortBinding]]

Çıkış bağlantı noktası bağlamalarının listesi.
params
Gerekli
dict

"AML_PARAMETER_" ile ortam değişkenleri olarak kaydedilen ad-değer çiftlerinin sözlüğü.
source_directory
Gerekli
str

R betiği, conda env ve adımda kullanılan diğer kaynakları içeren bir klasör.
use_gpu
Gerekli
bool

Denemeyi çalıştıracak ortamın GPU'ları desteklemesi gerekip gerekmediğini gösterir. True ise, ortamda GPU tabanlı varsayılan bir Docker görüntüsü kullanılır. False ise CPU tabanlı bir görüntü kullanılır. Varsayılan docker görüntüleri (CPU veya GPU) yalnızca bir kullanıcı hem base_dockerfile hem de base_image parametreleri ayarlamazsa kullanılır. Bu ayar yalnızca Docker özellikli işlem hedeflerinde kullanılır. hakkında daha fazla bilgi base_imageiçin bkzhttps://docs.microsoft.com/en-us/python/api/azureml-core/azureml.core.environment.dockersection. .
custom_docker_image
Gerekli
str

Eğitim için kullanılacak görüntünün oluşturulacağı Docker görüntüsünün adı. Ayarlanmadıysa, temel görüntü olarak varsayılan CPU tabanlı bir görüntü kullanılır. Bu kullanım dışı bırakıldı ve gelecek bir sürümde kaldırılacak. Lütfen bunun yerine DockerSection'da base_image kullanın.
cran_packages
Gerekli
list

Yüklenecek CRAN paketleri. Bu kullanım dışı bırakıldı ve gelecek bir sürümde kaldırılacak. Lütfen bunun yerine RSection.cran_packages kullanın.
github_packages
Gerekli
list

Yüklenecek GitHub paketleri. Bu kullanım dışı bırakıldı ve gelecek bir sürümde kaldırılacak. Lütfen bunun yerine RSection.github_packages kullanın.
custom_url_packages
Gerekli
list

Yerel, dizin veya özel URL'den yüklenecek paketler. Bu kullanım dışı bırakıldı ve gelecek bir sürümde kaldırılacak. Lütfen bunun yerine RSection.custom_url_packages kullanın.
allow_reuse
Gerekli
bool

Aynı ayarlarla yeniden çalıştırıldığında adımın önceki sonuçları yeniden kullanıp kullanmayacağını gösterir. Yeniden kullanma varsayılan olarak etkindir. Adım içeriği (betikler/bağımlılıklar) ve girişler ve parametreler değişmeden kalırsa, bu adımın önceki çalıştırmasından elde edilen çıkış yeniden kullanılır. Adımı yeniden kullanırken, işi işlem için göndermek yerine, önceki çalıştırmanın sonuçları hemen sonraki adımlarda kullanılabilir hale gelir. Giriş olarak Azure Machine Learning veri kümelerini kullanıyorsanız, yeniden kullanım, temel alınan verilerin değişip değişmediğine göre değil, veri kümesinin tanımının değişip değişmediğine göre belirlenir.
version
Gerekli
str

Adıma yönelik işlev değişikliğini belirtmek için isteğe bağlı bir sürüm etiketi.

Açıklamalar

RScriptStep, işlem hedefinde R betiğini çalıştırmak için temel, yerleşik bir adımdır. Betik adını ve betiğin bağımsız değişkenleri, işlem hedefi, girişler ve çıkışlar gibi diğer isteğe bağlı parametreleri alır. Özel docker görüntüsü, gerekli cran/github paketleri gibi RScriptStep gereksinimlerini belirtmek için bir RunConfiguration kullanmanız gerekir.

RScriptStep ile çalışmak için en iyi yöntem, betikler ve adımla ilişkili bağımlı dosyalar için ayrı bir klasör kullanmak ve bu klasörü parametresiyle source_directory belirtmektir. Bu en iyi uygulamanın iki avantajı vardır. İlk olarak, yalnızca adım için gerekenler anlık görüntülendiğinden, adım için oluşturulan anlık görüntünün boyutunu azaltmaya yardımcı olur. İkinci olarak, adımın önceki çalıştırmadan elde edilen çıkışı, anlık görüntünün yeniden yüklenmesini source_directory tetikleyecek bir değişiklik yapılmazsa yeniden kullanılabilir.

Aşağıdaki kod örneği, bir makine öğrenmesi eğitim senaryosunda RScriptStep'in nasıl kullanılacağını gösterir.


   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)

Genel olarak işlem hattı oluşturma hakkında daha fazla bilgi için bkz https://aka.ms/pl-first-pipeline . RSection hakkında daha fazla ayrıntı için bkz https://docs.microsoft.com/en-us/python/api/azureml-core/azureml.core.environment.rsection .

Yöntemler

create_node

RScriptStep için bir düğüm oluşturun ve bunu belirtilen grafiğe ekleyin.

KALDIRIL -MIŞ. Bunun yerine öğesini CommandStep kullanın. Örnek için bkz. CommandStep ile işlem hatlarında R betiklerini çalıştırma.

Bu yöntem doğrudan kullanılmak üzere tasarlanmamıştır. Bu adımla bir işlem hattı örneği oluşturulduğunda, Azure ML bu yöntem aracılığıyla gerekli parametreleri otomatik olarak geçirir, böylece adım iş akışını temsil eden bir işlem hattı grafiğine eklenebilir.

create_node

RScriptStep için bir düğüm oluşturun ve bunu belirtilen grafiğe ekleyin.

KALDIRIL -MIŞ. Bunun yerine öğesini CommandStep kullanın. Örnek için bkz. CommandStep ile işlem hatlarında R betiklerini çalıştırma.

Bu yöntem doğrudan kullanılmak üzere tasarlanmamıştır. Bu adımla bir işlem hattı örneği oluşturulduğunda, Azure ML bu yöntem aracılığıyla gerekli parametreleri otomatik olarak geçirir, böylece adım iş akışını temsil eden bir işlem hattı grafiğine eklenebilir.

create_node(graph, default_datastore, context)

Parametreler

Name Description
graph
Gerekli
Graph

Düğümün ekleneceği graf nesnesi.
default_datastore
Gerekli
Union[AbstractAzureStorageDatastore, AzureDataLakeDatastore]

Varsayılan veri deposu.
context
Gerekli
<xref:azureml.pipeline.core._GraphContext>

Grafik bağlamı.

Döndürülenler

Tür Description
Node

Oluşturulan düğüm.