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. Las áreas de trabajo se usan para experimentar, entrenar e implementar modelos de Machine Learning. Cada área de trabajo está vinculada a una suscripción y un grupo de recursos de Azure, y tiene una SKU asociada.

Para más información sobre las áreas de trabajo, consulte:

Herencia
builtins.object
Workspace

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

subscription_id
str
Requerido

Identificador de la suscripción de Azure que contiene el área de trabajo.

resource_group
str
Requerido

Grupo de recursos que contiene el área de trabajo.

workspace_name
str
Requerido

Nombre del área de trabajo existente.

auth
ServicePrincipalAuthentication o InteractiveLoginAuthentication o MsiAuthentication
valor predeterminado: None

Objeto de autenticación. Para más información, consulte https://aka.ms/aml-notebook-auth. Si es None (Ninguno), se usarán las credenciales predeterminadas de la CLI de Azure o la API solicitará las credenciales.

_location
str
valor predeterminado: None

Solo para uso interno.

_disable_service_check
bool
valor predeterminado: False

Solo para uso interno.

_workspace_id
str
valor predeterminado: None

Solo para uso interno.

sku
str
valor predeterminado: basic

El parámetro está presente por compatibilidad con versiones anteriores y se omite.

_cloud
str
valor predeterminado: None

Exclusivamente para uso interno.

_cloud
valor predeterminado: AzureCloud

Comentarios

En el ejemplo siguiente, se muestra cómo se crea 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 método write_config.


   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 ver un ejemplo del archivo de configuración.

Para cargar el área de trabajo desde el archivo de configuración, use el método from_config.


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

También puede usar el método get 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 solicitar las 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 autenticar y la autenticación en flujos de trabajo automatizados, consulte Autenticación en Azure Machine Learning.

Métodos

add_private_endpoint

Agrega un punto de conexión privado al área de trabajo.

create

Crea un área de trabajo de Azure Machine Learning.

Produce una excepción si ya existe el área de trabajo o no se cumple alguno de los requisitos del área de trabajo.

delete

Elimina los recursos asociados al área de trabajo de Azure Machine Learning.

delete_connection

Elimina una conexión del área de trabajo.

delete_private_endpoint_connection

Elimina la conexión del punto de conexión privado con el área de trabajo.

diagnose_workspace

Se diagnostican los problemas de configuración del área de trabajo.

from_config

Devuelve un objeto de área de trabajo del á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 método write_config y usar este método para cargar la misma área de trabajo en otros cuadernos o proyectos de Python sin volver a escribir las propiedades de ARM del área de trabajo.

get

Devuelve un objeto de área de trabajo de 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

Obtiene una conexión del área de trabajo.

get_default_compute_target

Obtiene el destino de proceso predeterminado del área de trabajo.

get_default_datastore

Obtiene el almacén de datos predeterminado del área de trabajo.

get_default_keyvault

Obtiene el objeto de almacén de claves predeterminado del área de trabajo.

get_details

Devuelve los detalles del área de trabajo.

get_mlflow_tracking_uri

Obtiene el identificador URI de seguimiento de MLflow del área de trabajo.

MLflow (https://mlflow.org/) es una plataforma de código abierto para el seguimiento de experimentos de aprendizaje automático y la administración de 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 valor de run_id especificado en el área de trabajo.

list

Enumera 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

Enumera las conexiones de esta área de trabajo.

list_keys

Enumera las claves del área de trabajo actual.

set_connection

Agrega o actualiza una conexión del área de trabajo.

set_default_datastore

Establece el almacén de datos predeterminado del área de trabajo.

setup

Crea un área de trabajo o recupera una existente.

sync_keys

Desencadena que el área de trabajo sincronice las claves inmediatamente.

Si se cambian las claves de cualquier recurso del área de trabajo, pueden tardar aproximadamente una hora en actualizarse automáticamente. Esta función permite que las claves se actualicen a petición. Un escenario de ejemplo es la necesidad de acceso inmediato al almacenamiento después de regenerar las claves de almacenamiento.

update

Actualiza el nombre descriptivo, la descripción, las etiquetas, el proceso de compilación de imágenes y otras configuraciones asociadas a un área de trabajo.

update_dependencies

Actualiza los recursos asociados existentes para el área de trabajo en los casos siguientes.

a) Cuando un usuario elimina accidentalmente un recurso asociado y quiere actualizarlo con uno nuevo sin tener que volver a crear toda el área de trabajo. b) Cuando un usuario tiene un recurso asociado y quiere reemplazar el actual que está asociado al área de trabajo. c) Cuando aún no se ha creado un recurso asociado y el usuario quiere usar uno existente que ya tiene (solo se aplica al registro de contenedor).

