Workspace Classe
Définit une ressource Azure Machine Learning pour la gestion des artefacts d’apprentissage 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 et possède une référence SKU associée.
Pour plus d’informations sur les espaces de travail, consultez :
Constructeur d’espace de travail de classe pour charger un espace de travail Azure Machine Learning existant.
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
|
ID d’abonnement Azure contenant l’espace de travail. |
resource_group
Obligatoire
|
Groupe de ressources contenant l’espace de travail. |
workspace_name
Obligatoire
|
Nom de l’espace de travail existant. |
auth
|
Objet d’authentification. Pour plus d’informations, consultez https://aka.ms/aml-notebook-auth. Si aucune, les informations d’identification Azure CLI par défaut sont utilisées ou l’API demande des informations d’identification. Valeur par défaut: None
|
_location
|
Utilisation interne uniquement. Valeur par défaut: None
|
_disable_service_check
|
Utilisation interne uniquement. Valeur par défaut: False
|
_workspace_id
|
Utilisation interne uniquement. Valeur par défaut: None
|
sku
|
Le paramètre est présent pour la compatibilité descendante et est ignoré. Valeur par défaut: basic
|
_cloud
|
Utilisation interne uniquement. Valeur par défaut: AzureCloud
|
subscription_id
Obligatoire
|
ID d’abonnement Azure contenant l’espace de travail. |
resource_group
Obligatoire
|
Groupe de ressources contenant l’espace de travail. |
workspace_name
Obligatoire
|
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 nombre), mais le reste du nom peut contenir des caractères alphanumériques, des traits d’union et des traits de soulignement. L’espace blanc n’est pas autorisé. |
auth
Obligatoire
|
Objet d’authentification. Pour plus d’informations, consultez https://aka.ms/aml-notebook-auth. Si aucune, les informations d’identification Azure CLI par défaut sont utilisées ou l’API demande des informations d’identification. |
_location
Obligatoire
|
Utilisation interne uniquement. |
_disable_service_check
Obligatoire
|
Utilisation interne uniquement. |
_workspace_id
Obligatoire
|
Utilisation interne uniquement. |
sku
Obligatoire
|
Le paramètre est présent pour la compatibilité descendante et est ignoré. |
tags
|
Balises à associer à l’espace de travail. Valeur par défaut: None
|
_cloud
Obligatoire
|
Utilisation 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 de configuration JSON. Le fichier de configuration enregistre votre abonnement, votre ressource et le nom de l’espace de travail afin qu’il puisse être facilement chargé. Pour enregistrer la configuration, utilisez la write_config méthode.
ws.write_config(path="./file-path", file_name="ws_config.json")
Consultez Créer un fichier de configuration d’espace de travail pour obtenir un exemple de fichier de configuration.
Pour charger l’espace de travail à partir du fichier de configuration, utilisez la from_config méthode.
ws = Workspace.from_config()
ws.get_details()
Vous pouvez également utiliser la get méthode pour charger un espace de travail existant sans utiliser de fichiers de configuration.
ws = Workspace.get(name="myworkspace",
subscription_id='<azure-subscription-id>',
resource_group='myresourcegroup')
Les exemples ci-dessus peuvent vous inviter à entrer des informations d’identification d’authentification 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 authentifier et l’authentification dans des flux de travail automatisés, consultez Authentification dans Azure Machine Learning.
Méthodes
add_private_endpoint |
Ajoutez un point de terminaison privé à l’espace de travail. |
create |
Créez un espace de travail Azure Machine Learning. Lève une exception si l’espace de travail existe déjà ou si l’une des exigences de l’espace de travail n’est pas satisfaite. |
delete |
Supprimez les ressources associées à l’espace de travail Azure Machine Learning. |
delete_connection |
Supprimez une connexion de l’espace de travail. |
delete_private_endpoint_connection |
Supprimez la connexion de point de terminaison privé à l’espace de travail. |
diagnose_workspace |
Diagnostiquer les problèmes de configuration 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 offre 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 Azure Resource Manager (ARM) de l’espace de travail à l’aide de la write_config méthode et utiliser cette méthode pour charger le même espace de travail dans différents notebooks ou projets Python sans taper de nouveau 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 |
Obtenez une connexion de l’espace de travail. |
get_default_compute_target |
Obtenez la cible de calcul par défaut pour l’espace de travail. |
get_default_datastore |
Obtenez le magasin de données par défaut pour l’espace de travail. |
get_default_keyvault |
Obtenez l’objet de coffre de clés par défaut pour l’espace de travail. |
get_details |
Retournez les détails de l’espace de travail. |
get_mlflow_tracking_uri |
Obtenez l’URI de suivi MLflow pour l’espace de travail. MLflow (https://mlflow.org/) est une plateforme open source pour le suivi des expériences machine learning et la gestion des modèles. Vous pouvez utiliser les API de journalisation MLflow avec Azure Machine Learning afin que les métriques, les modèles et les artefacts soient enregistrés dans votre espace de travail Azure Machine Learning. |
get_run |
Retournez l’exécution avec le run_id spécifié dans l’espace de travail. |
list |
Répertoriez 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 |
Répertorier les connexions sous cet espace de travail. |
list_keys |
Répertorier les clés de l’espace de travail actuel. |
set_connection |
Ajoutez ou mettez à jour une connexion sous l’espace de travail. |
set_default_datastore |
Définissez le magasin de données par défaut pour l’espace de travail. |
setup |
Créez un espace de travail ou récupérez un espace de travail existant. |
sync_keys |
Déclenche l’espace de travail pour synchroniser immédiatement les clés. Si des clés pour une ressource de l’espace de travail sont modifiées, la mise à jour automatique 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 |
Mettez à jour le nom convivial, la description, les balises, le calcul de génération d’image et d’autres paramètres associés à un espace de travail. |
update_dependencies |
Mettez à jour les ressources associées existantes pour l’espace de travail dans les cas suivants. a) Lorsqu’un utilisateur supprime accidentellement une ressource associée existante et souhaite la mettre à jour avec une nouvelle ressource sans avoir à recréer l’ensemble de l’espace de travail. b) Lorsqu’un utilisateur a une ressource associée existante et souhaite remplacer celle actuelle associée à l’espace de travail. c) Lorsqu’une ressource associée n’a pas encore été créée et qu’elle souhaite utiliser une ressource existante dont elle dispose déjà (s’applique uniquement au registre de conteneurs). |
write_config |
Écrivez les propriétés Azure Resource Manager (ARM) de l’espace de travail dans un fichier de configuration. Les propriétés ARM de l’espace de travail peuvent être chargées ultérieurement à l’aide de la from_config méthode. La La méthode offre 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 retaper les propriétés ARM de l’espace de travail. |
add_private_endpoint
Ajoutez 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
|
Configuration du point de terminaison privé pour créer un point de terminaison privé dans l’espace de travail. |
private_endpoint_auto_approval
|
Indicateur booléen qui indique si la création du point de terminaison privé doit être approuvée automatiquement ou approuvée manuellement à partir d’Azure Private Link Center. En cas d’approbation manuelle, les utilisateurs peuvent afficher la demande en attente dans le portail Private Link pour approuver/rejeter la demande. Valeur par défaut: True
|
location
|
Emplacement du point de terminaison privé, la valeur par défaut est l’emplacement de l’espace de travail Valeur par défaut: None
|
show_output
|
Indicateur pour afficher la progression de la création de l’espace de travail Valeur par défaut: True
|
tags
|
Balises à associer à l’espace de travail. Valeur par défaut: None
|
Retours
Type | Description |
---|---|
Objet PrivateEndPoint créé. |
create
Créez un espace de travail Azure Machine Learning.
Lève une exception si l’espace de travail existe déjà ou si l’une des exigences de l’espace de travail n’est pas satisfaite.
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
|
Nouveau 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 nombre), mais le reste du nom peut contenir des caractères alphanumériques, des traits d’union et des traits de soulignement. L’espace blanc n’est pas autorisé. |
auth
|
Objet d’authentification. Pour plus d’informations, consultez https://aka.ms/aml-notebook-auth. Si aucune, les informations d’identification Azure CLI par défaut sont utilisées ou l’API demande des informations d’identification. Valeur par défaut: None
|
subscription_id
|
ID d’abonnement de l’abonnement contenant pour le nouvel espace de travail. Le paramètre est requis si l’utilisateur a accès à plusieurs abonnements. Valeur par défaut: None
|
resource_group
|
Groupe de ressources Azure qui contient l’espace de travail. Le paramètre est défini par défaut sur une mutation du nom de l’espace de travail. Valeur par défaut: None
|
location
|
Emplacement de l’espace de travail. Le paramètre est défini par défaut sur 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
|
Indique s’il faut créer le groupe de ressources s’il n’existe pas. Valeur par défaut: True
|
sku
|
Le paramètre est présent pour la compatibilité descendante et est ignoré. Valeur par défaut: basic
|
tags
|
Balises à associer à l’espace de travail. Valeur par défaut: None
|
friendly_name
|
Nom convivial facultatif de l’espace de travail qui peut être affiché dans l’interface utilisateur. Valeur par défaut: None
|
storage_account
|
Un compte de stockage existant au format ID de ressource Azure. Le stockage sera utilisé par l’espace de travail pour enregistrer les sorties d’exécution, le code, les journaux, etc. Si aucun n’est fait, un nouveau compte de stockage est créé. Valeur par défaut: None
|
key_vault
|
Coffre de clés existant au format ID de ressource Azure. Consultez l’exemple de code ci-dessous pour plus d’informations sur le format d’ID de ressource Azure. Le coffre de clés sera utilisé par l’espace de travail pour stocker les informations d’identification ajoutées à l’espace de travail par les utilisateurs. Si aucun n’est fait, un nouveau coffre de clés est créé. Valeur par défaut: None
|
app_insights
|
Application Insights 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. Application Insights sera utilisé par l’espace de travail pour journaliser les événements de webservices. Si aucun n’est fait, une nouvelle Application Insights est créée. Valeur par défaut: None
|
container_registry
|
Registre de conteneurs existant au format ID de ressource Azure (voir l’exemple de code ci-dessous pour plus d’informations sur le format d’ID de ressource Azure). Le registre de conteneurs sera utilisé par l’espace de travail pour extraire et envoyer (push) des images d’expérimentation et de webservices. Si aucun n’est fait, un nouveau registre de conteneurs est créé uniquement si nécessaire et non pas avec la création de l’espace de travail. Valeur par défaut: None
|
adb_workspace
|
Un espace de travail Adb existant au format ID de ressource Azure (voir l’exemple de code ci-dessous pour plus d’informations sur le format ID de ressource Azure). L’espace de travail Adb sera utilisé pour établir un lien avec l’espace de travail. Si aucun n’est fait, le lien de l’espace de travail ne se produit pas. Valeur par défaut: None
|
primary_user_assigned_identity
|
ID de ressource de l’identité affectée par l’utilisateur utilisée pour représenter l’espace de travail Valeur par défaut: None
|
cmk_keyvault
|
Coffre de clés contenant la clé gérée par le client au format d’ID de ressource Azure :
Valeur par défaut: None
|
resource_cmk_uri
|
URI de clé de la clé gérée par le client pour chiffrer les données au repos.
Le format d’URI est : Valeur par défaut: None
|
hbi_workspace
|
Spécifie si l’espace de travail contient des données de HBI (High Business Impact), c’est-à-dire qu’il contient des informations métier sensibles. Cet indicateur ne peut être défini que lors de la création de l’espace de travail. Sa valeur ne peut pas être modifiée une fois l’espace de travail créé. La valeur par défaut est False. Lorsque la valeur est True, d’autres étapes de chiffrement sont effectuées et, en fonction du composant du Kit de développement logiciel (SDK), les informations modifiées sont mises en œuvre dans les données de télémétrie collectées en interne. Pour plus d’informations, consultez Chiffrement des données. Lorsque cet indicateur a la valeur True, un impact possible est plus difficile à résoudre les problèmes. 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 peut donc ne pas être en mesure de réagir de manière proactive lorsque cet indicateur a la valeur True. La recommandation utilise la valeur par défaut False pour cet indicateur, sauf si strictement nécessaire pour être True. Valeur par défaut: False
|
default_cpu_compute_target
|
(DÉCONSEILLÉ) Configuration qui sera utilisée pour créer un calcul processeur. Le paramètre est défini par défaut sur {min_nodes=0, max_nodes=2, vm_size="STANDARD_DS2_V2 », vm_priority="dedicated"} Si aucun calcul n’est créé. Valeur par défaut: None
|
default_gpu_compute_target
|
(DÉCONSEILLÉ) Configuration qui sera utilisée pour créer un calcul GPU. Le paramètre est défini par défaut sur {min_nodes=0, max_nodes=2, vm_size="STANDARD_NC6 », vm_priority="dedicated"} Si aucun calcul n’est créé. Valeur par défaut: None
|
private_endpoint_config
|
Configuration du point de terminaison privé pour créer un point de terminaison privé dans l’espace de travail Azure ML. Valeur par défaut: None
|
private_endpoint_auto_approval
|
Indicateur booléen qui indique si la création du point de terminaison privé doit être approuvée automatiquement ou approuvée manuellement à partir d’Azure Private Link Center. En cas d’approbation manuelle, les utilisateurs peuvent afficher la demande en attente dans le portail Private Link pour approuver/rejeter la demande. Valeur par défaut: True
|
exist_ok
|
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 s’il existe. Valeur par défaut: False
|
show_output
|
Indique si cette méthode affiche la progression incrémentielle. Valeur par défaut: True
|
user_assigned_identity_for_cmk_encryption
|
ID de ressource de l’identité affectée par l’utilisateur qui doit être utilisé pour accéder à la clé de gestion du client Valeur par défaut: None
|
system_datastores_auth_mode
|
Détermine s’il faut ou non utiliser des informations d’identification pour les magasins de données système de l’espace de travail « workspaceblobstore » et « workspacefilestore ». La valeur par défaut est « accessKey », auquel cas l’espace de travail crée les magasins de données système avec des informations d’identification. Si la valeur est « identity », 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
|
Empêcher l’utilisation du service d’API v2 sur Azure Resource Manager public Valeur par défaut: None
|
Retours
Type | Description |
---|---|
Objet d’espace de travail. |
Exceptions
Type | Description |
---|---|
Déclenché pour les problèmes de création de l’espace de travail. |
Remarques
Ce premier exemple nécessite uniquement une spécification minimale, et toutes les ressources dépendantes ainsi que le groupe de ressources seront 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 les 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 de développement logiciel (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
Supprimez 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
|
Indique s’il faut supprimer des ressources associées à l’espace de travail, c’est-à-dire le registre de conteneurs, le compte de stockage, le coffre de clés et application Insights. La valeur par défaut est False. Définissez la valeur True pour supprimer ces ressources. Valeur par défaut: False
|
no_wait
|
Indique s’il faut attendre la fin de la suppression de l’espace de travail. Valeur par défaut: False
|
Retours
Type | Description |
---|---|
Aucun en cas de réussite ; sinon, lève une erreur. |
delete_connection
Supprimez une connexion de l’espace de travail.
delete_connection(name)
Paramètres
Nom | Description |
---|---|
name
Obligatoire
|
Nom unique de la connexion sous l’espace de travail |
delete_private_endpoint_connection
Supprimez 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
|
Nom unique de la connexion de point de terminaison privé sous l’espace de travail |
diagnose_workspace
Diagnostiquer les problèmes de configuration 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 offre 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 Azure Resource Manager (ARM) de l’espace de travail à l’aide de la write_config méthode et utiliser cette méthode pour charger le même espace de travail dans différents notebooks ou projets Python sans taper de nouveau 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
|
Chemin d’accès au fichier config ou répertoire de démarrage à rechercher. Le paramètre par défaut démarre la recherche dans le répertoire actif. Valeur par défaut: None
|
auth
|
Objet d’authentification. Pour plus d’informations, consultez https://aka.ms/aml-notebook-auth. Si aucune, les informations d’identification Azure CLI par défaut sont utilisées ou l’API demande des informations d’identification. Valeur par défaut: None
|
_logger
|
Autorise la substitution de l’enregistreur d’événements par défaut. Valeur par défaut: None
|
_file_name
|
Permet de remplacer le nom du fichier de configuration pour rechercher quand le chemin d’accès est un chemin d’accès au répertoire. Valeur par défaut: None
|
Retours
Type | Description |
---|---|
Objet d’espace de travail pour 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
|
Nom de l’espace de travail à obtenir. |
auth
|
Objet d’authentification. Pour plus d’informations, reportez-vous à https://aka.ms/aml-notebook-auth. Si aucune, les informations d’identification Azure CLI par défaut sont utilisées ou l’API demande des informations d’identification. Valeur par défaut: None
|
subscription_id
|
ID d’abonnement à utiliser. Le paramètre est requis si l’utilisateur a accès à plusieurs abonnements. Valeur par défaut: None
|
resource_group
|
Groupe de ressources à utiliser. Si aucune, la méthode recherche tous les groupes de ressources dans l’abonnement. Valeur par défaut: None
|
location
|
Emplacement de l’espace de travail. Valeur par défaut: None
|
cloud
|
Nom du cloud cible. Peut être l’un des « AzureCloud », « AzureChinaCloud » ou « AzureUSGovernment ». Si aucun cloud n’est spécifié , « AzureCloud » est utilisé. Valeur par défaut: AzureCloud
|
id
|
ID de l’espace de travail. Valeur par défaut: None
|
Retours
Type | Description |
---|---|
Objet d’espace de travail. |
get_connection
Obtenez une connexion de l’espace de travail.
get_connection(name)
Paramètres
Nom | Description |
---|---|
name
Obligatoire
|
Nom unique de la connexion sous l’espace de travail |
get_default_compute_target
Obtenez la cible de calcul par défaut pour l’espace de travail.
get_default_compute_target(type)
Paramètres
Nom | Description |
---|---|
type
Obligatoire
|
Type de calcul. Les valeurs possibles sont « CPU » ou « GPU ». |
Retours
Type | Description |
---|---|
Cible de calcul par défaut pour un type de calcul donné. |
get_default_datastore
Obtenez le magasin de données par défaut pour l’espace de travail.
get_default_datastore()
Retours
Type | Description |
---|---|
Magasin de données par défaut. |
get_default_keyvault
Obtenez l’objet de coffre de clés par défaut pour l’espace de travail.
get_default_keyvault()
Retours
Type | Description |
---|---|
Objet KeyVault associé à l’espace de travail. |
get_details
Retournez les détails de l’espace de travail.
get_details()
Retours
Type | Description |
---|---|
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.
nom : nom de cet espace de travail.
emplacement : région de l’espace de travail.
type : URI du format « {providerName}/workspaces ».
balises : non utilisées actuellement.
workspaceid : ID de cet espace de travail.
description : non utilisé actuellement.
friendlyName : nom convivial de l’espace de travail affiché dans l’interface utilisateur.
creationTime : heure de création de cet espace de travail, au format ISO8601.
containerRegistry : Registre de conteneurs d’espace de travail utilisé pour extraire et envoyer (push) des images d’expérimentation et de webservices.
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 : Application Insights sera utilisé par l’espace de travail pour journaliser les événements de webservices.
identityPrincipalId :
identityTenantId
identityType
storageAccount : le stockage sera utilisé par l’espace de travail pour enregistrer les sorties d’exécution, le code, les journaux, etc.
référence sku : référence SKU de l’espace de travail (également appelée édition). Le paramètre est présent pour la 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. Reportez-vous aux https://docs.microsoft.com/en-us/azure-stack/user/azure-stack-key-vault-manage-portal?view=azs-1910 étapes de création d’une clé et obtenez son URI.
hbiWorkspace : spécifie si les données client ont un impact commercial élevé.
imageBuildCompute : cible de calcul pour la génération d’image.
systemDatastoresAuthMode : détermine s’il faut utiliser ou non des informations d’identification pour les magasins de données système de l’espace de travail « workspaceblobstore » et « workspacefilestore ». La valeur par défaut est « accessKey », auquel cas l’espace de travail crée les magasins de données système avec des informations d’identification. Si la valeur est « identity », 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
Obtenez l’URI de suivi MLflow pour l’espace de travail.
MLflow (https://mlflow.org/) est une plateforme open source pour le suivi des expériences machine learning et la gestion des modèles. Vous pouvez utiliser les API de journalisation MLflow avec Azure Machine Learning afin que les métriques, les modèles et les artefacts soient enregistrés dans votre espace de travail Azure Machine Learning.
get_mlflow_tracking_uri(_with_auth=False)
Paramètres
Nom | Description |
---|---|
_with_auth
|
(DÉCONSEILLÉ) Ajoutez des informations d’authentification au suivi de l’URI. Valeur par défaut: False
|
Retours
Type | Description |
---|---|
URI de suivi compatible MLflow. |
Remarques
Utilisez l’exemple suivant pour configurer le suivi MLflow pour 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
list
Répertoriez 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
|
ID d’abonnement pour lequel répertorier les espaces de travail. |
auth
|
Objet d’authentification. Pour plus d’informations, reportez-vous à https://aka.ms/aml-notebook-auth. Si aucune, les informations d’identification Azure CLI par défaut sont utilisées ou l’API demande des informations d’identification. Valeur par défaut: None
|
resource_group
|
Groupe de ressources pour filtrer les espaces de travail retournés. Si aucune, la méthode répertorie tous les espaces de travail de l’abonnement spécifié. Valeur par défaut: None
|
Retours
Type | Description |
---|---|
Dictionnaire où la clé est le nom de l’espace de travail et la valeur est une liste d’objets Workspace. |
list_connections
Répertorier les connexions sous cet espace de travail.
list_connections(category=None, target=None)
Paramètres
Nom | Description |
---|---|
type
Obligatoire
|
Type de cette connexion qui sera filtrée sur |
target
|
cible de cette connexion qui sera filtrée sur Valeur par défaut: None
|
category
|
Valeur par défaut: None
|
list_keys
set_connection
Ajoutez ou mettez à jour une connexion sous l’espace de travail.
set_connection(name, category, target, authType, value)
Paramètres
Nom | Description |
---|---|
name
Obligatoire
|
Nom unique de la connexion sous l’espace de travail |
category
Obligatoire
|
Catégorie de cette connexion |
target
Obligatoire
|
la cible à cette connexion se connecte à |
authType
Obligatoire
|
le type d’autorisation de cette connexion |
value
Obligatoire
|
chaîne de sérialisation au format json des détails de la connexion |
set_default_datastore
setup
Créez un espace de travail ou récupérez un espace de travail existant.
static setup()
Retours
Type | Description |
---|---|
Objet Workspace. |
sync_keys
Déclenche l’espace de travail pour synchroniser immédiatement les clés.
Si des clés pour une ressource de l’espace de travail sont modifiées, la mise à jour automatique 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
|
Indique s’il faut attendre que les clés de synchronisation de l’espace de travail soient terminées. Valeur par défaut: False
|
Retours
Type | Description |
---|---|
Aucun en cas de réussite ; sinon, lève une erreur. |
update
Mettez à jour le nom convivial, la description, les balises, 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
|
Nom convivial de l’espace de travail qui peut être affiché dans l’interface utilisateur. Valeur par défaut: None
|
description
|
Description de l’espace de travail. Valeur par défaut: None
|
tags
|
Balises à associer à l’espace de travail. Valeur par défaut: None
|
image_build_compute
|
Nom de calcul de la build d’image. Valeur par défaut: None
|
service_managed_resources_settings
|
<xref:azureml._base_sdk_common.workspace.models.ServiceManagedResourcesSettings>
Paramètres des ressources gérées par le service. Valeur par défaut: None
|
primary_user_assigned_identity
|
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
|
Autoriser l’accès public à l’espace de travail de liaison privée. Valeur par défaut: None
|
v1_legacy_mode
|
Empêcher l’utilisation du service d’API v2 sur Azure Resource Manager public Valeur par défaut: None
|
Retours
Type | Description |
---|---|
Dictionnaire d’informations mises à jour. |
update_dependencies
Mettez à jour les ressources associées existantes pour l’espace de travail dans les cas suivants.
a) Lorsqu’un utilisateur supprime accidentellement une ressource associée existante et souhaite la mettre à jour avec une nouvelle ressource sans avoir à recréer l’ensemble de l’espace de travail. b) Lorsqu’un utilisateur a une ressource associée existante et souhaite remplacer celle actuelle associée à l’espace de travail. c) Lorsqu’une ressource associée n’a pas encore été créée et qu’elle souhaite utiliser une ressource existante dont elle dispose déjà (s’applique uniquement au registre de conteneurs).
update_dependencies(container_registry=None, force=False)
Paramètres
Nom | Description |
---|---|
container_registry
|
ID ARM pour le registre de conteneurs. Valeur par défaut: None
|
force
|
Si forcez la mise à jour des ressources dépendantes sans confirmation demandée. Valeur par défaut: False
|
Retours
Type | Description |
---|---|
write_config
Écrivez les propriétés Azure Resource Manager (ARM) de l’espace de travail dans un fichier de configuration.
Les propriétés ARM de l’espace de travail peuvent être chargées ultérieurement à l’aide de la from_config méthode. La path
valeur par défaut est « .azureml/ » dans le répertoire de travail actuel et file_name
la valeur par défaut «config.json».
La méthode offre 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 retaper les propriétés ARM de l’espace de travail.
write_config(path=None, file_name=None)
Paramètres
Nom | Description |
---|---|
path
|
Emplacement fourni par l’utilisateur pour écrire le fichier config.json. Le paramètre est défini par défaut sur « .azureml/ » dans le répertoire de travail actuel. Valeur par défaut: None
|
file_name
|
Nom à utiliser pour le fichier de configuration. Le paramètre est défini par défaut sur config.json. Valeur par défaut: None
|
Attributs
compute_targets
Répertorier toutes les cibles de calcul dans l’espace de travail.
Retours
Type | Description |
---|---|
Dictionnaire avec clé en tant que nom de cible de calcul et valeur en tant qu’objet ComputeTarget . |
datasets
datastores
Répertorier tous les magasins de données dans l’espace de travail. Cette opération ne retourne pas d’informations d’identification des magasins de données.
Retours
Type | Description |
---|---|
Dictionnaire avec clé en tant que nom de magasin de données et valeur en tant qu’objet Datastore . |
discovery_url
Retournez l’URL de découverte de cet espace de travail.
Retours
Type | Description |
---|---|
URL de découverte de cet espace de travail. |
environments
Répertoriez tous les environnements dans l’espace de travail.
Retours
Type | Description |
---|---|
Dictionnaire avec clé comme nom d’environnement et valeur en tant qu’objet Environment . |
experiments
Répertorier toutes les expériences dans l’espace de travail.
Retours
Type | Description |
---|---|
Dictionnaire avec clé comme nom d’expérience et valeur en tant qu’objet Experiment . |
images
Retourne la liste des images dans l’espace de travail.
Déclenche un WebserviceException problème d’interaction avec le service de gestion des modèles.
Retours
Type | Description |
---|---|
Dictionnaire avec clé en tant que nom d’image et valeur en tant qu’objet Image . |
Exceptions
Type | Description |
---|---|
Un problème s’est produit lors de l’interaction avec le service de gestion des modèles. |
linked_services
Répertoriez tous les services liés dans l’espace de travail.
Retours
Type | Description |
---|---|
Dictionnaire où la clé est un nom de service lié et une valeur est un LinkedService objet. |
location
Retourne l’emplacement de cet espace de travail.
Retours
Type | Description |
---|---|
Emplacement de cet espace de travail. |
models
Retourne une liste de modèle dans l’espace de travail.
Déclenche un WebserviceException problème d’interaction avec le service de gestion des modèles.
Retours
Type | Description |
---|---|
Dictionnaire de modèle avec clé en tant que nom de modèle et valeur en tant qu’objet Model . |
Exceptions
Type | Description |
---|---|
Un problème s’est produit lors de l’interaction avec le service de gestion des modèles. |
name
private_endpoints
Répertoriez tous les points de terminaison privés de l’espace de travail.
Retours
Type | Description |
---|---|
dictée d’objets PrivateEndPoint associés à l’espace de travail. La clé est le nom du point de terminaison privé. |
resource_group
Retournez le nom du groupe de ressources pour cet espace de travail.
Retours
Type | Description |
---|---|
Nom du groupe de ressources. |
service_context
Retournez le contexte de service pour cet espace de travail.
Retours
Type | Description |
---|---|
<xref:azureml._restclient.service_context.ServiceContext>
|
Renvoie l’objet ServiceContext. |
sku
Retournez la référence SKU de cet espace de travail.
Retours
Type | Description |
---|---|
Référence SKU de cet espace de travail. |
subscription_id
tags
Retournez les balises de cet espace de travail.
Retours
Type | Description |
---|---|
Balises de cet espace de travail. |
webservices
Retourne une liste de webservices dans l’espace de travail.
Déclenche un WebserviceException problème en cas de problème de renvoi de la liste.
Retours
Type | Description |
---|---|
Liste des services web dans l’espace de travail. |
Exceptions
Type | Description |
---|---|
Il y avait un problème de renvoi 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'