Delen via


Workspace Klas

Definieert een Azure Machine Learning-resource voor het beheren van trainings- 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, trainen en implementeren. Elke werkruimte is gekoppeld aan een Azure-abonnement en -resourcegroep en heeft een bijbehorende SKU.

Zie voor meer informatie over werkruimten:

Class Workspace-constructor voor het laden van een bestaande Azure Machine Learning-werkruimte.

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

Name Description
subscription_id
Vereist
str

De Azure-abonnements-id die de werkruimte bevat.

resource_group
Vereist
str

De resourcegroep met de werkruimte.

workspace_name
Vereist
str

De naam van de bestaande werkruimte.

auth

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

Default value: None
_location
str

Alleen intern gebruik.

Default value: None
_disable_service_check

Alleen intern gebruik.

Default value: False
_workspace_id
str

Alleen intern gebruik.

Default value: None
sku
str

De parameter is aanwezig voor compatibiliteit met eerdere versies en wordt genegeerd.

Default value: basic
_cloud
str

Alleen intern gebruik.

Default value: AzureCloud
subscription_id
Vereist
str

De Azure-abonnements-id die de werkruimte bevat.

resource_group
Vereist
str

De resourcegroep met de werkruimte.

workspace_name
Vereist
str

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 mag alfanumerieke tekens, afbreekstreepjes en onderstrepingstekens bevatten. Witruimte is niet toegestaan.

auth
Vereist

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

_location
Vereist
str

Alleen intern gebruik.

_disable_service_check
Vereist

Alleen intern gebruik.

_workspace_id
Vereist
str

Alleen intern gebruik.

sku
Vereist
str

De parameter is aanwezig voor compatibiliteit met eerdere versies en wordt genegeerd.

tags

Tags die u aan de werkruimte wilt koppelen.

Default value: None
_cloud
Vereist
str

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 create_resource_group deze optie in op False als u een bestaande Azure-resourcegroep hebt die u voor de werkruimte wilt gebruiken.

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


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

Zie Een configuratiebestand voor een werkruimte maken voor een voorbeeld van het configuratiebestand.

Gebruik de from_config 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 kunt u worden gevraagd om referenties voor Azure-verificatie met behulp van een interactief aanmeldingsdialoogvenster. Zie Verificatie in Azure Machine Learning voor andere gebruiksvoorbeelden, 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 werkruimtevereisten wordt voldaan.

delete

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

delete_connection

Verwijder een verbinding van de werkruimte.

delete_private_endpoint_connection

Verwijder de privé-eindpuntverbinding met de werkruimte.

diagnose_workspace

Problemen met het instellen van werkruimten vaststellen.

from_config

Retourneert een werkruimteobject uit een bestaande Azure Machine Learning-werkruimte.

Leest de configuratie van de werkruimte 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 azure Resource Manager-eigenschappen (ARM) van de werkruimte 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

Retourneert een werkruimteobject 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

Haal een verbinding van de werkruimte op.

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-logboekregistratie-API's gebruiken met Azure Machine Learning, zodat metrische gegevens, modellen en artefacten worden vastgelegd in uw Azure Machine Learning-werkruimte.

get_run

Retourneer de uitvoering met de opgegeven run_id in de werkruimte.

list

Vermeld alle werkruimten 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 weergeven voor de huidige werkruimte.

set_connection

Voeg een verbinding toe of werk deze bij 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 wordt de werkruimte geactiveerd om sleutels onmiddellijk te synchroniseren.

Als sleutels voor een resource in de werkruimte worden gewijzigd, kan het ongeveer een uur duren voordat deze 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, rekenkracht voor installatiekopieën en andere instellingen bij die zijn gekoppeld aan een werkruimte.

update_dependencies

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

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

write_config

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

Arm-eigenschappen voor werkruimten kunnen later worden geladen met behulp van de from_config methode. De path standaardwaarde is '.azureml/' in de huidige werkmap en file_name wordt 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 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

Name Description
private_endpoint_config
Vereist

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

private_endpoint_auto_approval

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

Default value: True
location

Locatie van het privé-eindpunt, standaard is de locatie van de werkruimte

Default value: None
show_output

Vlag voor het weergeven van de voortgang van het maken van een werkruimte

Default value: True
tags

Tags die u aan de werkruimte wilt koppelen.

Default value: None

Retouren

Type Description

Het PrivateEndPoint-object dat is gemaakt.

create

Maak een nieuwe Azure Machine Learning-werkruimte.

Genereert een uitzondering als de werkruimte al bestaat of als niet aan een van de werkruimtevereisten 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 Description
name
Vereist
str

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 mag alfanumerieke tekens, afbreekstreepjes en onderstrepingstekens bevatten. Witruimte is niet toegestaan.

