Condividi tramite

ComponentOperations Classe

  • Riferimento

ComponentOperations.

Non è consigliabile creare direttamente un'istanza di questa classe. È invece necessario creare un'istanza di MLClient che lo crea e lo associa come attributo.

Ereditarietà
azure.ai.ml._scope_dependent_operations._ScopeDependentOperations
ComponentOperations

Costruttore

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

Parametri

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

Ambito dell'operazione.

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

Configurazione dell'operazione.

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

Client del servizio per le operazioni api.

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

Contenitore per tutte le operazioni disponibili.

preflight_operation
Optional[<xref:azure.ai.ml._vendor.azure_resources.operations.DeploymentsOperations>]
valore predefinito: None

Operazione preliminare per le distribuzioni.

kwargs
Dict
Necessario

Argomenti di parole chiave aggiuntivi.

Metodi

archive

Archiviare un componente.
create_or_update

Creare o aggiornare un componente specificato. se sono presenti entità definite inline, ad esempio Ambiente, Codice, verranno create insieme al componente.
download

Nota

Si tratta di un metodo sperimentale e può cambiare in qualsiasi momento. Per altre informazioni, vedere https://aka.ms/azuremlexperimental.

Scaricare il componente specificato e le relative dipendenze in locale. Il componente locale può essere usato per creare il componente in un'altra area di lavoro o per lo sviluppo offline.
get

Restituisce informazioni sul componente specificato.
list

Elencare componenti o componenti specifici dell'area di lavoro.
restore

Ripristinare un componente archiviato.
validate

Nota

Si tratta di un metodo sperimentale e può cambiare in qualsiasi momento. Per altre informazioni, vedere https://aka.ms/azuremlexperimental.

convalidare un componente specificato. se sono presenti entità definite inline, ad esempio Ambiente, Codice, non verranno create.

archive

Archiviare un componente.

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

Parametri

name
str
Necessario

Nome del componente.

version
str
Necessario

Versione del componente.

label
str
Necessario

Etichetta del componente. (a vicenda esclusivo con la versione).

Esempio

Esempio di componente di archiviazione.


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

create_or_update

Creare o aggiornare un componente specificato. se sono presenti entità definite inline, ad esempio Ambiente, Codice, verranno create insieme al componente.

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

Parametri

component
Union[Component, FunctionType]
Necessario

Oggetto componente o una funzione componente mldesigner che genera un oggetto componente

version
str
Necessario

Versione del componente da eseguire l'override.

skip_validation
bool

se ignorare la convalida prima di creare/aggiornare il componente, impostazione predefinita su False

Restituisce

Oggetto componente specificato.

Tipo restituito

Component

Eccezioni

ValidationException

Generato se il componente non può essere convalidato correttamente. I dettagli verranno forniti nel messaggio di errore.

AssetException

Generato se gli asset componente (ad esempio Dati, Codice, Modello, Ambiente) non possono essere convalidati correttamente. I dettagli verranno forniti nel messaggio di errore.

ComponentException

Generato se il tipo di componente non è supportato. I dettagli verranno forniti nel messaggio di errore.

ModelException

Generato se il modello componente non può essere convalidato correttamente. I dettagli verranno forniti nel messaggio di errore.

EmptyDirectoryError

Generato se il percorso locale ha fornito punti a una directory vuota.

Esempio

Creare un esempio di componente.


   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

Nota

Si tratta di un metodo sperimentale e può cambiare in qualsiasi momento. Per altre informazioni, vedere https://aka.ms/azuremlexperimental.

Scaricare il componente specificato e le relative dipendenze in locale. Il componente locale può essere usato per creare il componente in un'altra area di lavoro o per lo sviluppo offline.

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

Parametri

name
str
Necessario

Nome del componente di codice.

download_path
str
Necessario

Percorso locale come destinazione di download, impostazione predefinita per la directory di lavoro corrente dell'utente corrente. Verrà creato se non esiste.

version
Optional[str]

Versione del componente.

Restituisce

Oggetto componente specificato.

Tipo restituito

Component

Eccezioni

OSError

Generato se download_path punta a una directory esistente che non è vuota. identificato e recuperato. I dettagli verranno forniti nel messaggio di errore.

get

Restituisce informazioni sul componente specificato.

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

Parametri

name
str
Necessario

Nome del componente di codice.

version
Optional[str]
Necessario

Versione del componente.

label
Optional[str]
Necessario

Etichetta del componente, a vicenda esclusiva con la versione.

Restituisce

Oggetto componente specificato.

Tipo restituito

Component

Eccezioni

ValidationException

Generato se il componente non può essere identificato e recuperato correttamente. I dettagli verranno forniti nel messaggio di errore.

Esempio

Ottenere un esempio di componente.


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

list

Elencare componenti o componenti specifici dell'area di lavoro.

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

Parametri

name
Optional[str]
Necessario

Nome componente, se non impostato, elencare tutti i componenti dell'area di lavoro

list_view_type

Tipo di visualizzazione per i componenti archiviati(ad esempio) inclusi/esclusi. Impostazione predefinita: ACTIVE_ONLY.

Restituisce

Iteratore come istanza di oggetti componente

Tipo restituito

ItemPaged[Component]

Esempio

Esempio di componente elenco.


   print(ml_client.components.list())

restore

Ripristinare un componente archiviato.

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

Parametri

name
str
Necessario

Nome del componente.

version
str
Necessario

Versione del componente.

label
str
Necessario

Etichetta del componente. (a vicenda esclusivo con la versione).

Esempio

Esempio di componente di ripristino.


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

validate

Nota

Si tratta di un metodo sperimentale e può cambiare in qualsiasi momento. Per altre informazioni, vedere https://aka.ms/azuremlexperimental.

convalidare un componente specificato. se sono presenti entità definite inline, ad esempio Ambiente, Codice, non verranno create.

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

Parametri

component
Union[Component, FunctionType]
Necessario

Oggetto componente o una funzione componente mldesigner che genera un oggetto componente

raise_on_failure
bool
Necessario

Indica se generare un'eccezione per l'errore di convalida. Il valore predefinito è False

Restituisce

Tutti gli errori di convalida

Tipo restituito

ValidationResult