PortDataReference Classe

Modelos de dados associados a uma saída de uma StepRun concluída.

Um objeto PortDataReference pode ser utilizado para transferir os dados de saída produzidos por um StepRun. Também pode ser utilizado como uma entrada de passo num futuro Pipeline.

Inicializar PortDataReference.

Herança

builtins.object

PortDataReference

Construtor

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

Parâmetros

Name	Description
context Necessário	<xref:azureml.pipeline.core._GraphContext> O objeto de contexto do gráfico.
pipeline_run_id Necessário	str O ID da execução do pipeline que produziu o resultado.
data_reference Necessário	DataReference O objeto de referência de dados.
step_run	StepRun O objeto StepRun que produziu os dados. valor predefinido: None
context Necessário	<xref:azureml.pipeline.core._GraphContext> O objeto de contexto do gráfico.
pipeline_run_id Necessário	str O ID da execução do pipeline que produziu o resultado.
data_reference Necessário	DataReference O objeto de referência de dados.
step_run Necessário	StepRun O objeto StepRun que produziu os dados.

Observações

Uma PortDataReference aponta para dados produzidos por um .StepRun

Obtenha uma PortDataReference a partir de um PipelineRun e transfira os dados de saída da seguinte forma:

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

Uma PortDataReference pode ser utilizada como uma entrada para um passo num Pipeline, semelhante a utilizar um DataReference.

Um exemplo para utilizar um PortDataReference como uma entrada de passo é o seguinte:

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

Neste exemplo, o Pipeline recentemente construído utilizará a saída que foi criada pelo PipelineRun concluído como uma entrada para o passo de preparação.

Métodos

as_download	Consuma o PortDataReference como uma entrada de passo através do modo de "transferência".
as_input	Crie um InputPortBinding e especifique um nome de entrada (mas utilize o modo predefinido).
as_mount	Consuma o PortDataReference como uma entrada de passo através do modo de "montagem".
create_input_binding	Crie o enlace de entrada com esta PortDataReference como a origem.
download	Transfira os dados representados pela PortDataReference.

as_download

Consuma o PortDataReference como uma entrada de passo através do modo de "transferência".

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

Parâmetros

Name	Description
input_name	str Especifique um nome para esta entrada. valor predefinido: None
path_on_compute	str O caminho na computação para o qual transferir os dados. valor predefinido: None
overwrite	bool Utilize para indicar se deve substituir os dados existentes. valor predefinido: None

Devoluções

Tipo	Description
InputPortBinding	O InputPortBinding com esta PortDataReference como a origem.

as_input

Crie um InputPortBinding e especifique um nome de entrada (mas utilize o modo predefinido).

as_input(input_name)

Parâmetros

Name	Description
input_name Necessário	str Utilize para especificar um nome para esta entrada.

Devoluções

Tipo	Description
InputPortBinding	O InputPortBinding com esta PortDataReference como a origem.

as_mount

Consuma o PortDataReference como uma entrada de passo através do modo de "montagem".

as_mount(input_name=None)

Parâmetros

Name	Description
input_name	str Utilize para especificar um nome para esta entrada. valor predefinido: None

Devoluções

Tipo	Description
InputPortBinding	O InputPortBinding com esta PortDataReference como a origem.

create_input_binding

Crie o enlace de entrada com esta PortDataReference como a origem.

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

Parâmetros

Name	Description
input_name	str O nome da entrada. valor predefinido: None
mode	str O modo para aceder à PortDataReference ("montagem" ou "download"). valor predefinido: None
path_on_compute	str Para o modo de "transferência", o caminho na computação dos dados irá residir. valor predefinido: None
overwrite	bool Para o modo de "transferência", quer substitua os dados existentes. valor predefinido: None

Devoluções

Tipo	Description
InputPortBinding	O InputPortBinding com esta PortDataReference como a origem.

download

Transfira os dados representados pela PortDataReference.

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

Parâmetros

Name	Description
local_path Necessário	str Caminho local para o qual transferir.
overwrite	bool Se for verdadeiro, substitua o ficheiro existente, a predefinição é Falso. valor predefinido: None
show_progress	bool Mostrar o progresso da transferência na consola, predefinição para Verdadeiro. valor predefinido: None

Devoluções

Tipo	Description
int	O número de ficheiros transferidos com êxito.

Atributos

datastore

Obtenha o Arquivo de Dados associado à PortDataReference.

Devoluções

Tipo	Description
Datastore	O objeto arquivo de dados.

datastore_name

Obtenha o nome do Arquivo de Dados associado à PortDataReference.

Devoluções

Tipo	Description
str	O nome do arquivo de dados.

name

Obtenha o nome desta referência de dados.

Devoluções

Tipo	Description
str	O nome da referência de dados.

path_on_datastore

Obtenha o caminho no arquivo de dados do PortDataReference.

Devoluções

Tipo	Description
str	O caminho no arquivo de dados.