auth

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

Default value: None
subscription_id
str

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

Default value: None
resource_group
str

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

Default value: None
location
str

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.

Default value: None
create_resource_group

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

Default value: True
sku
str

De parameter is aanwezig voor compatibiliteit met eerdere versies en wordt genegeerd.

Default value: basic
tags

Tags die u aan de werkruimte wilt koppelen.

Default value: None
friendly_name
str

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

Default value: None
storage_account
str

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

Default value: None
key_vault
str

Een bestaande sleutelkluis in de Azure-resource-id-indeling. Zie de voorbeeldcode hieronder voor meer informatie over de indeling van de Azure-resource-id. De sleutelkluis wordt door de werkruimte gebruikt om referenties op te slaan die zijn toegevoegd aan de werkruimte door de gebruikers. Als geen, wordt er een nieuwe sleutelkluis gemaakt.

Default value: None
app_insights
str

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

Default value: None
container_registry
str

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

Default value: None
adb_workspace
str

Een bestaande Adb-werkruimte in de Azure-resource-id-indeling (zie de 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 geen, wordt de werkruimtekoppeling niet uitgevoerd.

Default value: None
primary_user_assigned_identity
str

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

Default value: None
cmk_keyvault
str

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 opmerkingen hieronder voor meer informatie over de Indeling van de Azure-resource-id.

Default value: None
resource_cmk_uri
str

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 de stappen voor het maken van een sleutel en het ophalen van de URI.

Default value: None
hbi_workspace

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

Wanneer deze instelling is ingesteld op Waar, worden verdere versleutelingsstappen uitgevoerd en worden, afhankelijk van het SDK-onderdeel, gegevens opgeslagen in intern verzamelde telemetriegegevens. Zie Gegevensversleuteling voor meer informatie.

Wanneer deze vlag is ingesteld op Waar, is één mogelijke impact een grotere moeilijkheid bij het oplossen van problemen. Dit kan gebeuren omdat sommige telemetrie niet naar Microsoft wordt verzonden en er minder inzicht is in succespercentages of probleemtypen en daarom mogelijk niet zo proactief kan reageren als deze vlag Waar is. De aanbeveling gebruikt de standaardwaarde False voor deze vlag, tenzij strikt vereist is om Waar te zijn.

Default value: False
default_cpu_compute_target

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

Default value: None
default_gpu_compute_target

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

Default value: None
private_endpoint_config

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

Default value: None
private_endpoint_auto_approval

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

Default value: True
exist_ok

Geeft aan of deze methode slaagt als de werkruimte al bestaat. Als deze methode onwaar is, mislukt deze methode als de werkruimte bestaat. Als waar is, retourneert deze methode de bestaande werkruimte als deze bestaat.

Default value: False
show_output

Hiermee wordt aangegeven of met deze methode incrementele voortgang wordt afgedrukt.

Default value: True
user_assigned_identity_for_cmk_encryption
str

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

Default value: None
system_datastores_auth_mode
str

Bepaalt of er 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 deze optie is ingesteld op 'identiteit', maakt de werkruimte de systeemgegevensarchieven zonder referenties.

Default value: accessKey
v1_legacy_mode

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

Default value: None

Retouren

Type Description

Het werkruimteobject.

Uitzonderingen

Type Description

Er zijn problemen opgetreden bij het maken van de werkruimte.

Opmerkingen

Voor dit eerste voorbeeld is slechts een minimale specificatie vereist en worden alle afhankelijke resources en de resourcegroep 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 hergebruikt 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

Name Description
delete_dependent_resources

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

Default value: False
no_wait

Of het verwijderen van de werkruimte is voltooid.

Default value: False

Retouren

Type Description

Geen indien geslaagd; anders treedt er een fout op.

delete_connection

Verwijder een verbinding van de werkruimte.

delete_connection(name)

Parameters

Name Description
name
Vereist
str

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

Name Description
private_endpoint_connection_name
Vereist
str

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

diagnose_workspace

Problemen met het instellen van werkruimten vaststellen.

diagnose_workspace(diagnose_parameters)

Parameters

Name Description
diagnose_parameters
Vereist
<xref:_restclient.models.DiagnoseWorkspaceParameters>

De parameter voor het diagnosticeren van de werkruimtestatus

Retouren

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

Een exemplaar van AzureOperationPoller dat DiagnoseResponseResult retourneert

from_config

Retourneert een werkruimteobject uit een bestaande Azure Machine Learning-werkruimte.

Leest de configuratie van de werkruimte 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 azure Resource Manager-eigenschappen (ARM) van de werkruimte 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

Name Description
path
str

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.

Default value: None
auth

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

Default value: None
_logger

Hiermee kan de standaardlogger worden overschreven.

Default value: None
_file_name
str

Hiermee kan de configuratiebestandsnaam worden overschreven om te zoeken wanneer het pad een mappad is.

Default value: None

Retouren

Type Description

Het werkruimteobject voor een bestaande Azure ML-werkruimte.

get

Retourneert een werkruimteobject 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 Description
name
Vereist
str

De naam van de werkruimte die u wilt ophalen.

auth

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

Default value: None
subscription_id
str

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

Default value: None
resource_group
str

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

Default value: None
location
str

De locatie van de werkruimte.

Default value: None
cloud
str

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

Default value: AzureCloud
id
str

De id van de werkruimte.

Default value: None

Retouren

Type Description

Het werkruimteobject.

get_connection

Haal een verbinding van de werkruimte op.

get_connection(name)

Parameters

Name Description
name
Vereist
str

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

Name Description
type
Vereist
str

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

Retouren

Type Description

Het standaard rekendoel voor het opgegeven rekentype.

get_default_datastore

Haal het standaardgegevensarchief voor de werkruimte op.

get_default_datastore()

Retouren

Type Description

Het standaardgegevensarchief.

get_default_keyvault

Haal het standaardsleutelkluisobject voor de werkruimte op.

get_default_keyvault()

Retouren

Type Description

Het KeyVault-object dat is gekoppeld aan de werkruimte.

get_details

Retourneer de details van de werkruimte.

get_details()

Retouren

Type Description

Werkruimtedetails in woordenlijstindeling.

Opmerkingen

De geretourneerde woordenlijst bevat de volgende sleutel-waardeparen.

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

  • name: De naam van deze werkruimte.

  • locatie: de werkruimteregio.

  • type: Een URI van 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: Tijd waarop deze werkruimte is gemaakt, in ISO8601 indeling.

  • containerRegistry: het containerregister van de werkruimte dat wordt gebruikt voor het ophalen en pushen van installatiekopieën voor experimenten en 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 compatibiliteit met eerdere versies 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 de stappen voor het maken van een sleutel en het ophalen van de URI.

  • hbiWorkspace: Hiermee geeft u op of de klantgegevens van grote invloed zijn op het bedrijf.

  • 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 deze optie 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-logboekregistratie-API's gebruiken met Azure Machine Learning, zodat metrische gegevens, modellen en artefacten worden vastgelegd in uw Azure Machine Learning-werkruimte.

get_mlflow_tracking_uri(_with_auth=False)

Parameters

Name Description
_with_auth

(AFGESCHAFT) Verificatiegegevens toevoegen aan tracerings-URI.

Default value: False

Retouren

Type Description
str

De met MLflow compatibele tracerings-URI.

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

Name Description
run_id
Vereist

De uitvoerings-id.

Retouren

Type Description
Run

De ingediende uitvoering.

list

Vermeld alle werkruimten 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

Name Description
subscription_id
Vereist
str

De abonnements-id waarvoor werkruimten moeten worden weergegeven.

auth

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

Default value: None
resource_group
str

Een resourcegroep om de geretourneerde werkruimten te filteren. Als er geen is, worden met de methode alle werkruimten binnen het opgegeven abonnement weergegeven.

Default value: None

Retouren

Type Description

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

list_connections

Maak een lijst met verbindingen onder deze werkruimte.

list_connections(category=None, target=None)

Parameters

Name Description
type
Vereist
str

Het type van deze verbinding waarop wordt gefilterd

target
str

het doel van deze verbinding waarop wordt gefilterd

Default value: None
category
Default value: None

list_keys

Sleutels weergeven voor de huidige werkruimte.

list_keys()

Retouren

Type Description

set_connection

Voeg een verbinding toe of werk deze bij onder de werkruimte.

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

Parameters

Name Description
name
Vereist
str

De unieke naam van de verbinding onder de werkruimte

category
Vereist
str

De categorie van deze verbinding

target
Vereist
str

het doel van deze verbinding maakt verbinding met

authType
Vereist
str

het autorisatietype van deze verbinding

value
Vereist
str

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 Description
name
Vereist
str

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

setup

Maak een nieuwe werkruimte of haal een bestaande werkruimte op.

static setup()

Retouren

Type Description

Een werkruimteobject.

sync_keys

Hiermee wordt de werkruimte geactiveerd om sleutels onmiddellijk te synchroniseren.

Als sleutels voor een resource in de werkruimte worden gewijzigd, kan het ongeveer een uur duren voordat deze 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

Name Description
no_wait

Of u wilt wachten totdat de synchronisatiesleutels voor de werkruimte zijn voltooid.

Default value: False

Retouren

Type Description

Geen indien geslaagd; anders treedt er een fout op.

update

Werk beschrijvende naam, beschrijving, tags, rekenkracht voor 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

Name Description
friendly_name
str

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

Default value: None
description
str

Een beschrijving van de werkruimte.

Default value: None
tags

Tags die u aan de werkruimte wilt koppelen.

Default value: None
image_build_compute
str

De rekennaam voor de build van de installatiekopieën.

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

De instellingen voor door de service beheerde resources.

Default value: None
primary_user_assigned_identity
str

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

Default value: None
allow_public_access_when_behind_vnet

Openbare toegang tot de werkruimte private link toestaan.

Default value: None
v1_legacy_mode

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

Default value: None

Retouren

Type Description

Een woordenlijst met bijgewerkte informatie.

update_dependencies

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

a) Wanneer een gebruiker per ongeluk een bestaande gekoppelde resource verwijdert en deze bijwerkt met een nieuwe resource zonder dat de hele werkruimte opnieuw hoeft te worden gemaakt. b) Wanneer een gebruiker een bestaande gekoppelde resource heeft en de huidige resource wil vervangen die is gekoppeld aan de werkruimte. c) Wanneer een gekoppelde resource nog niet 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

