ComponentOperations Třída

  • Reference

ComponentOperations.

Neměli byste vytvořit instanci této třídy přímo. Místo toho byste měli vytvořit instanci MLClient, která vytvoří instanci za vás a připojí ji jako atribut.

Dědičnost
azure.ai.ml._scope_dependent_operations._ScopeDependentOperations
ComponentOperations

Konstruktor

ComponentOperations(operation_scope: OperationScope, operation_config: OperationConfig, service_client: AzureMachineLearningWorkspaces | AzureMachineLearningWorkspaces, all_operations: OperationsContainer, preflight_operation: DeploymentsOperations | None = None, **kwargs: Dict)

Parametry

operation_scope
<xref:azure.ai.ml._scope_dependent_operations.OperationScope>
Vyžadováno

Rozsah operace.

operation_config
<xref:azure.ai.ml._scope_dependent_operations.OperationConfig>
Vyžadováno

Konfigurace operace.

service_client
Union[ <xref:azure.ai.ml._restclient.v2022_10_01.AzureMachineLearningWorkspaces>, <xref:azure.ai.ml._restclient.v2021_10_01_dataplanepreview.AzureMachineLearningWorkspaces>]
Vyžadováno

Klient služby pro operace rozhraní API.

all_operations
<xref:azure.ai.ml._scope_dependent_operations.OperationsContainer>
Vyžadováno

Kontejner pro všechny dostupné operace.

preflight_operation
Optional[<xref:azure.ai.ml._vendor.azure_resources.operations.DeploymentsOperations>]
výchozí hodnota: None

Předběžná operace pro nasazení.

kwargs
Dict
Vyžadováno

Další argumenty klíčových slov

Metody

archive

Archivujte komponentu.
create_or_update

Vytvořte nebo aktualizujte zadanou komponentu. Pokud existují vložené definované entity, například Prostředí nebo Kód, vytvoří se společně s komponentou.
download

Poznámka

Jedná se o experimentální metodu, která se může kdykoli změnit. Další informace najdete tady: https://aka.ms/azuremlexperimental.

Stáhněte zadanou komponentu a její závislosti do místního prostředí. Místní komponentu je možné použít k vytvoření komponenty v jiném pracovním prostoru nebo k offline vývoji.
get

Vrátí informace o zadané komponentě.
list

Vypíše konkrétní komponenty nebo komponenty pracovního prostoru.
restore

Obnovte archivovanou komponentu.
validate

Poznámka

Jedná se o experimentální metodu, která se může kdykoli změnit. Další informace najdete tady: https://aka.ms/azuremlexperimental.

ověřit zadanou komponentu. Pokud existují vložené definované entity, například Prostředí nebo Kód, nebudou vytvořeny.

archive

Archivujte komponentu.

archive(name: str, version: str | None = None, label: str | None = None, **kwargs) -> None

Parametry

name
str
Vyžadováno

Název komponenty.

version
str
Vyžadováno

Verze komponenty.

label
str
Vyžadováno

Popisek komponenty. (vzájemně se vylučují s verzí).

Příklady

Příklad součásti archivu


   ml_client.components.archive(name=component_example.name)

create_or_update

Vytvořte nebo aktualizujte zadanou komponentu. Pokud existují vložené definované entity, například Prostředí nebo Kód, vytvoří se společně s komponentou.

create_or_update(component: Component | function, version=None, *, skip_validation: bool = False, **kwargs) -> Component

Parametry

component
Union[Component, FunctionType]
Vyžadováno

Objekt komponenty nebo funkce komponenty mldesigner, která generuje objekt komponenty

version
str
Vyžadováno

Verze komponenty, která se má přepsat.

skip_validation
bool

jestli se má přeskočit ověření před vytvořením nebo aktualizací komponenty, výchozí hodnota je Nepravda

Návraty

Zadaný objekt komponenty.

Návratový typ

Component

Výjimky

ValidationException

Vyvolána, pokud komponentu nelze úspěšně ověřit. Podrobnosti budou uvedeny v chybové zprávě.

AssetException

Vyvolána, pokud prostředky komponenty (např. data, kód, model, prostředí) nelze úspěšně ověřit. Podrobnosti budou uvedeny v chybové zprávě.

ComponentException

Vyvoláno, pokud typ komponenty není podporován. Podrobnosti budou uvedeny v chybové zprávě.

