PortDataReference Класс

Моделирует данные, связанные с выходными данными завершенного StepRun.

Объект PortDataReference можно использовать для загрузки выходных данных, созданных с помощью StepRun. Его также можно использовать в качестве входных данных этапа в будущем конвейере.

Инициализация PortDataReference.

Наследование

builtins.object

PortDataReference

Конструктор

PortDataReference(context, pipeline_run_id, data_reference, step_run=None)

Параметры

Имя	Описание
context Обязательно	<xref:azureml.pipeline.core._GraphContext> Объект контекста графа.
pipeline_run_id Обязательно	str Идентификатор выполнения конвейера, в рамках которого выданы выходные данные.
data_reference Обязательно	DataReference Объект ссылки на данные.
step_run	StepRun Объект StepRun, который создал данные. значение по умолчанию: None
context Обязательно	<xref:azureml.pipeline.core._GraphContext> Объект контекста графа.
pipeline_run_id Обязательно	str Идентификатор выполнения конвейера, в рамках которого выданы выходные данные.
data_reference Обязательно	DataReference Объект ссылки на данные.
step_run Обязательно	StepRun Объект StepRun, который создал данные.

Комментарии

Объект PortDataReference указывает на данные, созданные завершенным StepRun.

Получение PortDataReference из PipelineRun и загрузка выходных данных следующим образом:

   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])

В этом примере вновь сконструированный конвейер будет использовать выходные данные, созданные завершенным 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)

Параметры

Имя	Описание
input_name	str Указание имени для этих входных данных. значение по умолчанию: None
path_on_compute	str Путь к вычислительному ресурсу, в который нужно загрузить данные. значение по умолчанию: None
overwrite	bool Позволяет указать, следует ли перезаписывать существующие данные. значение по умолчанию: None

Возвращаемое значение

Тип	Описание
InputPortBinding	InputPortBinding с этим PortDataReference в качестве источника.

as_input

Создание InputPortBinding и указание имени входных данных (но используется режим по умолчанию).

as_input(input_name)

Параметры

Имя	Описание
input_name Обязательно	str Указание имени для этих входных данных.

Возвращаемое значение

Тип	Описание
InputPortBinding	InputPortBinding с этим PortDataReference в качестве источника.

as_mount

Использование PortDataReference в качестве входных данных этапа в режиме подключения.

as_mount(input_name=None)

Параметры

Имя	Описание
input_name	str Указание имени для этих входных данных. значение по умолчанию: None

Возвращаемое значение

Тип	Описание
InputPortBinding	InputPortBinding с этим PortDataReference в качестве источника.

create_input_binding

Создание привязки входных данных с этим PortDataReference в качестве источника.

create_input_binding(input_name=None, mode=None, path_on_compute=None, overwrite=None)

Параметры

Имя	Описание
input_name	str Имя входа. значение по умолчанию: None
mode	str Режим для доступа к PortDataReference (подключение или загрузка). значение по умолчанию: None
path_on_compute	str Для режима загрузки путь к вычислительному ресурсу, в котором будут размещаться данные. значение по умолчанию: None
overwrite	bool Для режима загрузки указывает, следует ли перезаписывать существующие данные. значение по умолчанию: None

Возвращаемое значение

Тип	Описание
InputPortBinding	InputPortBinding с этим PortDataReference в качестве источника.

download

Загрузка данных, представленных PortDataReference.

download(local_path, overwrite=None, show_progress=None)

Параметры

Имя	Описание
local_path Обязательно	str Локальный путь для загрузки.
overwrite	bool Если задано значение True, то существующий файл будет перезаписываться. По умолчанию используется значение False. значение по умолчанию: None
show_progress	bool Отображение хода загрузки в консоли. По умолчанию используется значение True. значение по умолчанию: None

Возвращаемое значение

Тип	Описание
int	Количество успешно загруженных файлов.

Атрибуты

datastore

Получение хранилища данных, связанного с PortDataReference.

Возвращаемое значение

Тип	Описание
Datastore	Объект хранилища данных.

datastore_name

Получение имени хранилища данных, связанного с PortDataReference.

Возвращаемое значение

Тип	Описание
str	Имя хранилища данных.

name

Получение имени этой ссылки на данные.

Возвращаемое значение

Тип	Описание
str	Имя ссылки на данные.

path_on_datastore

Получение пути к хранилищу данных для PortDataReference.

Возвращаемое значение

Тип	Описание
str	Путь к хранилищу данных.