Name Description
container_registry
str

ARM-id voor het containerregister.

Default value: None
force

Als u afhankelijke resources geforceerd bijwerkt zonder dat hierom wordt gevraagd.

Default value: False

Retouren

Type Description

write_config

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

Arm-eigenschappen voor werkruimten kunnen later worden geladen met behulp van de from_config methode. De path standaardwaarde is '.azureml/' in de huidige werkmap en file_name wordt 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 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

Name Description
path
str

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

Default value: None
file_name
str

De naam die moet worden gebruikt voor het configuratiebestand. De parameter wordt standaard ingesteld op config.json.

Default value: None

Kenmerken

compute_targets

Geef alle rekendoelen in de werkruimte weer.

Retouren

Type Description

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

datasets

Geef alle gegevenssets in de werkruimte weer.

Retouren

Type Description

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

datastores

Geef alle gegevensarchieven in de werkruimte weer. Deze bewerking retourneert geen referenties van de gegevensarchieven.

Retouren

Type Description

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

discovery_url

Retourneert de detectie-URL van deze werkruimte.

Retouren

Type Description
str

De detectie-URL van deze werkruimte.

environments

Geef alle omgevingen in de werkruimte weer.

Retouren

Type Description

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

experiments

Geef alle experimenten in de werkruimte weer.

