Workspace Osztály

Referencia

Definiál egy Azure Machine Learning-erőforrást a betanítási és üzembehelyezési összetevők kezeléséhez.

A munkaterület alapvető erőforrás a gépi tanuláshoz az Azure Machine Learningben. Egy munkaterület használatával kísérletezhet, taníthat be és helyezhet üzembe gépi tanulási modelleket. Minden munkaterület egy Azure-előfizetéshez és erőforráscsoporthoz van kötve, és társított termékváltozattal rendelkezik.

A munkaterületekkel kapcsolatos további információkért lásd:

Osztály-munkaterület konstruktor egy meglévő Azure Machine Learning-munkaterület betöltéséhez.

Öröklődés: builtins.object

Workspace

Konstruktor

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

Paraméterek

Name	Description
subscription_id Kötelező	str A munkaterületet tartalmazó Azure-előfizetés azonosítója.
resource_group Kötelező	str A munkaterületet tartalmazó erőforráscsoport.
workspace_name Kötelező	str A meglévő munkaterület neve.
auth	ServicePrincipalAuthentication vagy InteractiveLoginAuthentication vagy MsiAuthentication A hitelesítési objektum. További részletekért lásd: https://aka.ms/aml-notebook-auth. Ha nincs, a rendszer az alapértelmezett Azure CLI-hitelesítő adatokat használja, vagy az API hitelesítő adatokat kér. Alapértelmezett érték: None
_location	str Csak belső használatra. Alapértelmezett érték: None
_disable_service_check	bool Csak belső használatra. Alapértelmezett érték: False
_workspace_id	str Csak belső használatra. Alapértelmezett érték: None
sku	str A paraméter a visszamenőleges kompatibilitás érdekében jelen van, és figyelmen kívül lesz hagyva. Alapértelmezett érték: basic
_cloud	str Csak belső használatra. Alapértelmezett érték: AzureCloud
subscription_id Kötelező	str A munkaterületet tartalmazó Azure-előfizetés azonosítója.
resource_group Kötelező	str A munkaterületet tartalmazó erőforráscsoport.
workspace_name Kötelező	str A munkaterület neve. A név hossza 2–32 karakter lehet. A név első karakterének alfanumerikusnak (betűnek vagy számnak) kell lennie, de a név többi része tartalmazhat alfanumerikus, kötőjeleket és aláhúzásjeleket. A térköz nem engedélyezett.
auth Kötelező	ServicePrincipalAuthentication vagy InteractiveLoginAuthentication vagy MsiAuthentication A hitelesítési objektum. További részletekért lásd: https://aka.ms/aml-notebook-auth. Ha nincs, a rendszer az alapértelmezett Azure CLI-hitelesítő adatokat használja, vagy az API hitelesítő adatokat kér.
_location Kötelező	str Csak belső használatra.
_disable_service_check Kötelező	bool Csak belső használatra.
_workspace_id Kötelező	str Csak belső használatra.
sku Kötelező	str A paraméter a visszamenőleges kompatibilitás érdekében jelen van, és figyelmen kívül lesz hagyva.
tags	dict A munkaterülethez társítandó címkék. Alapértelmezett érték: None
_cloud Kötelező	str Csak belső használatra.

Megjegyzések

Az alábbi minta bemutatja, hogyan hozhat létre munkaterületet.


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

Állítsa create_resource_group False (Hamis) értékre, ha van egy meglévő Azure-erőforráscsoportja, amelyet a munkaterülethez szeretne használni.

Ha ugyanazt a munkaterületet több környezetben szeretné használni, hozzon létre egy JSON-konfigurációs fájlt. A konfigurációs fájl menti az előfizetés, az erőforrás és a munkaterület nevét, hogy könnyen betölthető legyen. A konfiguráció mentéséhez használja a metódust write_config .


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

Példa a konfigurációs fájlra: Munkaterület konfigurációs fájljának létrehozása .

A munkaterület konfigurációs fájlból való betöltéséhez használja a metódust from_config .


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

Másik lehetőségként a get metódussal konfigurációs fájlok használata nélkül tölthet be egy meglévő munkaterületet.


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

A fenti minták egy interaktív bejelentkezési párbeszédpanel használatával kérhetik az Azure-beli hitelesítési hitelesítő adatok megadását. Egyéb használati esetek, például az Azure CLI használata az automatizált munkafolyamatok hitelesítéséhez és hitelesítéséhez lásd: Hitelesítés az Azure Machine Learningben.

Metódusok

