Delen via

AmlCompute Klas

  • Referentie

Beheert een Azure Machine Learning-berekening in Azure Machine Learning.

Een Azure Machine Learning Compute (AmlCompute) is een beheerde rekeninfrastructuur waarmee u eenvoudig berekeningen met één of meerdere knooppunten kunt maken. De berekening wordt in uw werkruimteregio gemaakt als een resource die kan worden gedeeld met andere gebruikers. Zie Wat zijn rekendoelen in Azure Machine Learning? voor meer informatie.

Klasse ComputeTarget-constructor.

Haal een cloudweergave op van een compute-object dat is gekoppeld aan de opgegeven werkruimte. Retourneert een exemplaar van een onderliggende klasse die overeenkomt met het specifieke type van het opgehaalde Compute-object.

Overname
ComputeTarget
AmlCompute

Constructor

AmlCompute(workspace, name)

Parameters

Name Description
workspace
Vereist
Workspace

Het werkruimteobject met het AmlCompute-object dat moet worden opgehaald.
name
Vereist
str

De naam van het AmlCompute-object dat moet worden opgehaald.
workspace
Vereist
Workspace

Het werkruimteobject met het rekenobject dat moet worden opgehaald.
name
Vereist
str

De naam van het rekenobject dat moet worden opgehaald.

Opmerkingen

In het volgende voorbeeld wordt een permanent rekendoel gemaakt dat is ingericht door AmlCompute . De provisioning_configuration parameter in dit voorbeeld is van het type AmlComputeProvisioningConfiguration. Dit is een onderliggende klasse van 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)

Het volledige voorbeeld is beschikbaar via https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/training/train-on-amlcompute/train-on-amlcompute.ipynb

Methoden

add_identity

Voeg identiteitstype en/of identiteits-id's toe voor dit AmlCompute-doel.
delete

Verwijder het AmlCompute-object uit de bijbehorende werkruimte.
deserialize

Converteer een JSON-object naar een AmlCompute-object.
detach

Loskoppelen wordt niet ondersteund voor het AmlCompute-object. Gebruik in plaats daarvan delete.
get

Retourneer rekenobject.
get_active_runs

Retourneert een generator van de uitvoeringen voor deze berekening.
get_status

Haal de huidige gedetailleerde status voor het AmlCompute-cluster op.
list_nodes

Haal de details op (bijvoorbeeld IP-adres, poort, enzovoort) van alle rekenknooppunten in het rekendoel.
list_quotas

Haal de momenteel toegewezen werkruimtequota op op basis van VMFamily voor de opgegeven werkruimte en het abonnement.
list_usages

Haal de huidige gebruiksgegevens en limieten voor AML-resources op voor een bepaalde werkruimte en abonnement.
provisioning_configuration

Maak een configuratieobject voor het inrichten van een AmlCompute-doel.
refresh_state

Voer een in-place update van de eigenschappen van het object uit.

Met deze methode worden de eigenschappen bijgewerkt op basis van de huidige status van het bijbehorende cloudobject. Dit wordt voornamelijk gebruikt voor handmatige polling van de rekenstatus.
remove_identity

Verwijder de identiteit op de berekening.
serialize

Converteer dit AmlCompute-object naar een geserialiseerde JSON-woordenlijst.
supported_vmsizes

De ondersteunde VM-grootten in een regio weergeven.
update

Werk de ScaleSettings bij voor dit AmlCompute-doel.
update_quotas

Quotum bijwerken voor een VM-familie in de werkruimte.
wait_for_completion

Wacht tot het AmlCompute-cluster is ingericht.

Dit kan worden geconfigureerd om te wachten op een minimum aantal knooppunten en om een time-out na een ingestelde periode.

add_identity

Voeg identiteitstype en/of identiteits-id's toe voor dit AmlCompute-doel.

add_identity(identity_type, identity_id=None)

Parameters

Name Description
identity_type
Vereist
string

Mogelijke waarden zijn:

  • SystemAssigned - Door het systeem toegewezen identiteit

  • UserAssigned - Door de gebruiker toegewezen identiteit. Vereist dat de id is ingesteld.
identity_id
list[str]

Lijst met resource-id's voor de door de gebruiker toegewezen identiteit. bijvoorbeeld ['/subscriptions//resourceGroups//providers/Microsoft.ManagedIdentity /userAssignedIdentities/']

Default value: None

Opmerkingen

identity_id mag alleen worden opgegeven wanneer identity_type == UserAssigned

delete

Verwijder het AmlCompute-object uit de bijbehorende werkruimte.

delete()

Uitzonderingen

Type Description
ComputeTargetException

Opmerkingen

Als dit object is gemaakt via Azure Machine Learning, worden de bijbehorende cloudobjecten ook verwijderd. Als dit object extern is gemaakt en alleen aan de werkruimte is gekoppeld, wordt met deze methode een ComputeTargetException gegenereerd en wordt er niets gewijzigd.

deserialize

Converteer een JSON-object naar een AmlCompute-object.

