Workspace Classe

Définit une ressource Azure Machine Learning pour la gestion des artefacts d’entraînement et de déploiement.

Un espace de travail est une ressource fondamentale pour le machine learning dans Azure Machine Learning. Vous utilisez un espace de travail pour expérimenter, entraîner et déployer des modèles Machine Learning. Chaque espace de travail est lié à un abonnement Azure et à un groupe de ressources. Il est également associé à une référence SKU.

Pour plus d’informations sur les espaces de travail, consultez :

• Qu’est-ce qu’un espace de travail Azure Machine Learning ?

• Gérer l’accès à un espace de travail

Constructeur d’espace de travail de classe pour charger un espace de travail Azure Machine Learning existant.

Héritage

builtins.object

Workspace

Constructeur

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ètres

Nom	Description
subscription_id Obligatoire	str ID d’abonnement Azure contenant l’espace de travail.
resource_group Obligatoire	str Groupe de ressources contenant l’espace de travail.
workspace_name Obligatoire	str Nom de l’espace de travail existant.
auth	ServicePrincipalAuthentication ou InteractiveLoginAuthentication ou MsiAuthentication Objet d’authentification. Pour plus d’informations, consultez https://aka.ms/aml-notebook-auth. Si None est spécifié, les informations d’identification Azure CLI par défaut sont utilisées, ou l’API vous invite à entrer vos informations d’identification. valeur par défaut: None
_location	str Usage interne uniquement. valeur par défaut: None
_disable_service_check	bool Usage interne uniquement. valeur par défaut: False
_workspace_id	str Usage interne uniquement. valeur par défaut: None
sku	str Le paramètre est présent pour des raisons de compatibilité descendante et est ignoré. valeur par défaut: basic
_cloud	str À usage interne uniquement valeur par défaut: AzureCloud
subscription_id Obligatoire	str ID d’abonnement Azure contenant l’espace de travail.
resource_group Obligatoire	str Groupe de ressources contenant l’espace de travail.
workspace_name Obligatoire	str Nom de l’espace de travail. Le nom doit compter entre 2 et 32 caractères. Le premier caractère du nom doit être alphanumérique (lettre ou chiffre), mais le reste du nom peut contenir des caractères alphanumériques, des traits d’union et des traits de soulignement. Les espaces blancs ne sont pas autorisés.
auth Obligatoire	ServicePrincipalAuthentication ou InteractiveLoginAuthentication ou MsiAuthentication Objet d’authentification. Pour plus d’informations, consultez https://aka.ms/aml-notebook-auth. Si None est spécifié, les informations d’identification Azure CLI par défaut sont utilisées, ou l’API vous invite à entrer vos informations d’identification.
_location Obligatoire	str Usage interne uniquement.
_disable_service_check Obligatoire	bool Usage interne uniquement.
_workspace_id Obligatoire	str Usage interne uniquement.
sku Obligatoire	str Le paramètre est présent pour des raisons de compatibilité descendante et est ignoré.
tags	dict Étiquettes à associer à l’espace de travail. valeur par défaut: None
_cloud Obligatoire	str À usage interne uniquement

Remarques

L’exemple suivant montre comment créer un espace de travail.

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

Si vous disposez déjà d’un groupe de ressources Azure que vous souhaitez utiliser comme espace de travail, définissez create_resource_group sur False.

Pour utiliser le même espace de travail dans plusieurs environnements, créez un fichier config JSON. Le fichier config enregistre les informations relatives à l’abonnement, à la ressource et au nom de l’espace de travail pour faciliter le chargement de ce dernier. Pour enregistrer la configuration, utilisez la méthode write_config.

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

Consultez Créer un fichier config d’espace de travail pour obtenir un exemple de fichier config.

Pour charger l’espace de travail à partir du fichier config, utilisez la méthode from_config.

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

Vous pouvez également utiliser la méthode get pour charger un espace de travail existant sans utiliser de fichiers config.

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

Dans les exemples ci-dessus, vous pouvez être invité à entrer vos informations d’identification Azure à l’aide d’une boîte de dialogue de connexion interactive. Pour d’autres cas d’usage, notamment l’utilisation d’Azure CLI pour s’authentifier et permettre l’authentification dans les workflows automatisés, consultez Authentification dans Azure Machine Learning.

Méthodes

