PortDataReference 類別
建立與已完成 StepRun 輸出相關聯的數據模型。
PortDataReference 物件可用來下載 所產生的 StepRun輸出數據。 它也可以作為未來管線中的步驟輸入。
初始化 PortDataReference。
建構函式
PortDataReference(context, pipeline_run_id, data_reference, step_run=None)
參數
| 名稱 | Description |
|---|---|
|
context
必要
|
<xref:azureml.pipeline.core._GraphContext>
圖形內容物件。 |
|
pipeline_run_id
必要
|
產生輸出之管線執行的標識碼。 |
|
data_reference
必要
|
數據參考物件。 |
|
step_run
|
產生數據的 StepRun 物件。 預設值: None
|
|
context
必要
|
<xref:azureml.pipeline.core._GraphContext>
圖形內容物件。 |
|
pipeline_run_id
必要
|
產生輸出之管線執行的標識碼。 |
|
data_reference
必要
|
數據參考物件。 |
|
step_run
必要
|
產生數據的 StepRun 物件。 |
備註
PortDataReference 指向已完成 StepRun所產生的數據。
從 PipelineRun 取得 PortDataReference,並下載輸出數據,如下所示:
from azureml.pipeline.core import PipelineRun, StepRun, PortDataReference
pipeline_run = PipelineRun(experiment, "<pipeline_run_id>")
step_run = pipeline_run.find_step_run("<node_name>")[0]
port_data_reference = step_run.get_output_data("<output_name>")
port_data_reference.download(local_path="path")
PortDataReference 可用來做為 中步驟的 Pipeline輸入,類似於使用 DataReference。
使用 PortDataReference 做為步驟輸入的範例如下:
from azureml.pipeline.core import PortDataReference, Pipeline, PipelineRun
from azureml.pipeline.steps import PythonScriptStep
pipeline_run = PipelineRun(experiment, "<pipeline_run_id>")
step_run = pipeline_run.find_step_run("<node_name>")[0]
port_data_reference = step_run.get_output_data("<output_name>")
step_1 = PythonScriptStep(
name='train',
script_name="train.py",
compute_target=compute,
arguments=["--input", port_data_reference],
inputs=[port_data_reference]
)
pipeline = Pipeline(workspace=workspace, steps=[step_1])
在此範例中,新建構的 Pipeline 會使用已完成 PipelineRun 所建立的輸出作為定型步驟的輸入。
方法
| as_download |
使用 PortDataReference 作為透過「下載」模式的逐步輸入。 |
| as_input |
建立 InputPortBinding 並指定輸入名稱(但使用預設模式)。 |
| as_mount |
使用 PortDataReference 作為透過「掛接」模式的逐步輸入。 |
| create_input_binding |
使用此 PortDataReference 作為來源建立輸入系結。 |
| download |
下載 PortDataReference 所代表的數據。 |
as_download
使用 PortDataReference 作為透過「下載」模式的逐步輸入。
as_download(input_name=None, path_on_compute=None, overwrite=None)
參數
| 名稱 | Description |
|---|---|
|
input_name
|
指定此輸入的名稱。 預設值: None
|
|
path_on_compute
|
要下載數據之計算的路徑。 預設值: None
|
|
overwrite
|
使用 來指出是否要覆寫現有的數據。 預設值: None
|
傳回
| 類型 | Description |
|---|---|
|
以這個 PortDataReference 做為來源的 InputPortBinding。 |
as_input
建立 InputPortBinding 並指定輸入名稱(但使用預設模式)。
as_input(input_name)
參數
| 名稱 | Description |
|---|---|
|
input_name
必要
|
使用 來指定此輸入的名稱。 |
傳回
| 類型 | Description |
|---|---|
|
以這個 PortDataReference 做為來源的 InputPortBinding。 |
as_mount
使用 PortDataReference 作為透過「掛接」模式的逐步輸入。
as_mount(input_name=None)
參數
| 名稱 | Description |
|---|---|
|
input_name
|
使用 來指定此輸入的名稱。 預設值: None
|
傳回
| 類型 | Description |
|---|---|
|
以這個 PortDataReference 做為來源的 InputPortBinding。 |
create_input_binding
使用此 PortDataReference 作為來源建立輸入系結。
create_input_binding(input_name=None, mode=None, path_on_compute=None, overwrite=None)
參數
| 名稱 | Description |
|---|---|
|
input_name
|
輸入的名稱。 預設值: None
|
|
mode
|
存取 PortDataReference 的模式(“mount” 或 “download” )。 預設值: None
|
|
path_on_compute
|
針對「下載」模式,計算數據所在的路徑。 預設值: None
|
|
overwrite
|
如果是「下載」模式,是否要覆寫現有的數據。 預設值: None
|
傳回
| 類型 | Description |
|---|---|
|
以這個 PortDataReference 做為來源的 InputPortBinding。 |