PortDataReference Classe

  • Referência

Modela dados associados a uma saída de um StepRun concluído.

Um objeto PortDataReference pode ser usado para baixar os dados de saída que foram produzidos por um StepRun. Ele também pode ser usado como uma entrada de etapa em um pipeline futuro.

Inicializar PortDataReference.

Herança
builtins.object
PortDataReference

Construtor

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

Parâmetros

Nome Description
context
Obrigatório
<xref:azureml.pipeline.core._GraphContext>

O objeto de contexto de gráfico.
pipeline_run_id
Obrigatório
str

A ID da execução do pipeline que produziu a saída.
data_reference
Obrigatório
DataReference

O objeto de referência de dados.
step_run
StepRun

O objeto StepRun que produziu os dados.

Valor padrão: None
context
Obrigatório
<xref:azureml.pipeline.core._GraphContext>

O objeto de contexto de gráfico.
pipeline_run_id
Obrigatório
str

A ID da execução do pipeline que produziu a saída.
data_reference
Obrigatório
DataReference

O objeto de referência de dados.
step_run
Obrigatório
StepRun

O objeto StepRun que produziu os dados.

Comentários

Um PortDataReference aponta para os dados que foram produzidos por um StepRun concluído.

Obtém um PortDataReference de um PipelineRun e baixa 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")

Um PortDataReference pode ser usado como uma entrada para uma etapa em Pipeline, semelhante ao uso de um DataReference.

Um exemplo para usar um PortDataReference como uma entrada de etapa é 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])

Nesse exemplo, o Pipeline recém-construído usará a saída que foi criada pelo PipelineRun concluído como uma entrada para a etapa de treinamento.

Métodos

as_download

Consuma o PortDataReference como uma entrada de etapa através do modo "download".
as_input

Criar um InputPortBinding e especificar um nome de entrada (mas usar o modo padrão).
as_mount

Consuma o PortDataReference como uma entrada de etapa através do modo "mount".
create_input_binding

Cria a associação de entrada com esse PortDataReference como a origem.
download

Baixa os dados representados pelo PortDataReference.

as_download

Consuma o PortDataReference como uma entrada de etapa através do modo "download".

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

Parâmetros

Nome Description
input_name
str

Especifica um nome para essa instância.

Valor padrão: None
path_on_compute
str

O caminho na computação para o qual baixar os dados.

Valor padrão: None
overwrite
bool

Use para indicar se os dados existentes devem ser substituídos.

Valor padrão: None

Retornos

Tipo Description
InputPortBinding

O InputPortBinding com esse PortDataReference como a origem.

as_input

Criar um InputPortBinding e especificar um nome de entrada (mas usar o modo padrão).

as_input(input_name)

Parâmetros

Nome Description
input_name
Obrigatório
str

Use para especificar um nome para essa entrada.

Retornos

Tipo Description
InputPortBinding

O InputPortBinding com esse PortDataReference como a origem.

as_mount

Consuma o PortDataReference como uma entrada de etapa através do modo "mount".

as_mount(input_name=None)

Parâmetros

Nome Description
input_name
str

Use para especificar um nome para essa entrada.

Valor padrão: None

Retornos

Tipo Description
InputPortBinding

O InputPortBinding com esse PortDataReference como a origem.

create_input_binding

Cria a associação de entrada com esse PortDataReference como a origem.

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

Parâmetros

Nome Description
input_name
str

Nome da entrada.

Valor padrão: None
mode
str

O modo para acessar o PortDataReference ("mount" ou "download").

Valor padrão: None
path_on_compute
str

Para o modo "download", o caminho na computação em que os dados residirão.

Valor padrão: None
overwrite
bool

Para o modo "download", se os dados existentes devem ser substituídos.

Valor padrão: None

Retornos

Tipo Description
InputPortBinding

O InputPortBinding com esse PortDataReference como a origem.

download

Baixa os dados representados pelo PortDataReference.

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

Parâmetros

Nome Description
local_path
Obrigatório
str

Caminho local para o qual fazer download.
overwrite
bool

Se for true, substituirá o arquivo existente, o padrão é False.

Valor padrão: None
show_progress
bool

Mostra o progresso do download no console, o padrão é True.

Valor padrão: None

Retornos

Tipo Description
int

O número de arquivos baixados com êxito.

Atributos

datastore

Obtém o armazenamento de dados associado ao PortDataReference.

Retornos

Tipo Description
Datastore

O objeto de armazenamento de dados.

datastore_name

Obtém o nome do armazenamento de dados associado ao PortDataReference.

Retornos

Tipo Description
str

O nome do armazenamento de dados.

name

Obtém o nome dessa referência de dados.

Retornos

Tipo Description
str

O nome da referência de dados.

path_on_datastore

Obtém o caminho no armazenamento de dados para PortDataReference.

Retornos

Tipo Description
str

O caminho no armazenamento de dados.