add_private_endpoint	Ajoute un point de terminaison privé à l’espace de travail.
create	Crée un espace de travail Azure Machine Learning. Lève une exception si l’espace de travail existe déjà ou si l’une des conditions relatives à l’espace de travail n’est pas remplie.
delete	Supprime les ressources associées à l’espace de travail Azure Machine Learning.
delete_connection	Supprime une connexion de l’espace de travail.
delete_private_endpoint_connection	Supprime la connexion de point de terminaison privé à l’espace de travail.
diagnose_workspace	Diagnostique les problèmes d’installation de l’espace de travail.
from_config	Retourne un objet d’espace de travail à partir d’un espace de travail Azure Machine Learning existant. Lit la configuration de l’espace de travail à partir d’un fichier. Lève une exception si le fichier config est introuvable. La méthode fournit un moyen simple de réutiliser le même espace de travail sur plusieurs notebooks ou projets Python. Les utilisateurs peuvent enregistrer les propriétés ARM (Azure Resource Manager) de l’espace de travail à l’aide de la méthode write_config, et utiliser cette méthode pour charger le même espace de travail dans différents notebooks ou projets Python sans avoir à retaper les propriétés ARM de l’espace de travail.
get	Retourne un objet d’espace de travail pour un espace de travail Azure Machine Learning existant. Lève une exception si l’espace de travail n’existe pas, ou si les champs obligatoires n’identifient pas de manière unique un espace de travail.
get_connection	Obtient une connexion à l’espace de travail.
get_default_compute_target	Obtient la cible de calcul par défaut de l’espace de travail.
get_default_datastore	Obtient le magasin de données par défaut de l’espace de travail.
get_default_keyvault	Obtient l’objet de coffre de clés par défaut de l’espace de travail.
get_details	Retourne les détails de l’espace de travail.
get_mlflow_tracking_uri	Obtient l’URI de suivi MLflow de l’espace de travail. MLflow (https://mlflow.org/) est une plateforme open source pour le suivi des expériences de machine learning et la gestion des modèles. Vous pouvez utiliser les API de journalisation MLflow avec Azure Machine Learning pour que les métriques, les modèles et les artefacts soient journalisés dans votre espace de travail Azure Machine Learning.
get_run	Retourne l’exécution ayant le run_id spécifié dans l’espace de travail.
list	Liste tous les espaces de travail auxquels l’utilisateur a accès dans l’abonnement. La liste des espaces de travail peut être filtrée en fonction du groupe de ressources.
list_connections	Liste les connexions de cet espace de travail.
list_keys	Liste les clés de l’espace de travail actif.
set_connection	Ajoute ou met à jour une connexion dans l’espace de travail.
set_default_datastore	Définit le magasin de données par défaut de l’espace de travail.
setup	Crée un espace de travail ou utilise un espace de travail existant.
sync_keys	Déclenche l’espace de travail pour synchroniser immédiatement les clés. Si les clés d’une ressource de l’espace de travail sont modifiées, l’opération de mise à jour automatique de celles-ci peut prendre environ une heure. Cette fonction permet de mettre à jour les clés à la demande. Un exemple de scénario nécessite un accès immédiat au stockage après la régénération des clés de stockage.
update	Met à jour le nom convivial, la description, les étiquettes, le calcul de génération d’image et d’autres paramètres associés à un espace de travail.
update_dependencies	Met à jour les ressources associées à l’espace de travail dans les cas suivants. a) Quand un utilisateur supprime accidentellement une ressource associée existante et souhaite la mettre à jour avec une nouvelle ressource sans devoir recréer l’espace de travail entier. b) Quand un utilisateur dispose d’une ressource associée existante et souhaite remplacer la ressource associée qui est actuellement associée à l’espace de travail. c) Quand une ressource associée n’a pas encore été créée et que l’utilisateur souhaite utiliser une ressource déjà existante (s’applique uniquement au registre de conteneurs).
write_config	Écrit les propriétés de l’espace de travail ARM (Azure Resource Manager) dans un fichier config. Les propriétés ARM de l’espace de travail peuvent être chargées plus tard à l’aide de la méthode from_config. La valeur par défaut de path est « .azureml/ » dans le répertoire de travail actif, et la valeur par défaut de file_name est « config.json ». La méthode fournit un moyen simple de réutiliser le même espace de travail sur plusieurs notebooks ou projets Python. Les utilisateurs peuvent enregistrer les propriétés ARM de l’espace de travail à l’aide de cette fonction, et utiliser from_config pour charger le même espace de travail dans différents notebooks ou projets Python sans avoir à retaper les propriétés ARM de l’espace de travail.

add_private_endpoint

Ajoute un point de terminaison privé à l’espace de travail.

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

Paramètres

Nom	Description
private_endpoint_config Obligatoire	PrivateEndPointConfig Configuration de point de terminaison privé pour créer un point de terminaison privé pour l’espace de travail.
private_endpoint_auto_approval	bool Indicateur booléen qui spécifie si la création du point de terminaison privé doit être approuvée automatiquement ou manuellement à partir du Centre Azure Private Link. En cas d’approbation manuelle, les utilisateurs peuvent voir la demande en attente dans le portail Private Link pour l’approuver ou la rejeter. valeur par défaut: True
location	string Emplacement du point de terminaison privé. Par défaut, il s’agit de l’emplacement de l’espace de travail valeur par défaut: None
show_output	bool Indicateur permettant d’afficher la progression de la création de l’espace de travail valeur par défaut: True
tags	dict Étiquettes à associer à l’espace de travail. valeur par défaut: None

