PortDataReference Classe

Modélise les données associées à une sortie d’une StepRun terminée.

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

Initialisez PortDataReference.

Héritage

builtins.object

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 du graphe.
pipeline_run_id Obligatoire	str ID de l’exécution du pipeline qui a produit la sortie.
data_reference Obligatoire	DataReference Objet de référence de données.
step_run	StepRun Objet StepRun qui a produit les données. valeur par défaut: None
context Obligatoire	<xref:azureml.pipeline.core._GraphContext> Objet de contexte du graphe.
pipeline_run_id Obligatoire	str ID de l’exécution du pipeline qui a produit la sortie.
data_reference Obligatoire	DataReference Objet de référence de données.
step_run Obligatoire	StepRun Objet StepRun qui a produit les données.

Remarques

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

Obtenir un élément PortDataReference à partir d’un PipelineRun et télécharger 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 élément PortDataReference peut être utilisé comme entrée d’une étape dans un Pipeline, semblable à l’utilisation d’un DataReference.

Voici un exemple d’utilisation d’un élément 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 que vous venez de construire utilise la sortie qui a été créée par le PipelineRun terminé comme entrée de l’étape de formation.

Méthodes

as_download	Consommer PortDataReference en tant qu’entrée d’étape via le mode « download ».
as_input	Permet de créer un InputPortBinding et de spécifier un nom d’entrée (mais utilise le mode par défaut).
as_mount	Consommer PortDataReference en tant qu’entrée d’étape via le mode « mount ».
create_input_binding	Créer une liaison d’entrée avec cet élément PortDataReference en tant que source.
download	Télécharger les données représentées par PortDataReference.

as_download

Consommer PortDataReference en tant qu’entrée d’étape via le mode « download ».

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

Paramètres

Nom	Description
input_name	str Spécifier un nom pour cette entrée. valeur par défaut: None
path_on_compute	str Chemin d’accès sur le calcul où effectuer le téléchargement des données. valeur par défaut: None
overwrite	bool Permet d’indiquer s’il est nécessaire de remplacer les données existantes. valeur par défaut: None

Retours

Type	Description
InputPortBinding	InputPortBinding avec cet élément PortDataReference en tant que source.

as_input

Permet de créer un InputPortBinding et de spécifier un nom d’entrée (mais utilise 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	InputPortBinding avec cet élément PortDataReference en tant que source.

as_mount

Consommer PortDataReference en tant qu’entrée d’étape via le mode « mount ».

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	InputPortBinding avec cet élément PortDataReference en tant que source.

create_input_binding

Créer une liaison d’entrée avec cet élément PortDataReference en tant que 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 d’accès à PortDataReference (« mount » ou « download »). valeur par défaut: None
path_on_compute	str Pour le mode « download », chemin de la cible de calcul où les données vont résider. valeur par défaut: None
overwrite	bool Pour le mode « download », indique s’il est nécessaire de remplacer les données existantes. valeur par défaut: None

Retours

Type	Description
InputPortBinding	InputPortBinding avec cet élément PortDataReference en tant que source.

download

Télécharger 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 de destination local du téléchargement.
overwrite	bool Si la valeur est true, remplacer le fichier existant, la valeur par défaut est false. valeur par défaut: None
show_progress	bool Afficher la progression du téléchargement dans la console, la valeur par défaut est true. valeur par défaut: None

Retours

Type	Description
int	Nombre de fichiers téléchargés.

Attributs

datastore

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

Retours

Type	Description
Datastore	Objet magasin de données.

datastore_name

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

Retours

Type	Description
str	Nom du magasin de données.

name

Obtenir le nom de cette référence des données.

Retours

Type	Description
str	Nom de référence des données.

path_on_datastore

Obtenir le chemin dans le magasin de données pour PortDataReference.

Retours

Type	Description
str	Chemin dans le magasin de données.