Workspace Clase
Define un recurso de Azure Machine Learning para administrar artefactos de entrenamiento e implementación.
Un área de trabajo es un recurso fundamental para el aprendizaje automático en Azure Machine Learning. Use un área de trabajo para experimentar, entrenar e implementar modelos de aprendizaje automático. Cada área de trabajo está asociada a una suscripción de Azure y a un grupo de recursos, y tiene una SKU asociada.
Para obtener más información sobre las áreas de trabajo, consulte:
Constructor de área de trabajo de clase para cargar un área de trabajo de Azure Machine Learning existente.
Constructor
Workspace(subscription_id, resource_group, workspace_name, auth=None, _location=None, _disable_service_check=False, _workspace_id=None, sku='basic', tags=None, _cloud='AzureCloud')
Parámetros
Nombre | Description |
---|---|
subscription_id
Requerido
|
Identificador de suscripción de Azure que contiene el área de trabajo. |
resource_group
Requerido
|
Grupo de recursos que contiene el área de trabajo. |
workspace_name
Requerido
|
Nombre del área de trabajo existente. |
auth
|
Objeto de autenticación. Para obtener más información, consulte https://aka.ms/aml-notebook-auth. Si no, se usarán las credenciales predeterminadas de la CLI de Azure o la API solicitará las credenciales. Valor predeterminado: None
|
_location
|
Solo para uso interno. Valor predeterminado: None
|
_disable_service_check
|
Solo para uso interno. Valor predeterminado: False
|
_workspace_id
|
Solo para uso interno. Valor predeterminado: None
|
sku
|
El parámetro está presente para la compatibilidad con versiones anteriores y se omite. Valor predeterminado: basic
|
_cloud
|
Solo para uso interno. Valor predeterminado: AzureCloud
|
subscription_id
Requerido
|
Identificador de suscripción de Azure que contiene el área de trabajo. |
resource_group
Requerido
|
Grupo de recursos que contiene el área de trabajo. |
workspace_name
Requerido
|
Nombre del área de trabajo. El nombre debe tener entre 2 y 32 caracteres. El primer carácter del nombre debe ser alfanumérico (letra o número), pero el resto del nombre puede contener caracteres alfanuméricos, guiones y caracteres de subrayado. No se permite el espacio en blanco. |
auth
Requerido
|
Objeto de autenticación. Para obtener más información, consulte https://aka.ms/aml-notebook-auth. Si no, se usarán las credenciales predeterminadas de la CLI de Azure o la API solicitará las credenciales. |
_location
Requerido
|
Solo para uso interno. |
_disable_service_check
Requerido
|
Solo para uso interno. |
_workspace_id
Requerido
|
Solo para uso interno. |
sku
Requerido
|
El parámetro está presente para la compatibilidad con versiones anteriores y se omite. |
tags
|
Etiquetas que se van a asociar al área de trabajo. Valor predeterminado: None
|
_cloud
Requerido
|
Solo para uso interno. |
Comentarios
En el ejemplo siguiente se muestra cómo crear un área de trabajo.
from azureml.core import Workspace
ws = Workspace.create(name='myworkspace',
subscription_id='<azure-subscription-id>',
resource_group='myresourcegroup',
create_resource_group=True,
___location='eastus2'
)
Establezca create_resource_group
en False si tiene un grupo de recursos de Azure existente que quiera usar para el área de trabajo.
Para usar la misma área de trabajo en varios entornos, cree un archivo de configuración JSON. El archivo de configuración guarda la suscripción, el recurso y el nombre del área de trabajo para que se pueda cargar fácilmente. Para guardar la configuración, use el write_config método .
ws.write_config(path="./file-path", file_name="ws_config.json")
Consulte Creación de un archivo de configuración del área de trabajo para obtener un ejemplo del archivo de configuración.
Para cargar el área de trabajo desde el archivo de configuración, use el from_config método .
ws = Workspace.from_config()
ws.get_details()
Como alternativa, use el get método para cargar un área de trabajo existente sin usar archivos de configuración.
ws = Workspace.get(name="myworkspace",
subscription_id='<azure-subscription-id>',
resource_group='myresourcegroup')
Los ejemplos anteriores pueden solicitarle credenciales de autenticación de Azure mediante un cuadro de diálogo de inicio de sesión interactivo. Para otros casos de uso, incluido el uso de la CLI de Azure para autenticarse y autenticarse en flujos de trabajo automatizados, consulte Autenticación en Azure Machine Learning.
Métodos
add_private_endpoint |
Agregue un punto de conexión privado al área de trabajo. |
create |
Cree un área de trabajo de Azure Machine Learning. Produce una excepción si el área de trabajo ya existe o no se cumplen los requisitos del área de trabajo. |
delete |
Elimine los recursos asociados al área de trabajo de Azure Machine Learning. |
delete_connection |
Elimine una conexión del área de trabajo. |
delete_private_endpoint_connection |
Elimine la conexión del punto de conexión privado al área de trabajo. |
diagnose_workspace |
Diagnosticar problemas de configuración del área de trabajo. |
from_config |
Devuelve un objeto de área de trabajo de un área de trabajo de Azure Machine Learning existente. Lee la configuración del área de trabajo de un archivo. Produce una excepción si no se encuentra el archivo de configuración. El método proporciona una manera sencilla de reutilizar la misma área de trabajo en varios cuadernos o proyectos de Python. Los usuarios pueden guardar las propiedades de Azure Resource Manager (ARM) del área de trabajo mediante el write_config método y usar este método para cargar el mismo área de trabajo en distintos cuadernos o proyectos de Python sin volver a ajustar las propiedades de ARM del área de trabajo. |
get |
Devuelve un objeto de área de trabajo para un área de trabajo de Azure Machine Learning existente. Produce una excepción si el área de trabajo no existe o los campos obligatorios no identifican de forma única un área de trabajo. |
get_connection |
Obtenga una conexión del área de trabajo. |
get_default_compute_target |
Obtenga el destino de proceso predeterminado para el área de trabajo. |
get_default_datastore |
Obtenga el almacén de datos predeterminado para el área de trabajo. |
get_default_keyvault |
Obtenga el objeto de almacén de claves predeterminado para el área de trabajo. |
get_details |
Devuelve los detalles del área de trabajo. |
get_mlflow_tracking_uri |
Obtenga el URI de seguimiento de MLflow para el área de trabajo. MLflow (https://mlflow.org/) es una plataforma de código abierto para realizar el seguimiento de experimentos de aprendizaje automático y administrar modelos. Puede usar las API de registro de MLflow con Azure Machine Learning para que las métricas, los modelos y los artefactos se registren en el área de trabajo de Azure Machine Learning. |
get_run |
Devuelve la ejecución con el run_id especificado en el área de trabajo. |
list |
Enumere todas las áreas de trabajo a las que el usuario tiene acceso dentro de la suscripción. La lista de áreas de trabajo se puede filtrar en función del grupo de recursos. |
list_connections |
Enumere las conexiones en esta área de trabajo. |
list_keys |
Enumera las claves del área de trabajo actual. |
set_connection |
Agregue o actualice una conexión en el área de trabajo. |
set_default_datastore |
Establezca el almacén de datos predeterminado para el área de trabajo. |
setup |
Cree una nueva área de trabajo o recupere una área de trabajo existente. |
sync_keys |
Desencadena el área de trabajo para sincronizar inmediatamente las claves. Si se cambian las claves de cualquier recurso del área de trabajo, puede tardar aproximadamente una hora en actualizarse automáticamente. Esta función permite actualizar las claves a petición. Un escenario de ejemplo es la necesidad de acceso inmediato al almacenamiento después de volver a generar claves de almacenamiento. |
update |
Actualice el nombre descriptivo, la descripción, las etiquetas, el proceso de compilación de imágenes y otras opciones de configuración asociadas a un área de trabajo. |
update_dependencies |
Actualice los recursos asociados para el área de trabajo en los casos siguientes. a) Cuando un usuario elimina accidentalmente un recurso asociado existente y desea actualizarlo con uno nuevo sin tener que volver a crear todo el área de trabajo. b) Cuando un usuario tiene un recurso asociado existente y desea reemplazar el actual asociado al área de trabajo. c) Cuando aún no se ha creado un recurso asociado y quieren usar uno existente que ya tienen (solo se aplica al registro de contenedor). |
write_config |
Escriba las propiedades de Azure Resource Manager (ARM) del área de trabajo en un archivo de configuración. Las propiedades de ARM del área de trabajo se pueden cargar más adelante mediante el from_config método . El El método proporciona una manera sencilla de reutilizar el mismo área de trabajo en varios cuadernos o proyectos de Python. Los usuarios pueden guardar las propiedades de ARM del área de trabajo con esta función y usar from_config para cargar la misma área de trabajo en distintos cuadernos o proyectos de Python sin volver a ajustar las propiedades de ARM del área de trabajo. |
add_private_endpoint
Agregue un punto de conexión privado al área de trabajo.
add_private_endpoint(private_endpoint_config, private_endpoint_auto_approval=True, ___location=None, show_output=True, tags=None)
Parámetros
Nombre | Description |
---|---|
private_endpoint_config
Requerido
|
Configuración del punto de conexión privado para crear un punto de conexión privado en el área de trabajo. |
private_endpoint_auto_approval
|
Marca booleana que indica si la creación del punto de conexión privado debe aprobarse automáticamente o aprobarse manualmente desde azure Private Link Center. En caso de aprobación manual, los usuarios pueden ver la solicitud pendiente en el portal de Private Link para aprobar o rechazar la solicitud. Valor predeterminado: True
|
___location
|
Ubicación del punto de conexión privado, el valor predeterminado es la ubicación del área de trabajo. Valor predeterminado: None
|
show_output
|
Marca para mostrar el progreso de la creación del área de trabajo Valor predeterminado: True
|
tags
|
Etiquetas que se van a asociar al área de trabajo. Valor predeterminado: None
|
Devoluciones
Tipo | Description |
---|---|
Objeto PrivateEndPoint creado. |
create
Cree un área de trabajo de Azure Machine Learning.
Produce una excepción si el área de trabajo ya existe o no se cumplen los requisitos del área de trabajo.
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)
Parámetros
Nombre | Description |
---|---|
name
Requerido
|
Nombre del área de trabajo nueva. El nombre debe tener entre 2 y 32 caracteres. El primer carácter del nombre debe ser alfanumérico (letra o número), pero el resto del nombre puede contener caracteres alfanuméricos, guiones y caracteres de subrayado. No se permite el espacio en blanco. |
auth
|
Objeto de autenticación. Para obtener más información, consulte https://aka.ms/aml-notebook-auth. Si no, se usarán las credenciales predeterminadas de la CLI de Azure o la API solicitará las credenciales. Valor predeterminado: None
|
subscription_id
|
Identificador de suscripción de la suscripción que contiene la nueva área de trabajo. El parámetro es necesario si el usuario tiene acceso a más de una suscripción. Valor predeterminado: None
|
resource_group
|
Grupo de recursos de Azure que contiene el área de trabajo. El parámetro tiene como valor predeterminado una mutación del nombre del área de trabajo. Valor predeterminado: None
|
___location
|
Ubicación del área de trabajo. El parámetro tiene como valor predeterminado la ubicación del grupo de recursos. La ubicación debe ser una región admitida para Azure Machine Learning. Valor predeterminado: None
|
create_resource_group
|
Indica si se va a crear el grupo de recursos si no existe. Valor predeterminado: True
|
sku
|
El parámetro está presente para la compatibilidad con versiones anteriores y se omite. Valor predeterminado: basic
|
tags
|
Etiquetas que se van a asociar al área de trabajo. Valor predeterminado: None
|
friendly_name
|
Un nombre descriptivo opcional para el área de trabajo que se puede mostrar en la interfaz de usuario. Valor predeterminado: None
|
storage_account
|
Una cuenta de almacenamiento existente en el formato de identificador de recurso de Azure. El área de trabajo usará el almacenamiento para guardar salidas de ejecución, código, registros, etc. Si no, se creará una nueva cuenta de almacenamiento. Valor predeterminado: None
|
key_vault
|
Un almacén de claves existente en el formato de identificador de recurso de Azure. Consulte el código de ejemplo siguiente para más información sobre el formato de identificador de recurso de Azure. El área de trabajo usará el almacén de claves para almacenar las credenciales agregadas al área de trabajo por los usuarios. Si no, se creará un nuevo almacén de claves. Valor predeterminado: None
|
app_insights
|
Una instancia de Application Insights existente en el formato de identificador de recurso de Azure. Consulte el código de ejemplo siguiente para más información sobre el formato de identificador de recurso de Azure. El área de trabajo usará Application Insights para registrar eventos de servicios web. Si no, se creará una nueva instancia de Application Insights. Valor predeterminado: None
|
container_registry
|
Un registro de contenedor existente en el formato de identificador de recurso de Azure (consulte el código de ejemplo siguiente para obtener más información sobre el formato del identificador de recurso de Azure). El área de trabajo usará el registro de contenedor para extraer e insertar imágenes de experimentación y servicios web. Si no, se creará un nuevo registro de contenedor solo cuando sea necesario y no junto con la creación del área de trabajo. Valor predeterminado: None
|
adb_workspace
|
Un área de trabajo de Adb existente en el formato de identificador de recurso de Azure (consulte el código de ejemplo siguiente para obtener más información sobre el formato del identificador de recurso de Azure). El área de trabajo de Adb se usará para vincular con el área de trabajo. Si no es Ninguno, no se producirá el vínculo del área de trabajo. Valor predeterminado: None
|
primary_user_assigned_identity
|
Identificador de recurso de la identidad asignada por el usuario que usó para representar el área de trabajo. Valor predeterminado: None
|
cmk_keyvault
|
Almacén de claves que contiene la clave administrada por el cliente en el formato de identificador de recurso de Azure:
Valor predeterminado: None
|
resource_cmk_uri
|
Identificador URI de clave de la clave administrada por el cliente para cifrar los datos en reposo.
El formato de URI es: Valor predeterminado: None
|
hbi_workspace
|
Especifica si el área de trabajo contiene datos de alto impacto empresarial (HBI), es decir, contiene información empresarial confidencial. Esta marca solo se puede establecer durante la creación del área de trabajo. Su valor no se puede cambiar después de crear el área de trabajo. El valor predeterminado es False. Cuando se establece en True, se realizan pasos de cifrado adicionales y, en función del componente del SDK, se genera información redactada en telemetría recopilada internamente. Para obtener más información, consulte Cifrado de datos. Cuando esta marca se establece en True, un posible impacto es mayor dificultad para solucionar problemas. Esto puede ocurrir porque algunos datos de telemetría no se envían a Microsoft y hay menos visibilidad de las tasas de éxito o los tipos de problemas, y por lo tanto, es posible que no puedan reaccionar de forma proactiva cuando esta marca es True. La recomendación es usar el valor predeterminado de False para esta marca, a menos que sea estrictamente necesario ser True. Valor predeterminado: False
|
default_cpu_compute_target
|
(EN DESUSO) Configuración que se usará para crear un proceso de CPU. El parámetro tiene como valor predeterminado {min_nodes=0, max_nodes=2, vm_size="STANDARD_DS2_V2", vm_priority="dedicated"} Si ninguno, no se creará ningún proceso. Valor predeterminado: None
|
default_gpu_compute_target
|
(EN DESUSO) Configuración que se usará para crear un proceso de GPU. El parámetro tiene como valor predeterminado {min_nodes=0, max_nodes=2, vm_size="STANDARD_NC6", vm_priority="dedicated"} Si ninguno, no se creará ningún proceso. Valor predeterminado: None
|
private_endpoint_config
|
Configuración del punto de conexión privado para crear un punto de conexión privado en el área de trabajo de Azure ML. Valor predeterminado: None
|
private_endpoint_auto_approval
|
Marca booleana que indica si la creación del punto de conexión privado debe aprobarse automáticamente o aprobarse manualmente desde azure Private Link Center. En caso de aprobación manual, los usuarios pueden ver la solicitud pendiente en el portal de Private Link para aprobar o rechazar la solicitud. Valor predeterminado: True
|
exist_ok
|
Indica si este método se realiza correctamente si el área de trabajo ya existe. Si es False, este método produce un error si el área de trabajo existe. Si es True, este método devuelve el área de trabajo existente si existe. Valor predeterminado: False
|
show_output
|
Indica si este método imprimirá el progreso incremental. Valor predeterminado: True
|
user_assigned_identity_for_cmk_encryption
|
Identificador de recurso de la identidad asignada por el usuario que debe usarse para acceder a la clave de administración del cliente. Valor predeterminado: None
|
system_datastores_auth_mode
|
Determina si se van a usar credenciales para los almacenes de datos del sistema del área de trabajo "workspaceblobstore" y "workspacefilestore". El valor predeterminado es "accessKey", en cuyo caso, el área de trabajo creará los almacenes de datos del sistema con credenciales. Si se establece en "identity", el área de trabajo creará los almacenes de datos del sistema sin credenciales. Valor predeterminado: accessKey
|
v1_legacy_mode
|
Impedir el uso del servicio de API v2 en Azure Resource Manager público Valor predeterminado: None
|
Devoluciones
Tipo | Description |
---|---|
Objeto del área de trabajo. |
Excepciones
Tipo | Description |
---|---|
Se han generado problemas al crear el área de trabajo. |
Comentarios
En este primer ejemplo solo se requiere una especificación mínima, y todos los recursos dependientes, así como el grupo de recursos se crearán automáticamente.
from azureml.core import Workspace
ws = Workspace.create(name='myworkspace',
subscription_id='<azure-subscription-id>',
resource_group='myresourcegroup',
create_resource_group=True,
___location='eastus2')
En el ejemplo siguiente se muestra cómo reutilizar los recursos de Azure existentes mediante el formato de identificador de recurso de Azure. Los identificadores de recursos de Azure específicos se pueden recuperar mediante Azure Portal o el SDK. Esto supone que el grupo de recursos, la cuenta de almacenamiento, el almacén de claves, App Insights y el registro de contenedor ya existen.
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
Elimine los recursos asociados al área de trabajo de Azure Machine Learning.
delete(delete_dependent_resources=False, no_wait=False)
Parámetros
Nombre | Description |
---|---|
delete_dependent_resources
|
Si desea eliminar los recursos asociados al área de trabajo, es decir, el registro de contenedor, la cuenta de almacenamiento, el almacén de claves y Application Insights. El valor predeterminado es False. Establézcalo en True para eliminar estos recursos. Valor predeterminado: False
|
no_wait
|
Si desea esperar a que se complete la eliminación del área de trabajo. Valor predeterminado: False
|
Devoluciones
Tipo | Description |
---|---|
Ninguno si se ejecuta correctamente; De lo contrario, produce un error. |
delete_connection
Elimine una conexión del área de trabajo.
delete_connection(name)
Parámetros
Nombre | Description |
---|---|
name
Requerido
|
Nombre único de la conexión en el área de trabajo |
delete_private_endpoint_connection
Elimine la conexión del punto de conexión privado al área de trabajo.
delete_private_endpoint_connection(private_endpoint_connection_name)
Parámetros
Nombre | Description |
---|---|
private_endpoint_connection_name
Requerido
|
Nombre único de la conexión de punto de conexión privado en el área de trabajo |
diagnose_workspace
Diagnosticar problemas de configuración del área de trabajo.
diagnose_workspace(diagnose_parameters)
Parámetros
Nombre | Description |
---|---|
diagnose_parameters
Requerido
|
<xref:_restclient.models.DiagnoseWorkspaceParameters>
El parámetro de diagnóstico del estado del área de trabajo |
Devoluciones
Tipo | Description |
---|---|
<xref:msrestazure.azure_operation.AzureOperationPoller>[<xref:_restclient.models.DiagnoseResponseResult>]
|
Instancia de AzureOperationPoller que devuelve DiagnoseResponseResult |
from_config
Devuelve un objeto de área de trabajo de un área de trabajo de Azure Machine Learning existente.
Lee la configuración del área de trabajo de un archivo. Produce una excepción si no se encuentra el archivo de configuración.
El método proporciona una manera sencilla de reutilizar la misma área de trabajo en varios cuadernos o proyectos de Python. Los usuarios pueden guardar las propiedades de Azure Resource Manager (ARM) del área de trabajo mediante el write_config método y usar este método para cargar el mismo área de trabajo en distintos cuadernos o proyectos de Python sin volver a ajustar las propiedades de ARM del área de trabajo.
static from_config(path=None, auth=None, _logger=None, _file_name=None)
Parámetros
Nombre | Description |
---|---|
path
|
Ruta de acceso al archivo de configuración o al directorio de inicio que se va a buscar. El parámetro tiene como valor predeterminado iniciar la búsqueda en el directorio actual. Valor predeterminado: None
|
auth
|
Objeto de autenticación. Para obtener más información, consulte https://aka.ms/aml-notebook-auth. Si no, se usarán las credenciales predeterminadas de la CLI de Azure o la API solicitará las credenciales. Valor predeterminado: None
|
_logger
|
Permite invalidar el registrador predeterminado. Valor predeterminado: None
|
_file_name
|
Permite reemplazar el nombre del archivo de configuración para buscar cuando la ruta de acceso es una ruta de acceso de directorio. Valor predeterminado: None
|
Devoluciones
Tipo | Description |
---|---|
Objeto del área de trabajo de un área de trabajo de Azure ML existente. |
get
Devuelve un objeto de área de trabajo para un área de trabajo de Azure Machine Learning existente.
Produce una excepción si el área de trabajo no existe o los campos obligatorios no identifican de forma única un área de trabajo.
static get(name, auth=None, subscription_id=None, resource_group=None, ___location=None, cloud='AzureCloud', id=None)
Parámetros
Nombre | Description |
---|---|
name
Requerido
|
Nombre del área de trabajo que se va a obtener. |
auth
|
Objeto de autenticación. Para obtener más información, consulte https://aka.ms/aml-notebook-auth. Si no, se usarán las credenciales predeterminadas de la CLI de Azure o la API solicitará las credenciales. Valor predeterminado: None
|
subscription_id
|
Identificador de suscripción que se va a usar. El parámetro es necesario si el usuario tiene acceso a más de una suscripción. Valor predeterminado: None
|
resource_group
|
Grupo de recursos que se va a usar. Si es None, el método buscará en todos los grupos de recursos de la suscripción. Valor predeterminado: None
|
___location
|
Ubicación del área de trabajo. Valor predeterminado: None
|
cloud
|
Nombre de la nube de destino. Puede ser uno de "AzureCloud", "AzureChinaCloud" o "AzureUSGovernment". Si no se especifica ninguna nube , se usa "AzureCloud". Valor predeterminado: AzureCloud
|
id
|
Identificador del área de trabajo. Valor predeterminado: None
|
Devoluciones
Tipo | Description |
---|---|
Objeto del área de trabajo. |
get_connection
Obtenga una conexión del área de trabajo.
get_connection(name)
Parámetros
Nombre | Description |
---|---|
name
Requerido
|
Nombre único de la conexión en el área de trabajo |
get_default_compute_target
Obtenga el destino de proceso predeterminado para el área de trabajo.
get_default_compute_target(type)
Parámetros
Nombre | Description |
---|---|
type
Requerido
|
Tipo de proceso. Los valores posibles son "CPU" o "GPU". |
Devoluciones
Tipo | Description |
---|---|
Destino de proceso predeterminado para un tipo de proceso determinado. |
get_default_datastore
Obtenga el almacén de datos predeterminado para el área de trabajo.
get_default_datastore()
Devoluciones
Tipo | Description |
---|---|
Almacén de datos predeterminado. |
get_default_keyvault
Obtenga el objeto de almacén de claves predeterminado para el área de trabajo.
get_default_keyvault()
Devoluciones
Tipo | Description |
---|---|
Objeto KeyVault asociado al área de trabajo. |
get_details
Devuelve los detalles del área de trabajo.
get_details()
Devoluciones
Tipo | Description |
---|---|
Detalles del área de trabajo en formato de diccionario. |
Comentarios
El diccionario devuelto contiene los siguientes pares clave-valor.
id: URI que apunta a este recurso de área de trabajo, que contiene el identificador de suscripción, el grupo de recursos y el nombre del área de trabajo.
name: nombre de esta área de trabajo.
___location: la región del área de trabajo.
type: URI del formato "{providerName}/workspaces".
etiquetas: no se usa actualmente.
workspaceid: el identificador de esta área de trabajo.
description: no se usa actualmente.
friendlyName: un nombre descriptivo para el área de trabajo que se muestra en la interfaz de usuario.
creationTime: hora en que se creó esta área de trabajo, en formato ISO8601.
containerRegistry: el registro de contenedor del área de trabajo que se usa para extraer e insertar imágenes de experimentación y servicios web.
keyVault: almacén de claves del área de trabajo que se usa para almacenar las credenciales agregadas al área de trabajo por los usuarios.
applicationInsights: el área de trabajo usará Application Insights para registrar eventos de servicios web.
identityPrincipalId:
identityTenantId
identityType
storageAccount: el área de trabajo usará el almacenamiento para guardar salidas de ejecución, código, registros, etc.
sku: la SKU del área de trabajo (también denominada edición). El parámetro está presente para la compatibilidad con versiones anteriores y se omite.
resourceCmkUri: el URI de clave de la clave administrada por el cliente para cifrar los datos en reposo. Consulte para https://docs.microsoft.com/en-us/azure-stack/user/azure-stack-key-vault-manage-portal?view=azs-1910 ver los pasos sobre cómo crear una clave y obtener su URI.
hbiWorkspace: especifica si los datos del cliente son de gran impacto empresarial.
imageBuildCompute: destino de proceso para la compilación de imágenes.
systemDatastoresAuthMode: determina si se deben usar credenciales para los almacenes de datos del sistema del área de trabajo "workspaceblobstore" y "workspacefilestore". El valor predeterminado es "accessKey", en cuyo caso, el área de trabajo creará los almacenes de datos del sistema con credenciales. Si se establece en "identity", el área de trabajo creará los almacenes de datos del sistema sin credenciales.
Para obtener más información sobre estos pares clave-valor, vea create.
get_mlflow_tracking_uri
Obtenga el URI de seguimiento de MLflow para el área de trabajo.
MLflow (https://mlflow.org/) es una plataforma de código abierto para realizar el seguimiento de experimentos de aprendizaje automático y administrar modelos. Puede usar las API de registro de MLflow con Azure Machine Learning para que las métricas, los modelos y los artefactos se registren en el área de trabajo de Azure Machine Learning.
get_mlflow_tracking_uri(_with_auth=False)
Parámetros
Nombre | Description |
---|---|
_with_auth
|
(EN DESUSO) Agregue información de autenticación al URI de seguimiento. Valor predeterminado: False
|
Devoluciones
Tipo | Description |
---|---|
URI de seguimiento compatible con MLflow. |
Comentarios
Use el ejemplo siguiente para configurar el seguimiento de MLflow para enviar datos al área de trabajo de 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
Enumere todas las áreas de trabajo a las que el usuario tiene acceso dentro de la suscripción.
La lista de áreas de trabajo se puede filtrar en función del grupo de recursos.
static list(subscription_id, auth=None, resource_group=None)
Parámetros
Nombre | Description |
---|---|
subscription_id
Requerido
|
Identificador de suscripción para el que se van a enumerar las áreas de trabajo. |
auth
|
Objeto de autenticación. Para obtener más información, consulte https://aka.ms/aml-notebook-auth. Si no, se usarán las credenciales predeterminadas de la CLI de Azure o la API solicitará las credenciales. Valor predeterminado: None
|
resource_group
|
Un grupo de recursos para filtrar las áreas de trabajo devueltas. Si es None, el método enumerará todas las áreas de trabajo de la suscripción especificada. Valor predeterminado: None
|
Devoluciones
Tipo | Description |
---|---|
Diccionario donde la clave es el nombre del área de trabajo y el valor es una lista de objetos Workspace. |
list_connections
Enumere las conexiones en esta área de trabajo.
list_connections(category=None, target=None)
Parámetros
Nombre | Description |
---|---|
type
Requerido
|
Tipo de esta conexión en la que se filtrará |
target
|
el destino de esta conexión en la que se filtrará Valor predeterminado: None
|
category
|
Valor predeterminado: None
|
list_keys
set_connection
Agregue o actualice una conexión en el área de trabajo.
set_connection(name, category, target, authType, value)
Parámetros
Nombre | Description |
---|---|
name
Requerido
|
Nombre único de la conexión en el área de trabajo |
category
Requerido
|
Categoría de esta conexión |
target
Requerido
|
el destino a la que se conecta esta conexión |
authType
Requerido
|
el tipo de autorización de esta conexión |
value
Requerido
|
cadena de serialización de formato JSON de los detalles de conexión |
set_default_datastore
setup
Cree una nueva área de trabajo o recupere una área de trabajo existente.
static setup()
Devoluciones
Tipo | Description |
---|---|
Un objeto Workspace. |
sync_keys
Desencadena el área de trabajo para sincronizar inmediatamente las claves.
Si se cambian las claves de cualquier recurso del área de trabajo, puede tardar aproximadamente una hora en actualizarse automáticamente. Esta función permite actualizar las claves a petición. Un escenario de ejemplo es la necesidad de acceso inmediato al almacenamiento después de volver a generar claves de almacenamiento.
sync_keys(no_wait=False)
Parámetros
Nombre | Description |
---|---|
no_wait
|
Si desea esperar a que se completen las claves de sincronización del área de trabajo. Valor predeterminado: False
|
Devoluciones
Tipo | Description |
---|---|
Ninguno si se ejecuta correctamente; De lo contrario, produce un error. |
update
Actualice el nombre descriptivo, la descripción, las etiquetas, el proceso de compilación de imágenes y otras opciones de configuración asociadas a un área de trabajo.
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)
Parámetros
Nombre | Description |
---|---|
friendly_name
|
Un nombre descriptivo para el área de trabajo que se puede mostrar en la interfaz de usuario. Valor predeterminado: None
|
description
|
Descripción del área de trabajo. Valor predeterminado: None
|
tags
|
Etiquetas que se van a asociar al área de trabajo. Valor predeterminado: None
|
image_build_compute
|
Nombre de proceso de la compilación de la imagen. Valor predeterminado: None
|
service_managed_resources_settings
|
<xref:azureml._base_sdk_common.workspace.models.ServiceManagedResourcesSettings>
Configuración de los recursos administrados por el servicio. Valor predeterminado: None
|
primary_user_assigned_identity
|
Identificador de recurso de identidad asignado por el usuario que representa la identidad del área de trabajo. Valor predeterminado: None
|
allow_public_access_when_behind_vnet
|
Permitir el acceso público al área de trabajo de Private Link. Valor predeterminado: None
|
v1_legacy_mode
|
Impedir el uso del servicio de API v2 en Azure Resource Manager público Valor predeterminado: None
|
Devoluciones
Tipo | Description |
---|---|
Diccionario de información actualizada. |
update_dependencies
Actualice los recursos asociados para el área de trabajo en los casos siguientes.
a) Cuando un usuario elimina accidentalmente un recurso asociado existente y desea actualizarlo con uno nuevo sin tener que volver a crear todo el área de trabajo. b) Cuando un usuario tiene un recurso asociado existente y desea reemplazar el actual asociado al área de trabajo. c) Cuando aún no se ha creado un recurso asociado y quieren usar uno existente que ya tienen (solo se aplica al registro de contenedor).
update_dependencies(container_registry=None, force=False)
Parámetros
Nombre | Description |
---|---|
container_registry
|
Id. de ARM para el registro de contenedor. Valor predeterminado: None
|
force
|
Si fuerza la actualización de recursos dependientes sin confirmación. Valor predeterminado: False
|
Devoluciones
Tipo | Description |
---|---|
write_config
Escriba las propiedades de Azure Resource Manager (ARM) del área de trabajo en un archivo de configuración.
Las propiedades de ARM del área de trabajo se pueden cargar más adelante mediante el from_config método . El path
valor predeterminado es ".azureml/" en el directorio de trabajo actual y file_name
el valor predeterminado es "config.json".
El método proporciona una manera sencilla de reutilizar el mismo área de trabajo en varios cuadernos o proyectos de Python. Los usuarios pueden guardar las propiedades de ARM del área de trabajo con esta función y usar from_config para cargar la misma área de trabajo en distintos cuadernos o proyectos de Python sin volver a ajustar las propiedades de ARM del área de trabajo.
write_config(path=None, file_name=None)
Parámetros
Nombre | Description |
---|---|
path
|
Ubicación proporcionada por el usuario para escribir el archivo config.json. El parámetro tiene como valor predeterminado ".azureml/" en el directorio de trabajo actual. Valor predeterminado: None
|
file_name
|
Nombre que se va a usar para el archivo de configuración. El parámetro tiene como valor predeterminado config.json. Valor predeterminado: None
|
Atributos
compute_targets
Enumere todos los destinos de proceso en el área de trabajo.
Devoluciones
Tipo | Description |
---|---|
Diccionario con clave como nombre y valor de destino de proceso como ComputeTarget objeto. |
datasets
datastores
discovery_url
Devuelve la dirección URL de detección de esta área de trabajo.
Devoluciones
Tipo | Description |
---|---|
Dirección URL de detección de esta área de trabajo. |
environments
Enumere todos los entornos del área de trabajo.
Devoluciones
Tipo | Description |
---|---|
Diccionario con clave como nombre de entorno y valor como Environment objeto. |
experiments
Enumere todos los experimentos del área de trabajo.
Devoluciones
Tipo | Description |
---|---|
Diccionario con clave como nombre del experimento y valor como Experiment objeto. |
images
Devuelve la lista de imágenes del área de trabajo.
Genera un WebserviceException si se produjo un problema al interactuar con el servicio de administración de modelos.
Devoluciones
Tipo | Description |
---|---|
Diccionario con clave como nombre de imagen y valor como Image objeto. |
Excepciones
Tipo | Description |
---|---|
Se produjo un problema al interactuar con el servicio de administración de modelos. |
linked_services
Enumere todos los servicios vinculados en el área de trabajo.
Devoluciones
Tipo | Description |
---|---|
Diccionario donde key es un nombre de servicio vinculado y un valor es un LinkedService objeto . |
___location
Devuelve la ubicación de esta área de trabajo.
Devoluciones
Tipo | Description |
---|---|
Ubicación de esta área de trabajo. |
models
Devuelve una lista de modelos en el área de trabajo.
Genera un WebserviceException si se produjo un problema al interactuar con el servicio de administración de modelos.
Devoluciones
Tipo | Description |
---|---|
Diccionario de modelo con clave como nombre de modelo y valor como Model objeto. |
Excepciones
Tipo | Description |
---|---|
Se produjo un problema al interactuar con el servicio de administración de modelos. |
name
Devuelve el nombre del área de trabajo.
Devoluciones
Tipo | Description |
---|---|
Nombre del área de trabajo. |
private_endpoints
Enumere todos los puntos de conexión privados del área de trabajo.
Devoluciones
Tipo | Description |
---|---|
Un dict de objetos PrivateEndPoint asociados al área de trabajo. La clave es el nombre del punto de conexión privado. |
resource_group
Devuelve el nombre del grupo de recursos de esta área de trabajo.
Devoluciones
Tipo | Description |
---|---|
Nombre del grupo de recursos. |
service_context
Devuelve el contexto del servicio para esta área de trabajo.
Devoluciones
Tipo | Description |
---|---|
<xref:azureml._restclient.service_context.ServiceContext>
|
Devuelve el objeto ServiceContext. |
sku
Devuelve la SKU de esta área de trabajo.
Devoluciones
Tipo | Description |
---|---|
SKU de esta área de trabajo. |
subscription_id
Devuelve el identificador de suscripción de esta área de trabajo.
Devoluciones
Tipo | Description |
---|---|
Identificador de suscripción. |
tags
Devuelve las etiquetas de esta área de trabajo.
Devoluciones
Tipo | Description |
---|---|
Etiquetas de esta área de trabajo. |
webservices
Devuelve una lista de servicios web en el área de trabajo.
Genera un WebserviceException si se produjo un problema al devolver la lista.
Devoluciones
Tipo | Description |
---|---|
Lista de servicios web en el área de trabajo. |
Excepciones
Tipo | Description |
---|---|
Hubo un problema al devolver la lista. |
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'