AmlCompute Clase

Referencia

Administra un proceso de Azure Machine Learning en Azure Machine Learning.

Un Proceso de Azure Machine Learning (AmlCompute) es una infraestructura de proceso administrada que permite al usuario crear fácilmente un proceso de uno o varios nodos. El proceso se crea dentro de la región del área de trabajo como un recurso que se puede compartir con otros usuarios. Para más información, consulte ¿Qué son los destinos de proceso en Azure Machine Learning?

Constructor ComputeTarget de clase.

Recupere una representación en la nube de un objeto Compute asociado al área de trabajo proporcionada. Devuelve una instancia de una clase secundaria correspondiente al tipo específico del objeto Compute recuperado.

Herencia: ComputeTarget

AmlCompute

Constructor

AmlCompute(workspace, name)

Parámetros

Nombre	Description
workspace Requerido	Workspace Objeto de área de trabajo que contiene el objeto AmlCompute que se recuperará.
name Requerido	str Nombre del objeto AmlCompute que se recuperará.
workspace Requerido	Workspace Objeto de área de trabajo que contiene el objeto Compute que se recuperará.
name Requerido	str Nombre del objeto Compute que se va a recuperar.

Comentarios

En el ejemplo siguiente, se crea un destino de proceso persistente aprovisionado por AmlCompute. El parámetro provisioning_configuration de este ejemplo es de tipo AmlComputeProvisioningConfiguration, que es una clase secundaria de ComputeTargetProvisioningConfiguration.


   from azureml.core.compute import ComputeTarget, AmlCompute
   from azureml.core.compute_target import ComputeTargetException

   # Choose a name for your CPU cluster
   cpu_cluster_name = "cpu-cluster"

   # Verify that cluster does not exist already
   try:
       cpu_cluster = ComputeTarget(workspace=ws, name=cpu_cluster_name)
       print('Found existing cluster, use it.')
   except ComputeTargetException:
       compute_config = AmlCompute.provisioning_configuration(vm_size='STANDARD_D2_V2',
                                                              max_nodes=4)
       cpu_cluster = ComputeTarget.create(ws, cpu_cluster_name, compute_config)

   cpu_cluster.wait_for_completion(show_output=True)

El ejemplo completo está disponible en https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/training/train-on-amlcompute/train-on-amlcompute.ipynb.

Métodos

add_identity	Agrega el tipo de identidad o los id. de identidad para este destino de AmlCompute.
delete	Quita el objeto AmlCompute de su área de trabajo asociada.
deserialize	Convierte un objeto JSON en un objeto AmlCompute.
detach	La desasociación no se admite para el objeto AmlCompute. En su lugar, use delete.
get	Devuelve el objeto de proceso.
get_active_runs	Devuelve un generador de las ejecuciones de este proceso.
get_status	Recupera el estado detallado actual del clúster de AmlCompute.
list_nodes	Obtenga los detalles (por ejemplo, dirección IP, puerto, etc.) de todos los nodos de proceso del destino de proceso.
list_quotas	Obtiene las cuotas de área de trabajo asignadas actualmente en función de VMFamily para un área de trabajo y una suscripción determinadas.
list_usages	Obtiene la información de la utilización actual, así como los límites de recursos de AML para un área de trabajo y una suscripción determinadas.
provisioning_configuration	Crea un objeto de configuración para aprovisionar un destino de AmlCompute.
refresh_state	Realiza una actualización local de las propiedades del objeto. Este método actualiza las propiedades en función del estado actual del objeto de nube correspondiente. Se usa principalmente para el sondeo manual del estado de proceso.
remove_identity	Quita la identidad del proceso.
serialize	Convierte este objeto AmlCompute en un diccionario serializado JSON.
supported_vmsizes	Muestra los tamaños de máquina virtual admitidos de una región.
update	Actualiza el valor de ScaleSettings de este destino de AmlCompute.
update_quotas	Actualiza la cuota de una familia de máquinas virtuales del área de trabajo.
wait_for_completion	Espera a que el clúster de AmlCompute termine de aprovisionarse. Se puede configurar para esperar un número mínimo de nodos y para agotar el tiempo de espera después de un período de tiempo establecido.