add_private_endpoint	Adjon hozzá egy privát végpontot a munkaterülethez.
create	Hozzon létre egy új Azure Machine Learning-munkaterületet. Kivételt jelez, ha a munkaterület már létezik, vagy a munkaterület egyik követelménye sem teljesül.
delete	Törölje az Azure Machine Learning-munkaterülethez társított erőforrásokat.
delete_connection	Törölje a munkaterület kapcsolatát.
delete_private_endpoint_connection	Törölje a munkaterület privát végponti kapcsolatát.
diagnose_workspace	Munkaterület beállítási problémáinak diagnosztizálása.
from_config	Munkaterület-objektumot ad vissza egy meglévő Azure Machine Learning-munkaterületről. Beolvassa a munkaterület konfigurációját egy fájlból. Kivételt jelez, ha a konfigurációs fájl nem található. A metódus egyszerű módot kínál arra, hogy ugyanazt a munkaterületet több Python-jegyzetfüzetben vagy -projektben újra felhasználja. A felhasználók a metódussal write_config menthetik a munkaterület Azure Resource Manager (ARM) tulajdonságait, és ezzel a módszerrel tölthetik be ugyanazt a munkaterületet különböző Python-jegyzetfüzetekben vagy -projektekben a munkaterület ARM-tulajdonságainak módosítása nélkül.
get	Egy meglévő Azure Machine Learning-munkaterület munkaterület-objektumát adja vissza. Kivételt jelez, ha a munkaterület nem létezik, vagy a szükséges mezők nem azonosítják egyedileg a munkaterületet.
get_connection	A munkaterület kapcsolatának lekérése.
get_default_compute_target	Kérje le a munkaterület alapértelmezett számítási célját.
get_default_datastore	Kérje le a munkaterület alapértelmezett adattárát.
get_default_keyvault	Kérje le a munkaterület alapértelmezett Key Vault-objektumát.
get_details	Adja vissza a munkaterület adatait.
get_mlflow_tracking_uri	Kérje le a munkaterület MLflow-nyomkövetési URI-ját. Az MLflow (https://mlflow.org/) egy nyílt forráskódú platform a gépi tanulási kísérletek nyomon követéséhez és a modellek kezeléséhez. Az MLflow naplózási API-kat használhatja az Azure Machine Learning szolgáltatással, hogy a metrikákat, modelleket és összetevőket a rendszer naplózza az Azure Machine Learning-munkaterületre.
get_run	A futtatás visszaadása a munkaterületen megadott run_id.
list	Listázhatja az összes olyan munkaterületet, amelyhez a felhasználó hozzáféréssel rendelkezik az előfizetésen belül. A munkaterületek listája az erőforráscsoport alapján szűrhető.
list_connections	A munkaterület alatti kapcsolatok listázása.
list_keys	Az aktuális munkaterület kulcsainak listázása.
set_connection	Adjon hozzá vagy frissítsen egy kapcsolatot a munkaterület alatt.
set_default_datastore	Állítsa be a munkaterület alapértelmezett adattárát.
setup	Hozzon létre egy új munkaterületet, vagy kérjen le egy meglévő munkaterületet.
sync_keys	Aktiválja a munkaterületet a kulcsok azonnali szinkronizálásához. Ha a munkaterület bármely erőforrásának kulcsait módosítják, az automatikus frissítésük körülbelül egy órát is igénybe vehet. Ez a függvény lehetővé teszi a kulcsok kérésre történő frissítését. Példaforgatókönyv, ha a tárolókulcsok újragenerálása után azonnal hozzá kell férnie a tárolóhoz.
update	Frissítse a munkaterülethez társított rövid nevet, leírást, címkéket, rendszerkép-összeállítási számítást és egyéb beállításokat.
update_dependencies	Frissítse a munkaterülethez társított erőforrásokat a következő esetekben. a) Ha egy felhasználó véletlenül töröl egy meglévő társított erőforrást, és egy új erőforrással szeretné frissíteni anélkül, hogy újra létre kellene hoznia a teljes munkaterületet. b) Ha egy felhasználó rendelkezik meglévő társított erőforrással, és le szeretné cserélni a munkaterülethez társított aktuális erőforrást. c) Ha még nem hoztak létre társított erőforrást, és egy már meglévő erőforrást szeretnének használni (csak a tárolóregisztrációs adatbázisra vonatkozik).
write_config	Írja be a munkaterület Azure Resource Manager (ARM) tulajdonságait egy konfigurációs fájlba. A munkaterület ARM-tulajdonságai később betölthetők a from_config metódussal. Az `path` alapértelmezett érték a ".azureml/" lesz az aktuális munkakönyvtárban, az `file_name` alapértelmezett érték pedig a "config.json". A metódus egyszerű módot kínál ugyanazon munkaterület több Python-jegyzetfüzetben vagy -projektben való újrafelhasználására. A felhasználók ezzel a függvénnyel menthetik a munkaterület ARM-tulajdonságait, és a from_config használatával tölthetik be ugyanazt a munkaterületet különböző Python-jegyzetfüzetekben vagy -projektekben anélkül, hogy a munkaterület ARM-tulajdonságainak újraformázását használták.

add_private_endpoint

Adjon hozzá egy privát végpontot a munkaterülethez.

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

Paraméterek

Name	Description
private_endpoint_config Kötelező	PrivateEndPointConfig A privát végpont konfigurációja, amellyel privát végpontot hozhat létre a munkaterületen.
private_endpoint_auto_approval	bool Logikai jelző, amely azt jelzi, hogy a privát végpont létrehozását automatikusan vagy manuálisan jóvá kell-e hagyni a Azure Private Link Centerben. Manuális jóváhagyás esetén a felhasználók megtekinthetik a függőben lévő kérést Private Link portálon a kérelem jóváhagyásához/elutasításához. Alapértelmezett érték: True
location	string A privát végpont helye, alapértelmezés szerint a munkaterület helye Alapértelmezett érték: None
show_output	bool A munkaterület létrehozásának előrehaladását jelző jelző Alapértelmezett érték: True
tags	dict A munkaterülethez társítandó címkék. Alapértelmezett érték: None

Válaszok

Típus	Description
PrivateEndPoint	A létrehozott PrivateEndPoint-objektum.

create

