PortDataReference Classe

  • Référence

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

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

Objet de contexte du graphe.

pipeline_run_id
str
Obligatoire

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

data_reference
DataReference
Obligatoire

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

step_run
StepRun
valeur par défaut: None

Objet StepRun qui a produit les données.

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

Objet de contexte du graphe.

pipeline_run_id
str
Obligatoire

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

data_reference
DataReference
Obligatoire

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

step_run
StepRun
Obligatoire

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

input_name
str
valeur par défaut: None

Spécifier un nom pour cette entrée.

path_on_compute
str
valeur par défaut: None

Chemin d’accès sur le calcul où effectuer le téléchargement des données.

overwrite
bool
valeur par défaut: None

Permet d’indiquer s’il est nécessaire de remplacer les données existantes.

Retours

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

Type de retour

InputPortBinding

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

input_name
str
Obligatoire

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

Retours

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

Type de retour

InputPortBinding

as_mount

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

as_mount(input_name=None)

Paramètres

input_name
str
valeur par défaut: None

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

Retours

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

Type de retour

InputPortBinding

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

input_name
str
valeur par défaut: None

Nom de l'entrée.

mode
str
valeur par défaut: None

Mode d’accès à PortDataReference (« mount » ou « download »).

path_on_compute
str
valeur par défaut: None

Pour le mode « download », chemin de la cible de calcul où les données vont résider.

overwrite
bool
valeur par défaut: None

Pour le mode « download », indique s’il est nécessaire de remplacer les données existantes.

Retours

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

Type de retour

InputPortBinding

download

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

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

Paramètres

local_path
str
Obligatoire

Chemin de destination local du téléchargement.

overwrite
bool
valeur par défaut: None

Si la valeur est true, remplacer le fichier existant, la valeur par défaut est false.

show_progress
bool
valeur par défaut: None

Afficher la progression du téléchargement dans la console, la valeur par défaut est true.

Retours

Nombre de fichiers téléchargés.

Type de retour

int

Attributs

datastore

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

Retours

Objet magasin de données.

Type de retour

Datastore

datastore_name

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

Retours

Nom du magasin de données.

Type de retour

str

name

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

Retours

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

Type de retour

str

path_on_datastore

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

Retours

Chemin dans le magasin de données.

Type de retour

str