ModelException

Vyvolána, pokud model komponenty nelze úspěšně ověřit. Podrobnosti budou uvedeny v chybové zprávě.

EmptyDirectoryError

Vyvoláno, pokud zadaná místní cesta odkazuje na prázdný adresář.

Příklady

Příklad vytvoření komponenty


   from azure.ai.ml import load_component
   from azure.ai.ml.entities._component.component import Component

   component_example = load_component(
       source="./sdk/ml/azure-ai-ml/tests/test_configs/components/helloworld_component.yml",
       params_override=[{"version": "1.0.2"}],
   )
   component = ml_client.components.create_or_update(component_example)

download

Poznámka

Jedná se o experimentální metodu, která se může kdykoli změnit. Další informace najdete tady: https://aka.ms/azuremlexperimental.

Stáhněte zadanou komponentu a její závislosti do místního prostředí. Místní komponentu je možné použít k vytvoření komponenty v jiném pracovním prostoru nebo k offline vývoji.

download(name: str, download_path: PathLike | str = '.', *, version: str = None) -> None

Parametry

name
str
Vyžadováno

Název komponenty kódu.

download_path
str
Vyžadováno

Místní cesta jako cíl stahování, ve výchozím nastavení je aktuální pracovní adresář aktuálního uživatele. Pokud neexistuje, vytvoří se.

version
Optional[str]

Verze komponenty.

Návraty

Zadaný objekt komponenty.

Návratový typ

Component

Výjimky

OSError

Vyvolána, pokud download_path ukazuje na existující adresář, který není prázdný. identifikované a načtené. Podrobnosti budou uvedeny v chybové zprávě.

get

Vrátí informace o zadané komponentě.

get(name: str, version: str | None = None, label: str | None = None) -> Component

Parametry

name
str
Vyžadováno

Název komponenty kódu.

version
Optional[str]
Vyžadováno

Verze komponenty.

label
Optional[str]
Vyžadováno

Popisek komponenty, který se vzájemně vylučuje s verzí.

Návraty

Zadaný objekt komponenty.

Návratový typ

Component

Výjimky

ValidationException

Vyvolána, pokud nelze úspěšně identifikovat a načíst komponentu. Podrobnosti budou uvedeny v chybové zprávě.

Příklady

Získejte příklad komponenty.


   ml_client.components.get(name=component_example.name, version="1.0.2")

list

Vypíše konkrétní komponenty nebo komponenty pracovního prostoru.

list(name: str | None = None, *, list_view_type: ListViewType = ListViewType.ACTIVE_ONLY) -> Iterable[Component]

Parametry

name
Optional[str]
Vyžadováno

Název komponenty, pokud není nastavený, zobrazí seznam všech součástí pracovního prostoru.

list_view_type

Typ zobrazení pro zahrnutí nebo vyloučení (například) archivovaných komponent Výchozí: ACTIVE_ONLY.

Návraty

Iterátor, jako je instance objektů komponent

Návratový typ

ItemPaged[Component]

Příklady

Příklad komponenty seznamu


   print(ml_client.components.list())

restore

Obnovte archivovanou komponentu.

restore(name: str, version: str | None = None, label: str | None = None, **kwargs) -> None

Parametry

name
str
Vyžadováno

Název komponenty.

version
str
Vyžadováno

Verze komponenty.

label
str
Vyžadováno

Popisek komponenty. (vzájemně se vylučují s verzí).

Příklady

Příklad obnovení komponenty


   ml_client.components.restore(name=component_example.name)

validate

Poznámka

Jedná se o experimentální metodu, která se může kdykoli změnit. Další informace najdete tady: https://aka.ms/azuremlexperimental.

ověřit zadanou komponentu. Pokud existují vložené definované entity, například Prostředí nebo Kód, nebudou vytvořeny.

validate(component: Component | function, raise_on_failure: bool = False, **kwargs) -> ValidationResult

Parametry

component
Union[Component, FunctionType]
Vyžadováno

Objekt komponenty nebo funkce komponenty mldesigner, která generuje objekt komponenty

raise_on_failure
bool
Vyžadováno

Zda se má vyvolat výjimka při chybě ověření. Výchozí hodnota je Nepravda.

Návraty

Všechny chyby ověřování

Návratový typ

ValidationResult