RScriptStep クラス

注

これは試験的なクラスであり、いつでも変更される可能性があります。詳細については、https://aka.ms/azuremlexperimental を参照してください。

R スクリプトを実行する Azure ML パイプラインステップを作成します。

廃止。代わりに CommandStep を使用してください。例については、「 CommandStep を使用してパイプラインで R スクリプトを実行する方法」を参照してください。

コンストラクター

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)

パラメーター

名前	説明
script_name 必須	str [必須] `source_directory`を基準とした R スクリプトの名前。
name 必須	str ステップの名前。指定しない場合は、 `script_name` が使用されます。
arguments 必須	list R スクリプトファイルのコマンドライン引数。引数は、RunConfiguration の `arguments` パラメーターを使用して計算に渡されます。特別なシンボルなどの引数を処理する方法の詳細については、 RunConfigurationを参照してください。
compute_target 必須	Union[DsvmCompute, AmlCompute, RemoteCompute, HDInsightCompute, str, tuple] [必須]使用するコンピューティング先。指定しない場合は、 `runconfig` のターゲットが使用されます。このパラメーターは、コンピューティング先オブジェクトまたはワークスペース上のコンピューティング先の文字列名として指定できます。必要に応じて、パイプラインの作成時にコンピューティングターゲットを使用できない場合は、コンピューティングターゲットオブジェクトをフェッチしないように ('コンピューティングターゲット名'、'コンピューティングターゲットの種類') のタプルを指定できます (AmlCompute 型は 'AmlCompute' で RemoteCompute 型は 'VirtualMachine' です)。
runconfig 必須	RunConfiguration [必須]実験でトレーニング実行を送信するために必要な情報をカプセル化する実行構成。これは、 RSectionで定義できる R 実行構成を定義するために必要です。この手順では、RSection が必要です。
runconfig_pipeline_params 必須	dict[str, PipelineParameter] キーと値のペアをそれぞれ runconfig プロパティの名前を持ち、そのプロパティの PipelineParameter を使用して実行時に runconfig プロパティをオーバーライドします。サポートされている値: 'NodeCount'、'MpiProcessCountPerNode'、'TensorflowWorkerCount'、'TensorflowParameterServerCount'
inputs 必須	list[Union[InputPortBinding, DataReference, PortDataReference, PipelineData, PipelineOutputFileDataset, PipelineOutputTabularDataset, DatasetConsumptionConfig]] 入力ポートバインドの一覧。
outputs 必須	list[Union[PipelineData, OutputDatasetConfig, PipelineOutputAbstractDataset, OutputPortBinding]] 出力ポートバインドの一覧。
params 必須	dict 環境変数として "AML_PARAMETER_" で登録された名前と値のペアのディクショナリ。
source_directory 必須	str 手順で使用する R スクリプト、conda env、およびその他のリソースを含むフォルダー。
use_gpu 必須	bool 実験を実行する環境が GPU をサポートする必要があるかどうかを示します。 True の場合、GPU ベースの既定の Docker イメージが環境で使用されます。 False の場合、CPU ベースのイメージが使用されます。既定の Docker イメージ (CPU または GPU) は、ユーザーが `base_image` パラメーターと `base_dockerfile` パラメーターの両方を設定していない場合にのみ使用されます。この設定は、Docker 対応のコンピューティングターゲットでのみ使用されます。 https://docs.microsoft.com/en-us/python/api/azureml-core/azureml.core.environment.dockersectionの詳細については、`base_image`を参照してください。
custom_docker_image 必須	str トレーニングに使用するイメージのビルド元となる Docker イメージの名前。設定しない場合は、既定の CPU ベースのイメージが基本イメージとして使用されます。これは非推奨となり、今後のリリースで削除される予定です。代わりに、DockerSection でbase_imageを使用してください。
cran_packages 必須	list インストールする CRAN パッケージ。これは非推奨となり、今後のリリースで削除される予定です。代わりにRSection.cran_packagesを使用してください。
github_packages 必須	list インストールする GitHub パッケージ。これは非推奨となり、今後のリリースで削除される予定です。代わりにRSection.github_packagesを使用してください。
custom_url_packages 必須	list ローカル、ディレクトリ、またはカスタム URL からインストールするパッケージ。これは非推奨となり、今後のリリースで削除される予定です。代わりにRSection.custom_url_packagesを使用してください。
allow_reuse 必須	bool 同じ設定で再実行するときに、前の結果をステップで再利用するかどうかを示します。再利用は既定で有効になっています。ステップの内容 (スクリプト/依存関係) と入力とパラメーターが変更されていない場合は、この手順の前の実行からの出力が再利用されます。ステップを再利用すると、ジョブをコンピューティングに送信する代わりに、前の実行の結果が後続のステップですぐに使用できるようになります。 Azure Machine Learning データセットを入力として使用する場合、再利用は、基になるデータが変更されたかどうかではなく、データセットの定義が変更されたかどうかによって決まります。
version 必須	str ステップの機能の変更を示すオプションのバージョンタグ。
script_name 必須	str [必須] `source_directory`を基準とした R スクリプトの名前。
name 必須	str ステップの名前。指定しない場合は、 `script_name` が使用されます。
arguments 必須	list R スクリプトファイルのコマンドライン引数。引数は、RunConfiguration の `arguments` パラメーターを使用して計算に渡されます。特別なシンボルなどの引数を処理する方法の詳細については、 RunConfigurationを参照してください。
compute_target 必須	Union[DsvmCompute, AmlCompute, RemoteCompute, HDInsightCompute, str, tuple] [必須]使用するコンピューティング先。指定しない場合は、 `runconfig` のターゲットが使用されます。このパラメーターは、コンピューティング先オブジェクトまたはワークスペース上のコンピューティング先の文字列名として指定できます。必要に応じて、パイプラインの作成時にコンピューティングターゲットを使用できない場合は、コンピューティングターゲットオブジェクトをフェッチしないように ('コンピューティングターゲット名'、'コンピューティングターゲットの種類') のタプルを指定できます (AmlCompute 型は 'AmlCompute' で RemoteCompute 型は 'VirtualMachine' です)。
runconfig 必須	RunConfiguration [必須]実験でトレーニング実行を送信するために必要な情報をカプセル化する実行構成。これは、 RSectionで定義できる R 実行構成を定義するために必要です。この手順では、RSection が必要です。
runconfig_pipeline_params 必須	dict[str, PipelineParameter] キーと値のペアをそれぞれ runconfig プロパティの名前を持ち、そのプロパティの PipelineParameter を使用して実行時に runconfig プロパティをオーバーライドします。サポートされている値: 'NodeCount'、'MpiProcessCountPerNode'、'TensorflowWorkerCount'、'TensorflowParameterServerCount'
inputs 必須	list[Union[InputPortBinding, DataReference, PortDataReference, PipelineData, PipelineOutputFileDataset, PipelineOutputTabularDataset, DatasetConsumptionConfig]] 入力ポートバインドの一覧。
outputs 必須	list[Union[PipelineData, PipelineOutputAbstractDataset, OutputPortBinding]] 出力ポートバインドの一覧。
params 必須	dict 環境変数として "AML_PARAMETER_" で登録された名前と値のペアのディクショナリ。
source_directory 必須	str 手順で使用する R スクリプト、conda env、およびその他のリソースを含むフォルダー。
use_gpu 必須	bool 実験を実行する環境が GPU をサポートする必要があるかどうかを示します。 True の場合、GPU ベースの既定の Docker イメージが環境で使用されます。 False の場合、CPU ベースのイメージが使用されます。既定の Docker イメージ (CPU または GPU) は、ユーザーが `base_image` パラメーターと `base_dockerfile` パラメーターの両方を設定していない場合にのみ使用されます。この設定は、Docker 対応のコンピューティングターゲットでのみ使用されます。 https://docs.microsoft.com/en-us/python/api/azureml-core/azureml.core.environment.dockersectionの詳細については、`base_image`を参照してください。
custom_docker_image 必須	str トレーニングに使用するイメージのビルド元となる Docker イメージの名前。設定しない場合は、既定の CPU ベースのイメージが基本イメージとして使用されます。これは非推奨となり、今後のリリースで削除される予定です。代わりに、DockerSection でbase_imageを使用してください。
cran_packages 必須	list インストールする CRAN パッケージ。これは非推奨となり、今後のリリースで削除される予定です。代わりにRSection.cran_packagesを使用してください。
github_packages 必須	list インストールする GitHub パッケージ。これは非推奨となり、今後のリリースで削除される予定です。代わりにRSection.github_packagesを使用してください。
custom_url_packages 必須	list ローカル、ディレクトリ、またはカスタム URL からインストールするパッケージ。これは非推奨となり、今後のリリースで削除される予定です。代わりにRSection.custom_url_packagesを使用してください。
allow_reuse 必須	bool 同じ設定で再実行するときに、前の結果をステップで再利用するかどうかを示します。再利用は既定で有効になっています。ステップの内容 (スクリプト/依存関係) と入力とパラメーターが変更されていない場合は、この手順の前の実行からの出力が再利用されます。ステップを再利用すると、ジョブをコンピューティングに送信する代わりに、前の実行の結果が後続のステップですぐに使用できるようになります。 Azure Machine Learning データセットを入力として使用する場合、再利用は、基になるデータが変更されたかどうかではなく、データセットの定義が変更されたかどうかによって決まります。
version 必須	str ステップの機能の変更を示すオプションのバージョンタグ。