Retours

Type	Description
PrivateEndPoint	Objet PrivateEndPoint créé.

create

Crée un espace de travail Azure Machine Learning.

Lève une exception si l’espace de travail existe déjà ou si l’une des conditions relatives à l’espace de travail n’est pas remplie.

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ètres

Nom	Description
name Obligatoire	str Nom du nouvel espace de travail. Le nom doit compter entre 2 et 32 caractères. Le premier caractère du nom doit être alphanumérique (lettre ou chiffre), mais le reste du nom peut contenir des caractères alphanumériques, des traits d’union et des traits de soulignement. Les espaces blancs ne sont pas autorisés.
auth	ServicePrincipalAuthentication ou InteractiveLoginAuthentication Objet d’authentification. Pour plus d’informations, consultez https://aka.ms/aml-notebook-auth. Si None est spécifié, les informations d’identification Azure CLI par défaut sont utilisées, ou l’API vous invite à entrer vos informations d’identification. valeur par défaut: None
subscription_id	str ID d’abonnement de l’abonnement conteneur du nouvel espace de travail. Le paramètre est obligatoire si l’utilisateur a accès à plusieurs abonnements. valeur par défaut: None
resource_group	str Groupe de ressources Azure qui contient l’espace de travail. La valeur par défaut du paramètre est une mutation du nom de l’espace de travail. valeur par défaut: None
location	str Emplacement de l’espace de travail. La valeur par défaut du paramètre correspond à l’emplacement du groupe de ressources. L’emplacement doit être une région prise en charge pour Azure Machine Learning. valeur par défaut: None
create_resource_group	bool Indique si le groupe de ressources doit être créé, s’il n’existe pas. valeur par défaut: True
sku	str Le paramètre est présent pour des raisons de compatibilité descendante et est ignoré. valeur par défaut: basic
tags	dict Étiquettes à associer à l’espace de travail. valeur par défaut: None
friendly_name	str Nom convivial facultatif de l’espace de travail pouvant s’afficher dans l’IU. valeur par défaut: None
storage_account	str Compte de stockage existant au format d’ID de ressource Azure. Le stockage est utilisé par l’espace de travail pour enregistrer les sorties d’exécution, le code, les journaux, etc. Si None est spécifié, un compte de stockage est créé. valeur par défaut: None
key_vault	str Coffre de clés existant au format d’ID de ressource Azure. Pour plus d’informations sur le format d’ID de ressource Azure, consultez l’exemple de code ci-dessous. Le coffre de clés est utilisé par l’espace de travail pour stocker les informations d’identification ajoutées à l’espace de travail par les utilisateurs. Si None est spécifié, un coffre de clés est créé. valeur par défaut: None
app_insights	str Ressource Application Insights existante au format d’ID de ressource Azure. Pour plus d’informations sur le format d’ID de ressource Azure, consultez l’exemple de code ci-dessous. La ressource Application Insights est utilisée par l’espace de travail pour journaliser les événements liés aux services web. Si None est spécifié, une ressource Application Insights est créée. valeur par défaut: None
container_registry	str Registre de conteneurs existant au format d’ID de ressource Azure (consultez l’exemple de code ci-dessous pour plus d’informations sur le format d’ID de ressource Azure). Le registre de conteneurs est utilisé par l’espace de travail pour tirer (pull) et envoyer (push) les images d’expérimentation et les images de services web. Si None est spécifié, un registre de conteneurs est créé uniquement quand cela est nécessaire. Il n’est pas créé en même temps que l’espace de travail. valeur par défaut: None
adb_workspace	str Espace de travail Adb existant au format d’ID de ressource Azure (consultez l’exemple de code ci-dessous pour plus d’informations sur le format d’ID de ressource Azure). L’espace de travail Adb est utilisé pour établir une liaison avec l’espace de travail. Si None est défini, la liaison de l’espace de travail n’est pas effectuée. valeur par défaut: None
primary_user_assigned_identity	str ID de ressource de l’identité affectée par l’utilisateur utilisé pour représenter l’espace de travail valeur par défaut: None
cmk_keyvault	str Coffre de clés contenant la clé gérée par le client au format d’ID de ressource Azure : /subscriptions/<azure-subscription-id>/resourcegroups/<azure-resource-group>/providers/microsoft.keyvault/vaults/<azure-keyvault-name> Par exemple : « /subscriptions/d139f240-94e6-4175-87a7-954b9d27db16/resourcegroups/myresourcegroup/providers/microsoft.keyvault/vaults/mykeyvault ». Pour plus d’informations sur le format de l’ID de ressource Azure, consultez l’exemple de code dans la section Remarques ci-dessous. valeur par défaut: None
resource_cmk_uri	str URI de clé de la clé gérée par le client pour chiffrer les données au repos. Le format d’URI est le suivant : https://<keyvault-dns-name>/keys/<key-name>/<key-version>. Par exemple, « https://mykeyvault.vault.azure.net/keys/mykey/bc5dce6d01df49w2na7ffb11a2ee008b ». Consultez https://docs.microsoft.com/azure-stack/user/azure-stack-key-vault-manage-portal pour savoir comment créer une clé et obtenir son URI. valeur par défaut: None
hbi_workspace	bool Spécifie si l’espace de travail contient des données HBI (High Business Impact), c’est-à-dire s’il contient des informations métier sensibles. Cet indicateur peut être défini uniquement durant la création de l’espace de travail. Sa valeur ne peut pas être changée une fois l’espace de travail créé. La valeur par défaut est False. Quand la valeur est True, des étapes de chiffrement supplémentaires sont effectuées. En fonction du composant du kit SDK, elles entraînent l’édition des informations dans la télémétrie collectée de manière interne. Pour plus d’informations, consultez Chiffrement des données. Lorsque cet indicateur est défini sur True, l’impact possible sur la résolution des problèmes est accru. Cela peut se produire parce que certaines données de télémétrie ne sont pas envoyées à Microsoft et qu’il y a moins de visibilité sur les taux de réussite ou les types de problèmes, et ne peut par conséquent pas être en mesure de réagir de manière proactive lorsque cet indicateur est True. Il est recommandé d’utiliser la valeur par défaut False pour cet indicateur, sauf si True est absolument nécessaire. valeur par défaut: False
default_cpu_compute_target	AmlComputeProvisioningConfiguration (DÉPRÉCIÉ) Configuration utilisée pour créer un calcul de processeur. La valeur par défaut du paramètre est {min_nodes=0, max_nodes=2, vm_size="STANDARD_DS2_V2", vm_priority="dedicated"} Si None est spécifié, aucun calcul n’est créé. valeur par défaut: None
default_gpu_compute_target	AmlComputeProvisioningConfiguration (DÉPRÉCIÉ) Configuration utilisée pour créer un calcul de GPU. La valeur par défaut du paramètre est {min_nodes=0, max_nodes=2, vm_size="STANDARD_NC6", vm_priority="dedicated"} Si None est spécifié, aucun calcul n’est créé. valeur par défaut: None
private_endpoint_config	PrivateEndPointConfig Configuration de point de terminaison privé permettant de créer un point de terminaison privé pour l’espace de travail Azure ML. valeur par défaut: None
private_endpoint_auto_approval	bool Indicateur booléen qui spécifie si la création du point de terminaison privé doit être approuvée automatiquement ou manuellement à partir du Centre Azure Private Link. En cas d’approbation manuelle, les utilisateurs peuvent voir la demande en attente dans le portail Private Link pour l’approuver ou la rejeter. valeur par défaut: True
exist_ok	bool Indique si cette méthode réussit, si l’espace de travail existe déjà. Si la valeur est False, cette méthode échoue si l’espace de travail existe. Si la valeur est True, cette méthode retourne l’espace de travail existant, le cas échéant. valeur par défaut: False
show_output	bool Indique si cette méthode affiche la progression incrémentielle. valeur par défaut: True
user_assigned_identity_for_cmk_encryption	str ID de ressource de l’identité affectée par l’utilisateur devant être utilisée pour accéder à la clé de gestion du client valeur par défaut: None
system_datastores_auth_mode	str Détermine si les informations d’identification doivent être utilisées ou non pour les magasins de données système de l’espace de travail « workspaceblobstore » et « workspacefilestore ». La valeur par défaut est « accessKey ». Dans ce cas, l’espace de travail crée les magasins de données système avec les informations d’identification. Si « identity » est défini, l’espace de travail crée les magasins de données système sans informations d’identification. valeur par défaut: accessKey
v1_legacy_mode	bool Empêcher l’utilisation du service API v2 sur des Resource Manager Azure publics valeur par défaut: None

