CommandComponent Klasa

Wersja składnika polecenia używana do definiowania składnika polecenia lub zadania.

Dziedziczenie

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)

Parametry Tylko słowo kluczowe

Nazwa	Opis
name	Optional[str] Nazwa zadania polecenia lub składnika.
version	Optional[str] Wersja zadania polecenia lub składnika.
description	Optional[str] Opis składnika. Wartość domyślna to None (Brak).
tags	Optional[dict] Słownik tagów. Tagi można dodawać, usuwać i aktualizować. Wartość domyślna to None (Brak).
display_name	Optional[str] Nazwa wyświetlana składnika.
command	Optional[str] Polecenie do wykonania.
code	Kod źródłowy do uruchomienia zadania. Może to być ścieżka lokalna lub "http:", "https:" lub "azureml:" adres URL wskazujący lokalizację zdalną.
environment	Optional[Union[str, Environment]] Środowisko, w których zostanie uruchomione zadanie.
distribution	Optional[Union[PyTorchDistribution, MpiDistribution, TensorFlowDistribution, RayDistribution]] Konfiguracja zadań rozproszonych. Wartość domyślna to None (Brak).
resources	Optional[JobResourceConfiguration] Konfiguracja zasobów obliczeniowych dla polecenia .
inputs	Optional[dict[str, Union[ Input, str, bool, int, float, <xref:Enum>, ]]] Mapowanie nazw wejściowych na wejściowe źródła danych używane w zadaniu. Wartość domyślna to None (Brak).
outputs	Optional[dict[str, Union[str, Output]]] Mapowanie nazw danych wyjściowych na wyjściowe źródła danych używane w zadaniu. Wartość domyślna to None (Brak).
instance_count	Optional[int] Liczba wystąpień lub węzłów, które mają być używane przez docelowy obiekt obliczeniowy. Wartość domyślna to 1.
is_deterministic	Optional[bool] Określa, czy polecenie zwróci te same dane wyjściowe, biorąc pod uwagę te same dane wejściowe. Wartość domyślna to True. Jeśli wartość True, jeśli polecenie (składnik) jest deterministyczne i zostało uruchomione wcześniej w bieżącym obszarze roboczym z tymi samymi danymi wejściowymi i ustawieniami, spowoduje ponowne użycie wyników z poprzedniego przesłanego zadania, gdy jest używane jako węzeł lub krok w potoku. W tym scenariuszu nie będą używane żadne zasoby obliczeniowe. wartość domyślna: True
additional_includes	Optional[List[str]] Lista udostępnionych dodatkowych plików do ujęć w składniku. Wartość domyślna to None (Brak).
properties	Optional[dict[str, str]] Słownik właściwości zadania. Wartość domyślna to None (Brak).

Przykłady

Tworzenie elementu CommandComponent.

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

Metody

dump	Zrzuć zawartość składnika do pliku w formacie yaml.

dump

Zrzuć zawartość składnika do pliku w formacie yaml.

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

Parametry

Nazwa

Opis

dest Wymagane

Union[<xref:PathLike>, str, IO[AnyStr]] Miejsce docelowe odbierania zawartości tego składnika. Musi być ścieżką do pliku lokalnego lub już otwartym strumieniem plików. Jeśli dest jest ścieżką pliku, zostanie utworzony nowy plik i zostanie zgłoszony wyjątek, jeśli plik istnieje. Jeśli dest jest otwartym plikiem, plik zostanie zapisany bezpośrednio, a wyjątek zostanie zgłoszony, jeśli plik nie będzie zapisywalny.

Atrybuty

base_path

Ścieżka podstawowa zasobu.

Zwraca

Typ	Opis
str	Ścieżka podstawowa zasobu.

creation_context

Kontekst tworzenia zasobu.

Zwraca

Typ	Opis
Optional[SystemData]	Metadane tworzenia zasobu.

display_name

Nazwa wyświetlana składnika.

Zwraca

Typ	Opis
str	Nazwa wyświetlana składnika.

distribution

Konfiguracja składnika lub zadania polecenia rozproszonego.

Zwraca

Typ	Opis
Union[PyTorchDistribution, MpiDistribution, TensorFlowDistribution, RayDistribution]	Konfiguracja dystrybucji.

id

Identyfikator zasobu.

Zwraca

Typ	Opis
Optional[str]	Identyfikator globalny zasobu, identyfikator usługi Azure Resource Manager (ARM).

inputs

Dane wejściowe składnika.

Zwraca

Typ	Opis
dict	Dane wejściowe składnika.

instance_count

Liczba wystąpień lub węzłów, które mają być używane przez docelowy obiekt obliczeniowy.

Zwraca

Typ	Opis
int	Liczba wystąpień lub węzłów.

is_deterministic

Czy składnik jest deterministyczny.

Zwraca

Typ	Opis
bool	Czy składnik jest deterministyczny

outputs

Dane wyjściowe składnika.

Zwraca

Typ	Opis
dict	Dane wyjściowe składnika.

resources

Konfiguracja zasobów obliczeniowych dla składnika polecenia lub zadania.

Zwraca

Typ	Opis
JobResourceConfiguration	Konfiguracja zasobów obliczeniowych dla składnika polecenia lub zadania.

type

Typ składnika, wartość domyślna to "command".

Zwraca

Typ	Opis
str	Typ składnika.

version

Wersja składnika.

Zwraca

Typ	Opis
str	Wersja składnika.