static deserialize(workspace, object_dict)

Parameters

Name Description
workspace
Vereist
Workspace

Het werkruimteobject waar het AmlCompute-object aan is gekoppeld.
object_dict
Vereist
dict

Een JSON-object dat moet worden geconverteerd naar een AmlCompute-object.

Retouren

Type Description
AmlCompute

De AmlCompute-weergave van het opgegeven JSON-object.

Uitzonderingen

Type Description
ComputeTargetException

Opmerkingen

Verhoogt een ComputeTargetException als de opgegeven werkruimte niet de werkruimte is die de compute is gekoppeld.

detach

Loskoppelen wordt niet ondersteund voor het AmlCompute-object. Gebruik in plaats daarvan delete.

detach()

Uitzonderingen

Type Description
ComputeTargetException

get

Retourneer rekenobject.

get()

get_active_runs

Retourneert een generator van de uitvoeringen voor deze berekening.

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

Parameters

Name Description
type
str

Filter de geretourneerde generator van uitvoeringen op het opgegeven type. Zie add_type_provider voor het maken van uitvoeringstypen.

Default value: None
tags
str of dict

Filter wordt uitgevoerd op "tag" of {"tag": "value"}

Default value: None
properties
str of dict

Filter wordt uitgevoerd op 'eigenschap' of {'property': 'value'}

Default value: None
status
str

Uitvoeringsstatus - 'Wordt uitgevoerd' of 'In wachtrij'

Default value: None

Retouren

Type Description
<xref:builtin.generator>

een generator van ~_restclient.models.RunDto

get_status

Haal de huidige gedetailleerde status voor het AmlCompute-cluster op.

get_status()

Retouren

Type Description
AmlComputeStatus

Een gedetailleerd statusobject voor het cluster

list_nodes

Haal de details op (bijvoorbeeld IP-adres, poort, enzovoort) van alle rekenknooppunten in het rekendoel.

list_nodes()

Retouren

Type Description
list

De details van alle rekenknooppunten in het rekendoel.

list_quotas

Haal de momenteel toegewezen werkruimtequota op op basis van VMFamily voor de opgegeven werkruimte en het abonnement.

static list_quotas(workspace, location=None)

Parameters

Name Description
workspace
Vereist
Workspace
location
str

De locatie van de quota. Als dit niet is opgegeven, wordt standaard de locatie van de werkruimte ingesteld.

Default value: None

Retouren

Type Description
list

Lijst met momenteel toegewezen werkruimtequota op basis van VMFamily

list_usages

Haal de huidige gebruiksgegevens en limieten voor AML-resources op voor een bepaalde werkruimte en abonnement.

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

Parameters

Name Description
workspace
Vereist
Workspace
show_all

Hiermee geeft u op of gedetailleerde gebruiksgegevens van onderliggende resources vereist zijn. Standaard ingesteld op False.

Default value: False
location
str

De locatie van de resources. Als dit niet is opgegeven, wordt standaard de locatie van de werkruimte ingesteld.

Default value: None

Retouren

Type Description
list

Lijst met huidige gebruiksgegevens en limieten voor AML-resources

provisioning_configuration

Maak een configuratieobject voor het inrichten van een AmlCompute-doel.

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)

Parameters

Name Description
vm_size
Vereist
str

De grootte van agent-VM's. Meer informatie vindt u hier: https://aka.ms/azureml-vm-details. Houd er rekening mee dat niet alle grootten beschikbaar zijn in alle regio's, zoals beschreven in de vorige koppeling. Als dit niet is opgegeven, wordt standaard ingesteld op Standard_NC6.
vm_priority
str

De VM-prioriteit, toegewezen of lage prioriteit.

Default value: dedicated
min_nodes
int

Het minimale aantal knooppunten dat in het cluster moet worden gebruikt. Als dit niet is opgegeven, wordt de standaardwaarde ingesteld op 0.

Default value: 0
max_nodes
int

Het maximum aantal knooppunten dat op het cluster moet worden gebruikt. Als dit niet is opgegeven, wordt de standaardwaarde ingesteld op 4.

Default value: None
idle_seconds_before_scaledown
int

Knooppunt inactieve tijd in seconden voordat het cluster omlaag wordt geschaald. Als dit niet is opgegeven, wordt de standaardwaarde 1800.

Default value: 1800
admin_username
str

De naam van het beheerdersaccount dat kan worden gebruikt voor SSH in knooppunten.

Default value: None
admin_user_password
str

Het wachtwoord van het beheerdersaccount.

Default value: None
admin_user_ssh_key
str

De openbare SSH-sleutel van het beheerdersaccount.

Default value: None
vnet_resourcegroup_name
str

De naam van de resourcegroep waarin het virtuele netwerk zich bevindt.

Default value: None
vnet_name
str

De naam van het virtuele netwerk.

Default value: None
subnet_name
str

De naam van het subnet in het VNet.

Default value: None
tags
dict[str, str]

Een woordenlijst met sleutelwaardetags die aan het rekenobject moeten worden verstrekt.

