Workspace Klas

Definieert een Azure Machine Learning-resource voor het beheren van training en implementatieartefacten.

Een werkruimte is een fundamentele resource voor machine learning in Azure Machine Learning. U gebruikt een werkruimte om machine learning-modellen te experimenteren, te trainen en te implementeren. Elke werkruimte is gekoppeld aan een Azure-abonnement en resourcegroep en heeft een bijbehorende SKU.

Zie voor meer informatie over werkruimten:

Klassewerkruimteconstructor voor het laden van een bestaande Azure Machine Learning-werkruimte.

Overname
builtins.object
Workspace

Constructor

Workspace(subscription_id, resource_group, workspace_name, auth=None, _location=None, _disable_service_check=False, _workspace_id=None, sku='basic', tags=None, _cloud='AzureCloud')

Parameters

subscription_id
str
Vereist

De Azure-abonnements-id die de werkruimte bevat.

resource_group
str
Vereist

De resourcegroep die de werkruimte bevat.

workspace_name
str
Vereist

De naam van de bestaande werkruimte.

auth
ServicePrincipalAuthentication of InteractiveLoginAuthentication of MsiAuthentication
standaardwaarde: None

Het verificatieobject. Zie voor meer informatie https://aka.ms/aml-notebook-auth. Indien Geen, worden de standaard Azure CLI-referenties gebruikt of wordt door de API om referenties gevraagd.

_location
str
standaardwaarde: None

Alleen intern gebruik.

_disable_service_check
bool
standaardwaarde: False

Alleen intern gebruik.

_workspace_id
str
standaardwaarde: None

Alleen intern gebruik.

sku
str
standaardwaarde: basic

De parameter is aanwezig voor achterwaartse compatibiliteit en wordt genegeerd.

_cloud
str
standaardwaarde: AzureCloud

Alleen intern gebruik.

subscription_id
str
Vereist

De Azure-abonnements-id die de werkruimte bevat.

resource_group
str
Vereist

De resourcegroep die de werkruimte bevat.

workspace_name
str
Vereist

De naam van de werkruimte. De naam moet tussen 2 en 32 tekens lang zijn. Het eerste teken van de naam moet alfanumeriek (letter of cijfer) zijn, maar de rest van de naam kan alfanumerieke tekens, afbreekstreepjes en onderstrepingstekens bevatten. Witruimte is niet toegestaan.

auth
ServicePrincipalAuthentication of InteractiveLoginAuthentication of MsiAuthentication
Vereist

Het verificatieobject. Zie voor meer informatie https://aka.ms/aml-notebook-auth. Indien Geen, worden de standaard Azure CLI-referenties gebruikt of wordt door de API om referenties gevraagd.

_location
str
Vereist

Alleen intern gebruik.

_disable_service_check
bool
Vereist

Alleen intern gebruik.

_workspace_id
str
Vereist

Alleen intern gebruik.

sku
str
Vereist

De parameter is aanwezig voor achterwaartse compatibiliteit en wordt genegeerd.

tags
dict
standaardwaarde: None

Tags die aan de werkruimte moeten worden gekoppeld.

_cloud
str
Vereist

Alleen intern gebruik.

Opmerkingen

In het volgende voorbeeld ziet u hoe u een werkruimte maakt.


   from azureml.core import Workspace
   ws = Workspace.create(name='myworkspace',
               subscription_id='<azure-subscription-id>',
               resource_group='myresourcegroup',
               create_resource_group=True,
               location='eastus2'
               )

Stel in create_resource_group op Onwaar als u een bestaande Azure-resourcegroep hebt die u wilt gebruiken voor de werkruimte.

Als u dezelfde werkruimte in meerdere omgevingen wilt gebruiken, maakt u een JSON-configuratiebestand. Het configuratiebestand slaat uw abonnement, resource en werkruimtenaam op, zodat deze eenvoudig kan worden geladen. Gebruik de write_config methode om de configuratie op te slaan.


   ws.write_config(path="./file-path", file_name="ws_config.json")

Zie Een werkruimteconfiguratiebestand maken voor een voorbeeld van het configuratiebestand.

Gebruik from_config de methode om de werkruimte uit het configuratiebestand te laden.


   ws = Workspace.from_config()
   ws.get_details()

U kunt ook de get methode gebruiken om een bestaande werkruimte te laden zonder configuratiebestanden te gebruiken.


   ws = Workspace.get(name="myworkspace",
               subscription_id='<azure-subscription-id>',
               resource_group='myresourcegroup')

In de bovenstaande voorbeelden wordt u mogelijk om Azure-verificatiereferenties gevraagd via een interactief aanmeldingsdialoogvenster. Zie Verificatie in Azure Machine Learning voor andere use cases, waaronder het gebruik van de Azure CLI voor verificatie en verificatie in geautomatiseerde werkstromen.

Methoden

add_private_endpoint

Voeg een privé-eindpunt toe aan de werkruimte.

create

Maak een nieuwe Azure Machine Learning-werkruimte.

Genereert een uitzondering als de werkruimte al bestaat of als niet aan een van de vereisten voor de werkruimte wordt voldaan.

delete

Verwijder de gekoppelde resources van de Azure Machine Learning-werkruimte.

delete_connection

Een verbinding van de werkruimte verwijderen.

delete_private_endpoint_connection

Verwijder de privé-eindpuntverbinding met de werkruimte.

diagnose_workspace

Problemen met het instellen van werkruimten vaststellen.

from_config

