CommandComponent Osztály

Parancsösszetevő verziója, amely parancsösszetevő vagy feladat definiálására szolgál.

Öröklődés

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)

Csak kulcsszavas paraméterek

Name	Description
name	Optional[str] A Parancsfeladat vagy -összetevő neve.
version	Optional[str] A Parancsfeladat vagy -összetevő verziója.
description	Optional[str] Az összetevő leírása. Alapértelmezés szerint Nincs.
tags	Optional[dict] Címkeszótár. A címkék hozzáadhatók, eltávolíthatók és frissíthetők. Alapértelmezés szerint Nincs.
display_name	Optional[str] Az összetevő megjelenítendő neve.
command	Optional[str] A végrehajtandó parancs.
code	A feladat futtatásához használt forráskód. Lehet helyi elérési út, "http:", "https:" vagy "azureml:" url, amely egy távoli helyre mutat.
environment	Optional[Union[str, Environment]] A környezet, amelyben a feladat futni fog.
distribution	Optional[Union[PyTorchDistribution, MpiDistribution, TensorFlowDistribution, RayDistribution]] Az elosztott feladatok konfigurációja. Alapértelmezés szerint Nincs.
resources	Optional[JobResourceConfiguration] A parancs számítási erőforrás-konfigurációja.
inputs	Optional[dict[str, Union[ Input, str, bool, int, float, <xref:Enum>, ]]] Bemeneti nevek leképezése a feladatban használt bemeneti adatforrásokhoz. Alapértelmezés szerint Nincs.
outputs	Optional[dict[str, Union[str, Output]]] A kimeneti nevek leképezése a feladatban használt kimeneti adatforrásokhoz. Alapértelmezés szerint Nincs.
instance_count	Optional[int] A számítási cél által használandó példányok vagy csomópontok száma. Alapértelmezés szerint 1.
is_deterministic	Optional[bool] Megadja, hogy a parancs ugyanazt a kimenetet adja-e vissza ugyanazzal a bemenettel. Alapértelmezés szerint Igaz. Ha igaz, akkor ha egy parancs (összetevő) determinisztikus, és korábban már futtatták az aktuális munkaterületen ugyanazokkal a bemenetekkel és beállításokkal, akkor az egy korábbi elküldött feladat eredményeit fogja újra felhasználni csomópontként vagy folyamatlépésként használva. Ebben a forgatókönyvben a rendszer nem használ számítási erőforrásokat. alapértelmezett érték: True
additional_includes	Optional[List[str]] Az összetevőben szerepeltetni kívánt megosztott további fájlok listája. Alapértelmezés szerint Nincs.
properties	Optional[dict[str, str]] A feladattulajdonság szótára. Alapértelmezés szerint Nincs.

Példák

Parancsösszetevő létrehozása.

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

Metódusok

dump	Az összetevő tartalmát yaml formátumban egy fájlba kell kivenni.

dump

Az összetevő tartalmát yaml formátumban egy fájlba kell kivenni.

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

Paraméterek

Name	Description
dest Kötelező	Union[<xref:PathLike>, str, IO[AnyStr]] Az összetevő tartalmának fogadásának célja. Egy helyi fájl elérési útjának vagy egy már megnyitott fájlstreamnek kell lennie. Ha a dest fájlelérési út, a rendszer létrehoz egy új fájlt, és kivételt hoz létre, ha a fájl létezik. Ha a dest egy megnyitott fájl, a program közvetlenül a fájlba írja a fájlt, és kivételt jelez, ha a fájl nem írható.

Attribútumok

base_path

Az erőforrás alapútvonala.

Válaszok

Típus	Description
str	Az erőforrás alapútvonala.

creation_context

Az erőforrás létrehozási környezete.

Válaszok

Típus	Description
Optional[SystemData]	Az erőforrás létrehozási metaadatai.

display_name

Az összetevő megjelenítendő neve.

Válaszok

Típus	Description
str	Az összetevő megjelenítendő neve.

distribution

Az elosztott parancsösszetevő vagy -feladat konfigurációja.

Válaszok

Típus	Description
Union[PyTorchDistribution, MpiDistribution, TensorFlowDistribution, RayDistribution]	A terjesztési konfiguráció.

id

Az erőforrás-azonosító.

Válaszok

Típus	Description
Optional[str]	Az erőforrás globális azonosítója, egy Azure Resource Manager (ARM) azonosító.

inputs

Az összetevő bemenetei.

Válaszok

Típus	Description
dict	Az összetevő bemenetei.

instance_count

A számítási cél által használandó példányok vagy csomópontok száma.

Válaszok

Típus	Description
int	A példányok vagy csomópontok száma.

is_deterministic

Hogy az összetevő determinisztikus-e.

Válaszok

Típus	Description
bool	Az összetevő determinisztikus-e

outputs

Az összetevő kimenetei.

Válaszok

Típus	Description
dict	Az összetevő kimenetei.

resources

A parancsösszetevő vagy -feladat számítási erőforrás-konfigurációja.

Válaszok

Típus	Description
JobResourceConfiguration	A parancsösszetevő vagy -feladat számítási erőforrás-konfigurációja.

type

Az összetevő típusa, az alapértelmezett érték a "command".

Válaszok

Típus	Description
str	Az összetevő típusa.

version

Az összetevő verziója.

Válaszok

Típus	Description
str	Az összetevő verziója.