ComponentOperations Klas

ComponentOperations.

U moet deze klasse niet rechtstreeks instantiëren. In plaats daarvan moet u een MLClient-exemplaar maken dat het voor u instanteert en als een kenmerk koppelt.

Overname

azure.ai.ml._scope_dependent_operations._ScopeDependentOperations

ComponentOperations

Constructor

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

Parameters

operation_scope

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

Vereist

Het bewerkingsbereik.

operation_config

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

Vereist

De bewerkingsconfiguratie.

service_client

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

Vereist

De serviceclient voor API-bewerkingen.

all_operations

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

Vereist

De container voor alle beschikbare bewerkingen.

preflight_operation

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

standaardwaarde: None

De voorbereidende bewerking voor implementaties.

kwargs

Dict

Vereist

Aanvullende trefwoordargumenten.

Methoden

archive	Een onderdeel archiveren.
create_or_update	Een opgegeven onderdeel maken of bijwerken. Als er inline gedefinieerde entiteiten zijn, bijvoorbeeld Omgeving, Code, worden deze samen met het onderdeel gemaakt.
download	Notitie Dit is een experimentele methode en kan op elk gewenst moment worden gewijzigd. Zie https://aka.ms/azuremlexperimental voor meer informatie. Download het opgegeven onderdeel en de bijbehorende afhankelijkheden naar lokaal. Het lokale onderdeel kan worden gebruikt om het onderdeel te maken in een andere werkruimte of voor offlineontwikkeling.
get	Retourneert informatie over het opgegeven onderdeel.
list	Een lijst maken met specifieke onderdelen van de werkruimte.
restore	Een gearchiveerd onderdeel herstellen.
validate	Notitie Dit is een experimentele methode en kan op elk gewenst moment worden gewijzigd. Zie https://aka.ms/azuremlexperimental voor meer informatie. een opgegeven onderdeel valideren. als er inline gedefinieerde entiteiten zijn, bijvoorbeeld Omgeving, Code, worden deze niet gemaakt.

archive

Een onderdeel archiveren.

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

Parameters

name

str

Vereist

Naam van het onderdeel.

version

str

Vereist

Versie van het onderdeel.

label

str

Vereist

Label van het onderdeel. (sluiten elkaar wederzijds uit met versie).

Voorbeelden

Voorbeeld van archiefonderdeel.

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

create_or_update

Een opgegeven onderdeel maken of bijwerken. Als er inline gedefinieerde entiteiten zijn, bijvoorbeeld Omgeving, Code, worden deze samen met het onderdeel gemaakt.

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

Parameters

component

Union[Component, FunctionType]

Vereist

Het onderdeelobject of een mldesigner-onderdeelfunctie die onderdeelobject genereert

version

str

Vereist

De onderdeelversie die moet worden overschreven.

skip_validation

bool

of validatie moet worden overgeslagen voordat u het onderdeel maakt/bijwerkt, wordt standaard ingesteld op False

Retouren

Het opgegeven onderdeelobject.

Retourtype

Component

Uitzonderingen

ValidationException

Gegenereerd als het onderdeel niet kan worden gevalideerd. Meer informatie vindt u in het foutbericht.

AssetException

Gegenereerd als onderdelenassets (bijvoorbeeld gegevens, code, model, omgeving) niet kunnen worden gevalideerd. Meer informatie vindt u in het foutbericht.

ComponentException

Gegenereerd als het onderdeeltype niet wordt ondersteund. Meer informatie vindt u in het foutbericht.

ModelException

Gegenereerd als het onderdeelmodel niet kan worden gevalideerd. Meer informatie vindt u in het foutbericht.

EmptyDirectoryError

Wordt gegenereerd als het opgegeven lokale pad verwijst naar een lege map.

Voorbeelden

Voorbeeld van onderdeel maken.

   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

Notitie

Dit is een experimentele methode en kan op elk gewenst moment worden gewijzigd. Zie https://aka.ms/azuremlexperimental voor meer informatie.

Download het opgegeven onderdeel en de bijbehorende afhankelijkheden naar lokaal. Het lokale onderdeel kan worden gebruikt om het onderdeel te maken in een andere werkruimte of voor offlineontwikkeling.

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

Parameters

name

str

Vereist

Naam van het codeonderdeel.

download_path

str

Vereist

Lokaal pad als downloadbestemming, wordt standaard ingesteld op de huidige werkmap van de huidige gebruiker. Wordt gemaakt als deze niet bestaat.

version

Optional[str]

Versie van het onderdeel.

Retouren

Het opgegeven onderdeelobject.

Retourtype

Component

Uitzonderingen

OSError

Wordt gegenereerd als download_path verwijst naar een bestaande map die niet leeg is. geïdentificeerd en opgehaald. Meer informatie vindt u in het foutbericht.

get

Retourneert informatie over het opgegeven onderdeel.

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

Parameters

name

str

Vereist

Naam van het codeonderdeel.

version

Optional[str]

Vereist

Versie van het onderdeel.

label

Optional[str]

Vereist

Label van het onderdeel, wederzijds exclusief met versie.

Retouren

Het opgegeven onderdeelobject.

Retourtype

Component

Uitzonderingen

ValidationException

Gegenereerd als het onderdeel niet kan worden geïdentificeerd en opgehaald. Meer informatie vindt u in het foutbericht.

Voorbeelden

Voorbeeld van onderdeel ophalen.

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

list

Een lijst maken met specifieke onderdelen van de werkruimte.

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

Parameters

name

Optional[str]

Vereist

Onderdeelnaam, indien niet ingesteld, lijst met alle onderdelen van de werkruimte

list_view_type

Weergavetype voor het opnemen/uitsluiten van (bijvoorbeeld) gearchiveerde onderdelen. Standaardinstelling: ACTIVE_ONLY.

Retouren

Een iterator-achtige instantie van onderdeelobjecten

Retourtype

ItemPaged[Component]

Voorbeelden

Voorbeeld van lijstonderdeel.

   print(ml_client.components.list())

restore

Een gearchiveerd onderdeel herstellen.

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

Parameters

name

str

Vereist

Naam van het onderdeel.

version

str

Vereist

Versie van het onderdeel.

label

str

Vereist

Label van het onderdeel. (sluiten elkaar wederzijds uit met versie).

Voorbeelden

Voorbeeld van onderdeel herstellen.

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

validate

Notitie

Dit is een experimentele methode en kan op elk gewenst moment worden gewijzigd. Zie https://aka.ms/azuremlexperimental voor meer informatie.

een opgegeven onderdeel valideren. als er inline gedefinieerde entiteiten zijn, bijvoorbeeld Omgeving, Code, worden deze niet gemaakt.

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

Parameters

component

Union[Component, FunctionType]

Vereist

Het onderdeelobject of een mldesigner-onderdeelfunctie die onderdeelobject genereert

raise_on_failure

bool

Vereist

Of er een uitzondering moet worden gegenereerd voor validatiefout. Standaard ingesteld op False.

Retouren

Alle validatiefouten

Retourtype

ValidationResult