write_config

Escribe 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 método from_config. El elemento path tiene el valor predeterminado ".azureml/" en el directorio de trabajo actual y el valor predeterminado de file_name es "config.json".

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 ARM del área de trabajo mediante esta función y usar from_config para cargar la misma área de trabajo en otros cuadernos o proyectos de Python sin volver a escribir las propiedades de ARM del área de trabajo.

add_private_endpoint

Agrega 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

private_endpoint_config
PrivateEndPointConfig
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
bool
valor predeterminado: True

Marca booleana que indica si la creación del punto de conexión privado debe aprobarse de forma automática o manual 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 aprobarla o rechazarla.

location
string
valor predeterminado: None

Ubicación del punto de conexión privado. El valor predeterminado es la ubicación del área de trabajo.

show_output
bool
valor predeterminado: True

Marca para mostrar el progreso de la creación del área de trabajo.

tags
dict
valor predeterminado: None

Etiquetas que se van a asociar al área de trabajo.

Devoluciones

Objeto PrivateEndPoint creado.

Tipo de valor devuelto

create

Crea un área de trabajo de Azure Machine Learning.

Produce una excepción si ya existe el área de trabajo o no se cumple alguno de 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

name
str
Requerido

Nuevo 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 subrayados. No se permiten espacios en blanco.

auth
ServicePrincipalAuthentication o InteractiveLoginAuthentication
valor predeterminado: None

Objeto de autenticación. Para más información, consulte https://aka.ms/aml-notebook-auth. Si es None (Ninguno), se usarán las credenciales predeterminadas de la CLI de Azure o la API solicitará las credenciales.

subscription_id
str
valor predeterminado: None

Identificador de la suscripción contenedora de la nueva área de trabajo. El parámetro es necesario si el usuario tiene acceso a más de una suscripción.

resource_group
str
valor predeterminado: None

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.

location
str
valor predeterminado: None

Ubicación del área de trabajo. El valor predeterminado del parámetro es la ubicación del grupo de recursos. La ubicación debe ser una región admitida para Azure Machine Learning.

create_resource_group
bool
valor predeterminado: True

Indica si se creará el grupo de recursos en caso de que no exista.

sku
str
valor predeterminado: basic

El parámetro está presente por compatibilidad con versiones anteriores y se omite.

tags
dict
valor predeterminado: None

Etiquetas que se van a asociar al área de trabajo.

friendly_name
str
valor predeterminado: None

Nombre descriptivo opcional del área de trabajo que se puede mostrar en la interfaz de usuario.

storage_account
str
valor predeterminado: None

Cuenta de almacenamiento existente con el formato de identificador de recurso de Azure. El área de trabajo usará el almacenamiento para guardar las salidas de la ejecución, el código, los registros, etc. Si es None (Ninguno), se creará una cuenta de almacenamiento.

key_vault
str
valor predeterminado: None

Almacén de claves existente con el formato de identificador de recurso de Azure. Consulte el código de ejemplo siguiente para obtener detalles sobre el formato del identificador de recurso de Azure. El área de trabajo usará el almacén de claves para almacenar las credenciales que los usuarios agreguen al área de trabajo. Si es None (Ninguno), se crea un almacén de claves.

app_insights
str
valor predeterminado: None

Instancia de Application Insights existente con el formato de identificador de recurso de Azure. Consulte el código de ejemplo siguiente para obtener detalles sobre el formato del identificador de recurso de Azure. El área de trabajo usará la instancia de Application Insights para registrar los eventos de los servicios web. Si es None (Ninguno), se crea una instancia de Application Insights.

container_registry
str
valor predeterminado: None