注釈

RScriptStep は、コンピューティング先で R スクリプトを実行するための基本的な組み込み手順です。スクリプト名とその他の省略可能なパラメーター (スクリプトの引数、コンピューティングターゲット、入力、出力など) を受け取ります。 RunConfigurationを使用して、カスタム Docker イメージ、必須の cran/github パッケージなど、RScriptStep の要件を指定する必要があります。

RScriptStep を使用する場合のベストプラクティスは、スクリプトとステップに関連付けられている依存ファイルに別のフォルダーを使用し、そのフォルダーを source_directory パラメーターで指定することです。このベストプラクティスに従う場合、2 つの利点があります。 1 つ目は、ステップに必要なスナップショットのみがスナップショットされるため、ステップ用に作成されるスナップショットのサイズを小さくするのに役立ちます。次に、スナップショットの再アップロードをトリガーする source_directory に変更がない場合は、前の実行からのステップの出力を再利用できます。

次のコード例は、機械学習トレーニングシナリオで RScriptStep を使用する方法を示しています。


   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 を参照してください。 RSection の詳細については、 https://docs.microsoft.com/en-us/python/api/azureml-core/azureml.core.environment.rsection を参照してください。

メソッド

create_node

RScriptStep のノードを作成し、指定したグラフに追加します。

このメソッドは、直接使用するためのものではありません。この手順でパイプラインがインスタンス化されると、Azure ML は、このメソッドに必要なパラメーターを自動的に渡して、そのステップをワークフローを表すパイプライングラフに追加できるようにします。

create_node

RScriptStep のノードを作成し、指定したグラフに追加します。

create_node(graph, default_datastore, context)

パラメーター

名前	説明
graph 必須	Graph ノードを追加するグラフオブジェクト。
default_datastore 必須	Union[AbstractAzureStorageDatastore, AzureDataLakeDatastore] 既定のデータストア。
context 必須	<xref:azureml.pipeline.core._GraphContext> グラフコンテキスト。

戻り値

型	説明
Node	作成されたノード。

次の方法で共有

RScriptStep クラス

コンストラクター

パラメーター

注釈

メソッド

create_node

パラメーター

戻り値

フィードバック