add_identity

Agrega el tipo de identidad o los id. de identidad para este destino de AmlCompute.

add_identity(identity_type, identity_id=None)

Parámetros

Nombre	Description
identity_type Requerido	string Los valores posibles son: SystemAssigned: identidad asignada por el sistema UserAssigned: identidad asignada por el usuario. Requiere que se establezca el id. de identidad.
identity_id	list[str] Lista de id. de recursos para la identidad asignada por el usuario. P. ej. ['/subscriptions//resourceGroups//providers/Microsoft.ManagedIdentity /userAssignedIdentities/'] Valor predeterminado: None

Comentarios

identity_id solo se debe especificar cuando identity_type == UserAssigned

delete

Quita el objeto AmlCompute de su área de trabajo asociada.

delete()

Excepciones

Tipo	Description
ComputeTargetException

Comentarios

Si este objeto se creó mediante Azure Machine Learning, también se eliminarán los objetos basados en la nube correspondientes. Si este objeto se creó externamente y solo está asociado al área de trabajo, se genera una excepción ComputeTargetException y no cambia nada.

deserialize

Convierte un objeto JSON en un objeto AmlCompute.

static deserialize(workspace, object_dict)

Parámetros

Nombre	Description
workspace Requerido	Workspace Objeto de área de trabajo al que está asociado el objeto AmlCompute.
object_dict Requerido	dict Objeto JSON que se convertirá en un objeto AmlCompute.

Devoluciones

Tipo	Description
AmlCompute	Representación de AmlCompute del objeto JSON proporcionado.

Excepciones

Tipo	Description
ComputeTargetException

Comentarios

Genera una excepción ComputeTargetException si el área de trabajo proporcionada no es el área de trabajo a la que está asociado el proceso.

detach

La desasociación no se admite para el objeto AmlCompute. En su lugar, use delete.

detach()

Excepciones

Tipo	Description
ComputeTargetException

get

Devuelve el objeto de proceso.

get()

get_active_runs

Devuelve un generador de las ejecuciones de este proceso.

get_active_runs(type=None, tags=None, properties=None, status=None)

Parámetros

Nombre	Description
type	str Filtra el generador de ejecuciones devuelto por el tipo proporcionado. Consulte add_type_provider para crear tipos de ejecución. Valor predeterminado: None
tags	str o dict Filtra las ejecuciones por "etiqueta" o {"etiqueta": "valor"} Valor predeterminado: None
properties	str o dict Filtra las ejecuciones por "propiedad" o {"propiedad": "valor"}. Valor predeterminado: None
status	str Estado de ejecución: "En ejecución" o "En cola" Valor predeterminado: None

Devoluciones

Tipo	Description
<xref:builtin.generator>	Un generador de ~_restclient.models.RunDto

get_status

Recupera el estado detallado actual del clúster de AmlCompute.

get_status()

Devoluciones

Tipo	Description
AmlComputeStatus	Objeto de estado detallado del clúster.

list_nodes

Obtenga los detalles (por ejemplo, dirección IP, puerto, etc.) de todos los nodos de proceso del destino de proceso.

list_nodes()

Devoluciones

Tipo	Description
list	Detalles de todos los nodos de proceso del destino de proceso.

list_quotas

Obtiene las cuotas de área de trabajo asignadas actualmente en función de VMFamily para un área de trabajo y una suscripción determinadas.

static list_quotas(workspace, location=None)

Parámetros

Nombre	Description
workspace Requerido	Workspace
location	str Ubicación de las cuotas. Si no se especifica, el valor predeterminado será la ubicación del área de trabajo. Valor predeterminado: None

Devoluciones

Tipo	Description
list	Lista de cuotas de área de trabajo asignadas actualmente basadas en VMFamily.

list_usages

Obtiene la información de la utilización actual, así como los límites de recursos de AML para un área de trabajo y una suscripción determinadas.

static list_usages(workspace, show_all=False, location=None)

Parámetros

Nombre	Description
workspace Requerido	Workspace
show_all	Especifica si se requieren utilizaciones detalladas de recursos secundarios. El valor predeterminado es False. Valor predeterminado: False
location	str Ubicación de los recursos. Si no se especifica, el valor predeterminado será la ubicación del área de trabajo. Valor predeterminado: None