Retours

Type	Description
Workspace	Objet d’espace de travail.

Exceptions

Type	Description
WorkspaceException	Exception levée en cas de problème durant la création de l’espace de travail.

Remarques

Ce premier exemple nécessite uniquement une spécification minimale. Toutes les ressources dépendantes ainsi que le groupe de ressources sont créés automatiquement.

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

L’exemple suivant montre comment réutiliser des ressources Azure existantes à l’aide du format d’ID de ressource Azure. Les ID de ressources Azure spécifiques peuvent être récupérés via le portail Azure ou le kit SDK. Cela suppose que le groupe de ressources, le compte de stockage, le coffre de clés, App Insights et le registre de conteneurs existent déjà.

   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

Supprime les ressources associées à l’espace de travail Azure Machine Learning.

delete(delete_dependent_resources=False, no_wait=False)

Paramètres

Nom	Description
delete_dependent_resources	bool Indique s’il est nécessaire de supprimer les ressources associées à l’espace de travail, c’est-à-dire le registre de conteneurs, le compte de stockage, le coffre de clés et les ressources Application Insights. La valeur par défaut est False. Affectez la valeur True pour supprimer ces ressources. valeur par défaut: False
no_wait	bool Indique s’il est nécessaire d’attendre ou non la fin de la suppression de l’espace de travail. valeur par défaut: False

