Partager via


PortDataReference Classe

Modèles les données associées à une sortie d’un StepRun terminé.

Un objet PortDataReference peut être utilisé pour télécharger les données de sortie qui ont été produites par un StepRun. Il peut également être utilisé comme entrée d’étape dans un pipeline futur.

Initialisez PortDataReference.

Constructeur

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

Paramètres

Nom Description
context
Obligatoire
<xref:azureml.pipeline.core._GraphContext>

Objet de contexte de graphique.

pipeline_run_id
Obligatoire
str

ID de l’exécution du pipeline qui a produit la sortie.

data_reference
Obligatoire

Objet de référence de données.

step_run

Objet StepRun qui a produit les données.

Valeur par défaut: None
context
Obligatoire
<xref:azureml.pipeline.core._GraphContext>

Objet de contexte de graphique.

pipeline_run_id
Obligatoire
str

ID de l’exécution du pipeline qui a produit la sortie.

data_reference
Obligatoire

Objet de référence de données.

step_run
Obligatoire

Objet StepRun qui a produit les données.

Remarques

Un PortDataReference pointe vers les données qui ont été produites par un terminé StepRun.

Obtenez un PortDataReference à partir d’un PipelineRun et téléchargez les données de sortie comme suit :


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

Un PortDataReference peut être utilisé comme entrée à une étape d’un Pipeline, similaire à l’utilisation d’un DataReference.

Voici un exemple d’utilisation d’un PortDataReference en tant qu’entrée d’étape :


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

Dans cet exemple, le pipeline nouvellement construit utilise la sortie qui a été créée par pipelineRun terminé comme entrée à l’étape d’apprentissage.

Méthodes

as_download

Utilisez portDataReference en tant qu’entrée pas à pas via le mode « téléchargement ».

as_input

Créez un InputPortBinding et spécifiez un nom d’entrée (mais utilisez le mode par défaut).

as_mount

Utilisez portDataReference en tant qu’entrée pas à pas via le mode « montage ».

create_input_binding

Créez une liaison d’entrée avec ce PortDataReference comme source.

download

Téléchargez les données représentées par PortDataReference.

as_download

Utilisez portDataReference en tant qu’entrée pas à pas via le mode « téléchargement ».

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

Paramètres

Nom Description
input_name
str

Spécifiez un nom pour cette entrée.

Valeur par défaut: None
path_on_compute
str

Chemin d’accès sur le calcul vers lequel télécharger les données.

Valeur par défaut: None
overwrite

Permet d’indiquer s’il faut remplacer les données existantes.

Valeur par défaut: None

Retours

Type Description

InputPortBinding avec ce PortDataReference comme source.

as_input

Créez un InputPortBinding et spécifiez un nom d’entrée (mais utilisez le mode par défaut).

as_input(input_name)

Paramètres

Nom Description
input_name
Obligatoire
str

Permet de spécifier un nom pour cette entrée.

Retours

Type Description

InputPortBinding avec ce PortDataReference comme source.

as_mount

Utilisez portDataReference en tant qu’entrée pas à pas via le mode « montage ».

as_mount(input_name=None)

Paramètres

Nom Description
input_name
str

Permet de spécifier un nom pour cette entrée.

Valeur par défaut: None

Retours

Type Description

InputPortBinding avec ce PortDataReference comme source.

create_input_binding

Créez une liaison d’entrée avec ce PortDataReference comme source.

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

Paramètres

Nom Description
input_name
str

Nom de l’entrée.

Valeur par défaut: None
mode
str

Mode permettant d’accéder à PortDataReference (« mount » ou « download »).

Valeur par défaut: None
path_on_compute
str

Pour le mode « télécharger », le chemin d’accès sur le calcul des données résidera.

Valeur par défaut: None
overwrite

Pour le mode « télécharger », indiquez s’il faut remplacer les données existantes.

Valeur par défaut: None

Retours

Type Description

InputPortBinding avec ce PortDataReference comme source.

download

Téléchargez les données représentées par PortDataReference.

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

Paramètres

Nom Description
local_path
Obligatoire
str

Chemin d’accès local à télécharger.

overwrite

Si la valeur est true, remplacez le fichier existant, par défaut sur False.

Valeur par défaut: None
show_progress

Affichez la progression du téléchargement dans la console, par défaut sur True.

Valeur par défaut: None

Retours

Type Description
int

Nombre de fichiers téléchargés avec succès.

Attributs

datastore

Obtenez le magasin de données associé à PortDataReference.

Retours

Type Description

Objet de magasin de données.

datastore_name

Obtenez le nom du magasin de données associé à PortDataReference.

Retours

Type Description
str

Nom du magasin de données.

name

Obtenez le nom de cette référence de données.

Retours

Type Description
str

Nom de référence des données.

path_on_datastore

Obtenez le chemin d’accès sur le magasin de données pour PortDataReference.

Retours

Type Description
str

Chemin d’accès du magasin de données.