Freigeben über

YAML-Schema für Pipelinekomponenten der CLI (v2)

  • Artikel

GILT FÜR: Azure CLI ml Erweiterung v2 (aktuell)

Das JSON-Quellschema finden Sie unter https://azuremlschemas.azureedge.net/latest/pipelineComponent.schema.json.

Hinweis

Die in diesem Dokument beschriebene YAML-Syntax basiert auf dem JSON-Schema für die neueste Version der ML CLI v2-Erweiterung. Die Funktion dieser Syntax wird nur mit der neuesten Version der ML CLI v2-Erweiterung garantiert. Die Schemas für ältere Erweiterungsversionen finden Sie unter https://azuremlschemasprod.azureedge.net/.

YAML-Syntax

Schlüssel type BESCHREIBUNG Zulässige Werte Standardwert
$schema Zeichenfolge Das YAML-Schema. Wenn Sie die VS Code-Erweiterung für Azure Machine Learning zum Erstellen einer YAML-Datei verwenden, können Sie durch das Einfügen von $schema am Anfang der Datei Schema- und Ressourcenvervollständigungen aufrufen.
type const Der Typ der Komponente. pipeline pipeline
name Zeichenfolge Erforderlich. Der Name der Komponente. Muss mit einem Kleinbuchstaben beginnen. Zulässige Zeichen sind Kleinbuchstaben, Zahlen und Unterstriche (_). Die maximale Länge beträgt 255 Zeichen.
version Zeichenfolge Version der Komponente. Wenn hier nichts angegeben wird, generiert Azure Machine Learning automatisch eine Version.
display_name Zeichenfolge Anzeigename der Komponente auf der Studio-Benutzeroberfläche Darf innerhalb des Arbeitsbereichs auch nicht eindeutig sein.
description Zeichenfolge Die Beschreibung der Komponente
tags Objekt (object) Wörterbuch der Tags für die Komponente
jobs Objekt (object) Erforderlich. Das Wörterbuch der einzelnen Aufträge, die als Schritte innerhalb der Pipeline ausgeführt werden sollen. Diese Aufträge werden als untergeordnete Aufträge des übergeordneten Pipelineauftrags betrachtet.

Der Schlüssel ist der Name des Schritts im Kontext des Pipelineauftrags. Dieser Name unterscheidet sich vom eindeutigen Auftragsnamen des untergeordneten Auftrags. Der Wert ist die Auftragsspezifikation, die dem Befehlsauftragsschema oder dem Sweepauftragsschema folgen kann. Derzeit können in einer Pipeline nur Befehlsaufträge und Sweepaufträge ausgeführt werden.
inputs Objekt (object) Das Wörterbuch der Eingaben für den Pipelineauftrag. Der Schlüssel ist ein Name für die Eingabe im Kontext des Auftrags, und der Wert ist der Eingabewert.

Auf diese Pipelineeingaben kann mithilfe des Ausdrucks ${{ parent.inputs.<input_name> }} durch die Eingaben eines einzelnen Schrittauftrags in der Pipeline verwiesen werden. Weitere Informationen zum Binden der Eingaben eines Pipelineschritts an die Eingaben des Pipelineauftrags auf oberster Ebene finden Sie in der Ausdruckssyntax zum Binden von Ein- und Ausgaben zwischen Schritten in einem Pipelineauftrag.
inputs.<input_name> number, integer, boolean, string oder object Ein Literalwert (vom Typ „number“, „integer“, „boolean“ oder „string“) oder ein Objekt, das eine Datenspezifikation für Komponenteneingaben enthält.
outputs Objekt (object) Das Wörterbuch der Ausgabekonfigurationen des Pipelineauftrags. Der Schlüssel ist de Name für die Ausgabe im Kontext des Auftrags, und der Wert ist die Ausgabekonfiguration.

Auf diese Pipelineausgaben kann mithilfe des Ausdrucks ${{ parents.outputs.<output_name> }} von den Ausgaben eines einzelnen Schrittauftrags in der Pipeline verwiesen werden. Weitere Informationen zum Binden der Eingaben eines Pipelineschritts an die Eingaben des Pipelineauftrags auf oberster Ebene finden Sie in der Ausdruckssyntax zum Binden von Ein- und Ausgaben zwischen Schritten in einem Pipelineauftrag.
outputs.<output_name> Objekt (object) Sie können das Objekt leer lassen. In diesem Fall weist die Ausgabe den Typ uri_folder auf, und Azure Machine Learning generiert einen Ausgabespeicherort für die Ausgabe basierend auf dem folgenden Vorlagenpfad: {settings.datastore}/azureml/{job-name}/{output-name}/. Die Dateien im Ausgabeverzeichnis wird über die Einbindung mit Lese-/Schreibzugriff geschrieben. Wenn Sie einen anderen Modus für die Ausgabe angeben möchten, stellen Sie ein Objekt bereit, das die Komponentenausgabespezifikation enthält.

Komponenteneingabe

Schlüssel type BESCHREIBUNG Zulässige Werte Standardwert
type Zeichenfolge Erforderlich. Der Typ der Komponenteneingabe Erfahren Sie mehr über Datenzugriff. number, integer, , stringboolean, uri_file, uri_folder, mltable, , mlflow_modelcustom_model
description Zeichenfolge Die Beschreibung der Eingabe
default number, integer, boolean oder string Der Standardwert für die Eingabe
optional boolean Gibt an, ob die Eingabe erforderlich ist Wenn diese Einstellung auf true festgelegt ist, müssen Sie den Befehl zum Einschließen optionaler Eingaben mit $[[]] verwenden false
min ganze Zahl oder Zahl Der minimale akzeptierte Wert für die Eingabe Dieses Feld kann nur angegeben werden, wenn das Feld typenumber oder integer ist.
max ganze Zahl oder Zahl Der maximale akzeptierte Wert für die Eingabe Dieses Feld kann nur angegeben werden, wenn das Feld typenumber oder integer ist.
enum array Die Liste der zulässigen Werte für die Eingabe Trifft nur zu, wenn das Feld typestring ist.

Komponentenausgabe

Schlüssel type BESCHREIBUNG Zulässige Werte Standardwert
type Zeichenfolge Erforderlich. Der Typ der Komponentenausgabe uri_file, , uri_foldermltable, , mlflow_modelcustom_model
description Zeichenfolge Beschreibung der Ausgabe

Bemerkungen

Mit den Befehlen az ml component können Sie Azure Machine Learning-Komponenten verwalten.

Beispiele

Beispiele finden Sie im GitHub-Beispielrepository.

Nächste Schritte