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.

Inicialice PortDataReference.

Herencia

builtins.object

PortDataReference

Constructor

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

Parámetros

context

<xref:azureml.pipeline.core._GraphContext>

Requerido

El objeto de contexto de grafo.

pipeline_run_id

str

Requerido

Id. de la ejecución de canalización que produjo la salida.

data_reference

DataReference

Requerido

Objeto de referencia de datos.

step_run

StepRun

valor predeterminado: None

Objeto StepRun que produjo los datos.

context

<xref:azureml.pipeline.core._GraphContext>

Requerido

El objeto de contexto de grafo.

pipeline_run_id

str

Requerido

Id. de la ejecución de canalización que produjo la salida.

data_reference

DataReference

Requerido

Objeto de referencia de datos.

step_run

StepRun

Requerido

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

input_name

str

valor predeterminado: None

Especifica un nombre para esta entrada.

path_on_compute

str

valor predeterminado: None

Ruta de acceso del proceso en el que se descargarán los datos.

overwrite

bool

valor predeterminado: None

Se usa para indicar si se quiere sobrescribir los datos existentes.

Devoluciones

InputPortBinding con PortDataReference como origen.

Tipo de valor devuelto

InputPortBinding

as_input

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

as_input(input_name)

Parámetros

input_name

str

Requerido

Se usa para especificar un nombre para esta entrada.

Devoluciones

InputPortBinding con PortDataReference como origen.

Tipo de valor devuelto

InputPortBinding

as_mount

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

as_mount(input_name=None)

Parámetros

input_name

str

valor predeterminado: None

Se usa para especificar un nombre para esta entrada.

Devoluciones

InputPortBinding con PortDataReference como origen.

Tipo de valor devuelto

InputPortBinding

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

input_name

str

valor predeterminado: None

Nombre de la entrada.

mode

str

valor predeterminado: None

Modo de acceso a PortDataReference ("mount" o "download").

path_on_compute

str

valor predeterminado: None

Para el modo "download", la ruta de acceso en el proceso donde residirán los datos.

overwrite

bool

valor predeterminado: None

Para el modo "download", si se van a sobrescribir los datos existentes.

Devoluciones

InputPortBinding con PortDataReference como origen.

Tipo de valor devuelto

InputPortBinding

download

Descarga los datos representados por PortDataReference.

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

Parámetros

local_path

str

Requerido

Ruta de acceso local donde se descargará.

overwrite

bool

valor predeterminado: None

Si es true, sobrescribe el archivo existente, el valor predeterminado es False.

show_progress

bool

valor predeterminado: None

Muestra el progreso de la descarga en la consola, el valor predeterminado es True.

Devoluciones

Número de archivos descargados correctamente.

Tipo de valor devuelto

int

Atributos

datastore

Obtiene el almacén de datos asociado a PortDataReference.

Devoluciones

Objeto de almacén de datos.

Tipo de valor devuelto

Datastore

datastore_name

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

Devoluciones

Nombre del almacén de datos.

Tipo de valor devuelto

str

name

Obtiene el nombre de esta referencia de datos.

Devoluciones

Nombre de referencia de datos.

Tipo de valor devuelto

str

path_on_datastore

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

Devoluciones

Ruta de acceso en el almacén de datos.

Tipo de valor devuelto

str