Een werkruimteobject retourneren uit een bestaande Azure Machine Learning-werkruimte.

Leest de werkruimteconfiguratie uit een bestand. Genereert een uitzondering als het configuratiebestand niet kan worden gevonden.

De methode biedt een eenvoudige manier om dezelfde werkruimte opnieuw te gebruiken in meerdere Python-notebooks of -projecten. Gebruikers kunnen de eigenschappen van de werkruimte Azure Resource Manager (ARM) opslaan met behulp van de write_config methode en deze methode gebruiken om dezelfde werkruimte in verschillende Python-notebooks of -projecten te laden zonder de ARM-eigenschappen van de werkruimte opnieuw te typen.

get

Een werkruimteobject retourneren voor een bestaande Azure Machine Learning-werkruimte.

Genereert een uitzondering als de werkruimte niet bestaat of als de vereiste velden een werkruimte niet uniek identificeren.

get_connection

Maak verbinding met de werkruimte.

get_default_compute_target

Haal het standaard rekendoel voor de werkruimte op.

get_default_datastore

Haal het standaardgegevensarchief voor de werkruimte op.

get_default_keyvault

Haal het standaardsleutelkluisobject voor de werkruimte op.

get_details

Retourneer de details van de werkruimte.

get_mlflow_tracking_uri

Haal de MLflow-tracerings-URI voor de werkruimte op.

MLflow (https://mlflow.org/) is een opensource-platform voor het bijhouden van machine learning-experimenten en het beheren van modellen. U kunt MLflow-API's voor logboekregistratie gebruiken met Azure Machine Learning, zodat metrische gegevens, modellen en artefacten worden geregistreerd in uw Azure Machine Learning-werkruimte.

get_run

Retourneer de uitvoering met de opgegeven run_id in de werkruimte.

list

Alle werkruimten weergeven waartoe de gebruiker toegang heeft binnen het abonnement.

De lijst met werkruimten kan worden gefilterd op basis van de resourcegroep.

list_connections

Maak een lijst met verbindingen onder deze werkruimte.

list_keys

Sleutels voor de huidige werkruimte weergeven.

set_connection

Een verbinding toevoegen of bijwerken onder de werkruimte.

set_default_datastore

Stel het standaardgegevensarchief voor de werkruimte in.

setup

Maak een nieuwe werkruimte of haal een bestaande werkruimte op.

sync_keys

Hiermee activeert u de werkruimte om sleutels onmiddellijk te synchroniseren.

Als sleutels voor een resource in de werkruimte worden gewijzigd, kan het ongeveer een uur duren voordat ze automatisch worden bijgewerkt. Met deze functie kunnen sleutels op aanvraag worden bijgewerkt. Een voorbeeldscenario is onmiddellijke toegang tot opslag nodig na het opnieuw genereren van opslagsleutels.

update

Werk beschrijvende naam, beschrijving, tags, berekening van installatiekopieën en andere instellingen bij die zijn gekoppeld aan een werkruimte.

update_dependencies

Werk bestaande de gekoppelde resources voor de werkruimte bij in de volgende gevallen.

a) Wanneer een gebruiker per ongeluk een bestaande gekoppelde resource verwijdert en deze wil bijwerken met een nieuwe resource zonder de hele werkruimte opnieuw te hoeven maken. b) Wanneer een gebruiker een bestaande gekoppelde resource heeft en de huidige resource die aan de werkruimte is gekoppeld, wil vervangen. c) Wanneer er nog geen gekoppelde resource is gemaakt en ze een bestaande resource willen gebruiken die ze al hebben (alleen van toepassing op containerregister).

write_config

Schrijf de eigenschappen van de werkruimte Azure Resource Manager (ARM) naar een configuratiebestand.

Arm-eigenschappen van werkruimten kunnen later worden geladen met behulp van de from_config methode . De path standaardinstelling is '.azureml/' in de huidige werkmap en file_name standaard ingesteld op 'config.json'.

De methode biedt een eenvoudige manier om dezelfde werkruimte opnieuw te gebruiken in meerdere Python-notebooks of -projecten. Gebruikers kunnen de ARM-eigenschappen van de werkruimte opslaan met behulp van deze functie en from_config gebruiken om dezelfde werkruimte in verschillende Python-notebooks of -projecten te laden zonder de ARM-eigenschappen van de werkruimte opnieuw te typen.

add_private_endpoint

Voeg een privé-eindpunt toe aan de werkruimte.

add_private_endpoint(private_endpoint_config, private_endpoint_auto_approval=True, location=None, show_output=True, tags=None)

Parameters

private_endpoint_config
PrivateEndPointConfig
Vereist

De configuratie van het privé-eindpunt voor het maken van een privé-eindpunt naar de werkruimte.

private_endpoint_auto_approval
bool
standaardwaarde: True

Een booleaanse vlag die aangeeft of het maken van het privé-eindpunt automatisch of handmatig moet worden goedgekeurd vanuit Azure Private Link Center. In het geval van handmatige goedkeuring kunnen gebruikers de in behandeling zijnde aanvraag bekijken in Private Link portal om de aanvraag goed te keuren of af te wijzen.

location
string
standaardwaarde: None

Locatie van het privé-eindpunt. Standaard is de werkruimtelocatie

show_output
bool
standaardwaarde: True

Vlag voor het weergeven van de voortgang van het maken van werkruimten

tags
dict
standaardwaarde: None

Tags die aan de werkruimte moeten worden gekoppeld.

Retouren

Het PrivateEndPoint-object dat is gemaakt.