Hozzon létre egy új Azure Machine Learning-munkaterületet.

Kivételt jelez, ha a munkaterület már létezik, vagy a munkaterület egyik követelménye sem teljesül.

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)

Paraméterek

Name	Description
name Kötelező	str Az új munkaterület neve. A név hossza 2–32 karakter lehet. A név első karakterének alfanumerikusnak (betűnek vagy számnak) kell lennie, de a név többi része tartalmazhat alfanumerikus, kötőjeleket és aláhúzásjeleket. A térköz nem engedélyezett.
auth	ServicePrincipalAuthentication vagy InteractiveLoginAuthentication A hitelesítési objektum. További részletekért lásd: https://aka.ms/aml-notebook-auth. Ha nincs, a rendszer az alapértelmezett Azure CLI-hitelesítő adatokat használja, vagy az API hitelesítő adatokat kér. Alapértelmezett érték: None
subscription_id	str Az új munkaterülethez tartozó előfizetés előfizetés-azonosítója. A paraméterre akkor van szükség, ha a felhasználó több előfizetéshez is hozzáfér. Alapértelmezett érték: None
resource_group	str A munkaterületet tartalmazó Azure-erőforráscsoport. A paraméter alapértelmezés szerint a munkaterület nevének mutációja. Alapértelmezett érték: None
location	str A munkaterület helye. A paraméter alapértelmezett értéke az erőforráscsoport helye. A helynek az Azure Machine Learning támogatott régiójának kell lennie. Alapértelmezett érték: None
create_resource_group	bool Azt jelzi, hogy létre kívánja-e hozni az erőforráscsoportot, ha az nem létezik. Alapértelmezett érték: True
sku	str A paraméter a visszamenőleges kompatibilitás érdekében jelen van, és figyelmen kívül lesz hagyva. Alapértelmezett érték: basic
tags	dict A munkaterülethez társítandó címkék. Alapértelmezett érték: None
friendly_name	str A munkaterület nem kötelező rövid neve, amely megjeleníthető a felhasználói felületen. Alapértelmezett érték: None
storage_account	str Egy meglévő tárfiók Azure-erőforrás-azonosító formátumban. A munkaterület a tárolót fogja használni a futtatási kimenetek, kódok, naplók stb. mentéséhez. Ha nincs, létrejön egy új tárfiók. Alapértelmezett érték: None
key_vault	str Egy meglévő kulcstartó Azure-erőforrás-azonosító formátumban. Az Azure-erőforrás-azonosító formátumának részleteiért tekintse meg az alábbi példakódot. A kulcstartót a munkaterület fogja használni a munkaterülethez a felhasználók által hozzáadott hitelesítő adatok tárolására. Ha nincs, létrejön egy új kulcstartó. Alapértelmezett érték: None
app_insights	str Egy meglévő Application Insights Azure-erőforrás-azonosító formátumban. Az Azure-erőforrás-azonosító formátumának részleteiért tekintse meg az alábbi példakódot. A munkaterület az Application Insights használatával naplózza a webszolgáltatási eseményeket. Ha nincs, létrejön egy új Application Insights. Alapértelmezett érték: None
container_registry	str Egy meglévő tárolóregisztrációs adatbázis Azure-erőforrás-azonosító formátumban (az Azure-erőforrás-azonosító formátumának részleteiért tekintse meg az alábbi példakódot). A munkaterület a tárolóregisztrációs adatbázist fogja használni a kísérletezési és webszolgáltatási rendszerképek lekéréséhez és leküldéséhez. Ha nincs, a rendszer csak szükség esetén hoz létre új tárolóregisztrációs adatbázist, a munkaterület létrehozásával együtt nem. Alapértelmezett érték: None
adb_workspace	str Egy meglévő Adb-munkaterület Azure-erőforrás-azonosító formátumban (az Azure-erőforrás-azonosító formátumának részleteiért tekintse meg az alábbi példakódot). A rendszer az Adb-munkaterületet használja a munkaterülethez való kapcsolódáshoz. Ha nincs, a munkaterület-hivatkozás nem fog megtörténni. Alapértelmezett érték: None
primary_user_assigned_identity	str A munkaterületet képviselő felhasználó által hozzárendelt identitás erőforrás-azonosítója Alapértelmezett érték: None
cmk_keyvault	str Az ügyfél által felügyelt kulcsot tartalmazó kulcstartó Azure-erőforrás-azonosító formátumban: `/subscriptions/<azure-subscription-id>/resourcegroups/<azure-resource-group>/providers/microsoft.keyvault/vaults/<azure-keyvault-name>` Például: "/subscriptions/d139f240-94e6-4175-87a7-954b9d27db16/resourcegroups/myresourcegroup/providers/microsoft.keyvault/vaults/mykeyvault" Az Azure-erőforrás-azonosító formátumával kapcsolatos további részletekért tekintse meg az alábbi Megjegyzésekben található példakódot. Alapértelmezett érték: None
resource_cmk_uri	str Az ügyfél által felügyelt kulcs kulcs URI-ja az inaktív adatok titkosításához. Az URI formátuma: `https://<keyvault-dns-name>/keys/<key-name>/<key-version>`. Például: ""https://mykeyvault.vault.azure.net/keys/mykey/bc5dce6d01df49w2na7ffb11a2ee008b. Tekintse meg a https://docs.microsoft.com/azure-stack/user/azure-stack-key-vault-manage-portal kulcsok létrehozásának és URI-jának beszerzésének lépéseit. Alapértelmezett érték: None
hbi_workspace	bool Meghatározza, hogy a munkaterület tartalmaz-e magas üzleti hatású (HBI) adatokat, azaz bizalmas üzleti adatokat tartalmaz-e. Ez a jelző csak a munkaterület létrehozásakor állítható be. Az értéke nem módosítható a munkaterület létrehozása után. Az alapértelmezett érték a Hamis. Igaz értékre állítva a rendszer további titkosítási lépéseket hajt végre, és az SDK-összetevőtől függően a rendszer a belsőleg gyűjtött telemetriában újrakijelzett információkat eredményez. További információ: Adattitkosítás. Ha ez a jelző True (Igaz) értékre van állítva, az egyik lehetséges hatás a problémák hibaelhárításával kapcsolatos megnövekedett nehézség. Ez azért fordulhat elő, mert a rendszer nem küld el bizonyos telemetriai adatokat a Microsoftnak, és kevésbé látható a sikerességi arányok és a problématípusok, ezért előfordulhat, hogy nem tud proaktívan reagálni, ha ez a jelző Igaz. A javaslat az alapértelmezett False (Hamis) értéket használja ehhez a jelzőhöz, kivéve, ha szigorúan igaz értékre van szükség. Alapértelmezett érték: False
default_cpu_compute_target	AmlComputeProvisioningConfiguration (ELAVULT) A cpu-számítás létrehozásához használt konfiguráció. A paraméter alapértelmezés szerint {min_nodes=0, max_nodes=2, vm_size="STANDARD_DS2_V2", vm_priority="dedicated"} Ha nincs, nem jön létre számítás. Alapértelmezett érték: None
default_gpu_compute_target	AmlComputeProvisioningConfiguration (ELAVULT) Gpu-számítás létrehozásához használt konfiguráció. A paraméter alapértelmezés szerint {min_nodes=0, max_nodes=2, vm_size="STANDARD_NC6", vm_priority="dedicated"} Ha nincs, nem jön létre számítás. Alapértelmezett érték: None
private_endpoint_config	PrivateEndPointConfig A privát végpont konfigurációja, amely privát végpontot hoz létre az Azure ML-munkaterületen. Alapértelmezett érték: None
private_endpoint_auto_approval	bool Logikai jelző, amely azt jelzi, hogy a privát végpont létrehozását automatikusan vagy manuálisan jóvá kell-e hagyni a Azure Private Link Centerben. Manuális jóváhagyás esetén a felhasználók megtekinthetik a függőben lévő kérést Private Link portálon a kérelem jóváhagyásához/elutasításához. Alapértelmezett érték: True
exist_ok	bool Azt jelzi, hogy ez a módszer sikeres-e, ha a munkaterület már létezik. Ha Hamis, ez a metódus meghiúsul, ha a munkaterület létezik. Ha igaz, ez a metódus a meglévő munkaterületet adja vissza, ha létezik. Alapértelmezett érték: False
show_output	bool Azt jelzi, hogy ez a metódus kiírja-e a növekményes folyamatot. Alapértelmezett érték: True
user_assigned_identity_for_cmk_encryption	str A felhasználó által hozzárendelt identitás erőforrás-azonosítója, amelyet az ügyfélkezelési kulcs eléréséhez kell használni Alapértelmezett érték: None
system_datastores_auth_mode	str Meghatározza, hogy használjon-e hitelesítő adatokat a munkaterület "workspaceblobstore" és "workspacefilestore" rendszeradattáraihoz. Az alapértelmezett érték az "accessKey", amely esetben a munkaterület hitelesítő adatokkal hozza létre a rendszeradattárakat. Ha az "identitás" értékre van állítva, a munkaterület hitelesítő adatok nélkül hozza létre a rendszeradattárakat. Alapértelmezett érték: accessKey
v1_legacy_mode	bool A v2 API-szolgáltatás használatának megakadályozása nyilvános Azure-Resource Manager Alapértelmezett érték: None

