Workspace Osztály

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

subscription_id
str
Kötelező

A munkaterületet tartalmazó Azure-előfizetés azonosítója.

resource_group
str
Kötelező

A munkaterületet tartalmazó erőforráscsoport.

workspace_name
str
Kötelező

A meglévő munkaterület neve.

auth
ServicePrincipalAuthentication vagy InteractiveLoginAuthentication vagy MsiAuthentication
alapértelmezett érték: None

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
str
alapértelmezett érték: None

Csak belső használatra.

_disable_service_check
bool
alapértelmezett érték: False

Csak belső használatra.

_workspace_id
str
alapértelmezett érték: None

Csak belső használatra.

sku
str
alapértelmezett érték: basic

A paraméter a visszamenőleges kompatibilitás érdekében jelen van, és figyelmen kívül lesz hagyva.

_cloud
str
alapértelmezett érték: AzureCloud

Csak belső használatra.

subscription_id
str
Kötelező

A munkaterületet tartalmazó Azure-előfizetés azonosítója.

resource_group
str
Kötelező

A munkaterületet tartalmazó erőforráscsoport.

workspace_name
str
Kötelező

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
ServicePrincipalAuthentication vagy InteractiveLoginAuthentication vagy MsiAuthentication
Kötelező

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
str
Kötelező

Csak belső használatra.

_disable_service_check
bool
Kötelező

Csak belső használatra.

_workspace_id
str
Kötelező

Csak belső használatra.

sku
str
Kötelező

A paraméter a visszamenőleges kompatibilitás érdekében jelen van, és figyelmen kívül lesz hagyva.

tags
dict
alapértelmezett érték: None

A munkaterülethez társítandó címkék.

_cloud
str
Kötelező

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

private_endpoint_config
PrivateEndPointConfig
Kötelező

A privát végpont konfigurációja, amellyel privát végpontot hozhat létre a munkaterületen.

private_endpoint_auto_approval
bool
alapértelmezett érték: True

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.

location
string
alapértelmezett érték: None

A privát végpont helye, alapértelmezés szerint a munkaterület helye

show_output
bool
alapértelmezett érték: True

A munkaterület létrehozásának előrehaladását jelző jelző

tags
dict
alapértelmezett érték: None

A munkaterülethez társítandó címkék.

Válaszok

A létrehozott PrivateEndPoint-objektum.

Visszatérési típus

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
str
Kötelező

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
alapértelmezett érték: None

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.

subscription_id
str
alapértelmezett érték: None

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.

resource_group
str
alapértelmezett érték: None

A munkaterületet tartalmazó Azure-erőforráscsoport. A paraméter alapértelmezés szerint a munkaterület nevének mutációja.

location
str
alapértelmezett érték: None

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.

create_resource_group
bool
alapértelmezett érték: True

Azt jelzi, hogy létre kívánja-e hozni az erőforráscsoportot, ha az nem létezik.

sku
str
alapértelmezett érték: basic

A paraméter a visszamenőleges kompatibilitás érdekében jelen van, és figyelmen kívül lesz hagyva.

tags
dict
alapértelmezett érték: None

A munkaterülethez társítandó címkék.

friendly_name
str
alapértelmezett érték: None

A munkaterület nem kötelező rövid neve, amely megjeleníthető a felhasználói felületen.

storage_account
str
alapértelmezett érték: None

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.

key_vault
str
alapértelmezett érték: None

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ó.

app_insights
str
alapértelmezett érték: None

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.

container_registry
str
alapértelmezett érték: None

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.

adb_workspace
str
alapértelmezett érték: None

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.

primary_user_assigned_identity
str
alapértelmezett érték: None

A munkaterületet képviselő felhasználó által hozzárendelt identitás erőforrás-azonosítója

cmk_keyvault
str
alapértelmezett érték: None

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.

resource_cmk_uri
str
alapértelmezett érték: None

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.

hbi_workspace
bool
alapértelmezett érték: False

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.

default_cpu_compute_target
AmlComputeProvisioningConfiguration
alapértelmezett érték: None