Retours

Type	Description
None	Aucune valeur en cas de réussite. Sinon, une erreur est générée.

delete_connection

Supprime une connexion de l’espace de travail.

delete_connection(name)

Paramètres

Nom	Description
name Obligatoire	str Nom unique de la connexion dans l’espace de travail

delete_private_endpoint_connection

Supprime la connexion de point de terminaison privé à l’espace de travail.

delete_private_endpoint_connection(private_endpoint_connection_name)

Paramètres

Nom	Description
private_endpoint_connection_name Obligatoire	str Nom unique de la connexion de point de terminaison privé dans l’espace de travail

diagnose_workspace

Diagnostique les problèmes d’installation de l’espace de travail.

diagnose_workspace(diagnose_parameters)

Paramètres

Nom	Description
diagnose_parameters Obligatoire	<xref:_restclient.models.DiagnoseWorkspaceParameters> Paramètre de diagnostic de l’intégrité de l’espace de travail

Retours

Type	Description
<xref:msrestazure.azure_operation.AzureOperationPoller>[<xref:_restclient.models.DiagnoseResponseResult>]	Instance d’AzureOperationPoller qui retourne DiagnoseResponseResult

from_config

Retourne un objet d’espace de travail à partir d’un espace de travail Azure Machine Learning existant.

Lit la configuration de l’espace de travail à partir d’un fichier. Lève une exception si le fichier config est introuvable.

La méthode fournit un moyen simple de réutiliser le même espace de travail sur plusieurs notebooks ou projets Python. Les utilisateurs peuvent enregistrer les propriétés ARM (Azure Resource Manager) de l’espace de travail à l’aide de la méthode write_config, et utiliser cette méthode pour charger le même espace de travail dans différents notebooks ou projets Python sans avoir à retaper les propriétés ARM de l’espace de travail.

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

Paramètres

Nom	Description
path	str Chemin d’accès au fichier config ou répertoire de démarrage dans lequel effectuer une recherche. La valeur par défaut du paramètre indique que la recherche doit démarrer dans le répertoire actif. valeur par défaut: None
auth	ServicePrincipalAuthentication ou InteractiveLoginAuthentication Objet d’authentification. Pour plus d’informations, consultez https://aka.ms/aml-notebook-auth. Si None est spécifié, les informations d’identification Azure CLI par défaut sont utilisées, ou l’API vous invite à entrer vos informations d’identification. valeur par défaut: None
_logger	Logger Permet de remplacer le journaliseur par défaut. valeur par défaut: None
_file_name	str Permet de remplacer le nom du fichier config à rechercher quand le chemin est un chemin de répertoire. valeur par défaut: None

Retours

Type	Description
Workspace	Objet d’espace de travail d’un espace de travail Azure ML existant.

get

Retourne un objet d’espace de travail pour un espace de travail Azure Machine Learning existant.

Lève une exception si l’espace de travail n’existe pas, ou si les champs obligatoires n’identifient pas de manière unique un espace de travail.

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

Paramètres

Nom	Description
name Obligatoire	str Nom de l’espace de travail à obtenir.
auth	ServicePrincipalAuthentication ou InteractiveLoginAuthentication Objet d’authentification. Pour plus d’informations, consultez https://aka.ms/aml-notebook-auth. Si None est spécifié, les informations d’identification Azure CLI par défaut sont utilisées, ou l’API vous invite à entrer vos informations d’identification. valeur par défaut: None
subscription_id	str ID d’abonnement à utiliser. Le paramètre est obligatoire si l’utilisateur a accès à plusieurs abonnements. valeur par défaut: None
resource_group	str Groupe de ressources à utiliser. Si None est défini, la méthode recherche dans tous les groupes de ressources dans l’abonnement. valeur par défaut: None
location	str Emplacement de l’espace de travail. valeur par défaut: None
cloud	str Nom du cloud cible. Il peut s’agir de « AzureCloud », « AzureChinaCloud » ou « AzureUSGovernment ». Si aucun cloud n’est spécifié, « AzureCloud » est utilisé. valeur par défaut: AzureCloud
id	str ID de l’espace de travail. valeur par défaut: None

Retours

Type	Description
Workspace	Objet d’espace de travail.

get_connection

Obtient une connexion à l’espace de travail.