Retourtype

create

Maak een nieuwe Azure Machine Learning-werkruimte.

Genereert een uitzondering als de werkruimte al bestaat of als niet aan een van de vereisten voor de werkruimte wordt voldaan.

static create(name, auth=None, subscription_id=None, resource_group=None, location=None, create_resource_group=True, sku='basic', tags=None, friendly_name=None, storage_account=None, key_vault=None, app_insights=None, container_registry=None, adb_workspace=None, primary_user_assigned_identity=None, cmk_keyvault=None, resource_cmk_uri=None, hbi_workspace=False, default_cpu_compute_target=None, default_gpu_compute_target=None, private_endpoint_config=None, private_endpoint_auto_approval=True, exist_ok=False, show_output=True, user_assigned_identity_for_cmk_encryption=None, system_datastores_auth_mode='accessKey', v1_legacy_mode=None)

Parameters

name
str
Vereist

De naam van de nieuwe werkruimte. De naam moet tussen 2 en 32 tekens lang zijn. Het eerste teken van de naam moet alfanumeriek (letter of cijfer) zijn, maar de rest van de naam kan alfanumerieke tekens, afbreekstreepjes en onderstrepingstekens bevatten. Witruimte is niet toegestaan.

auth
ServicePrincipalAuthentication of InteractiveLoginAuthentication
standaardwaarde: None

Het verificatieobject. Zie voor meer informatie https://aka.ms/aml-notebook-auth. Indien Geen, worden de standaard Azure CLI-referenties gebruikt of wordt door de API om referenties gevraagd.

subscription_id
str
standaardwaarde: None

De abonnements-id van het betreffende abonnement voor de nieuwe werkruimte. De parameter is vereist als de gebruiker toegang heeft tot meer dan één abonnement.

resource_group
str
standaardwaarde: None

De Azure-resourcegroep die de werkruimte bevat. De parameter is standaard ingesteld op een mutatie van de naam van de werkruimte.

location
str
standaardwaarde: None

De locatie van de werkruimte. De parameter wordt standaard ingesteld op de locatie van de resourcegroep. De locatie moet een ondersteunde regio zijn voor Azure Machine Learning.

create_resource_group
bool
standaardwaarde: True

Geeft aan of de resourcegroep moet worden gemaakt als deze niet bestaat.

sku
str
standaardwaarde: basic

De parameter is aanwezig voor achterwaartse compatibiliteit en wordt genegeerd.

tags
dict
standaardwaarde: None

Tags die aan de werkruimte moeten worden gekoppeld.

friendly_name
str
standaardwaarde: None

Een optionele beschrijvende naam voor de werkruimte die kan worden weergegeven in de gebruikersinterface.

storage_account
str
standaardwaarde: None

Een bestaand opslagaccount in de azure-resource-id-indeling. De opslag wordt door de werkruimte gebruikt om uitvoer, code, logboeken, enzovoort op te slaan. Bij Geen wordt er een nieuw opslagaccount gemaakt.

key_vault
str
standaardwaarde: None

Een bestaande sleutelkluis in de azure-resource-id-indeling. Zie voorbeeldcode hieronder voor meer informatie over de indeling van de Azure-resource-id. De sleutelkluis wordt door de werkruimte gebruikt voor het opslaan van referenties die door de gebruikers aan de werkruimte zijn toegevoegd. Bij Geen wordt er een nieuwe sleutelkluis gemaakt.

app_insights
str
standaardwaarde: None

Een bestaande Application Insights in de indeling van de Azure-resource-id. Zie voorbeeldcode hieronder voor meer informatie over de indeling van de Azure-resource-id. Application Insights wordt door de werkruimte gebruikt om webservices-gebeurtenissen te registreren. Als dit geen is, wordt er een nieuwe Application Insights gemaakt.

container_registry
str
standaardwaarde: None

Een bestaand containerregister in de indeling van de Azure-resource-id (zie voorbeeldcode hieronder voor meer informatie over de indeling van de Azure-resource-id). Het containerregister wordt door de werkruimte gebruikt om zowel experimenten als installatiekopieën van webservices op te halen en te pushen. Indien Geen, wordt er alleen een nieuw containerregister gemaakt wanneer dat nodig is en niet samen met het maken van een werkruimte.

adb_workspace
str
standaardwaarde: None

Een bestaande Adb-werkruimte in de Indeling van de Azure-resource-id (zie voorbeeldcode hieronder voor meer informatie over de indeling van de Azure-resource-id). De Adb-werkruimte wordt gebruikt om een koppeling te maken met de werkruimte. Als er Geen is, wordt de koppeling naar de werkruimte niet uitgevoerd.

primary_user_assigned_identity
str
standaardwaarde: None

De resource-id van de door de gebruiker toegewezen identiteit die wordt gebruikt om de werkruimte weer te geven

cmk_keyvault
str
standaardwaarde: None

De sleutelkluis met de door de klant beheerde sleutel in de azure-resource-id-indeling:/subscriptions/<azure-subscription-id>/resourcegroups/<azure-resource-group>/providers/microsoft.keyvault/vaults/<azure-keyvault-name> Bijvoorbeeld: '/subscriptions/d139f240-94e6-4175-87a7-954b9d27db16/resourcegroups/myresourcegroup/providers/microsoft.keyvault/vaults/mykeyvault' Zie de voorbeeldcode in de onderstaande opmerkingen voor meer informatie over de indeling van de Azure-resource-id.

