ComponentOperations Klasse
ComponentOperations.
Sie sollten diese Klasse nicht direkt instanziieren. Stattdessen sollten Sie einen MLClient-instance erstellen, der ihn für Sie instanziiert und als Attribut anfügt.
- Vererbung
-
azure.ai.ml._scope_dependent_operations._ScopeDependentOperationsComponentOperations
Konstruktor
ComponentOperations(operation_scope: OperationScope, operation_config: OperationConfig, service_client: AzureMachineLearningWorkspaces | AzureMachineLearningWorkspaces, all_operations: OperationsContainer, preflight_operation: DeploymentsOperations | None = None, **kwargs: Dict)
Parameter
- operation_scope
- <xref:azure.ai.ml._scope_dependent_operations.OperationScope>
Der Vorgangsbereich.
- operation_config
- <xref:azure.ai.ml._scope_dependent_operations.OperationConfig>
Die Vorgangskonfiguration.
- service_client
- Union[ <xref:azure.ai.ml._restclient.v2022_10_01.AzureMachineLearningWorkspaces>, <xref:azure.ai.ml._restclient.v2021_10_01_dataplanepreview.AzureMachineLearningWorkspaces>]
Der Dienstclient für API-Vorgänge.
- all_operations
- <xref:azure.ai.ml._scope_dependent_operations.OperationsContainer>
Der Container für alle verfügbaren Vorgänge.
- preflight_operation
- Optional[<xref:azure.ai.ml._vendor.azure_resources.operations.DeploymentsOperations>]
Der Preflight-Vorgang für Bereitstellungen.
Methoden
archive |
Archivieren sie eine Komponente. |
create_or_update |
Erstellen oder aktualisieren Sie eine angegebene Komponente. wenn inline definierte Entitäten vorhanden sind, z. B. Umgebung, Code, werden diese zusammen mit der Komponente erstellt. |
download |
Hinweis Dies ist eine experimentelle Methode, die sich jederzeit ändern kann. Unter https://aka.ms/azuremlexperimental finden Sie weitere Informationen. Laden Sie die angegebene Komponente und ihre Abhängigkeiten in local herunter. Die lokale Komponente kann verwendet werden, um die Komponente in einem anderen Arbeitsbereich oder für die Offlineentwicklung zu erstellen. |
get |
Gibt Informationen zur angegebenen Komponente zurück. |
list |
Listen Sie bestimmte Komponenten oder Komponenten des Arbeitsbereichs auf. |
restore |
Stellen Sie eine archivierte Komponente wieder her. |
validate |
Hinweis Dies ist eine experimentelle Methode, die sich jederzeit ändern kann. Unter https://aka.ms/azuremlexperimental finden Sie weitere Informationen. überprüfen Sie eine angegebene Komponente. wenn inline definierte Entitäten vorhanden sind, z. B. Umgebung, Code, werden sie nicht erstellt. |
archive
Archivieren sie eine Komponente.
archive(name: str, version: str | None = None, label: str | None = None, **kwargs) -> None
Parameter
Beispiele
Beispiel einer Archivkomponente.
ml_client.components.archive(name=component_example.name)
create_or_update
Erstellen oder aktualisieren Sie eine angegebene Komponente. wenn inline definierte Entitäten vorhanden sind, z. B. Umgebung, Code, werden diese zusammen mit der Komponente erstellt.
create_or_update(component: Component | function, version=None, *, skip_validation: bool = False, **kwargs) -> Component
Parameter
- component
- Union[Component, FunctionType]
Das Komponentenobjekt oder eine mldesigner-Komponentenfunktion, die das Komponentenobjekt generiert
- skip_validation
- bool
ob die Überprüfung vor dem Erstellen/Aktualisieren der Komponente übersprungen werden soll, ist standardmäßig False
Gibt zurück
Das angegebene Komponentenobjekt.
Rückgabetyp
Ausnahmen
Wird ausgelöst, wenn Die Komponente nicht erfolgreich überprüft werden kann. Details werden in der Fehlermeldung angegeben.
Wird ausgelöst, wenn Komponentenressourcen (z. B. Daten, Code, Modell, Umgebung) nicht erfolgreich überprüft werden können. Details werden in der Fehlermeldung angegeben.
Wird ausgelöst, wenn der Komponententyp nicht unterstützt wird. Details werden in der Fehlermeldung angegeben.
Wird ausgelöst, wenn das Komponentenmodell nicht erfolgreich überprüft werden kann. Details werden in der Fehlermeldung angegeben.
Wird ausgelöst, wenn der lokale Pfad auf ein leeres Verzeichnis verweist.
Beispiele
Beispiel zum Erstellen einer Komponente.
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
Hinweis
Dies ist eine experimentelle Methode, die sich jederzeit ändern kann. Unter https://aka.ms/azuremlexperimental finden Sie weitere Informationen.
Laden Sie die angegebene Komponente und ihre Abhängigkeiten in local herunter. Die lokale Komponente kann verwendet werden, um die Komponente in einem anderen Arbeitsbereich oder für die Offlineentwicklung zu erstellen.
download(name: str, download_path: PathLike | str = '.', *, version: str = None) -> None
Parameter
- download_path
- str
Lokaler Pfad als Downloadziel wird standardmäßig auf das aktuelle Arbeitsverzeichnis des aktuellen Benutzers festgelegt. Wird erstellt, wenn nicht vorhanden ist.
Gibt zurück
Das angegebene Komponentenobjekt.
Rückgabetyp
Ausnahmen
Wird ausgelöst, wenn download_path auf ein vorhandenes Verzeichnis verweist, das nicht leer ist. identifiziert und abgerufen. Details werden in der Fehlermeldung angegeben.
get
Gibt Informationen zur angegebenen Komponente zurück.
get(name: str, version: str | None = None, label: str | None = None) -> Component
Parameter
Bezeichnung der Komponente, die sich mit version gegenseitig ausschließt.
Gibt zurück
Das angegebene Komponentenobjekt.
Rückgabetyp
Ausnahmen
Wird ausgelöst, wenn Die Komponente nicht erfolgreich identifiziert und abgerufen werden kann. Details werden in der Fehlermeldung angegeben.
Beispiele
Komponentenbeispiel abrufen.
ml_client.components.get(name=component_example.name, version="1.0.2")
list
Listen Sie bestimmte Komponenten oder Komponenten des Arbeitsbereichs auf.
list(name: str | None = None, *, list_view_type: ListViewType = ListViewType.ACTIVE_ONLY) -> Iterable[Component]
Parameter
Komponentenname, falls nicht festgelegt, listet alle Komponenten des Arbeitsbereichs auf.
- list_view_type
Ansichtstyp für das Einschließen/Ausschließen von (z. B.) archivierten Komponenten. Standardwert: ACTIVE_ONLY.
Gibt zurück
Ein Iterator wie instance von Komponentenobjekten
Rückgabetyp
Beispiele
Beispiel für eine Listenkomponente.
print(ml_client.components.list())
restore
Stellen Sie eine archivierte Komponente wieder her.
restore(name: str, version: str | None = None, label: str | None = None, **kwargs) -> None
Parameter
Beispiele
Beispiel für die Wiederherstellungskomponente.
ml_client.components.restore(name=component_example.name)
validate
Hinweis
Dies ist eine experimentelle Methode, die sich jederzeit ändern kann. Unter https://aka.ms/azuremlexperimental finden Sie weitere Informationen.
überprüfen Sie eine angegebene Komponente. wenn inline definierte Entitäten vorhanden sind, z. B. Umgebung, Code, werden sie nicht erstellt.
validate(component: Component | function, raise_on_failure: bool = False, **kwargs) -> ValidationResult
Parameter
- component
- Union[Component, FunctionType]
Das Komponentenobjekt oder eine mldesigner-Komponentenfunktion, die das Komponentenobjekt generiert
- raise_on_failure
- bool
Gibt an, ob eine Ausnahme beim Überprüfungsfehler ausgelöst werden soll. Der Standardwert ist „FALSE“.
Gibt zurück
Alle Validierungsfehler
Rückgabetyp
Azure SDK for Python