(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.

default_gpu_compute_target
AmlComputeProvisioningConfiguration
alapértelmezett érték: None

(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.

private_endpoint_config
PrivateEndPointConfig
alapértelmezett érték: None

A privát végpont konfigurációja, amely privát végpontot hoz létre az Azure ML-munkaterületen.

private_endpoint_auto_approval
bool
alapértelmezett érték: True

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.

exist_ok
bool
alapértelmezett érték: False

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.

show_output
bool
alapértelmezett érték: True

Azt jelzi, hogy ez a metódus kiírja-e a növekményes folyamatot.

user_assigned_identity_for_cmk_encryption
str
alapértelmezett érték: None

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

system_datastores_auth_mode
str
alapértelmezett érték: accessKey

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.

v1_legacy_mode
bool
alapértelmezett érték: None

A v2 API-szolgáltatás használatának megakadályozása nyilvános Azure-Resource Manager

Válaszok

A munkaterület-objektum.

Visszatérési típus

Kivételek

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

delete_dependent_resources
bool
alapértelmezett érték: False

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.

no_wait
bool
alapértelmezett érték: False

Várjon-e, amíg a munkaterület törlése befejeződik.

Válaszok

Sikeres esetben nincs; ellenkező esetben hibát jelez.

Visszatérési típus

delete_connection

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

delete_connection(name)

Paraméterek

name
str
Kötelező

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

private_endpoint_connection_name
str
Kötelező

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

diagnose_parameters
<xref:_restclient.models.DiagnoseWorkspaceParameters>
Kötelező

A munkaterület állapotának diagnosztizálásának paramétere

Válaszok

Az AzureOperationPoller egy példánya, amely a DiagnoseResponseResult értéket adja vissza

Visszatérési típus

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

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

path
str
alapértelmezett érték: None

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.

auth
ServicePrincipalAuthentication vagy InteractiveLoginAuthentication
alapértelmezett érték: None

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.

_logger
Logger
alapértelmezett érték: None

Lehetővé teszi az alapértelmezett naplózó felülírását.

_file_name
str
alapértelmezett érték: None

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.

Válaszok

Egy meglévő Azure ML-munkaterület munkaterület-objektuma.

Visszatérési típus

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
str
Kötelező

A lekérni kívánt munkaterület neve.

auth
ServicePrincipalAuthentication vagy InteractiveLoginAuthentication
alapértelmezett érték: None

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.

subscription_id
str
alapértelmezett érték: None

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.

resource_group
str
alapértelmezett érték: None

A használni kívánt erőforráscsoport. Ha nincs, a metódus az előfizetés összes erőforráscsoportjában keres.

location
str
alapértelmezett érték: None

A munkaterület helye.

cloud
str
alapértelmezett érték: AzureCloud

A célfelhő neve. Az "AzureCloud", az "AzureChinaCloud" vagy az "AzureUSGovernment" egyike lehet. Ha nincs megadva felhő, az "AzureCloud" lesz használva.

id
str
alapértelmezett érték: None

A munkaterület azonosítója.

Válaszok

A munkaterület-objektum.

Visszatérési típus

get_connection

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

get_connection(name)

Paraméterek

name
str
Kötelező

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

type
str
Kötelező

A számítás típusa. A lehetséges értékek a "CPU" vagy a "GPU".

Válaszok

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

Visszatérési típus

get_default_datastore

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

get_default_datastore()

Válaszok

Az alapértelmezett adattár.

Visszatérési típus

get_default_keyvault

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

get_default_keyvault()

Válaszok

A munkaterülethez társított KeyVault objektum.

Visszatérési típus

get_details

Adja vissza a munkaterület adatait.

get_details()

Válaszok

A munkaterület részletei szótár formátumban.

Visszatérési típus

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

_with_auth
bool
alapértelmezett érték: False

(ELAVULT) Adjon meg hitelesítési adatokat az URI nyomon követéséhez.

Válaszok

Az MLflow-kompatibilis nyomkövetési URI.

Visszatérési típus

str

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

run_id
string
Kötelező

A futtatási azonosító.

Válaszok

A beküldött futtatás.

Visszatérési típus

Run

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

subscription_id
str
Kötelező

Az előfizetés azonosítója, amelynek a munkaterületeit listázni szeretné.

auth
ServicePrincipalAuthentication vagy InteractiveLoginAuthentication
alapértelmezett érték: None

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.

resource_group
str
alapértelmezett érték: None

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.

Válaszok

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

Visszatérési típus

list_connections

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

list_connections(category=None, target=None)

Paraméterek

type
str
Kötelező

A szűrni kívánt kapcsolat típusa

target
str
alapértelmezett érték: None

ennek a kapcsolatnak a célja, amelyre szűrni fog

category
alapértelmezett érték: None

list_keys

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

list_keys()

Visszatérési típus

set_connection

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

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

Paraméterek

name
str
Kötelező

A munkaterület alatti kapcsolat egyedi neve

category
str
Kötelező

A kapcsolat kategóriája

target
str
Kötelező

a cél, amelyhez a kapcsolat csatlakozik

authType
str
Kötelező

a kapcsolat engedélyezési típusa

value
str
Kötelező

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
str
Kötelező

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

Munkaterület-objektum.

Visszatérési típus

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

no_wait
bool
alapértelmezett érték: False

Várjon-e, amíg a munkaterület szinkronizálási kulcsai befejeződnek.

Válaszok

Sikeres esetben nincs; ellenkező esetben hibát jelez.

Visszatérési típus

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

friendly_name
str
alapértelmezett érték: None

A munkaterület felhasználóbarát neve, amely megjeleníthető a felhasználói felületen.

description
str
alapértelmezett érték: None

A munkaterület leírása.

tags
dict
alapértelmezett érték: None

A munkaterülethez társítandó címkék.

image_build_compute
str
alapértelmezett érték: None

A rendszerkép buildjének számítási neve.

service_managed_resources_settings
<xref:azureml._base_sdk_common.workspace.models.ServiceManagedResourcesSettings>
alapértelmezett érték: None

A szolgáltatás által felügyelt erőforrások beállításai.

primary_user_assigned_identity
str
alapértelmezett érték: None

A felhasználó által hozzárendelt identitás erőforrás-azonosítója, amely a munkaterület identitását jelöli.

allow_public_access_when_behind_vnet
bool
alapértelmezett érték: None

Nyilvános hozzáférés engedélyezése privát kapcsolatú munkaterülethez.

v1_legacy_mode
bool
alapértelmezett érték: None

A v2 API-szolgáltatás használatának megakadályozása nyilvános Azure-Resource Manager

Válaszok

A frissített információk szótára.

Visszatérési típus

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

container_registry
str
alapértelmezett érték: None

A tárolóregisztrációs adatbázis ARM-azonosítója.

force
bool
alapértelmezett érték: False

Ha megerősítés nélkül kényszeríti a függő erőforrások frissítését.

Visszatérési típus

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

path
str
alapértelmezett érték: None

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.

file_name
str
alapértelmezett érték: None

A konfigurációs fájlhoz használandó név. A paraméter alapértelmezés szerint config.json.

Attribútumok

compute_targets

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

Válaszok

Egy szótár, amelynek kulcsát a számítási cél neve és értéke objektumként ComputeTarget adja meg.

Visszatérési típus

datasets

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

Válaszok

Egy szótár, amely kulcsként szolgál az adathalmaz neveként és értékeként objektumként Dataset .

Visszatérési típus

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

Egy szótár, amely kulcsként szerepel az adattár neveként és értékeként objektumként Datastore .

Visszatérési típus

discovery_url

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

Válaszok

A munkaterület felderítési URL-címe.

Visszatérési típus

str

environments

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

Válaszok

Egy szótár, amely a kulcsot környezeti névként és értékként objektumként Environment használja.

Visszatérési típus

experiments

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

Válaszok

Egy szótár, amelynek a kulcsa a kísérlet neve, az érték Experiment pedig objektum.

Visszatérési típus

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

Egy szótár képnévként és értékként, objektumként Image .

Visszatérési típus

Kivételek

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

Egy szótár, ahol a kulcs egy társított szolgáltatásnév, az érték pedig egy LinkedService objektum.

Visszatérési típus

location

Adja vissza a munkaterület helyét.

Válaszok

A munkaterület helye.

Visszatérési típus

str

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

A modell szótára, amelynek kulcsát modellnévként és értékként objektumként adja Model meg.

Visszatérési típus

Kivételek

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

A munkaterület neve.

Visszatérési típus

str

private_endpoints

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

Válaszok

A munkaterülethez társított PrivateEndPoint-objektumok diktálása. A kulcs a privát végpont neve.

Visszatérési típus

resource_group

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

Válaszok

Az erőforráscsoport neve.

Visszatérési típus

str

service_context

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

Válaszok

A ServiceContext objektumot adja vissza.

Visszatérési típus

<xref:azureml._restclient.service_context.ServiceContext>

sku

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

Válaszok

A munkaterület termékváltozata.

Visszatérési típus

str

subscription_id

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

Válaszok

Az előfizetés azonosítója.

Visszatérési típus

str

tags

Adja vissza a munkaterület címkéinek értékét.

Válaszok

A munkaterület címkéi.

Visszatérési típus

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

A munkaterületen található webszolgáltatások listája.

Visszatérési típus

Kivételek

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'