Válaszok

Típus	Description
Workspace	A munkaterület-objektum.

Kivételek

Típus	Description
WorkspaceException	A munkaterület létrehozásával kapcsolatos problémák esetén merült fel.

Megjegyzések

Ez az első példa csak minimális specifikációt igényel, és az összes függő erőforrás és az erőforráscsoport automatikusan létrejön.


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

Az alábbi példa bemutatja, hogyan használhatja újra a meglévő Azure-erőforrásokat az Azure-erőforrás-azonosító formátum használatával. Az adott Azure-erőforrásazonosítók az Azure Portalon vagy az SDK-on keresztül kérhetők le. Ez feltételezi, hogy az erőforráscsoport, a tárfiók, a kulcstartó, az App Insights és a tárolóregisztrációs adatbázis már létezik.


   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

Törölje az Azure Machine Learning-munkaterülethez társított erőforrásokat.

delete(delete_dependent_resources=False, no_wait=False)

Paraméterek

Name	Description
delete_dependent_resources	bool Törli-e a munkaterülethez társított erőforrásokat, például a tárolóregisztrációs adatbázist, a tárfiókot, a kulcstartót és az Application Insightsot. Az alapértelmezett érték a Hamis. Az erőforrások törléséhez állítsa a True (Igaz) értéket. Alapértelmezett érték: False
no_wait	bool Várjon-e, amíg a munkaterület törlése befejeződik. Alapértelmezett érték: False