Devoluciones

Tipo	Description
list	Lista de la información de uso actual, así como los límites de recursos de AML.

provisioning_configuration

Crea un objeto de configuración para aprovisionar un destino de AmlCompute.

static provisioning_configuration(vm_size='', vm_priority='dedicated', min_nodes=0, max_nodes=None, idle_seconds_before_scaledown=1800, admin_username=None, admin_user_password=None, admin_user_ssh_key=None, vnet_resourcegroup_name=None, vnet_name=None, subnet_name=None, tags=None, description=None, remote_login_port_public_access='NotSpecified', identity_type=None, identity_id=None, location=None, enable_node_public_ip=True)

Parámetros

Nombre	Description
vm_size Requerido	str Tamaño de las máquinas virtuales de agente. Se pueden encontrar más detalles aquí: https://aka.ms/azureml-vm-details. Tenga en cuenta que no todos los tamaños están disponibles en todas las regiones, como se detalla en el vínculo anterior. Si no se especifica, el valor predeterminado es Standard_NC6.
vm_priority	str Prioridad de máquina virtual, dedicated o lowpriority. Valor predeterminado: dedicated
min_nodes	int Número mínimo de nodos que se usarán en el clúster. Si no se especifica, el valor predeterminado es 0. Valor predeterminado: 0
max_nodes	int Número máximo de nodos que se usarán en el clúster. Si no se especifica, el valor predeterminado es 4. Valor predeterminado: None
idle_seconds_before_scaledown	int Tiempo de inactividad del nodo en segundos antes de reducir verticalmente el clúster. Si no se especifica, el valor predeterminado es 1800. Valor predeterminado: 1800
admin_username	str Nombre de la cuenta de usuario administrador que se puede usar para SSH en nodos. Valor predeterminado: None
admin_user_password	str Contraseña de la cuenta de usuario administrador. Valor predeterminado: None
admin_user_ssh_key	str Clave pública SSH de la cuenta de usuario administrador. Valor predeterminado: None
vnet_resourcegroup_name	str Nombre del grupo de recursos donde se encuentra la red virtual. Valor predeterminado: None
vnet_name	str El nombre de la red virtual. Valor predeterminado: None
subnet_name	str Nombre de la subred dentro de la red virtual. Valor predeterminado: None
tags	dict[str, str] Diccionario de etiquetas de valor de clave que se proporcionan al objeto de proceso. Valor predeterminado: None
description	str Descripción que se proporciona al objeto de proceso. Valor predeterminado: None
remote_login_port_public_access	str Estado del puerto SSH público. Los valores posibles son: Disabled: indica que el puerto SSH público está cerrado en todos los nodos del clúster. Enabled: indica que el puerto SSH público está abierto en todos los nodos del clúster. NotSpecified: indica que el puerto SSH público está cerrado en todos los nodos del clúster si se define la red virtual; de lo contrario, está abierto en todos los nodos públicos. Puede ser este valor predeterminado solo durante el tiempo de creación del clúster. Después de la creación, estará habilitado o deshabilitado. Valor predeterminado: NotSpecified
identity_type	string Los valores posibles son: SystemAssigned: identidad asignada por el sistema UserAssigned: identidad asignada por el usuario. Requiere que se establezca el id. de identidad. Valor predeterminado: None
identity_id	list[str] Lista de id. de recursos para la identidad asignada por el usuario. P. ej. ['/subscriptions//resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/'] Valor predeterminado: None
location	str Ubicación en la que aprovisionar el clúster. Valor predeterminado: None
enable_node_public_ip	bool Habilita la dirección IP pública del nodo. Los valores posibles son: True: habilitar la dirección IP pública del nodo. False: deshabilitar la dirección IP pública del nodo. NotSpecified: habilitar la dirección IP pública del nodo. Valor predeterminado: True

Devoluciones

Tipo	Description
AmlComputeProvisioningConfiguration	Objeto de configuración que se va a usar al crear un objeto de proceso.

Excepciones

Tipo	Description
ComputeTargetException