Retouren

Type Description

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

images

Retourneert de lijst met afbeeldingen in de werkruimte.

Hiermee wordt een WebserviceException probleem weergegeven als er een probleem is opgetreden bij het werken met de modelbeheerservice.

Retouren

Type Description

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

Uitzonderingen

Type Description

Er is een probleem opgetreden bij het werken met de modelbeheerservice.

linked_services

Geef alle gekoppelde services in de werkruimte weer.

Retouren

Type Description

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

location

Hiermee wordt de locatie van deze werkruimte geretourneerd.

Retouren

Type Description
str

De locatie van deze werkruimte.

models

Retourneert een lijst met modellen in de werkruimte.

Hiermee wordt een WebserviceException probleem weergegeven als er een probleem is opgetreden bij het werken met de modelbeheerservice.

Retouren

Type Description

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

Uitzonderingen

Type Description

Er is een probleem opgetreden bij het werken met de modelbeheerservice.

name

Geef de naam van de werkruimte als resultaat.

Retouren

Type Description
str

De naam van de werkruimte.

private_endpoints

Een lijst weergeven van alle privé-eindpunten van de werkruimte.

Retouren

Type Description

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

resource_group

Retourneert de naam van de resourcegroep voor deze werkruimte.

Retouren

Type Description
str

De naam van de resourcegroep.

service_context

Retourneert de servicecontext voor deze werkruimte.

Retouren

Type Description
<xref:azureml._restclient.service_context.ServiceContext>

Retourneert het ServiceContext-object.

sku

Hiermee wordt de SKU van deze werkruimte geretourneerd.

Retouren

Type Description
str

De SKU van deze werkruimte.

subscription_id

Retourneer de abonnements-id voor deze werkruimte.

Retouren

Type Description
str

De ID van het abonnement.

tags

Hiermee worden de tags van deze werkruimte geretourneerd.

Retouren

Type Description

De tags van deze werkruimte.

webservices

Hiermee wordt een lijst met webservices in de werkruimte geretourneerd.

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

Retouren

Type Description

Een lijst met webservices in de werkruimte.

Uitzonderingen

Type Description

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'