Registro de contenedor existente en formato de identificador de recurso de Azure (consulte el código de ejemplo siguiente para obtener detalles sobre el formato de identificador de recurso de Azure). El área de trabajo usará el registro de contenedor para extraer e insertar imágenes de experimentación y de servicios web. Si es None (Ninguno), se creará un registro de contenedor solo cuando sea necesario y no con la creación del área de trabajo.

adb_workspace
str
valor predeterminado: None

Área de trabajo de Adb existente en formato de identificador de recurso de Azure (consulte el código de ejemplo siguiente para obtener detalles sobre el formato de identificador de recurso de Azure). El área de trabajo de Adb se usará para vincularla con el área de trabajo. Si es None, el vínculo del área de trabajo no aparecerá.

primary_user_assigned_identity
str
valor predeterminado: None

Identificador de recurso de la identidad asignada por el usuario que se usó para representar el área de trabajo.

cmk_keyvault
str
valor predeterminado: None

El almacén de claves que contiene la clave administrada por el cliente con el formato de identificador de recurso de Azure:/subscriptions/<azure-subscription-id>/resourcegroups/<azure-resource-group>/providers/microsoft.keyvault/vaults/<azure-keyvault-name> Por ejemplo: "/subscriptions/d139f240-94e6-4175-87a7-954b9d27db16/resourcegroups/myresourcegroup/providers/microsoft.keyvault/vaults/mykeyvault". Consulte el código de ejemplo en los comentarios a continuación para obtener más detalles sobre el formato de identificador de recurso de Azure.

resource_cmk_uri
str
valor predeterminado: None

Identificador URI de la clave administrada por el cliente para cifrar los datos en reposo. El formato del identificador URI es https://<keyvault-dns-name>/keys/<key-name>/<key-version>. Por ejemplo: 'https://mykeyvault.vault.azure.net/keys/mykey/bc5dce6d01df49w2na7ffb11a2ee008b'. Consulte https://docs.microsoft.com/azure-stack/user/azure-stack-key-vault-manage-portal para conocer los pasos sobre cómo crear una clave y obtener su identificador URI.

hbi_workspace
bool
valor predeterminado: False

Especifica si el área de trabajo contiene datos de alto impacto para la empresa (HBI), por ejemplo, si contiene información empresarial confidencial. Esta marca solo se puede establecer durante la creación del área de trabajo. No se puede cambiar su valor después de crear el área de trabajo. El valor predeterminado es False.

Cuando se establece en True, se realizan más pasos de cifrado y, en función del componente del SDK, se genera información censurada en los datos de telemetría recopilados internamente. Para más información, consulte Cifrado de datos.

Cuando esta marca se establece en True, un posible impacto es una mayor dificultad para solucionar problemas. Esto podría deberse a que algunos datos de telemetría no se envían a Microsoft y hay menos visibilidad de las tasas de éxito o de los tipos de problemas y, por tanto, es posible que no pueda reaccionar de forma proactiva cuando esta marca está establecida en True. La recomendación es usar el valor predeterminado de False para esta marca, a menos que sea estrictamente necesario que sea True.

default_cpu_compute_target
AmlComputeProvisioningConfiguration
valor predeterminado: None