get_connection(name)

Paramètres

Nom	Description
name Obligatoire	str Nom unique de la connexion dans l’espace de travail

get_default_compute_target

Obtient la cible de calcul par défaut de l’espace de travail.

get_default_compute_target(type)

Paramètres

Nom	Description
type Obligatoire	str Type de calcul. Les valeurs possibles sont CPU ou GPU.

Retours

Type	Description
ComputeTarget	Cible de calcul par défaut pour un type de calcul donné.

get_default_datastore

Obtient le magasin de données par défaut de l’espace de travail.

get_default_datastore()

Retours

Type	Description
Datastore	Magasin de données par défaut.

get_default_keyvault

Obtient l’objet de coffre de clés par défaut de l’espace de travail.

get_default_keyvault()

Retours

Type	Description
Keyvault	Objet KeyVault associé à l’espace de travail.

get_details

Retourne les détails de l’espace de travail.

get_details()

Retours

Type	Description
dict[str, str]	Détails de l’espace de travail au format dictionnaire.

Remarques

Le dictionnaire retourné contient les paires clé-valeur suivantes.

• id : URI pointant vers cette ressource d’espace de travail, contenant l’ID d’abonnement, le groupe de ressources et le nom de l’espace de travail.

• name : nom de cet espace de travail.

• location : région de l’espace de travail.

• type : URI au format « {providerName}/workspaces ».

• tags : non utilisé pour le moment.

• workspaceid : ID de cet espace de travail.

• description : non utilisé pour le moment.

• friendlyName : nom convivial de l’espace de travail affiché dans l’IU.

• creationTime : heure de création de cet espace de travail, au format ISO8601.

• containerRegistry : registre de conteneurs d’espace de travail utilisé pour tirer (pull) et envoyer (push) les images d’expérimentation et les images de services web.

• keyVault : coffre de clés d’espace de travail utilisé pour stocker les informations d’identification ajoutées à l’espace de travail par les utilisateurs.

• applicationInsights : ressource Application Insights utilisée par l’espace de travail pour journaliser les événements liés aux services web.

• identityPrincipalId :

• identityTenantId

• identityType

• storageAccount : le stockage est utilisé par l’espace de travail pour enregistrer les sorties d’exécution, le code, les journaux, etc.

• sku : référence SKU de l’espace de travail (également appelée édition). Le paramètre est présent pour des raisons de compatibilité descendante et est ignoré.

• resourceCmkUri : URI de clé de la clé gérée par le client pour chiffrer les données au repos. Consultez https://docs.microsoft.com/en-us/azure-stack/user/azure-stack-key-vault-manage-portal?view=azs-1910 pour savoir comment créer une clé et obtenir son URI.

• hbiWorkspace : spécifie si les données client ont un impact métier important.

• imageBuildCompute : cible de calcul pour la génération d’image.

• systemDatastoresAuthMode : détermine si les informations d’identification doivent être utilisées ou non pour les magasins de données système de l’espace de travail « workspaceblobstore » et « workspacefilestore ». La valeur par défaut est « accessKey ». Dans ce cas, l’espace de travail crée les magasins de données système avec les informations d’identification. Si « identity » est défini, l’espace de travail crée les magasins de données système sans informations d’identification.

Pour plus d’informations sur ces paires clé-valeur, consultez create.

get_mlflow_tracking_uri

Obtient l’URI de suivi MLflow de l’espace de travail.