resource_cmk_uri
str
standaardwaarde: None

De sleutel-URI van de door de klant beheerde sleutel om de data-at-rest te versleutelen. De URI-indeling is: https://<keyvault-dns-name>/keys/<key-name>/<key-version>. Bijvoorbeeld: 'https://mykeyvault.vault.azure.net/keys/mykey/bc5dce6d01df49w2na7ffb11a2ee008b'. https://docs.microsoft.com/azure-stack/user/azure-stack-key-vault-manage-portal Raadpleeg voor stappen voor het maken van een sleutel en het ophalen van de bijbehorende URI.

hbi_workspace
bool
standaardwaarde: False

Hiermee geeft u op of de werkruimte gegevens van HBI (High Business Impact) bevat, d.w.w.v. gevoelige bedrijfsgegevens bevat. Deze vlag kan alleen worden ingesteld tijdens het maken van de werkruimte. De waarde ervan kan niet worden gewijzigd nadat de werkruimte is gemaakt. De standaardwaarde is False.

Als deze optie is ingesteld op Waar, worden verdere versleutelingsstappen uitgevoerd. Afhankelijk van het SDK-onderdeel resulteert dit in geredigeerde informatie in intern verzamelde telemetrie. Zie Gegevensversleuteling voor meer informatie.

Wanneer deze vlag is ingesteld op Waar, is een mogelijke impact de toegenomen problemen met het oplossen van problemen. Dit kan gebeuren omdat bepaalde telemetriegegevens niet naar Microsoft worden verzonden en er minder inzicht is in succespercentages of probleemtypen, en daarom mogelijk niet zo proactief kunnen reageren als deze vlag Waar is. De aanbeveling is het gebruik van de standaardwaarde Onwaar voor deze vlag, tenzij strikt vereist is om Waar te zijn.

default_cpu_compute_target
AmlComputeProvisioningConfiguration
standaardwaarde: None

(AFGESCHAFT) Een configuratie die wordt gebruikt om een CPU-berekening te maken. De parameter is standaard ingesteld op {min_nodes=0, max_nodes=2, vm_size="STANDARD_DS2_V2", vm_priority="dedicated"} Als er geen is, wordt er geen berekening gemaakt.

default_gpu_compute_target
AmlComputeProvisioningConfiguration
standaardwaarde: None

(AFGESCHAFT) Een configuratie die wordt gebruikt om een GPU-berekening te maken. De parameter is standaard ingesteld op {min_nodes=0, max_nodes=2, vm_size="STANDARD_NC6", vm_priority="dedicated"} Als er geen is, wordt er geen berekening gemaakt.

private_endpoint_config
PrivateEndPointConfig
standaardwaarde: None

De configuratie van het privé-eindpunt voor het maken van een privé-eindpunt voor Azure ML-werkruimte.

private_endpoint_auto_approval
bool
standaardwaarde: True

Een booleaanse vlag die aangeeft of het maken van het privé-eindpunt automatisch of handmatig moet worden goedgekeurd vanuit Azure Private Link Center. In het geval van handmatige goedkeuring kunnen gebruikers de in behandeling zijnde aanvraag bekijken in Private Link portal om de aanvraag goed te keuren of af te wijzen.

exist_ok
bool
standaardwaarde: False

Hiermee wordt aangegeven of deze methode slaagt als de werkruimte al bestaat. Als onwaar is, mislukt deze methode als de werkruimte bestaat. Indien Waar retourneert deze methode de bestaande werkruimte als deze bestaat.

show_output
bool
standaardwaarde: True

Geeft aan of met deze methode incrementele voortgang wordt afgedrukt.

user_assigned_identity_for_cmk_encryption
str
standaardwaarde: None

De resource-id van de door de gebruiker toegewezen identiteit die moet worden gebruikt voor toegang tot de door de klant beheerde sleutel

system_datastores_auth_mode
str
standaardwaarde: accessKey

Bepaalt of referenties moeten worden gebruikt voor de systeemgegevensarchieven van de werkruimte 'workspaceblobstore' en 'workspacefilestore'. De standaardwaarde is 'accessKey'. In dat geval maakt de werkruimte de systeemgegevensarchieven met referenties. Als dit is ingesteld op 'identiteit', maakt de werkruimte de systeemgegevensarchieven zonder referenties.

v1_legacy_mode
bool
standaardwaarde: None

Voorkomen dat v2 API-service wordt gebruikt in openbare Azure Resource Manager

Retouren

Het werkruimteobject.

Retourtype

Uitzonderingen

Gemeld voor problemen met het maken van de werkruimte.

Opmerkingen

Voor dit eerste voorbeeld is slechts minimale specificatie vereist. Alle afhankelijke resources en de resourcegroep worden automatisch gemaakt.


   from azureml.core import Workspace
   ws = Workspace.create(name='myworkspace',
                         subscription_id='<azure-subscription-id>',
                         resource_group='myresourcegroup',
                         create_resource_group=True,
                         location='eastus2')