Default value: None
description
str

Een beschrijving die moet worden opgegeven voor het rekenobject.

Default value: None
remote_login_port_public_access
str

Status van de openbare SSH-poort. Mogelijke waarden zijn:

  • Uitgeschakeld: geeft aan dat de openbare SSH-poort is gesloten op alle knooppunten van het cluster.

  • Ingeschakeld: geeft aan dat de openbare SSH-poort is geopend op alle knooppunten van het cluster.

  • NotSpecified: geeft aan dat de openbare SSH-poort is gesloten op alle knooppunten van het cluster als VNet is gedefinieerd, anders zijn alle openbare knooppunten geopend. Dit kan deze standaardwaarde alleen zijn tijdens het maken van het cluster. Na het maken wordt het in- of uitgeschakeld.

Default value: NotSpecified
identity_type
string

Mogelijke waarden zijn:

  • SystemAssigned - Door het systeem toegewezen identiteit

  • UserAssigned - Door de gebruiker toegewezen identiteit. Vereist dat de id is ingesteld.

Default value: None
identity_id
list[str]

Lijst met resource-id's voor de door de gebruiker toegewezen identiteit. bijvoorbeeld ['/subscriptions//resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/']

Default value: None
location
str

Locatie waarin het cluster moet worden ingericht.

Default value: None
enable_node_public_ip
bool

Schakel het openbare IP-adres van het knooppunt in. Mogelijke waarden zijn:

  • True: schakel het openbare IP-adres van het knooppunt in.

  • False: schakel het openbare IP-adres van het knooppunt uit.

  • NotSpecified: schakel het openbare IP-adres van het knooppunt in.

Default value: True

Retouren

Type Description
AmlComputeProvisioningConfiguration

Een configuratieobject dat moet worden gebruikt bij het maken van een compute-object.

Uitzonderingen

Type Description
ComputeTargetException

refresh_state

Voer een in-place update van de eigenschappen van het object uit.

Met deze methode worden de eigenschappen bijgewerkt op basis van de huidige status van het bijbehorende cloudobject. Dit wordt voornamelijk gebruikt voor handmatige polling van de rekenstatus.

refresh_state()

remove_identity

Verwijder de identiteit op de berekening.

remove_identity(identity_id=None)

Parameters

Name Description
identity_id
list[str]

Door de gebruiker toegewezen identiteiten

Default value: None

Opmerkingen

Door het systeem toegewezen identiteit wordt automatisch verwijderd als identity_id niet is opgegeven

serialize

Converteer dit AmlCompute-object naar een geserialiseerde JSON-woordenlijst.

serialize()

Retouren

Type Description
dict

De JSON-weergave van dit AmlCompute-object.

supported_vmsizes

De ondersteunde VM-grootten in een regio weergeven.

static supported_vmsizes(workspace, location=None)

Parameters

Name Description
workspace
Vereist
Workspace
location
str

De locatie van het cluster. Als dit niet is opgegeven, wordt standaard de werkruimtelocatie gebruikt.

Default value: None

Retouren

Type Description
list

Een lijst met ondersteunde VM-grootten in een regio met namen van de VM, VCPU's en RAM-geheugen.

update

Werk de ScaleSettings bij voor dit AmlCompute-doel.

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

Parameters

Name Description
min_nodes
int

Het minimale aantal knooppunten dat in het cluster moet worden gebruikt.

Default value: None
max_nodes
int

Het maximum aantal knooppunten dat op het cluster moet worden gebruikt.

Default value: None
idle_seconds_before_scaledown
int

De inactieve tijd van het knooppunt in seconden voordat het cluster omlaag wordt geschaald.

Default value: None

update_quotas

Quotum bijwerken voor een VM-familie in de werkruimte.

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

Parameters

Name Description
workspace
Vereist
Workspace
vm_family
Vereist
str

NAAM VAN VM-familie
limit
int

Het maximaal toegestane quotum van de resource

Default value: None
location
str

De locatie van het quotum. Als dit niet is opgegeven, wordt standaard de werkruimtelocatie gebruikt.

Default value: None

wait_for_completion

Wacht tot het AmlCompute-cluster is ingericht.

Dit kan worden geconfigureerd om te wachten op een minimum aantal knooppunten en om een time-out na een ingestelde periode.

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

Parameters

Name Description
show_output
bool

Booleaanse waarde voor uitgebreidere uitvoer.

Default value: False
min_node_count
int

Minimum aantal knooppunten waarop moet worden gewacht voordat het inrichten is voltooid. Dit hoeft niet gelijk te zijn aan het minimale aantal knooppunten waarmee de berekening is ingericht, maar het mag niet groter zijn dan dat.

Default value: None
timeout_in_minutes
int

De duur in minuten om te wachten voordat het inrichten is mislukt.

Default value: 25
is_delete_operation
bool

Hiermee wordt aangegeven of de bewerking is bedoeld om te worden verwijderd.

Default value: False

Uitzonderingen

Type Description
ComputeTargetException