(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 es None (Ninguno), no se creará ningún recurso de proceso.

default_gpu_compute_target
AmlComputeProvisioningConfiguration
valor predeterminado: None

(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 es None (Ninguno), no se creará ningún proceso.

private_endpoint_config
PrivateEndPointConfig
valor predeterminado: None

Configuración de punto de conexión privado para crear un punto de conexión privado en el área de trabajo de Azure ML.

private_endpoint_auto_approval
bool
valor predeterminado: True

Marca booleana que indica si la creación del punto de conexión privado debe aprobarse de forma automática o manual 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 aprobarla o rechazarla.

exist_ok
bool
valor predeterminado: False

Indica si este método se realiza correctamente si el área de trabajo ya existe. Si es False, se produce un error en este método si el área de trabajo existe. Si es True, este método devuelve el área de trabajo existente, si existe.

show_output
bool
valor predeterminado: True

Indica si este método imprimirá el progreso incremental.

user_assigned_identity_for_cmk_encryption
str
valor predeterminado: None

Identificador de recurso de la identidad asignada por el usuario que debe usarse para acceder a la clave de administración del cliente.

system_datastores_auth_mode
str
valor predeterminado: accessKey

Determina si se deben usar o no 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.

v1_legacy_mode
bool
valor predeterminado: None

Impedir el uso del servicio de API v2 en una instancia pública de Azure Resource Manager

Devoluciones

Objeto de área de trabajo.

Tipo de valor devuelto

Excepciones

Se emite por 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 con 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. Se da por supuesto 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

Elimina los recursos asociados al área de trabajo de Azure Machine Learning.

delete(delete_dependent_resources=False, no_wait=False)

Parámetros

delete_dependent_resources
bool
valor predeterminado: False

Indica si se van a 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. Se establece en True para eliminar estos recursos.

no_wait
bool
valor predeterminado: False

Indica si se debe esperar a que se complete la eliminación del área de trabajo.

Devoluciones

None (Ninguno) si es correcto; en caso contrario, produce un error.

Tipo de valor devuelto

delete_connection

Elimina una conexión del área de trabajo.

delete_connection(name)

Parámetros

name
str
Requerido

Nombre único de la conexión en el área de trabajo

delete_private_endpoint_connection

Elimina la conexión del punto de conexión privado con el área de trabajo.

delete_private_endpoint_connection(private_endpoint_connection_name)

Parámetros

private_endpoint_connection_name
str
Requerido

Nombre único de la conexión de punto de conexión privado en el área de trabajo.

diagnose_workspace

Se diagnostican los problemas de configuración del área de trabajo.

diagnose_workspace(diagnose_parameters)

Parámetros

diagnose_parameters
<xref:_restclient.models.DiagnoseWorkspaceParameters>
Requerido

Parámetro de diagnóstico del estado del área de trabajo.

Devoluciones

Instancia de AzureOperationPoller que devuelve DiagnoseResponseResult.

Tipo de valor devuelto

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

from_config

Devuelve un objeto de área de trabajo del á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 método write_config y usar este método para cargar la misma área de trabajo en otros cuadernos o proyectos de Python sin volver a escribir las propiedades de ARM del área de trabajo.

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

Parámetros

path
str
valor predeterminado: None

Ruta de acceso al archivo de configuración o al directorio de inicio en el que se buscará. El parámetro tiene como valor predeterminado iniciar la búsqueda en el directorio actual.

auth
ServicePrincipalAuthentication o InteractiveLoginAuthentication
valor predeterminado: None

Objeto de autenticación. Para más información, consulte https://aka.ms/aml-notebook-auth. Si es None (Ninguno), se usarán las credenciales predeterminadas de la CLI de Azure o la API solicitará las credenciales.

_logger
Logger
valor predeterminado: None

Permite reemplazar el registrador predeterminado.

_file_name
str
valor predeterminado: None

Permite reemplazar el nombre del archivo de configuración en el que buscar cuando la ruta de acceso es una ruta de acceso de directorio.

Devoluciones

Objeto de área de trabajo para un área de trabajo de Azure ML existente.

Tipo de valor devuelto

get

Devuelve un objeto de área de trabajo de 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

name
str
Requerido

Nombre del área de trabajo que se va a obtener.

auth
ServicePrincipalAuthentication o InteractiveLoginAuthentication
valor predeterminado: None

Objeto de autenticación. Para más información, consulte https://aka.ms/aml-notebook-auth. Si es None (Ninguno), se usarán las credenciales predeterminadas de la CLI de Azure o la API solicitará las credenciales.

subscription_id
str
valor predeterminado: None

Identificador de la suscripción que se va a usar. El parámetro es necesario si el usuario tiene acceso a más de una suscripción.

resource_group
str
valor predeterminado: None

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.

location
str
valor predeterminado: None

Ubicación del área de trabajo.

cloud
str
valor predeterminado: AzureCloud

Nombre de la nube de destino. Puede ser "AzureCloud", "AzureChinaCloud" o "AzureUSGovernment". Si no se especifica ninguna nube, se usa "AzureCloud".

id
str
valor predeterminado: None

Identificador del área de trabajo.

Devoluciones

Objeto de área de trabajo.

Tipo de valor devuelto

get_connection

Obtiene una conexión del área de trabajo.

get_connection(name)

Parámetros

name
str
Requerido

Nombre único de la conexión en el área de trabajo

get_default_compute_target

Obtiene el destino de proceso predeterminado del área de trabajo.

get_default_compute_target(type)

Parámetros

type
str
Requerido

Tipo de proceso. Los valores posibles son "CPU" o "GPU".

Devoluciones

Destino de proceso predeterminado para un tipo de proceso determinado.

Tipo de valor devuelto

get_default_datastore

Obtiene el almacén de datos predeterminado del área de trabajo.

get_default_datastore()

Devoluciones

El almacén de datos predeterminado.

Tipo de valor devuelto

get_default_keyvault

Obtiene el objeto de almacén de claves predeterminado del área de trabajo.

get_default_keyvault()

Devoluciones

Objeto KeyVault asociado al área de trabajo.

Tipo de valor devuelto

get_details

Devuelve los detalles del área de trabajo.

get_details()

Devoluciones

Detalles del área de trabajo en formato de diccionario.

Tipo de valor devuelto

Comentarios

El diccionario devuelto contiene los siguientes pares clave-valor.

  • id: identificador 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: región del área de trabajo.

  • type: identificador URI con el formato "{providerName}/workspaces".

  • tags: no se usa actualmente.

  • workspaceid: identificador de esta área de trabajo.

  • description: no se usa actualmente.

  • friendlyName: nombre descriptivo del área de trabajo que se muestra en la interfaz de usuario.

  • creationTime: hora en la que se creó esta área de trabajo, en formato ISO8601.

  • containerRegistry: registro de contenedor del área de trabajo usado para extraer e insertar imágenes de experimentación y de servicios web.

  • keyVault: almacén de claves del área de trabajo utilizado para almacenar las credenciales que los usuarios agreguen al área de trabajo.

  • applicationInsights: el área de trabajo usará la instancia de Application Insights para registrar los eventos de los servicios web.

  • identityPrincipalId

  • identityTenantId

  • identityType

  • storageAccount: el área de trabajo usará el almacenamiento para guardar las salidas de la ejecución, el código, los registros, etc.

  • sku: SKU del área de trabajo (también denominada edición). El parámetro está presente por compatibilidad con versiones anteriores y se omite.

  • resourceCmkUri: URI de la clave administrada por el cliente para cifrar los datos en reposo. Consulte https://docs.microsoft.com/en-us/azure-stack/user/azure-stack-key-vault-manage-portal?view=azs-1910 para conocer los pasos sobre cómo crear una clave y obtener su identificador URI.

  • hbiWorkspace: especifica si los datos del cliente tienen un gran impacto empresarial.

  • imageBuildCompute: destino de proceso para la creación de imágenes.

  • systemDatastoresAuthMode: determina si se deben usar o no 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 más información sobre estos pares clave-valor, vea create.

get_mlflow_tracking_uri

Obtiene el identificador URI de seguimiento de MLflow del área de trabajo.

MLflow (https://mlflow.org/) es una plataforma de código abierto para el seguimiento de experimentos de aprendizaje automático y la administración de 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

_with_auth
bool
valor predeterminado: False

(EN DESUSO) Agrega la información de autenticación al identificador URI de seguimiento.

Devoluciones

Identificador URI de seguimiento compatible con MLflow.

Tipo de valor devuelto

str

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

Devuelve la ejecución con el valor de run_id especificado en el área de trabajo.

get_run(run_id)

Parámetros

run_id
string
Requerido

Id. de ejecución.

Devoluciones

Ejecución enviada.

Tipo de valor devuelto

Run

list

Enumera 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

subscription_id
str
Requerido

Identificador de la suscripción para la que se enumeran las áreas de trabajo.

auth
ServicePrincipalAuthentication o InteractiveLoginAuthentication
valor predeterminado: None

Objeto de autenticación. Para más información, consulte https://aka.ms/aml-notebook-auth. Si es None (Ninguno), se usarán las credenciales predeterminadas de la CLI de Azure o la API solicitará las credenciales.

resource_group
str
valor predeterminado: None

Grupo de recursos para filtrar las áreas de trabajo devueltas. Si es None (Ninguno), el método enumerará todas las áreas de trabajo dentro de la suscripción especificada.

Devoluciones

Diccionario en el que la clave es el nombre del área de trabajo y el valor es una lista de objetos de área de trabajo.

Tipo de valor devuelto

list_connections

Enumera las conexiones de esta área de trabajo.

list_connections(category=None, target=None)

Parámetros

type
str
valor predeterminado: None

Tipo de esta conexión por el que se filtrará.

target
str
valor predeterminado: None

Destino de esta conexión por el que se filtrará.

list_keys

Enumera las claves del área de trabajo actual.

list_keys()

Tipo de valor devuelto

set_connection

Agrega o actualiza una conexión del área de trabajo.

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

Parámetros

name
str
Requerido

Nombre único de la conexión en el área de trabajo

category
str
Requerido

Categoría de esta conexión.

target
str
Requerido

Destino al que se conecta esta conexión.

authType
str
Requerido

Tipo de autorización de esta conexión.

value
str
Requerido

Cadena de serialización en formato JSON de los detalles de la conexión.

set_default_datastore

Establece el almacén de datos predeterminado del área de trabajo.

set_default_datastore(name)

Parámetros

name
str
Requerido

Nombre del elemento Datastore que se establecerá como valor predeterminado.

setup

Crea un área de trabajo o recupera una existente.

static setup()

Devoluciones

Objeto de área de trabajo.

Tipo de valor devuelto

sync_keys

Desencadena que el área de trabajo sincronice las claves inmediatamente.

Si se cambian las claves de cualquier recurso del área de trabajo, pueden tardar aproximadamente una hora en actualizarse automáticamente. Esta función permite que las claves se actualicen a petición. Un escenario de ejemplo es la necesidad de acceso inmediato al almacenamiento después de regenerar las claves de almacenamiento.

sync_keys(no_wait=False)

Parámetros

no_wait
bool
valor predeterminado: False

Indica si se debe esperar a que se complete la sincronización de claves del área de trabajo.

Devoluciones

None (Ninguno) si es correcto; en caso contrario, produce un error.

Tipo de valor devuelto

update

Actualiza el nombre descriptivo, la descripción, las etiquetas, el proceso de compilación de imágenes y otras configuraciones 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

friendly_name
str
valor predeterminado: None

Nombre descriptivo para el área de trabajo que se puede mostrar en la interfaz de usuario.

description
str
valor predeterminado: None

Descripción del área de trabajo.

tags
dict
valor predeterminado: None

Etiquetas que se van a asociar al área de trabajo.

image_build_compute
str
valor predeterminado: None

Nombre del proceso para la creación de la imagen.

service_managed_resources_settings
<xref:azureml._base_sdk_common.workspace.models.ServiceManagedResourcesSettings>
valor predeterminado: None

Configuración de los recursos administrados por el servicio.

primary_user_assigned_identity
str
valor predeterminado: None

Identificador de recurso de identidad asignado por el usuario que representa la identidad del área de trabajo.

allow_public_access_when_behind_vnet
bool
valor predeterminado: None

Permite el acceso público al área de trabajo de vínculo privado.

v1_legacy_mode
bool
valor predeterminado: None

Impedir el uso del servicio de API v2 en una instancia pública de Azure Resource Manager

Devoluciones

Diccionario de información actualizada.

Tipo de valor devuelto

update_dependencies

Actualiza los recursos asociados existentes para el área de trabajo en los casos siguientes.

a) Cuando un usuario elimina accidentalmente un recurso asociado y quiere actualizarlo con uno nuevo sin tener que volver a crear toda el área de trabajo. b) Cuando un usuario tiene un recurso asociado y quiere reemplazar el actual que está asociado al área de trabajo. c) Cuando aún no se ha creado un recurso asociado y el usuario quiere usar uno existente que ya tiene (solo se aplica al registro de contenedor).