refresh_state

Realiza una actualización local de las propiedades del objeto.

Este método actualiza las propiedades en función del estado actual del objeto de nube correspondiente. Se usa principalmente para el sondeo manual del estado de proceso.

refresh_state()

remove_identity

Quita la identidad del proceso.

remove_identity(identity_id=None)

Parámetros

Nombre	Description
identity_id	list[str] Identidades asignadas por el usuario Valor predeterminado: None

Comentarios

La identidad asignada por el sistema se quitará automáticamente si identity_id no se especifica.

serialize

Convierte este objeto AmlCompute en un diccionario serializado JSON.

serialize()

Devoluciones

Tipo	Description
dict	Representación JSON de este objeto AmlCompute.

supported_vmsizes

Muestra los tamaños de máquina virtual admitidos de una región.

static supported_vmsizes(workspace, location=None)

Parámetros

Nombre	Description
workspace Requerido	Workspace
location	str Ubicación del clúster. Si no se especifica, el valor predeterminado será la ubicación del área de trabajo. Valor predeterminado: None

Devoluciones

Tipo	Description
list	Lista de tamaños de máquina virtual admitidos en una región con los nombres de la máquina virtual, las VCPU y la RAM.

update

Actualiza el valor de ScaleSettings de este destino de AmlCompute.

update(min_nodes=None, max_nodes=None, idle_seconds_before_scaledown=None)

Parámetros

Nombre	Description
min_nodes	int Número mínimo de nodos que se usarán en el clúster. Valor predeterminado: None
max_nodes	int Número máximo de nodos que se usarán en el clúster. Valor predeterminado: None
idle_seconds_before_scaledown	int Tiempo de inactividad del nodo en segundos antes de reducir verticalmente el clúster. Valor predeterminado: None

update_quotas

Actualiza la cuota de una familia de máquinas virtuales del área de trabajo.

static update_quotas(workspace, vm_family, limit=None, location=None)

Parámetros

Nombre	Description
workspace Requerido	Workspace
vm_family Requerido	str Nombre de familia de máquinas virtuales.
limit	int Cuota máxima permitida del recurso. Valor predeterminado: None
location	str Ubicación de la cuota. Si no se especifica, el valor predeterminado será la ubicación del área de trabajo. Valor predeterminado: None

wait_for_completion

Espera a que el clúster de AmlCompute termine de aprovisionarse.

Se puede configurar para esperar un número mínimo de nodos y para agotar el tiempo de espera después de un período de tiempo establecido.

wait_for_completion(show_output=False, min_node_count=None, timeout_in_minutes=25, is_delete_operation=False)

Parámetros

Nombre	Description
show_output	bool Valor booleano para proporcionar una salida más detallada. Valor predeterminado: False
min_node_count	int Número mínimo de nodos que hay que esperar antes de considerar que el aprovisionamiento se ha completado. No tiene que ser igual al número mínimo de nodos con los que se aprovisionó el proceso, pero no debe ser mayor que él. Valor predeterminado: None
timeout_in_minutes	int La duración en minutos que hay que esperar antes de considerar que el aprovisionamiento ha generador errores. Valor predeterminado: 25
is_delete_operation	bool Indica si la operación está pensada para eliminarse. Valor predeterminado: False

Excepciones

Tipo	Description
ComputeTargetException

Compartir a través de

AmlCompute Clase

Constructor

Parámetros

Comentarios

Métodos

add_identity

Parámetros

Comentarios

delete

Excepciones

Comentarios

deserialize

Parámetros

Devoluciones

Excepciones

Comentarios

detach

Excepciones

get

get_active_runs

Parámetros

Devoluciones

get_status

Devoluciones

list_nodes

Devoluciones

list_quotas

Parámetros

Devoluciones

list_usages

Parámetros

Devoluciones

provisioning_configuration

Parámetros

Devoluciones

Excepciones

refresh_state

remove_identity

Parámetros

Comentarios

serialize

Devoluciones

supported_vmsizes

Parámetros

Devoluciones

update

Parámetros

update_quotas

Parámetros

wait_for_completion

Parámetros

Excepciones

Comentarios

Recursos adicionales