Válaszok

Típus	Description
None	Sikeres esetben nincs; ellenkező esetben hibát jelez.

delete_connection

Törölje a munkaterület kapcsolatát.

delete_connection(name)

Paraméterek

Name	Description
name Kötelező	str A munkaterület alatti kapcsolat egyedi neve

delete_private_endpoint_connection

Törölje a munkaterület privát végponti kapcsolatát.

delete_private_endpoint_connection(private_endpoint_connection_name)

Paraméterek

Name	Description
private_endpoint_connection_name Kötelező	str A privát végponti kapcsolat egyedi neve a munkaterületen

diagnose_workspace

Munkaterület beállítási problémáinak diagnosztizálása.

diagnose_workspace(diagnose_parameters)

Paraméterek

Name	Description
diagnose_parameters Kötelező	<xref:_restclient.models.DiagnoseWorkspaceParameters> A munkaterület állapotának diagnosztizálásának paramétere

Válaszok

Típus	Description
<xref:msrestazure.azure_operation.AzureOperationPoller>[<xref:_restclient.models.DiagnoseResponseResult>]	Az AzureOperationPoller egy példánya, amely a DiagnoseResponseResult értéket adja vissza

from_config

Munkaterület-objektumot ad vissza egy meglévő Azure Machine Learning-munkaterületről.

Beolvassa a munkaterület konfigurációját egy fájlból. Kivételt jelez, ha a konfigurációs fájl nem található.

A metódus egyszerű módot kínál arra, hogy ugyanazt a munkaterületet több Python-jegyzetfüzetben vagy -projektben újra felhasználja. A felhasználók a metódussal write_config menthetik a munkaterület Azure Resource Manager (ARM) tulajdonságait, és ezzel a módszerrel tölthetik be ugyanazt a munkaterületet különböző Python-jegyzetfüzetekben vagy -projektekben a munkaterület ARM-tulajdonságainak módosítása nélkül.

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

Paraméterek

Name	Description
path	str A kereséshez a konfigurációs fájl vagy a kezdőkönyvtár elérési útja. A paraméter alapértelmezés szerint az aktuális könyvtárban indítja el a keresést. Alapértelmezett érték: None
auth	ServicePrincipalAuthentication vagy InteractiveLoginAuthentication A hitelesítési objektum. További részletekért lásd: https://aka.ms/aml-notebook-auth. Ha nincs, a rendszer az alapértelmezett Azure CLI-hitelesítő adatokat használja, vagy az API hitelesítő adatokat kér. Alapértelmezett érték: None
_logger	Logger Lehetővé teszi az alapértelmezett naplózó felülírását. Alapértelmezett érték: None
_file_name	str Lehetővé teszi a konfigurációs fájl nevének felülírását, hogy megkeresse, ha az elérési út könyvtárelérési út. Alapértelmezett érték: None

Válaszok

Típus	Description
Workspace	Egy meglévő Azure ML-munkaterület munkaterület-objektuma.

get

Egy meglévő Azure Machine Learning-munkaterület munkaterület-objektumát adja vissza.

Kivételt jelez, ha a munkaterület nem létezik, vagy a szükséges mezők nem azonosítják egyedileg a munkaterületet.

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

Paraméterek

Name	Description
name Kötelező	str A lekérni kívánt munkaterület neve.
auth	ServicePrincipalAuthentication vagy InteractiveLoginAuthentication A hitelesítési objektum. További részletekért lásd: https://aka.ms/aml-notebook-auth. Ha nincs, a rendszer az alapértelmezett Azure CLI-hitelesítő adatokat használja, vagy az API hitelesítő adatokat kér. Alapértelmezett érték: None
subscription_id	str A használni kívánt előfizetés-azonosító. A paraméterre akkor van szükség, ha a felhasználó több előfizetéshez is hozzáfér. Alapértelmezett érték: None
resource_group	str A használni kívánt erőforráscsoport. Ha nincs, a metódus az előfizetés összes erőforráscsoportjában keres. Alapértelmezett érték: None
location	str A munkaterület helye. Alapértelmezett érték: None
cloud	str A célfelhő neve. Az "AzureCloud", az "AzureChinaCloud" vagy az "AzureUSGovernment" egyike lehet. Ha nincs megadva felhő, az "AzureCloud" lesz használva. Alapértelmezett érték: AzureCloud
id	str A munkaterület azonosítója. Alapértelmezett érték: None

Válaszok

Típus	Description
Workspace	A munkaterület-objektum.

get_connection

A munkaterület kapcsolatának lekérése.

get_connection(name)

Paraméterek

Name	Description
name Kötelező	str A munkaterület alatti kapcsolat egyedi neve

get_default_compute_target

Kérje le a munkaterület alapértelmezett számítási célját.

get_default_compute_target(type)

Paraméterek

Name	Description
type Kötelező	str A számítás típusa. A lehetséges értékek a "CPU" vagy a "GPU".

Válaszok

Típus	Description
ComputeTarget	Az adott számítási típus alapértelmezett számítási célja.

get_default_datastore

Kérje le a munkaterület alapértelmezett adattárát.

get_default_datastore()

Válaszok

Típus	Description
Datastore	Az alapértelmezett adattár.

get_default_keyvault

Kérje le a munkaterület alapértelmezett Key Vault-objektumát.