update_dependencies(container_registry=None, force=False)

Parámetros

container_registry
str
valor predeterminado: None

Identificador de ARM para el registro de contenedor.

force
bool
valor predeterminado: False

Si se fuerza la actualización de los recursos dependientes sin solicitar confirmación.

write_config

Escribe 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 método from_config. El elemento path tiene el valor predeterminado ".azureml/" en el directorio de trabajo actual y el valor predeterminado de file_name es "config.json".

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 ARM del área de trabajo mediante esta función y usar from_config para cargar la misma área de trabajo en otros cuadernos o proyectos de Python sin volver a escribir las propiedades de ARM del área de trabajo.

write_config(path=None, file_name=None)

Parámetros

path
str
valor predeterminado: None

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.

file_name
str
valor predeterminado: None

Nombre que se usará para el archivo de configuración. El parámetro tiene como valor predeterminado config.json.

Atributos

compute_targets

Enumera todos los destinos de proceso del área de trabajo.

Devoluciones

Diccionario con la clave como nombre de destino de proceso y el valor como objeto ComputeTarget.

Tipo de valor devuelto

datasets

Enumera todos los conjuntos de datos del área de trabajo.

Devoluciones

Diccionario con la clave como nombre de conjunto de datos y el valor como objeto Dataset.

Tipo de valor devuelto

