CommandComponent Klasse

Version der Befehlskomponente, die zum Definieren einer Befehlskomponente oder eines Auftrags verwendet wird.

Vererbung

azure.ai.ml.entities._component.component.Component

CommandComponent

azure.ai.ml.entities._job.parameterized_command.ParameterizedCommand

CommandComponent

azure.ai.ml.entities._component._additional_includes.AdditionalIncludesMixin

CommandComponent

Konstruktor

CommandComponent(*, name: str | None = None, version: str | None = None, description: str | None = None, tags: Dict | None = None, display_name: str | None = None, command: str | None = None, code: PathLike | str | None = None, environment: Environment | str | None = None, distribution: Dict | MpiDistribution | TensorFlowDistribution | PyTorchDistribution | RayDistribution | DistributionConfiguration | None = None, resources: JobResourceConfiguration | None = None, inputs: Dict | None = None, outputs: Dict | None = None, instance_count: int | None = None, is_deterministic: bool = True, additional_includes: List | None = None, properties: Dict | None = None, **kwargs: Any)

Nur Schlüsselwortparameter

Name	Beschreibung
name	Optional[str] Der Name des Befehlsauftrags oder der -Komponente.
version	Optional[str] Die Version des Befehlsauftrags oder der -Komponente.
description	Optional[str] Die Beschreibung der Komponente. Der Standardwert ist „None“.
tags	Optional[dict] Tagwörterbuch. Tags können hinzugefügt, entfernt und aktualisiert werden. Der Standardwert ist „None“.
display_name	Optional[str] Der Anzeigename der Komponente.
command	Optional[str] Der Befehl, der ausgeführt werden soll.
code	Der Quellcode zum Ausführen des Auftrags. Dies kann ein lokaler Pfad oder eine URL mit "http:", "https:" oder "azureml:" sein, die auf einen Remotespeicherort verweist.
environment	Optional[Union[str, Environment]] Die Umgebung, in der der Auftrag ausgeführt wird.
distribution	Optional[Union[PyTorchDistribution, MpiDistribution, TensorFlowDistribution, RayDistribution]] Die Konfiguration für verteilte Aufträge. Der Standardwert ist „None“.
resources	Optional[JobResourceConfiguration] Die Computeressourcenkonfiguration für den Befehl.
inputs	Optional[dict[str, Union[ Input, str, bool, int, float, <xref:Enum>, ]]] Eine Zuordnung von Eingabenamen zu Eingabedatenquellen, die im Auftrag verwendet werden. Der Standardwert ist „None“.
outputs	Optional[dict[str, Union[str, Output]]] Eine Zuordnung von Ausgabenamen zu ausgabedatenquellen, die im Auftrag verwendet werden. Der Standardwert ist „None“.
instance_count	Optional[int] Die Anzahl der Instanzen oder Knoten, die vom Computeziel verwendet werden sollen. Der Standardwert lautet 1.
is_deterministic	Optional[bool] Gibt an, ob der Befehl bei derselben Eingabe die gleiche Ausgabe zurückgibt. Der Standardwert ist „True“. Wenn bei True ein Befehl (Komponente) deterministisch ist und zuvor im aktuellen Arbeitsbereich mit den gleichen Eingaben und Einstellungen ausgeführt wurde, werden Ergebnisse aus einem vorherigen übermittelten Auftrag wiederverwendet, wenn er als Knoten oder Schritt in einer Pipeline verwendet wird. In diesem Szenario werden keine Computeressourcen verwendet. Standardwert: True
additional_includes	Optional[List[str]] Eine Liste der freigegebenen zusätzlichen Dateien, die in die Komponente aufgenommen werden sollen. Der Standardwert ist „None“.
properties	Optional[dict[str, str]] Das Auftragseigenschaftenverzeichnis. Der Standardwert ist „None“.

Beispiele

Erstellen einer CommandComponent-Komponente.

   from azure.ai.ml.entities import CommandComponent

   component = CommandComponent(
       name="sample_command_component_basic",
       display_name="CommandComponentBasic",
       description="This is the basic command component",
       tags={"tag": "tagvalue", "owner": "sdkteam"},
       version="1",
       outputs={"component_out_path": {"type": "uri_folder"}},
       command="echo Hello World",
       code="./src",
       environment="AzureML-sklearn-1.0-ubuntu20.04-py38-cpu:33",
   )

Methoden

dump	Speichern Sie den Komponenteninhalt in einer Datei im YAML-Format.

dump

Speichern Sie den Komponenteninhalt in einer Datei im YAML-Format.

dump(dest: str | PathLike | IO, **kwargs: Any) -> None

Parameter

Name

Beschreibung

dest Erforderlich

Union[<xref:PathLike>, str, IO[AnyStr]] Das Ziel, um den Inhalt dieser Komponente zu empfangen. Muss entweder ein Pfad zu einer lokalen Datei oder ein bereits geöffneter Dateidatenstrom sein. Wenn dest ein Dateipfad ist, wird eine neue Datei erstellt, und eine Ausnahme wird ausgelöst, wenn die Datei vorhanden ist. Wenn dest eine geöffnete Datei ist, wird die Datei direkt in geschrieben, und eine Ausnahme wird ausgelöst, wenn die Datei nicht beschreibbar ist.

Attribute

base_path

Der Basispfad der Ressource.

Gibt zurück

Typ	Beschreibung
str	Der Basispfad der Ressource.

creation_context

Der Erstellungskontext der Ressource.

Gibt zurück

Typ	Beschreibung
Optional[SystemData]	Die Erstellungsmetadaten für die Ressource.

display_name

Anzeigename der Komponente.

Gibt zurück

Typ	Beschreibung
str	Anzeigename der Komponente.

distribution

Die Konfiguration für die Verteilte Befehlskomponente oder den Auftrag.

Gibt zurück

Typ	Beschreibung
Union[PyTorchDistribution, MpiDistribution, TensorFlowDistribution, RayDistribution]	Die Verteilungskonfiguration.

id

Die Ressourcen-ID.

Gibt zurück

Typ	Beschreibung
Optional[str]	Die globale ID der Ressource, eine Arm-ID (Azure Resource Manager).

inputs

Eingaben der Komponente.

Gibt zurück

Typ	Beschreibung
dict	Eingaben der Komponente.

instance_count

Die Anzahl der Instanzen oder Knoten, die vom Computeziel verwendet werden sollen.

Gibt zurück

Typ	Beschreibung
int	Die Anzahl der Instanzen oder Knoten.

is_deterministic

Gibt an, ob die Komponente deterministisch ist.

Gibt zurück

Typ	Beschreibung
bool	Gibt an, ob die Komponente deterministisch ist.

outputs

Ausgaben der Komponente.

Gibt zurück

Typ	Beschreibung
dict	Ausgaben der Komponente.

resources

Die Computeressourcenkonfiguration für die Befehlskomponente oder den Auftrag.

Gibt zurück

Typ	Beschreibung
JobResourceConfiguration	Die Computeressourcenkonfiguration für die Befehlskomponente oder den Auftrag.

type

Typ der Komponente, Standardwert ist "command".

Gibt zurück

Typ	Beschreibung
str	Typ der Komponente.

version

Version der Komponente.

Gibt zurück

Typ	Beschreibung
str	Version der Komponente.