get_default_keyvault()

Válaszok

Típus	Description
Keyvault	A munkaterülethez társított KeyVault objektum.

get_details

Adja vissza a munkaterület adatait.

get_details()

Válaszok

Típus	Description
dict[str, str]	A munkaterület részletei szótár formátumban.

Megjegyzések

A visszaadott szótár a következő kulcs-érték párokat tartalmazza.

id: erre a munkaterületi erőforrásra mutató URI, amely tartalmazza az előfizetés azonosítóját, az erőforráscsoportot és a munkaterület nevét.
name: A munkaterület neve.
location: A munkaterület régiója.
type: A(z) "{providerName}/workspaces" formátumú URI.
tags: Jelenleg nincs használatban.
workspaceid: A munkaterület azonosítója.
description: Jelenleg nincs használatban.
friendlyName: A felhasználói felületen megjelenő munkaterület rövid neve.
creationTime: A munkaterület létrehozásának időpontja ISO8601 formátumban.
containerRegistry: A munkaterület tárolóregisztrációs adatbázisa, amely a kísérletezési és a webszolgáltatási rendszerképek lekéréséhez és leküldéséhez is használható.
keyVault: A munkaterület kulcstartója, amellyel a felhasználók a munkaterülethez hozzáadott hitelesítő adatokat tárolják.
applicationInsights: A munkaterület az Application Insights használatával naplózza a webszolgáltatási eseményeket.
identityPrincipalId:
identityTenantId
identityType
storageAccount: A munkaterület a futtatási kimenetek, a kód, a naplók stb. mentésére fogja használni a tárolót.
termékváltozat: A munkaterület termékváltozata (más néven kiadás). A paraméter a visszamenőleges kompatibilitás érdekében jelen van, és figyelmen kívül lesz hagyva.
resourceCmkUri: Az ügyfél által kezelt kulcs URI-ja az inaktív adatok titkosításához. Tekintse meg a https://docs.microsoft.com/en-us/azure-stack/user/azure-stack-key-vault-manage-portal?view=azs-1910 kulcsok létrehozásának és URI-jának beszerzésének lépéseit.
hbiWorkspace: Meghatározza, hogy az ügyféladatok nagy üzleti hatással vannak-e.
imageBuildCompute: A rendszerkép-létrehozás számítási célja.
systemDatastoresAuthMode: Meghatározza, hogy a "workspaceblobstore" és a "workspacefilestore" munkaterület rendszeradattáraihoz használjon-e hitelesítő adatokat. Az alapértelmezett érték az "accessKey", amely esetben a munkaterület hitelesítő adatokkal hozza létre a rendszeradattárakat. Ha az "identitás" értékre van állítva, a munkaterület hitelesítő adatok nélkül hozza létre a rendszeradattárakat.

További információ ezekről a kulcs-érték párokról: create.

get_mlflow_tracking_uri

Kérje le a munkaterület MLflow-nyomkövetési URI-ját.

Az MLflow (https://mlflow.org/) egy nyílt forráskódú platform a gépi tanulási kísérletek nyomon követéséhez és a modellek kezeléséhez. Az MLflow naplózási API-kat használhatja az Azure Machine Learning szolgáltatással, hogy a metrikákat, modelleket és összetevőket a rendszer naplózza az Azure Machine Learning-munkaterületre.

get_mlflow_tracking_uri(_with_auth=False)

Paraméterek

Name	Description
_with_auth	bool (ELAVULT) Adjon meg hitelesítési adatokat az URI nyomon követéséhez. Alapértelmezett érték: False

Válaszok

Típus	Description
str	Az MLflow-kompatibilis nyomkövetési URI.

Megjegyzések

Az alábbi példával konfigurálhatja az MLflow-nyomkövetést az adatok Azure ML-munkaterületre való küldéséhez:


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

get_run

A futtatás visszaadása a munkaterületen megadott run_id.

get_run(run_id)

Paraméterek

Name	Description
run_id Kötelező	string A futtatási azonosító.

Válaszok

Típus	Description
Run	A beküldött futtatás.

list

Listázhatja az összes olyan munkaterületet, amelyhez a felhasználó hozzáféréssel rendelkezik az előfizetésen belül.

A munkaterületek listája az erőforráscsoport alapján szűrhető.

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

Paraméterek

Name	Description
subscription_id Kötelező	str Az előfizetés azonosítója, amelynek a munkaterületeit listázni szeretné.
auth	ServicePrincipalAuthentication vagy InteractiveLoginAuthentication A hitelesítési objektum. További részletekért lásd: https://aka.ms/aml-notebook-auth. Ha nincs, a rendszer az alapértelmezett Azure CLI-hitelesítő adatokat használja, vagy az API hitelesítő adatokat kér. Alapértelmezett érték: None
resource_group	str Erőforráscsoport a visszaadott munkaterületek szűréséhez. Ha nincs, a metódus felsorolja a megadott előfizetésen belüli összes munkaterületet. Alapértelmezett érték: None

Válaszok

Típus	Description
dict	Egy szótár, ahol a kulcs a munkaterület neve, az érték pedig a Munkaterület-objektumok listája.

list_connections

A munkaterület alatti kapcsolatok listázása.

list_connections(category=None, target=None)

Paraméterek

Name	Description
type Kötelező	str A szűrni kívánt kapcsolat típusa
target	str ennek a kapcsolatnak a célja, amelyre szűrni fog Alapértelmezett érték: None
category	Alapértelmezett érték: None

list_keys

Az aktuális munkaterület kulcsainak listázása.

list_keys()

Válaszok

Típus	Description
object

set_connection

Adjon hozzá vagy frissítsen egy kapcsolatot a munkaterület alatt.

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

Paraméterek

Name	Description
name Kötelező	str A munkaterület alatti kapcsolat egyedi neve
category Kötelező	str A kapcsolat kategóriája
target Kötelező	str a cél, amelyhez a kapcsolat csatlakozik
authType Kötelező	str a kapcsolat engedélyezési típusa
value Kötelező	str a kapcsolat részleteinek json formátumú szerializálási sztringje

set_default_datastore

Állítsa be a munkaterület alapértelmezett adattárát.

set_default_datastore(name)

Paraméterek

Name	Description
name Kötelező	str Az alapértelmezettként beállítani kívánt név Datastore .

setup

Hozzon létre egy új munkaterületet, vagy kérjen le egy meglévő munkaterületet.

static setup()

Válaszok

Típus	Description
Workspace	Munkaterület-objektum.

sync_keys

Aktiválja a munkaterületet a kulcsok azonnali szinkronizálásához.

Ha a munkaterület bármely erőforrásának kulcsait módosítják, az automatikus frissítésük körülbelül egy órát is igénybe vehet. Ez a függvény lehetővé teszi a kulcsok kérésre történő frissítését. Példaforgatókönyv, ha a tárolókulcsok újragenerálása után azonnal hozzá kell férnie a tárolóhoz.

sync_keys(no_wait=False)

Paraméterek

Name	Description
no_wait	bool Várjon-e, amíg a munkaterület szinkronizálási kulcsai befejeződnek. Alapértelmezett érték: False

Válaszok

Típus	Description
None	Sikeres esetben nincs; ellenkező esetben hibát jelez.

update

Frissítse a munkaterülethez társított rövid nevet, leírást, címkéket, rendszerkép-összeállítási számítást és egyéb beállításokat.

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)