In het volgende voorbeeld ziet u hoe u bestaande Azure-resources opnieuw gebruikt met behulp van de indeling van de Azure-resource-id. De specifieke Azure-resource-id's kunnen worden opgehaald via de Azure-portal of SDK. Hierbij wordt ervan uitgegaan dat de resourcegroep, het opslagaccount, de sleutelkluis, App Insights en het containerregister al bestaan.


   import os
   from azureml.core import Workspace
   from azureml.core.authentication import ServicePrincipalAuthentication

   service_principal_password = os.environ.get("AZUREML_PASSWORD")

   service_principal_auth = ServicePrincipalAuthentication(
       tenant_id="<tenant-id>",
       username="<application-id>",
       password=service_principal_password)

   ws = Workspace.create(name='myworkspace',
                         auth=service_principal_auth,
                         subscription_id='<azure-subscription-id>',
                         resource_group='myresourcegroup',
                         create_resource_group=False,
                         location='eastus2',
                         friendly_name='My workspace',
                         storage_account='subscriptions/<azure-subscription-id>/resourcegroups/myresourcegroup/providers/microsoft.storage/storageaccounts/mystorageaccount',
                         key_vault='subscriptions/<azure-subscription-id>/resourcegroups/myresourcegroup/providers/microsoft.keyvault/vaults/mykeyvault',
                         app_insights='subscriptions/<azure-subscription-id>/resourcegroups/myresourcegroup/providers/microsoft.insights/components/myappinsights',
                         container_registry='subscriptions/<azure-subscription-id>/resourcegroups/myresourcegroup/providers/microsoft.containerregistry/registries/mycontainerregistry',
                         exist_ok=False)

delete

Verwijder de gekoppelde resources van de Azure Machine Learning-werkruimte.

delete(delete_dependent_resources=False, no_wait=False)

Parameters

delete_dependent_resources
bool
standaardwaarde: False

Of u resources wilt verwijderen die zijn gekoppeld aan de werkruimte, zoals containerregister, opslagaccount, sleutelkluis en Application Insights. De standaardwaarde is False. Stel in op Waar om deze resources te verwijderen.

no_wait
bool
standaardwaarde: False

Of moet worden gewacht totdat het verwijderen van de werkruimte is voltooid.

Retouren

Geen indien geslaagd; anders wordt er een fout gegenereerd.

Retourtype

delete_connection

Een verbinding van de werkruimte verwijderen.

delete_connection(name)

Parameters

name
str
Vereist

De unieke naam van de verbinding onder de werkruimte

delete_private_endpoint_connection

Verwijder de privé-eindpuntverbinding met de werkruimte.

delete_private_endpoint_connection(private_endpoint_connection_name)

Parameters

private_endpoint_connection_name
str
Vereist

De unieke naam van de privé-eindpuntverbinding onder de werkruimte

diagnose_workspace

Problemen met het instellen van werkruimten vaststellen.

diagnose_workspace(diagnose_parameters)

Parameters

diagnose_parameters
<xref:_restclient.models.DiagnoseWorkspaceParameters>
Vereist

De parameter voor het diagnosticeren van de status van de werkruimte

Retouren

Een exemplaar van AzureOperationPoller dat DiagnoseResponseResult retourneert

Retourtype

<xref:msrestazure.azure_operation.AzureOperationPoller>[<xref:_restclient.models.DiagnoseResponseResult>]

from_config

Een werkruimteobject retourneren uit een bestaande Azure Machine Learning-werkruimte.

Leest de werkruimteconfiguratie uit een bestand. Genereert een uitzondering als het configuratiebestand niet kan worden gevonden.

De methode biedt een eenvoudige manier om dezelfde werkruimte opnieuw te gebruiken in meerdere Python-notebooks of -projecten. Gebruikers kunnen de eigenschappen van de werkruimte Azure Resource Manager (ARM) opslaan met behulp van de write_config methode en deze methode gebruiken om dezelfde werkruimte in verschillende Python-notebooks of -projecten te laden zonder de ARM-eigenschappen van de werkruimte opnieuw te typen.

static from_config(path=None, auth=None, _logger=None, _file_name=None)

Parameters

path
str
standaardwaarde: None

Het pad naar het configuratiebestand of de beginmap om te zoeken. De parameter wordt standaard ingesteld op het starten van de zoekopdracht in de huidige map.

auth
ServicePrincipalAuthentication of InteractiveLoginAuthentication
standaardwaarde: None

Het verificatieobject. Zie voor meer informatie https://aka.ms/aml-notebook-auth. Indien Geen, worden de standaard Azure CLI-referenties gebruikt of wordt door de API om referenties gevraagd.

_logger
Logger
standaardwaarde: None

Hiermee staat u het overschrijven van de standaardlogboekregistratie toe.

_file_name
str
standaardwaarde: None

Hiermee kunt u de naam van het configuratiebestand overschrijven om te zoeken wanneer pad een mappad is.

Retouren

Het werkruimteobject voor een bestaande Azure ML-werkruimte.

Retourtype

get

Een werkruimteobject retourneren voor een bestaande Azure Machine Learning-werkruimte.

Genereert een uitzondering als de werkruimte niet bestaat of als de vereiste velden een werkruimte niet uniek identificeren.

static get(name, auth=None, subscription_id=None, resource_group=None, location=None, cloud='AzureCloud', id=None)

Parameters

name
str
Vereist

De naam van de werkruimte die u wilt ophalen.

auth
ServicePrincipalAuthentication of InteractiveLoginAuthentication
standaardwaarde: None

Het verificatieobject. Raadpleeg https://aka.ms/aml-notebook-authvoor meer informatie. Indien Geen, worden de standaard Azure CLI-referenties gebruikt of wordt door de API om referenties gevraagd.

subscription_id
str
standaardwaarde: None

De abonnements-id die moet worden gebruikt. De parameter is vereist als de gebruiker toegang heeft tot meer dan één abonnement.

resource_group
str
standaardwaarde: None