datastores

Enumera todos los almacenes de datos del área de trabajo. Esta operación no devuelve las credenciales de los almacenes de datos.

Devoluciones

Diccionario con la clave como nombre de almacén de datos y el valor como objeto Datastore.

Tipo de valor devuelto

discovery_url

Devuelve la dirección URL de detección de esta área de trabajo.

Devoluciones

Dirección URL de detección de esta área de trabajo.

Tipo de valor devuelto

str

environments

Enumera todos los entornos del área de trabajo.

Devoluciones

Diccionario con la clave como nombre de entorno y el valor como objeto Environment.

Tipo de valor devuelto

experiments

Enumera todos los experimentos del área de trabajo.

Devoluciones

Diccionario con la clave como nombre de experimento y el valor como objeto Experiment.

Tipo de valor devuelto

images

Devuelve la lista de imágenes del área de trabajo.

Emite una excepción WebserviceException si se produce un problema al interactuar con el servicio de administración de modelos.

Devoluciones

Diccionario con la clave como nombre de imagen y el valor como objeto Image.

Tipo de valor devuelto

Excepciones

Se produjo un problema al interactuar con el servicio de administración de modelos.

linked_services

Enumera todos los servicios vinculados del área de trabajo.

Devoluciones

Diccionario en el que la clave es un nombre de servicio vinculado y el valor es un objeto LinkedService.

