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

針對「上傳」模式,模組寫入輸出的目標路徑。

is_directory
bool
預設值: None

輸出是目錄或單一檔案。

overwrite
bool
預設值: None

針對「上傳」模式,是否要覆寫現有的資料。

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 intead。

name
str
必要

OutputPortBinding 物件的名稱,該物件只能包含字母、數位和底線。

datastore
Union[AbstractAzureStorageDatastore, AzureDataLakeDatastore]
必要

PipelineData 所在的資料存放區。

output_name
str
必要

如果使用 None 名稱,則輸出的名稱。 只能包含字母、數位和底線。

bind_mode
str
必要

指定產生步驟將使用 「upload」 或 「mount」 或 「hdfs」 方法來存取資料。

path_on_compute
str
必要

針對「上傳」模式,模組寫入輸出的目標路徑。

is_directory
bool
必要

如果輸出是目錄,則為

overwrite
bool
必要

針對「上傳」模式,是否要覆寫現有的資料。

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 intead。

備註

OutputPortBinding 的使用方式 PipelineData 與建置管線以指定步驟輸入和輸出的方式類似。 差異在於 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])

這會建立具有兩個步驟的管線。 程式步驟會先執行,然後在完成之後執行定型步驟。 Azure ML 會將處理常式步驟所產生的輸出提供給定型步驟,如 OutputPortBinding 物件所述。

屬性

bind_mode

取得模式 (「upload」 或 「mount」 或 「hdfs」,) 產生步驟將用來建立資料。

傳回

系結模式。

傳回類型

str

data_type

取得將產生的資料類型。

傳回

資料類型名稱。

傳回類型

str

dataset_registration

取得資料集註冊資訊。

傳回

資料集註冊資訊。

傳回類型

datastore

PipelineData 所在的資料存放區。

傳回

Datastore 物件。

傳回類型

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

is_directory

輸出是否為目錄。

傳回

is_directory

傳回類型

name

OutputPortBinding 物件的名稱。

傳回

名稱。

傳回類型

str

overwrite

針對 「上傳」模式,指出是否要覆寫現有的資料。

傳回

_覆蓋

傳回類型

path_on_compute

針對「上傳」模式,模組寫入輸出的目標路徑。

傳回

path_on_compute

傳回類型

str

pipeline_output_name

取得對應至此 OutputPortBinding 的管線輸出名稱。

傳回

管線輸出名稱。

傳回類型

str

training_output

取得定型輸出。

傳回

定型輸出

傳回類型