Paraméterek

Name	Description
friendly_name	str A munkaterület felhasználóbarát neve, amely megjeleníthető a felhasználói felületen. Alapértelmezett érték: None
description	str A munkaterület leírása. Alapértelmezett érték: None
tags	dict A munkaterülethez társítandó címkék. Alapértelmezett érték: None
image_build_compute	str A rendszerkép buildjének számítási neve. Alapértelmezett érték: None
service_managed_resources_settings	<xref:azureml._base_sdk_common.workspace.models.ServiceManagedResourcesSettings> A szolgáltatás által felügyelt erőforrások beállításai. Alapértelmezett érték: None
primary_user_assigned_identity	str A felhasználó által hozzárendelt identitás erőforrás-azonosítója, amely a munkaterület identitását jelöli. Alapértelmezett érték: None
allow_public_access_when_behind_vnet	bool Nyilvános hozzáférés engedélyezése privát kapcsolatú munkaterülethez. Alapértelmezett érték: None
v1_legacy_mode	bool A v2 API-szolgáltatás használatának megakadályozása nyilvános Azure-Resource Manager Alapértelmezett érték: None

Válaszok

Típus	Description
dict[str, str]	A frissített információk szótára.

update_dependencies

Frissítse a munkaterülethez társított erőforrásokat a következő esetekben.

a) Ha egy felhasználó véletlenül töröl egy meglévő társított erőforrást, és egy új erőforrással szeretné frissíteni anélkül, hogy újra létre kellene hoznia a teljes munkaterületet. b) Ha egy felhasználó rendelkezik meglévő társított erőforrással, és le szeretné cserélni a munkaterülethez társított aktuális erőforrást. c) Ha még nem hoztak létre társított erőforrást, és egy már meglévő erőforrást szeretnének használni (csak a tárolóregisztrációs adatbázisra vonatkozik).

update_dependencies(container_registry=None, force=False)

Paraméterek

Name	Description
container_registry	str A tárolóregisztrációs adatbázis ARM-azonosítója. Alapértelmezett érték: None
force	bool Ha megerősítés nélkül kényszeríti a függő erőforrások frissítését. Alapértelmezett érték: False

Válaszok

Típus	Description
Workspace

write_config

Írja be a munkaterület Azure Resource Manager (ARM) tulajdonságait egy konfigurációs fájlba.

A munkaterület ARM-tulajdonságai később betölthetők a from_config metódussal. Az path alapértelmezett érték a ".azureml/" lesz az aktuális munkakönyvtárban, az file_name alapértelmezett érték pedig a "config.json".

A metódus egyszerű módot kínál ugyanazon munkaterület több Python-jegyzetfüzetben vagy -projektben való újrafelhasználására. A felhasználók ezzel a függvénnyel menthetik a munkaterület ARM-tulajdonságait, és a from_config használatával tölthetik be ugyanazt a munkaterületet különböző Python-jegyzetfüzetekben vagy -projektekben anélkül, hogy a munkaterület ARM-tulajdonságainak újraformázását használták.

write_config(path=None, file_name=None)

Paraméterek

Name	Description
path	str A felhasználó megadta a config.json fájl írásának helyét. A paraméter alapértelmezett értéke ".azureml/" az aktuális munkakönyvtárban. Alapértelmezett érték: None
file_name	str A konfigurációs fájlhoz használandó név. A paraméter alapértelmezés szerint config.json. Alapértelmezett érték: None