Tipo de valor devuelto

location

Devuelve la ubicación de esta área de trabajo.

Devoluciones

Ubicación de esta área de trabajo.

Tipo de valor devuelto

str

models

Devuelve una lista de modelos del área de trabajo.

Emite una excepción WebserviceException si se produce un problema al interactuar con el servicio de administración de modelos.

Devoluciones

Diccionario de modelo con la clave como nombre de modelo y el valor como objeto Model.

Tipo de valor devuelto

Excepciones

Se produjo un problema al interactuar con el servicio de administración de modelos.

name

Devuelve el nombre del área de trabajo.

Devoluciones

Nombre del área de trabajo.

Tipo de valor devuelto

str

private_endpoints

Enumera todos los puntos de conexión privados del área de trabajo.

Devoluciones

Diccionario de objetos PrivateEndPoint asociados al área de trabajo. La clave es el nombre del punto de conexión privado.

Tipo de valor devuelto

resource_group

Devuelve el nombre del grupo de recursos para esta área de trabajo.

Devoluciones

El nombre del grupo de recursos.

Tipo de valor devuelto

str

service_context

Devuelve el contexto de servicio para esta área de trabajo.

Devoluciones

Devuelve el objeto ServiceContext.

Tipo de valor devuelto

<xref:azureml._restclient.service_context.ServiceContext>

sku

Devuelve la SKU de esta área de trabajo.

Devoluciones

SKU de esta área de trabajo.

Tipo de valor devuelto

str

subscription_id

Devuelve el identificador de suscripción de esta área de trabajo.

Devoluciones

Identificador de la suscripción.

Tipo de valor devuelto

str

tags

Devuelve las etiquetas de esta área de trabajo.

Devoluciones

Etiquetas de esta área de trabajo.

Tipo de valor devuelto

webservices

Devuelve una lista de servicios web del área de trabajo.

Genera una excepción WebserviceException si se produjo un problema al devolver la lista.

Devoluciones

Lista de servicios web del área de trabajo.

Tipo de valor devuelto

Excepciones

Se produjo 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'