Partager via

ComponentOperations Classe

  • Référence

ComponentOperations.

Vous ne devez pas instancier cette classe directement. Au lieu de cela, vous devez créer un instance MLClient qui l’instancie pour vous et l’attache en tant qu’attribut.

Héritage
azure.ai.ml._scope_dependent_operations._ScopeDependentOperations
ComponentOperations

Constructeur

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

Paramètres

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

Étendue de l’opération.

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

Configuration de l’opération.

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

Client de service pour les opérations d’API.

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

Conteneur pour toutes les opérations disponibles.

preflight_operation
Optional[<xref:azure.ai.ml._vendor.azure_resources.operations.DeploymentsOperations>]
valeur par défaut: None

Opération de pré-vol pour les déploiements.

kwargs
Dict
Obligatoire

Arguments mot clé supplémentaires.

Méthodes

archive

Archivez un composant.
create_or_update

Créez ou mettez à jour un composant spécifié. s’il existe des entités définies inline, par exemple Environnement, Code, elles seront créées avec le composant.
download

Notes

Il s’agit d’une méthode expérimentale qui peut changer à tout moment. Pour plus d’informations, consultez https://aka.ms/azuremlexperimental.

Téléchargez le composant spécifié et ses dépendances en local. Le composant local peut être utilisé pour créer le composant dans un autre espace de travail ou pour le développement hors connexion.
get

Retourne des informations sur le composant spécifié.
list

Répertorier le ou les composants spécifiques de l’espace de travail.
restore

Restaurez un composant archivé.
validate

Notes

Il s’agit d’une méthode expérimentale qui peut changer à tout moment. Pour plus d’informations, consultez https://aka.ms/azuremlexperimental.

valide un composant spécifié. s’il existe des entités définies inline, par exemple Environnement, Code, elles ne seront pas créées.

archive

Archivez un composant.

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

Paramètres

name
str
Obligatoire

Nom du composant.

version
str
Obligatoire

Numéro de version du composant.

label
str
Obligatoire

Étiquette du composant. (mutuellement exclusif avec version).

Exemples

Exemple de composant d’archive.


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

create_or_update

Créez ou mettez à jour un composant spécifié. s’il existe des entités définies inline, par exemple Environnement, Code, elles seront créées avec le composant.

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

Paramètres

component
Union[Component, FunctionType]
Obligatoire

Objet de composant ou fonction de composant mldesigner qui génère un objet de composant

version
str
Obligatoire

Version du composant à remplacer.

skip_validation
bool

s’il faut ignorer la validation avant de créer/mettre à jour le composant, la valeur par défaut est False

Retours

Objet de composant spécifié.

Type de retour

Component

Exceptions

ValidationException

Déclenché si le composant ne peut pas être validé avec succès. Les détails seront fournis dans le message d’erreur.

AssetException

Déclenché si les ressources de composant (par exemple, données, code, modèle, environnement) ne peuvent pas être validées avec succès. Les détails seront fournis dans le message d’erreur.

ComponentException

Déclenché si le type de composant n’est pas pris en charge. Les détails seront fournis dans le message d’erreur.

ModelException

Déclenché si le modèle de composant ne peut pas être validé avec succès. Les détails seront fournis dans le message d’erreur.

EmptyDirectoryError

Déclenché si le chemin d’accès local fourni pointe vers un répertoire vide.

Exemples

Créer un exemple de composant.


   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

Notes

Il s’agit d’une méthode expérimentale qui peut changer à tout moment. Pour plus d’informations, consultez https://aka.ms/azuremlexperimental.

Téléchargez le composant spécifié et ses dépendances en local. Le composant local peut être utilisé pour créer le composant dans un autre espace de travail ou pour le développement hors connexion.

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

Paramètres

name
str
Obligatoire

Nom du composant de code.

download_path
str
Obligatoire

Chemin d’accès local comme destination de téléchargement, par défaut sur le répertoire de travail actuel de l’utilisateur actuel. Sera créé s’il n’existe pas.

version
Optional[str]

Numéro de version du composant.

Retours

Objet de composant spécifié.

Type de retour

Component

Exceptions

OSError

Déclenché si download_path pointe vers un répertoire existant qui n’est pas vide. identifié et récupéré. Les détails seront fournis dans le message d’erreur.

get

Retourne des informations sur le composant spécifié.

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

Paramètres

name
str
Obligatoire

Nom du composant de code.

version
Optional[str]
Obligatoire

Numéro de version du composant.

label
Optional[str]
Obligatoire

Étiquette du composant, mutuellement exclusive avec la version.

Retours

Objet de composant spécifié.

Type de retour

Component

Exceptions

ValidationException

Déclenché si le composant ne peut pas être correctement identifié et récupéré. Les détails seront fournis dans le message d’erreur.

Exemples

Obtenir un exemple de composant.


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

list

Répertorier le ou les composants spécifiques de l’espace de travail.

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

Paramètres

name
Optional[str]
Obligatoire

Le nom du composant, s’il n’est pas défini, répertorie tous les composants de l’espace de travail

list_view_type

Type d’affichage pour inclure/exclure (par exemple) les composants archivés. Valeur par défaut : ACTIVE_ONLY.

Retours

Un itérateur comme instance d’objets de composant

Type de retour

ItemPaged[Component]

Exemples

Exemple de composant de liste.


   print(ml_client.components.list())

restore

Restaurez un composant archivé.

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

Paramètres

name
str
Obligatoire

Nom du composant.

version
str
Obligatoire

Numéro de version du composant.

label
str
Obligatoire

Étiquette du composant. (mutuellement exclusif avec version).

Exemples

Exemple de composant de restauration.


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

validate

Notes

Il s’agit d’une méthode expérimentale qui peut changer à tout moment. Pour plus d’informations, consultez https://aka.ms/azuremlexperimental.

valide un composant spécifié. s’il existe des entités définies inline, par exemple Environnement, Code, elles ne seront pas créées.

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

Paramètres

component
Union[Component, FunctionType]
Obligatoire

Objet de composant ou fonction de composant mldesigner qui génère un objet de composant

raise_on_failure
bool
Obligatoire

Indique s’il faut déclencher une exception en cas d’erreur de validation. Par défaut, False

Retours

Toutes les erreurs de validation

Type de retour

ValidationResult