ComponentOperations Klass

ComponentOperations.

Du bör inte instansiera den här klassen direkt. I stället bör du skapa en MLClient-instans som instansierar den åt dig och bifogar den som ett attribut.

Arv

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)

Parametrar

operation_scope

<xref:azure.ai.ml._scope_dependent_operations.OperationScope>

Obligatorisk

Åtgärdsomfånget.

operation_config

<xref:azure.ai.ml._scope_dependent_operations.OperationConfig>

Obligatorisk

Åtgärdskonfigurationen.

service_client

Union[ <xref:azure.ai.ml._restclient.v2022_10_01.AzureMachineLearningWorkspaces>, <xref:azure.ai.ml._restclient.v2021_10_01_dataplanepreview.AzureMachineLearningWorkspaces>]

Obligatorisk

Tjänstklienten för API-åtgärder.

all_operations

<xref:azure.ai.ml._scope_dependent_operations.OperationsContainer>

Obligatorisk

Containern för alla tillgängliga åtgärder.

preflight_operation

Optional[<xref:azure.ai.ml._vendor.azure_resources.operations.DeploymentsOperations>]

standardvärde: None

Den preliminära åtgärden för distributioner.

kwargs

Dict

Obligatorisk

Ytterligare nyckelordsargument.

Metoder

archive	Arkivera en komponent.
create_or_update	Skapa eller uppdatera en angiven komponent. Om det finns infogade entiteter, t.ex. miljö, kod, skapas de tillsammans med komponenten.
download	Anteckning Det här är en experimentell metod och kan ändras när som helst. Mer information finns i https://aka.ms/azuremlexperimental. Ladda ned den angivna komponenten och dess beroenden till lokalt. Lokal komponent kan användas för att skapa komponenten på en annan arbetsyta eller för offlineutveckling.
get	Returnerar information om den angivna komponenten.
list	Visa en lista över specifika komponenter i arbetsytan.
restore	Återställa en arkiverad komponent.
validate	Anteckning Det här är en experimentell metod och kan ändras när som helst. Mer information finns i https://aka.ms/azuremlexperimental. verifiera en angiven komponent. Om det finns infogade entiteter, t.ex. miljö, kod, skapas de inte.

archive

Arkivera en komponent.

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

Parametrar

name

str

Obligatorisk

Namnet på komponenten.

version

str

Obligatorisk

Komponentens version.

label

str

Obligatorisk

Komponentens etikett. (ömsesidigt uteslutande med version).

Exempel

Exempel på arkivkomponent.

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

create_or_update

Skapa eller uppdatera en angiven komponent. Om det finns infogade entiteter, t.ex. miljö, kod, skapas de tillsammans med komponenten.

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

Parametrar

component

Union[Component, FunctionType]

Obligatorisk

Komponentobjektet eller en mldesigner-komponentfunktion som genererar komponentobjekt

version

str

Obligatorisk

Komponentversionen som ska åsidosättas.

skip_validation

bool

om du vill hoppa över valideringen innan du skapar/uppdaterar komponenten är standardvärdet Falskt

Returer

Det angivna komponentobjektet.

Returtyp

Component

Undantag

ValidationException

Utlöses om komponenten inte kan verifieras. Information kommer att anges i felmeddelandet.

AssetException

Utlöses om komponenttillgångar (t.ex. data, kod, modell, miljö) inte kan verifieras. Information kommer att anges i felmeddelandet.

ComponentException

Aktiveras om komponenttypen inte stöds. Information kommer att anges i felmeddelandet.

ModelException

Utlöses om komponentmodellen inte kan verifieras. Information kommer att anges i felmeddelandet.

EmptyDirectoryError

Utlöses om den lokala sökvägen pekar på en tom katalog.

Exempel

Skapa komponentexempel.

   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

Anteckning

Det här är en experimentell metod och kan ändras när som helst. Mer information finns i https://aka.ms/azuremlexperimental.

Ladda ned den angivna komponenten och dess beroenden till lokalt. Lokal komponent kan användas för att skapa komponenten på en annan arbetsyta eller för offlineutveckling.

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

Parametrar

name

str

Obligatorisk

Namnet på kodkomponenten.

download_path

str

Obligatorisk

Lokal sökväg som nedladdningsmål, som standard till aktuell arbetskatalog för den aktuella användaren. Skapas om den inte finns.

version

Optional[str]

Komponentens version.

Returer

Det angivna komponentobjektet.

Returtyp

Component

Undantag

OSError

Aktiveras om download_path pekar på en befintlig katalog som inte är tom. identifieras och hämtas. Information kommer att anges i felmeddelandet.

get

Returnerar information om den angivna komponenten.

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

Parametrar

name

str

Obligatorisk

Namnet på kodkomponenten.

version

Optional[str]

Obligatorisk

Komponentens version.

label

Optional[str]

Obligatorisk

Etikett för komponenten, ömsesidigt uteslutande med version.

Returer

Det angivna komponentobjektet.

Returtyp

Component

Undantag

ValidationException

Utlöses om komponenten inte kan identifieras och hämtas. Information kommer att anges i felmeddelandet.

Exempel

Hämta komponentexempel.

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

list

Visa en lista över specifika komponenter i arbetsytan.

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

Parametrar

name

Optional[str]

Obligatorisk

Komponentnamn, om det inte anges, visar en lista över alla komponenter i arbetsytan

list_view_type

Visa typ för att inkludera/exkluderas (till exempel) arkiverade komponenter. Standard: ACTIVE_ONLY.

Returer

En iterator som en instans av komponentobjekt

Returtyp

ItemPaged[Component]

Exempel

Exempel på listkomponent.

   print(ml_client.components.list())

restore

Återställa en arkiverad komponent.

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

Parametrar

name

str

Obligatorisk

Namnet på komponenten.

version

str

Obligatorisk

Komponentens version.

label

str

Obligatorisk

Komponentens etikett. (ömsesidigt uteslutande med version).

Exempel

Exempel på återställningskomponent.

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

validate

Anteckning

Det här är en experimentell metod och kan ändras när som helst. Mer information finns i https://aka.ms/azuremlexperimental.

verifiera en angiven komponent. Om det finns infogade entiteter, t.ex. miljö, kod, skapas de inte.

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

Parametrar

component

Union[Component, FunctionType]

Obligatorisk

Komponentobjektet eller en mldesigner-komponentfunktion som genererar komponentobjekt

raise_on_failure

bool

Obligatorisk

Om du vill generera ett undantag vid valideringsfel. Standardvärdet är Falskt

Returer

Alla valideringsfel

Returtyp

ValidationResult