MLflow (https://mlflow.org/) est une plateforme open source pour le suivi des expériences de machine learning et la gestion des modèles. Vous pouvez utiliser les API de journalisation MLflow avec Azure Machine Learning pour que les métriques, les modèles et les artefacts soient journalisés dans votre espace de travail Azure Machine Learning.

get_mlflow_tracking_uri(_with_auth=False)

Paramètres

Nom	Description
_with_auth	bool (DÉPRÉCIÉ) Ajoute des informations d’authentification à l’URI de suivi. valeur par défaut: False

Retours

Type	Description
str	URI de suivi compatible avec MLflow.

Remarques

Utilisez l’exemple suivant pour configurer le suivi MLflow afin d’envoyer des données à l’espace de travail Azure ML :

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

get_run

Retourne l’exécution ayant le run_id spécifié dans l’espace de travail.

get_run(run_id)

Paramètres

Nom	Description
run_id Obligatoire	string ID d’exécution.

Retours

Type	Description
Run	Exécution soumise.

list

Liste tous les espaces de travail auxquels l’utilisateur a accès dans l’abonnement.

La liste des espaces de travail peut être filtrée en fonction du groupe de ressources.

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

Paramètres

Nom	Description
subscription_id Obligatoire	str ID d’abonnement dont les espaces de travail sont à lister.
auth	ServicePrincipalAuthentication ou InteractiveLoginAuthentication Objet d’authentification. Pour plus d’informations, consultez https://aka.ms/aml-notebook-auth. Si None est spécifié, les informations d’identification Azure CLI par défaut sont utilisées, ou l’API vous invite à entrer vos informations d’identification. valeur par défaut: None
resource_group	str Groupe de ressources permettant de filtrer les espaces de travail retournés. Si None est spécifié, la méthode liste tous les espaces de travail de l’abonnement spécifié. valeur par défaut: None

Retours

Type	Description
dict	Dictionnaire où la clé représente le nom de l’espace de travail et la valeur une liste d’objets Workspace.

list_connections

Liste les connexions de cet espace de travail.

list_connections(category=None, target=None)

Paramètres

Nom	Description
type Obligatoire	str Type de cette connexion à filtrer
target	str cible de cette connexion à filtrer valeur par défaut: None
category	valeur par défaut: None

list_keys

Liste les clés de l’espace de travail actif.

list_keys()

Retours

Type	Description
object

set_connection

Ajoute ou met à jour une connexion dans l’espace de travail.

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

Paramètres

Nom	Description
name Obligatoire	str Nom unique de la connexion dans l’espace de travail
category Obligatoire	str Catégorie de cette connexion
target Obligatoire	str cible à laquelle cette connexion se connecte
authType Obligatoire	str type d’autorisation de cette connexion
value Obligatoire	str chaîne de sérialisation au format JSON des détails de connexion

set_default_datastore

Définit le magasin de données par défaut de l’espace de travail.

set_default_datastore(name)

Paramètres

Nom	Description
name Obligatoire	str Nom du Datastore à définir par défaut.

setup

Crée un espace de travail ou utilise un espace de travail existant.

static setup()

Retours

Type	Description
Workspace	Objet Workspace.

sync_keys

Déclenche l’espace de travail pour synchroniser immédiatement les clés.

Si les clés d’une ressource de l’espace de travail sont modifiées, l’opération de mise à jour automatique de celles-ci peut prendre environ une heure. Cette fonction permet de mettre à jour les clés à la demande. Un exemple de scénario nécessite un accès immédiat au stockage après la régénération des clés de stockage.

sync_keys(no_wait=False)

Paramètres

Nom	Description
no_wait	bool Indique s’il faut patienter jusqu’à ce que l’opération des clés de synchronisation de l’espace de travail soit effectuée. valeur par défaut: False

Retours

Type	Description
None	None en cas de réussite. Dans le cas contraire, une erreur est levée.

update

Met à jour le nom convivial, la description, les étiquettes, le calcul de génération d’image et d’autres paramètres associés à un espace de travail.

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ètres

Nom	Description
friendly_name	str Nom convivial de l’espace de travail pouvant s’afficher dans l’interface utilisateur. valeur par défaut: None
description	str Description de l’espace de travail. valeur par défaut: None
tags	dict Étiquettes à associer à l’espace de travail. valeur par défaut: None
image_build_compute	str Nom de calcul pour la génération d’image. valeur par défaut: None
service_managed_resources_settings	<xref:azureml._base_sdk_common.workspace.models.ServiceManagedResourcesSettings> Paramètres des ressources managées par le service. valeur par défaut: None
primary_user_assigned_identity	str ID de ressource d’identité affectée par l’utilisateur qui représente l’identité de l’espace de travail. valeur par défaut: None
allow_public_access_when_behind_vnet	bool Autorise l’accès public à l’espace de travail de liaison privée. valeur par défaut: None
v1_legacy_mode	bool Empêcher l’utilisation du service d’API v2 sur des Resource Manager Azure publics valeur par défaut: None

Retours

Type	Description
dict[str, str]	Dictionnaire des informations mises à jour.

update_dependencies

Met à jour les ressources associées à l’espace de travail dans les cas suivants.

a) Quand un utilisateur supprime accidentellement une ressource associée existante et souhaite la mettre à jour avec une nouvelle ressource sans devoir recréer l’espace de travail entier. b) Quand un utilisateur dispose d’une ressource associée existante et souhaite remplacer la ressource associée qui est actuellement associée à l’espace de travail. c) Quand une ressource associée n’a pas encore été créée et que l’utilisateur souhaite utiliser une ressource déjà existante (s’applique uniquement au registre de conteneurs).

update_dependencies(container_registry=None, force=False)

Paramètres

Nom	Description
container_registry	str ID ARM pour le registre de conteneurs. valeur par défaut: None
force	bool Définit si la mise à jour des ressources dépendantes doit être forcée sans invite de confirmation. valeur par défaut: False

Retours

Type	Description
Workspace

write_config

Écrit les propriétés de l’espace de travail ARM (Azure Resource Manager) dans un fichier config.

Les propriétés ARM de l’espace de travail peuvent être chargées plus tard à l’aide de la méthode from_config. La valeur par défaut de path est « .azureml/ » dans le répertoire de travail actif, et la valeur par défaut de file_name est « config.json ».

