PortDataReference Clase

Modela los datos asociados a una salida de un elemento StepRun completado.

Se puede usar un objeto PortDataReference para descargar los datos de salida que StepRun generó. También se puede usar como entrada de un paso en una futura canalización.

Inicializar PortDataReference.

Herencia

builtins.object

PortDataReference

Constructor

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

Parámetros

Nombre	Description
context Requerido	<xref:azureml.pipeline.core._GraphContext> El objeto de contexto de grafo.
pipeline_run_id Requerido	str Id. de la ejecución de canalización que produjo la salida.
data_reference Requerido	DataReference Objeto de referencia de datos.
step_run	StepRun Objeto StepRun que produjo los datos. Valor predeterminado: None
context Requerido	<xref:azureml.pipeline.core._GraphContext> El objeto de contexto de grafo.
pipeline_run_id Requerido	str Id. de la ejecución de canalización que produjo la salida.
data_reference Requerido	DataReference Objeto de referencia de datos.
step_run Requerido	StepRun Objeto StepRun que produjo los datos.

Comentarios

PortDataReference apunta a los datos generados por un objeto StepRun completado.

Obtiene un PortDataReference de un elemento PipelineRun y descarga los datos de salida como se muestra a continuación:

   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 se puede usar como entrada para un paso de Pipeline, de forma similar a usar DataReference.

Un ejemplo del uso de PortDataReference como entrada de paso es el siguiente:

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

En este ejemplo, la canalización recién construida usará la salida que el elemento PipelineRun completado creó como entrada para el paso de entrenamiento.

Métodos

as_download	Consume PortDataReference como entrada de paso a través del modo "download".
as_input	Crea un objeto InputPortBinding y especifica un nombre de entrada (pero usa el modo predeterminado).
as_mount	Consume PortDataReference como entrada de paso a través del modo "mount".
create_input_binding	Crea un enlace de entrada con este PortDataReference como origen.
download	Descarga los datos representados por PortDataReference.

as_download

Consume PortDataReference como entrada de paso a través del modo "download".

as_download(input_name=None, path_on_compute=None, overwrite=None)

Parámetros

Nombre	Description
input_name	str Especifica un nombre para esta entrada. Valor predeterminado: None
path_on_compute	str Ruta de acceso del proceso en el que se descargarán los datos. Valor predeterminado: None
overwrite	bool Se usa para indicar si se quiere sobrescribir los datos existentes. Valor predeterminado: None

Devoluciones

Tipo	Description
InputPortBinding	InputPortBinding con PortDataReference como origen.

as_input

Crea un objeto InputPortBinding y especifica un nombre de entrada (pero usa el modo predeterminado).

as_input(input_name)

Parámetros

Nombre	Description
input_name Requerido	str Se usa para especificar un nombre para esta entrada.

Devoluciones

Tipo	Description
InputPortBinding	InputPortBinding con PortDataReference como origen.

as_mount

Consume PortDataReference como entrada de paso a través del modo "mount".

as_mount(input_name=None)

Parámetros

Nombre	Description
input_name	str Se usa para especificar un nombre para esta entrada. Valor predeterminado: None

Devoluciones

Tipo	Description
InputPortBinding	InputPortBinding con PortDataReference como origen.

create_input_binding

Crea un enlace de entrada con este PortDataReference como origen.

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

Parámetros

Nombre	Description
input_name	str Nombre de la entrada. Valor predeterminado: None
mode	str Modo de acceso a PortDataReference ("mount" o "download"). Valor predeterminado: None
path_on_compute	str Para el modo "download", la ruta de acceso en el proceso donde residirán los datos. Valor predeterminado: None
overwrite	bool Para el modo "download", si se van a sobrescribir los datos existentes. Valor predeterminado: None

Devoluciones

Tipo	Description
InputPortBinding	InputPortBinding con PortDataReference como origen.

download

Descarga los datos representados por PortDataReference.

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

Parámetros

Nombre	Description
local_path Requerido	str Ruta de acceso local donde se descargará.
overwrite	bool Si es true, sobrescribe el archivo existente, el valor predeterminado es False. Valor predeterminado: None
show_progress	bool Muestra el progreso de la descarga en la consola, el valor predeterminado es True. Valor predeterminado: None

Devoluciones

Tipo	Description
int	Número de archivos descargados correctamente.

Atributos

datastore

Obtiene el almacén de datos asociado a PortDataReference.

Devoluciones

Tipo	Description
Datastore	Objeto de almacén de datos.

datastore_name

Obtiene el nombre del almacén de datos asociado a PortDataReference.

Devoluciones

Tipo	Description
str	Nombre del almacén de datos.

name

Obtiene el nombre de esta referencia de datos.

Devoluciones

Tipo	Description
str	Nombre de referencia de datos.

path_on_datastore

Obtiene la ruta de acceso en el almacén de datos para PortDataReference.

Devoluciones

Tipo	Description
str	Ruta de acceso en el almacén de datos.