Attribútumok

compute_targets

A munkaterületen található összes számítási cél listázása.

Válaszok

Típus	Description
dict[str, ComputeTarget]	Egy szótár, amelynek kulcsát a számítási cél neve és értéke objektumként ComputeTarget adja meg.

datasets

A munkaterület összes adathalmazának listázása.

Válaszok

Típus	Description
dict[str, Dataset]	Egy szótár, amely kulcsként szolgál az adathalmaz neveként és értékeként objektumként Dataset .

datastores

A munkaterület összes adattárának listázása. Ez a művelet nem adja vissza az adattárak hitelesítő adatait.

Válaszok

Típus	Description
dict[str, Datastore]	Egy szótár, amely kulcsként szerepel az adattár neveként és értékeként objektumként Datastore .

discovery_url

Adja vissza a munkaterület felderítési URL-címét.

Válaszok

Típus	Description
str	A munkaterület felderítési URL-címe.

environments

A munkaterület összes környezetének listázása.

Válaszok

Típus	Description
dict[str, Environment]	Egy szótár, amely a kulcsot környezeti névként és értékként objektumként Environment használja.

experiments

Listázz minden kísérletet a munkaterületen.

Válaszok

Típus	Description
dict[str, Experiment]	Egy szótár, amelynek a kulcsa a kísérlet neve, az érték Experiment pedig objektum.

images

Adja vissza a munkaterületen lévő képek listáját.

Felvet egy hibát WebserviceException , ha probléma merült fel a modellkezelési szolgáltatással való interakció során.

Válaszok

Típus	Description
dict[str, Image]	Egy szótár képnévként és értékként, objektumként Image .

Kivételek

Típus	Description
WebserviceException	Probléma lépett fel a modellkezelési szolgáltatással való interakció során.

linked_services

A munkaterület összes társított szolgáltatásának listázása.

Válaszok

Típus	Description
dict[str, LinkedService]	Egy szótár, ahol a kulcs egy társított szolgáltatásnév, az érték pedig egy LinkedService objektum.

location

Adja vissza a munkaterület helyét.

Válaszok

Típus	Description
str	A munkaterület helye.

models

Adja vissza a munkaterület modelllistáját.

Felvet egy hibát WebserviceException , ha probléma merült fel a modellkezelési szolgáltatással való interakció során.

Válaszok

Típus	Description
dict[str, Model]	A modell szótára, amelynek kulcsát modellnévként és értékként objektumként adja Model meg.

Kivételek

Típus	Description
WebserviceException	Probléma lépett fel a modellkezelési szolgáltatással való interakció során.

name

Adja vissza a munkaterület nevét.

Válaszok

Típus	Description
str	A munkaterület neve.

private_endpoints

A munkaterület összes privát végpontjának listázása.

Válaszok

Típus	Description
dict[str, PrivateEndPoint]	A munkaterülethez társított PrivateEndPoint-objektumok diktálása. A kulcs a privát végpont neve.

resource_group

Adja vissza a munkaterület erőforráscsoportjának nevét.

Válaszok

Típus	Description
str	Az erőforráscsoport neve.

service_context

Adja vissza a munkaterület szolgáltatási környezetét.

Válaszok

Típus	Description
<xref:azureml._restclient.service_context.ServiceContext>	A ServiceContext objektumot adja vissza.

sku

Adja vissza a munkaterület termékváltozatát.

Válaszok

Típus	Description
str	A munkaterület termékváltozata.

subscription_id

Adja vissza a munkaterület előfizetés-azonosítóját.

Válaszok

Típus	Description
str	Az előfizetés azonosítója.

webservices

A munkaterületen található webszolgáltatások listájának visszaadása.

Felvet egy hibát WebserviceException , ha probléma merült fel a lista visszaadása során.

Válaszok

Típus	Description
dict[str, Webservice]	A munkaterületen található webszolgáltatások listája.

Kivételek

Típus	Description
WebserviceException	Hiba történt a lista visszaadása során.

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'

Megosztás a következőn keresztül:

Workspace Osztály

Konstruktor

Paraméterek

Megjegyzések

Metódusok

add_private_endpoint

Paraméterek

Válaszok

create

Paraméterek

Válaszok

Kivételek

Megjegyzések

delete

Paraméterek

Válaszok

delete_connection

Paraméterek

delete_private_endpoint_connection

Paraméterek

diagnose_workspace

Paraméterek

Válaszok

from_config

Paraméterek

Válaszok

get

Paraméterek

Válaszok

get_connection

Paraméterek

get_default_compute_target

Paraméterek

Válaszok

get_default_datastore

Válaszok

get_default_keyvault

Válaszok

get_details

Válaszok

Megjegyzések

get_mlflow_tracking_uri

Paraméterek

Válaszok

Megjegyzések

get_run

Paraméterek

Válaszok

list

Paraméterek

Válaszok

list_connections

Paraméterek

list_keys

Válaszok

set_connection

Paraméterek

set_default_datastore

Paraméterek

setup

Válaszok

sync_keys

Paraméterek

Válaszok

update

Paraméterek

Válaszok

update_dependencies

Paraméterek

Válaszok

write_config

Paraméterek

Attribútumok

compute_targets

Válaszok

datasets

Válaszok

datastores

Válaszok