OutputPortBinding クラス

  • リファレンス

パイプライン ステップの名前付き出力を定義します。

OutputPortBinding を使用して、ステップによって生成されるデータの型と、データの生成方法を指定できます。 InputPortBinding と共に使用して、ステップの出力が別のステップの必須の入力であることを指定できます。

OutputPortBinding を初期化します。

継承
builtins.object
OutputPortBinding

コンストラクター

OutputPortBinding(name, datastore=None, output_name=None, bind_mode='mount', path_on_compute=None, is_directory=None, overwrite=None, data_type=None, pipeline_output_name=None, training_output=None, dataset_registration=None, dataset_output=None)

パラメーター

name
str
必須

文字、数字、アンダースコアのみを含めることができる OutputPortBinding オブジェクトの名前。

datastore
Union[AbstractAzureStorageDatastore, AzureDataLakeDatastore]
既定値: None

PipelineData が置かれるデータストア。

output_name
str
既定値: None

None の名前が使用されている場合は、出力の名前。 文字、数字、アンダースコアのみを含めることができます。

bind_mode
str
既定値: mount

生成ステップでデータにアクセスするために "upload"、"mount"、または "hdfs" のどのメソッドを使用するかを指定します。

path_on_compute
str
既定値: None

"upload" モードの場合、モジュールが出力を書き込むパス。

is_directory
bool
既定値: None

出力がディレクトリかまたは単一のファイルかを示します。

overwrite
bool
既定値: None

"upload" モードの場合、既存のデータを上書きするかどうかを示します。

data_type
str
既定値: None

任意。 データ型を使用すると、予想される出力の型を指定したり、使用ステップでのデータの使用方法の詳細を指定したりできます。 任意のユーザー定義文字列を指定できます。

pipeline_output_name
str
既定値: None

指定した場合、この出力はPipelineRun.get_pipeline_output() を使用して利用できます。 パイプラインの出力名は、パイプライン内で一意である必要があります。

training_output
TrainingOutput
既定値: None

トレーニング結果の出力を定義します。 これは、メトリックやモデルなどの異なる種類の出力を生成する、特定のトレーニングに対してのみ必要です。 たとえば、AutoMLStep はメトリックとモデルを生成します。 また、最適なモデルを取得するために使用される、特定のトレーニング イテレーションまたはメトリックを定義することもできます。 HyperDriveStep では、出力に含める特定のモデル ファイルを定義することもできます。

dataset_registration
DatasetRegistration
既定値: None

任意。 これは内部パラメーターです。 代わりに PipelineData.as_dataset を使用する必要があります。

dataset_output
OutputDatasetConfig
既定値: None

任意。 これは内部パラメーターです。 代わりに OutputFileDatasetConfig を使用する必要があります。

name
str
必須

文字、数字、アンダースコアのみを含めることができる OutputPortBinding オブジェクトの名前。

datastore
Union[AbstractAzureStorageDatastore, AzureDataLakeDatastore]
必須

PipelineData が置かれるデータストア。

output_name
str
必須

None の名前が使用されている場合は、出力の名前。 文字、数字、アンダースコアのみを含めることができます。

bind_mode
str
必須

生成ステップでデータにアクセスするために "upload"、"mount"、または "hdfs" のどのメソッドを使用するかを指定します。

path_on_compute
str
必須

"upload" モードの場合、モジュールが出力を書き込むパス。

is_directory
bool
必須

出力がディレクトリの場合

overwrite
bool
必須

"upload" モードの場合、既存のデータを上書きするかどうかを示します。

data_type
str
必須

任意。 データ型を使用すると、予想される出力の型を指定したり、使用ステップでのデータの使用方法の詳細を指定したりできます。 任意のユーザー定義文字列を指定できます。

pipeline_output_name
str
必須

指定した場合、この出力はPipelineRun.get_pipeline_output() を使用して利用できます。 パイプラインの出力名は、パイプライン内で一意である必要があります。

training_output
TrainingOutput
必須

トレーニング結果の出力を定義します。 これは、メトリックやモデルなどの異なる種類の出力を生成する、特定のトレーニングに対してのみ必要です。 たとえば、AutoMLStep はメトリックとモデルを生成します。 また、最適なモデルを取得するために使用される、特定のトレーニング イテレーションまたはメトリックを定義することもできます。 HyperDriveStep では、出力に含める特定のモデル ファイルを定義することもできます。

dataset_registration
DatasetRegistration
必須

任意。 これは内部パラメーターです。 代わりに PipelineData.as_dataset を使用する必要があります。

dataset_output
OutputDatasetConfig
必須

任意。 これは内部パラメーターです。 代わりに OutputFileDatasetConfig を使用する必要があります。

注釈

パイプラインを構築してステップの入力と出力を指定する場合、 PipelineData と同様の方法で OutputPortBinding を使用できます。 違いは、別のステップへの入力として使用するには、OutputPortBinding を InputPortBinding と組み合わせて使用する必要があることです。

OutputPortBinding を使用してパイプラインを構築する例を次に示します。


   from azureml.pipeline.core import OutputPortBinding, InputPortBinding, Pipeline
   from azureml.pipeline.steps import PythonScriptStep

   step_1_output = OutputPortBinding("output", datastore=datastore)

   step_1 = PythonScriptStep(
       name='process data',
       script_name="process_data.py",
       compute_target=compute,
       arguments=["--output", step_1_output],
       outputs=[step_1_output]
   )

   step_2_input = InputPortBinding("input", bind_object=step_1_output)

   step_2 = PythonScriptStep(
       name='train',
       script_name="train.py",
       compute_target=compute,
       arguments=["--input", step_2_input],
       inputs=[step_2_input]
   )

   pipeline = Pipeline(workspace=workspace, steps=[step_1, step_2])

ここでは、2 つの手順でパイプラインを作成します。 最初にプロセス ステップが実行され、その完了後にトレーニング ステップが実行されます。 Azure ML では、OutputPortBinding オブジェクトで説明されているように、プロセス ステップによって生成されるた出力をトレーニング ステップに提供します。

属性

bind_mode

生成ステップでデータを作成するために使用されるモード ("upload" または "mount" または "hdfs") を取得します。

戻り値

バインド モード。

の戻り値の型 :

str

data_type

生成されるデータの型を取得します。

戻り値

データ型名。

の戻り値の型 :

str

dataset_registration

データセットの登録情報を取得します。

戻り値

データセットの登録情報。

の戻り値の型 :

DatasetRegistration

datastore

PipelineData が置かれるデータストア。

戻り値

データストア オブジェクト。

の戻り値の型 :

Union[<xref:azureml.data.azure_storage_datastore.AbstractAzureStorageDatastore,azureml.data.azure_data_lake_datastore.AzureDataLakeDatastore>]

is_directory

出力がディレクトリであるかどうかを示します。

戻り値

is_directory

の戻り値の型 :

bool

name

OutputPortBinding オブジェクトの名前。

戻り値

名前。

の戻り値の型 :

str

overwrite

"upload" モードの場合は、既存のデータを上書きするかどうかを示します。

戻り値

_overwrite

の戻り値の型 :

bool

path_on_compute

"upload" モードの場合、モジュールが出力を書き込むパス。

戻り値

path_on_compute

の戻り値の型 :

str

pipeline_output_name

この OutputPortBinding に対応するパイプライン出力の名前を取得します。

戻り値

パイプラインの出力名。

の戻り値の型 :

str

training_output

トレーニングの出力を取得します。

戻り値

トレーニングの出力

の戻り値の型 :

TrainingOutput