De resourcegroep die moet worden gebruikt. Als dit geen is, zoekt de methode alle resourcegroepen in het abonnement.

location
str
standaardwaarde: None

De locatie van de werkruimte.

cloud
str
standaardwaarde: AzureCloud

De naam van de doelcloud. Dit kan 'AzureCloud', 'AzureChinaCloud' of 'AzureUSGovernment' zijn. Als er geen cloud is opgegeven, wordt 'AzureCloud' gebruikt.

id
str
standaardwaarde: None

De id van de werkruimte.

Retouren

Het werkruimteobject.

Retourtype

get_connection

Maak verbinding met de werkruimte.

get_connection(name)

Parameters

name
str
Vereist

De unieke naam van de verbinding onder de werkruimte

get_default_compute_target

Haal het standaard rekendoel voor de werkruimte op.

get_default_compute_target(type)

Parameters

type
str
Vereist

Het type berekening. Mogelijke waarden zijn 'CPU' of 'GPU'.

Retouren

Het standaard rekendoel voor een bepaald rekentype.

Retourtype

get_default_datastore

Haal het standaardgegevensarchief voor de werkruimte op.

get_default_datastore()

Retouren

Het standaardgegevensarchief.

Retourtype

get_default_keyvault

Haal het standaardsleutelkluisobject voor de werkruimte op.

get_default_keyvault()

Retouren

Het KeyVault-object dat is gekoppeld aan de werkruimte.

Retourtype

get_details

Retourneer de details van de werkruimte.

get_details()

Retouren

Werkruimtedetails in woordenlijstindeling.

Retourtype

Opmerkingen

De geretourneerde woordenlijst bevat de volgende sleutel-waardeparen.

  • id: URI die verwijst naar deze werkruimteresource, die abonnements-id, resourcegroep en werkruimtenaam bevat.

  • name: de naam van deze werkruimte.

  • location: De werkruimteregio.

  • type: Een URI met de indeling {providerName}/workspaces.

  • tags: Momenteel niet gebruikt.

  • workspaceid: de id van deze werkruimte.

  • beschrijving: momenteel niet gebruikt.

  • friendlyName: een beschrijvende naam voor de werkruimte die wordt weergegeven in de gebruikersinterface.

  • creationTime: tijdstip waarop deze werkruimte is gemaakt, in ISO8601-indeling.

  • containerRegistry: het containerregister van de werkruimte dat wordt gebruikt voor het ophalen en pushen van zowel experimenten als installatiekopieën van webservices.

  • keyVault: de werkruimtesleutelkluis die wordt gebruikt voor het opslaan van referenties die door de gebruikers aan de werkruimte zijn toegevoegd.

  • applicationInsights: Application Insights wordt door de werkruimte gebruikt om webservices-gebeurtenissen te registreren.

  • identityPrincipalId:

  • identityTenantId

  • identityType

  • storageAccount: de opslag wordt door de werkruimte gebruikt om uitvoer, code, logboeken, enzovoort op te slaan.

  • sku: de werkruimte-SKU (ook wel editie genoemd). De parameter is aanwezig voor achterwaartse compatibiliteit en wordt genegeerd.

  • resourceCmkUri: de sleutel-URI van de door de klant beheerde sleutel om de data-at-rest te versleutelen. https://docs.microsoft.com/en-us/azure-stack/user/azure-stack-key-vault-manage-portal?view=azs-1910 Raadpleeg voor stappen voor het maken van een sleutel en het ophalen van de bijbehorende URI.

  • hbiWorkspace: geeft aan of de klantgegevens een hoge bedrijfsimpact hebben.

  • imageBuildCompute: het rekendoel voor het bouwen van installatiekopieën.

  • systemDatastoresAuthMode: bepaalt of referenties moeten worden gebruikt voor de systeemgegevensarchieven van de werkruimte 'workspaceblobstore' en 'workspacefilestore'. De standaardwaarde is 'accessKey'. In dat geval maakt de werkruimte de systeemgegevensarchieven met referenties. Als dit is ingesteld op 'identiteit', maakt de werkruimte de systeemgegevensarchieven zonder referenties.

Zie voor meer informatie over deze sleutel-waardeparen create.

get_mlflow_tracking_uri

Haal de MLflow-tracerings-URI voor de werkruimte op.