La méthode fournit un moyen simple de réutiliser le même espace de travail sur plusieurs notebooks ou projets Python. Les utilisateurs peuvent enregistrer les propriétés ARM de l’espace de travail à l’aide de cette fonction, et utiliser from_config pour charger le même espace de travail dans différents notebooks ou projets Python sans avoir à retaper les propriétés ARM de l’espace de travail.

write_config(path=None, file_name=None)

Paramètres

Nom	Description
path	str Emplacement fourni par l’utilisateur pour écrire le fichier config.json. La valeur par défaut du paramètre est « .azureml/ » dans le répertoire de travail actif. valeur par défaut: None
file_name	str Nom à utiliser pour le fichier config. La valeur par défaut du paramètre est config.json. valeur par défaut: None

Attributs

compute_targets

Liste toutes les cibles de calcul de l’espace de travail.

Retours

Type	Description
dict[str, ComputeTarget]	Dictionnaire avec une clé en tant que nom de cible de calcul et une valeur en tant qu’objet ComputeTarget.

datasets

Liste tous les jeux de données de l’espace de travail.

Retours

Type	Description
dict[str, Dataset]	Dictionnaire avec une clé en tant que nom de jeu de données et une valeur en tant qu’objet Dataset.

datastores

Liste tous les magasins de données de l’espace de travail. Cette opération ne retourne pas les informations d’identification des magasins de données.

Retours

Type	Description
dict[str, Datastore]	Dictionnaire avec une clé en tant que nom de magasin de données et une valeur en tant qu’objet Datastore.

discovery_url

Retourne l’URL de découverte de cet espace de travail.

Retours

Type	Description
str	URL de découverte de cet espace de travail.

environments

Liste tous les environnements de l’espace de travail.

Retours

Type	Description
dict[str, Environment]	Dictionnaire avec une clé en tant que nom d’environnement et une valeur en tant qu’objet Environment.

experiments

Liste toutes les expériences de l’espace de travail.

Retours

Type	Description
dict[str, Experiment]	Dictionnaire avec une clé en tant que nom d’expérience et une valeur en tant qu’objet Experiment.

images

Retourne la liste des images présentes dans l’espace de travail.

Lève une exception WebserviceException si un problème est survenu lors de l’interaction avec le service de gestion des modèles.

Retours

Type	Description
dict[str, Image]	Dictionnaire avec une clé en tant que nom d’image et une valeur en tant qu’objet Image.

Exceptions

Type	Description
WebserviceException	Un problème s’est produit durant l’interaction avec le service Gestion des modèles.

linked_services

Répertorie tous les services liés dans l’espace de travail.

Retours

Type	Description
dict[str, LinkedService]	Dictionnaire dans lequel la clé est un nom de service lié et la valeur est un objet LinkedService.

location

Retourne l’emplacement de cet espace de travail.

Retours

Type	Description
str	Emplacement de cet espace de travail.

models

Retourne une liste de modèles présents dans l’espace de travail.

Lève WebserviceException en cas de problème durant l’interaction avec le service Gestion des modèles.

Retours

Type	Description
dict[str, Model]	Dictionnaire de modèles avec une clé en tant que nom de modèle et une valeur en tant qu’objet Model.

Exceptions

Type	Description
WebserviceException	Un problème s’est produit durant l’interaction avec le service Gestion des modèles.

name

Retourne le nom de l’espace de travail.

Retours

Type	Description
str	Nom de l’espace de travail.

private_endpoints

Liste tous les points de terminaison privés de l’espace de travail.

Retours

Type	Description
dict[str, PrivateEndPoint]	Dictionnaire d’objets PrivateEndPoint associés à l’espace de travail. La clé représente le nom du point de terminaison privé.

resource_group

Retourne le nom du groupe de ressources de cet espace de travail.

Retours

Type	Description
str	Nom du groupe de ressources.

service_context

Retourne le contexte de service de cet espace de travail.

Retours

Type	Description
<xref:azureml._restclient.service_context.ServiceContext>	Retourne l’objet ServiceContext.

sku

Retourne la référence SKU de cet espace de travail.

Retours

Type	Description
str	Référence SKU de cet espace de travail.

subscription_id

Retourne l’ID d’abonnement de cet espace de travail.

Retours

Type	Description
str	L'ID de l'abonnement.

tags

Retourne les étiquettes de cet espace de travail.

Retours

Type	Description
dict	Étiquettes de cet espace de travail.

webservices

Retourne une liste des services web présents dans l’espace de travail.

Lève WebserviceException en cas de problème durant le retour de la liste.

Retours

Type	Description
dict[str, Webservice]	Liste des services web de l’espace de travail.

Exceptions

Type	Description
WebserviceException	Un problème s’est produit durant le retour de la liste.

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'