MLflow (https://mlflow.org/) is een opensource-platform voor het bijhouden van machine learning-experimenten en het beheren van modellen. U kunt MLflow-API's voor logboekregistratie gebruiken met Azure Machine Learning, zodat metrische gegevens, modellen en artefacten worden geregistreerd in uw Azure Machine Learning-werkruimte.

get_mlflow_tracking_uri(_with_auth=False)

Parameters

_with_auth
bool
standaardwaarde: False

(AFGESCHAFT) Voeg verificatiegegevens toe aan de tracerings-URI.

Retouren

De met MLflow compatibele tracerings-URI.

Retourtype

str

Opmerkingen

Gebruik het volgende voorbeeld om MLflow-tracering te configureren voor het verzenden van gegevens naar de Azure ML-werkruimte:


   import mlflow
   from azureml.core import Workspace
   workspace = Workspace.from_config()
   mlflow.set_tracking_uri(workspace.get_mlflow_tracking_uri())

get_run

Retourneer de uitvoering met de opgegeven run_id in de werkruimte.

get_run(run_id)

Parameters

run_id
string
Vereist

De uitvoerings-id.

Retouren

De verzonden uitvoering.

Retourtype

Run

list

Alle werkruimten weergeven waartoe de gebruiker toegang heeft binnen het abonnement.

De lijst met werkruimten kan worden gefilterd op basis van de resourcegroep.

static list(subscription_id, auth=None, resource_group=None)

Parameters

subscription_id
str
Vereist

De abonnements-id waarvoor werkruimten moeten worden weergegeven.

auth
ServicePrincipalAuthentication of InteractiveLoginAuthentication
standaardwaarde: None

Het verificatieobject. Raadpleeg https://aka.ms/aml-notebook-authvoor meer informatie. Indien Geen, worden de standaard Azure CLI-referenties gebruikt of wordt door de API om referenties gevraagd.

resource_group
str
standaardwaarde: None

Een resourcegroep om de geretourneerde werkruimten te filteren. Bij Geen worden met de methode alle werkruimten binnen het opgegeven abonnement weergegeven.

Retouren

Een woordenlijst waarbij de sleutel de naam van de werkruimte is en de waarde een lijst met werkruimteobjecten is.

Retourtype

list_connections

Maak een lijst met verbindingen onder deze werkruimte.

list_connections(category=None, target=None)

Parameters

type
str
Vereist

Het type verbinding waarop wordt gefilterd

target
str
standaardwaarde: None

het doel van deze verbinding waarop wordt gefilterd

category
standaardwaarde: None

list_keys

Sleutels voor de huidige werkruimte weergeven.

list_keys()

Retourtype

set_connection

Een verbinding toevoegen of bijwerken onder de werkruimte.

set_connection(name, category, target, authType, value)

Parameters

name
str
Vereist

De unieke naam van de verbinding onder de werkruimte

category
str
Vereist

De categorie van deze verbinding

target
str
Vereist

het doel waar deze verbinding verbinding mee maakt

authType
str
Vereist

het autorisatietype van deze verbinding

value
str
Vereist

de serialisatiereeks van de json-indeling van de verbindingsgegevens

set_default_datastore

Stel het standaardgegevensarchief voor de werkruimte in.

set_default_datastore(name)

Parameters

name
str
Vereist

De naam van de Datastore die als standaard moet worden ingesteld.

setup

Maak een nieuwe werkruimte of haal een bestaande werkruimte op.

static setup()

Retouren

Een werkruimteobject.

Retourtype

sync_keys

Hiermee activeert u de werkruimte om sleutels onmiddellijk te synchroniseren.

Als sleutels voor een resource in de werkruimte worden gewijzigd, kan het ongeveer een uur duren voordat ze automatisch worden bijgewerkt. Met deze functie kunnen sleutels op aanvraag worden bijgewerkt. Een voorbeeldscenario is onmiddellijke toegang tot opslag nodig na het opnieuw genereren van opslagsleutels.

sync_keys(no_wait=False)

Parameters

no_wait
bool
standaardwaarde: False

Of moet worden gewacht totdat de synchronisatiesleutels voor de werkruimte zijn voltooid.

Retouren

Geen indien geslaagd; anders wordt er een fout gegenereerd.

Retourtype

update

Werk beschrijvende naam, beschrijving, tags, berekening van installatiekopieën en andere instellingen bij die zijn gekoppeld aan een werkruimte.

update(friendly_name=None, description=None, tags=None, image_build_compute=None, service_managed_resources_settings=None, primary_user_assigned_identity=None, allow_public_access_when_behind_vnet=None, v1_legacy_mode=None)

Parameters

friendly_name
str
standaardwaarde: None

Een beschrijvende naam voor de werkruimte die kan worden weergegeven in de gebruikersinterface.

description
str
standaardwaarde: None

Een beschrijving van de werkruimte.

tags
dict
standaardwaarde: None

Tags die aan de werkruimte moeten worden gekoppeld.

image_build_compute
str
standaardwaarde: None

De berekeningsnaam voor de build van de installatiekopieën.

service_managed_resources_settings
<xref:azureml._base_sdk_common.workspace.models.ServiceManagedResourcesSettings>
standaardwaarde: None

De instellingen voor door de service beheerde resources.

primary_user_assigned_identity
str
standaardwaarde: None

De resource-id van de door de gebruiker toegewezen identiteit die de identiteit van de werkruimte vertegenwoordigt.

allow_public_access_when_behind_vnet
bool
standaardwaarde: None

Openbare toegang tot de werkruimte van private link toestaan.

v1_legacy_mode
bool
standaardwaarde: None

Voorkomen dat v2 API-service wordt gebruikt in openbare Azure Resource Manager

Retouren

Een woordenlijst met bijgewerkte informatie.

Retourtype

update_dependencies

Werk bestaande de gekoppelde resources voor de werkruimte bij in de volgende gevallen.

a) Wanneer een gebruiker per ongeluk een bestaande gekoppelde resource verwijdert en deze wil bijwerken met een nieuwe resource zonder de hele werkruimte opnieuw te hoeven maken. b) Wanneer een gebruiker een bestaande gekoppelde resource heeft en de huidige resource die aan de werkruimte is gekoppeld, wil vervangen. c) Wanneer er nog geen gekoppelde resource is gemaakt en ze een bestaande resource willen gebruiken die ze al hebben (alleen van toepassing op containerregister).

update_dependencies(container_registry=None, force=False)

Parameters

container_registry
str
standaardwaarde: None

ARM-id voor het containerregister.

force
bool
standaardwaarde: False

Als het bijwerken van afhankelijke resources wordt geforceerd zonder bevestiging te worden gevraagd.

Retourtype

write_config

Schrijf de eigenschappen van de werkruimte Azure Resource Manager (ARM) naar een configuratiebestand.

Arm-eigenschappen van werkruimten kunnen later worden geladen met behulp van de from_config methode . De path standaardinstelling is '.azureml/' in de huidige werkmap en file_name standaard ingesteld op 'config.json'.

De methode biedt een eenvoudige manier om dezelfde werkruimte opnieuw te gebruiken in meerdere Python-notebooks of -projecten. Gebruikers kunnen de ARM-eigenschappen van de werkruimte opslaan met behulp van deze functie en from_config gebruiken om dezelfde werkruimte in verschillende Python-notebooks of -projecten te laden zonder de ARM-eigenschappen van de werkruimte opnieuw te typen.

write_config(path=None, file_name=None)

Parameters

path
str
standaardwaarde: None

De gebruiker heeft de locatie opgegeven om het bestand config.json te schrijven. De parameter wordt standaard ingesteld op '.azureml/' in de huidige werkmap.

file_name
str
standaardwaarde: None

Naam die moet worden gebruikt voor het configuratiebestand. De parameter is standaard ingesteld op config.json.

Kenmerken

compute_targets

Alle rekendoelen in de werkruimte weergeven.

Retouren

Een woordenlijst met sleutel als naam van rekendoel en waarde als ComputeTarget object.

Retourtype

datasets

Alle gegevenssets in de werkruimte weergeven.

Retouren

Een woordenlijst met sleutel als gegevenssetnaam en waarde als Dataset object.

Retourtype

datastores

Alle gegevensarchieven in de werkruimte weergeven. Met deze bewerking worden geen referenties van de gegevensarchieven geretourneerd.

Retouren

Een woordenlijst met sleutel als gegevensarchiefnaam en waarde als Datastore object.

Retourtype

discovery_url

Retourneer de detectie-URL van deze werkruimte.

Retouren

De detectie-URL van deze werkruimte.

Retourtype

str

environments

Alle omgevingen in de werkruimte weergeven.

Retouren

Een woordenlijst met sleutel als omgevingsnaam en waarde als Environment object.

Retourtype

experiments

Alle experimenten in de werkruimte weergeven.

Retouren

Een woordenlijst met sleutel als experimentnaam en waarde als Experiment object.

Retourtype

images

Retourneer de lijst met afbeeldingen in de werkruimte.

Geeft een aan WebserviceException als er een probleem is met de interactie met de service voor modelbeheer.

Retouren

Een woordenlijst met sleutel als afbeeldingsnaam en waarde als Image object.

Retourtype

Uitzonderingen

Er is een probleem opgetreden bij de interactie met de service voor modelbeheer.

linked_services

Alle gekoppelde services in de werkruimte weergeven.

Retouren

Een woordenlijst waarbij sleutel een gekoppelde servicenaam en -waarde is, is een LinkedService object.

Retourtype

location

Retourneer de locatie van deze werkruimte.

Retouren

De locatie van deze werkruimte.

Retourtype

str

models

Retourneert een lijst met modellen in de werkruimte.

Geeft een aan WebserviceException als er een probleem is met de interactie met de service voor modelbeheer.

Retouren

Een woordenlijst van het model met sleutel als modelnaam en waarde als Model object.

Retourtype

Uitzonderingen

Er is een probleem opgetreden bij de interactie met de service voor modelbeheer.

name

Retourneer de naam van de werkruimte.

Retouren

De naam van de werkruimte.

Retourtype

str

private_endpoints

Alle privé-eindpunten van de werkruimte weergeven.

Retouren

Een dictaat van PrivateEndPoint-objecten die zijn gekoppeld aan de werkruimte. De sleutel is de naam van het privé-eindpunt.

Retourtype

resource_group

Retourneer de naam van de resourcegroep voor deze werkruimte.

Retouren

De naam van de resourcegroep.

Retourtype

str

service_context

Retourneer de servicecontext voor deze werkruimte.

Retouren

Retourneert het ServiceContext-object.

Retourtype

<xref:azureml._restclient.service_context.ServiceContext>

sku

Retourneer de SKU van deze werkruimte.

Retouren

De SKU van deze werkruimte.

Retourtype

str

subscription_id

Retourneer de abonnements-id voor deze werkruimte.

Retouren

De abonnements-id.

Retourtype

str

tags

Retourneer de tags van deze werkruimte.

Retouren

De tags van deze werkruimte.

Retourtype

webservices

Een lijst met webservices in de werkruimte retourneren.

Hiermee wordt een WebserviceException weergegeven als er een probleem is met het retourneren van de lijst.

Retouren

Een lijst met webservices in de werkruimte.

Retourtype

Uitzonderingen

Er is een probleem opgetreden bij het retourneren van de lijst.

DEFAULT_CPU_CLUSTER_CONFIGURATION

DEFAULT_CPU_CLUSTER_CONFIGURATION = <azureml.core.compute.amlcompute.AmlComputeProvisioningConfiguration object>

DEFAULT_CPU_CLUSTER_NAME

DEFAULT_CPU_CLUSTER_NAME = 'cpu-cluster'

DEFAULT_GPU_CLUSTER_CONFIGURATION

DEFAULT_GPU_CLUSTER_CONFIGURATION = <azureml.core.compute.amlcompute.AmlComputeProvisioningConfiguration object>

DEFAULT_GPU_CLUSTER_NAME

DEFAULT_GPU_CLUSTER_NAME = 'gpu-cluster'