AciWebservice Klasse

Referenz

Stellt ein Machine Learning-Modell dar, das als Webdienst-Endpunkt in Azure Container Instances bereitgestellt wird.

Ein bereitgestellter Dienst wird aus einem Modell, einem Skript und zugehörigen Dateien erstellt. Der resultierende Webdienst ist ein HTTP-Endpunkt mit Lastenausgleich und einer REST-API. Sie können Daten an diese API senden und die vom Modell zurückgegebene Vorhersage empfangen.

Weitere Informationen finden Sie unter Bereitstellen eines Modells in Azure Container Instances.

Initialisieren Sie die Webdienst-instance.

Der Webdienstkonstruktor ruft eine Clouddarstellung eines Webdienstobjekts ab, das dem bereitgestellten Arbeitsbereich zugeordnet ist. Es wird eine instance einer untergeordneten Klasse zurückgegeben, die dem spezifischen Typ des abgerufenen Webdienstobjekts entspricht.

Vererbung: Webservice

AciWebservice

Konstruktor

AciWebservice(workspace, name)

Parameter

Name	Beschreibung
workspace Erforderlich	Workspace Das Arbeitsbereichsobjekt, das das abzurufende Webdienstobjekt enthält.
name Erforderlich	str Der Name des abzurufenden Webdienstobjekts.

Hinweise

Das empfohlene Bereitstellungsmuster besteht darin, ein Bereitstellungskonfigurationsobjekt mit der deploy_configuration-Methode zu erstellen und es dann wie unten dargestellt mit der deploy-Methode der Model-Klasse zu verwenden.


   from azureml.core.model import InferenceConfig
   from azureml.core.webservice import AciWebservice


   service_name = 'my-custom-env-service'

   inference_config = InferenceConfig(entry_script='score.py', environment=environment)
   aci_config = AciWebservice.deploy_configuration(cpu_cores=1, memory_gb=1)

   service = Model.deploy(workspace=ws,
                          name=service_name,
                          models=[model],
                          inference_config=inference_config,
                          deployment_config=aci_config,
                          overwrite=True)
   service.wait_for_deployment(show_output=True)

Es gibt eine Reihe von Möglichkeiten, ein Modell als Webdienst bereitzustellen, darunter die folgenden:

deploy-Methode des Model für bereits im Arbeitsbereich registrierte Modelle.
deploy_from_image-Methode des Webservice.
deploy_from_model-Methode des Webservice für bereits im Arbeitsbereich registrierte Modelle. Mit dieser Methode wird ein Image erstellt.
deploy-Methode des Webservice, mit der ein Modell registriert und ein Image erstellt wird.

Informationen zum Arbeiten mit Webdiensten finden Sie unter

Im Abschnitt Variablen werden Attribute einer lokalen Darstellung des Cloud-AciWebservice-Objekts aufgeführt. Diese Variablen sollten als schreibgeschützt betrachtet werden. Das Ändern ihrer Werte wird im entsprechenden Cloudobjekt nicht widergespiegelt.

Variablen

Name	Beschreibung
enable_app_insights	bool Gibt an, ob die AppInsights-Protokollierung für den Webdienst aktiviert ist.
cname	str Der CNAME für den Webdienst.
container_resource_requirements	ContainerResourceRequirements Die Containerressourcenanforderungen für den Webdienst.
encryption_properties	EncryptionProperties Die Verschlüsselungseigenschaften für den Webdienst.
vnet_configuration	VnetConfiguration Die Eigenschaften des virtuellen Netzwerks für den Webdienst. Die Konfiguration muss vom Benutzer erstellt und bereitgestellt werden.
azureml.core.webservice.AciWebservice.location	str Der Speicherort, an dem der Webdienst bereitgestellt wird.
public_ip	str Die öffentliche IP-Adresse des Webdiensts.
azureml.core.webservice.AciWebservice.scoring_uri	str Der Bewertungsendpunkt für den Webdienst.
ssl_enabled	bool Gibt an, ob SSL für den Webdienst aktiviert ist
public_fqdn	str Der öffentliche FQDN für den Webdienst
environment	Environment Das Umgebungsobjekt, das zum Erstellen des Webdiensts verwendet wurde
azureml.core.webservice.AciWebservice.models	list[Model] Eine Liste der im Webdienst bereitgestellten Modelle
azureml.core.webservice.AciWebservice.swagger_uri	str Der Swagger-Endpunkt für den Webdienst

Methoden

add_properties	Fügen Sie dem Eigenschaftenwörterbuch dieses Webdiensts Schlüssel-Wert-Paare hinzu.
add_tags	Fügen Sie dem Tagwörterbuch dieses Webdiensts Schlüssel-Wert-Paare hinzu.
deploy_configuration	Erstellt ein Konfigurationsobjekt für die Bereitstellung eines AciWebservice.
get_token	Ruft das Authentifizierungstoken für diesen Webdienst ab, das auf den aktuellen Benutzer beschränkt ist. Hinweis Nicht implementiert.
remove_tags	Die angegebenen Schlüssel aus dem Wörterbuch der Tags dieses Webdiensts entfernen.
run	Ruft diesen Webdienst mit der bereitgestellten Eingabe auf.
serialize	Konvertiert diesen Webdienst in ein serialisiertes JSON-Schlüsselverzeichnis.
update	Den Webdienst mit den bereitgestellten Eigenschaften aktualisieren. Werte, die als „None“ belassen werden, bleiben in diesem Webdienst unverändert.

add_properties

Fügen Sie dem Eigenschaftenwörterbuch dieses Webdiensts Schlüssel-Wert-Paare hinzu.

add_properties(properties)

Parameter

Name	Beschreibung
properties Erforderlich	dict[str, str] Das Wörterbuch der hinzuzufügenden Eigenschaften.

add_tags

Fügen Sie dem Tagwörterbuch dieses Webdiensts Schlüssel-Wert-Paare hinzu.

add_tags(tags)

Parameter

Name	Beschreibung
tags Erforderlich	dict[str, str] Das Wörterbuch der hinzuzufügenden Tags.

Ausnahmen

Typ	Beschreibung
WebserviceException

deploy_configuration

Erstellt ein Konfigurationsobjekt für die Bereitstellung eines AciWebservice.

static deploy_configuration(cpu_cores=None, memory_gb=None, tags=None, properties=None, description=None, location=None, auth_enabled=None, ssl_enabled=None, enable_app_insights=None, ssl_cert_pem_file=None, ssl_key_pem_file=None, ssl_cname=None, dns_name_label=None, primary_key=None, secondary_key=None, collect_model_data=None, cmk_vault_base_url=None, cmk_key_name=None, cmk_key_version=None, vnet_name=None, subnet_name=None)

Parameter

Name	Beschreibung
cpu_cores	float Die Anzahl von CPU-Kernen, die für diesen Webdienst zugeordnet werden sollen. Kann eine Dezimalzahl sein. Der Standardwert ist 0.1 Standardwert: None
memory_gb	float Menge an Arbeitsspeicher (in GB), die für diesen Webdienst zugeordnet werden soll. Kann eine Dezimalzahl sein. Der Standardwert ist 0.5 Standardwert: None
tags	dict[str, str] Ein Wörterbuch der Schlüsselwerttags für diesen Webdienst. Standardwert: None
properties	dict[str, str] Ein Wörterbuch der Schlüsselwerteigenschaften für diesen Webdienst. Diese Eigenschaften können nach der Bereitstellung nicht mehr geändert werden. Es können jedoch neue Schlüssel-Wert-Paare hinzugefügt werden. Standardwert: None
description	str Eine Beschreibung für diesen Webdienst. Standardwert: None
location	str Die Azure-Region, in der dieser Webdienst bereitgestellt werden soll. Wenn keine Region angegeben ist, wird der Standort des Arbeitsbereichs verwendet. Weitere Details zu verfügbaren Regionen finden Sie unter Verfügbare Produkte nach Region. Standardwert: None
auth_enabled	bool Gibt an, ob die Authentifizierung für diesen Webdienst aktiviert werden soll. Der Standardwert lautet „False“. Standardwert: None
ssl_enabled	bool Gibt an, ob für diesen Webdienst SSL aktiviert werden soll. Der Standardwert lautet „False“. Standardwert: None
enable_app_insights	bool Gibt an, ob für diesen Webdienst AppInsights aktiviert werden soll. Der Standardwert lautet „False“. Standardwert: None
ssl_cert_pem_file	str Die benötigte CERT-Datei, wenn SSL aktiviert ist. Standardwert: None
ssl_key_pem_file	str Die benötigte KEY-Datei, wenn SSL aktiviert ist. Standardwert: None
ssl_cname	str Der CNAME, wenn SSL aktiviert ist. Standardwert: None
dns_name_label	str Die DNS-Namensbezeichnung für den Bewertungsendpunkt. Ist keine eindeutige DNS-Namensbezeichnung angegeben, wird eine für den Bewertungsendpunkt generiert. Standardwert: None
primary_key	str Ein primärer Authentifizierungsschlüssel, der für diesen Webdienst verwendet werden soll. Standardwert: None
secondary_key	str Ein sekundärer Authentifizierungsschlüssel, der für diesen Webdienst verwendet werden soll. Standardwert: None
collect_model_data	bool Gibt an, ob die Modelldatensammlung für den Webdienst aktiviert werden soll. Standardwert: None
cmk_vault_base_url	str Die Basis-URL des kundenseitig verwalteten Schlüsseltresors. Standardwert: None
cmk_key_name	str Der Name des kundenseitig verwalteten Schlüssels. Standardwert: None
cmk_key_version	str Die Version des kundenseitig verwalteten Schlüssels. Standardwert: None
vnet_name	str Der Name des virtuellen Netzwerks. Standardwert: None
subnet_name	str Der Subnetzname innerhalb des virtuellen Netzwerks. Standardwert: None

Gibt zurück

Typ	Beschreibung
AciServiceDeploymentConfiguration	Ein Konfigurationsobjekt, das beim Bereitstellen eines Webdienstobjekts verwendet werden soll.

Ausnahmen

Typ	Beschreibung
WebserviceException

get_token

Ruft das Authentifizierungstoken für diesen Webdienst ab, das auf den aktuellen Benutzer beschränkt ist.

Hinweis

Nicht implementiert.

get_token()

Gibt zurück

Typ	Beschreibung
str, datetime	Das Authentifizierungstoken für diesen Webdienst und nach welcher Zeit es aktualisiert werden soll.

Ausnahmen

Typ	Beschreibung
azureml.exceptions.NotImplementedError

remove_tags

Die angegebenen Schlüssel aus dem Wörterbuch der Tags dieses Webdiensts entfernen.

remove_tags(tags)

Parameter

Name	Beschreibung
tags Erforderlich	list[str] Die Liste der zu entfernenden Schlüssel.

run

Ruft diesen Webdienst mit der bereitgestellten Eingabe auf.

run(input_data)

Parameter

Name	Beschreibung
input_data Erforderlich	<xref:varies> Die Eingabe zum Aufrufen des Webdiensts

Gibt zurück

Typ	Beschreibung
dict	Das Ergebnis des Aufrufs des Webdiensts.

Ausnahmen

Typ	Beschreibung
WebserviceException

serialize

Konvertiert diesen Webdienst in ein serialisiertes JSON-Schlüsselverzeichnis.

serialize()

Gibt zurück

Typ	Beschreibung
dict	Die JSON-Darstellung dieses Webdienstobjekts.

update

Den Webdienst mit den bereitgestellten Eigenschaften aktualisieren.

Werte, die als „None“ belassen werden, bleiben in diesem Webdienst unverändert.

update(image=None, tags=None, properties=None, description=None, auth_enabled=None, ssl_enabled=None, ssl_cert_pem_file=None, ssl_key_pem_file=None, ssl_cname=None, enable_app_insights=None, models=None, inference_config=None)

Parameter

Name	Beschreibung
image	Image Ein neues Image, das für den Webdienst bereitgestellt werden soll. Standardwert: None
tags	dict[str, str] Ein Wörterbuch der Schlüsselwerttags für diesen Webdienst. Ersetzt vorhandene Tags. Standardwert: None
properties	dict[str, str] Ein Wörterbuch mit Schlüsselwerteigenschaften, die vorhandenen Eigenschaftenwörterbüchern hinzugefügt werden. Standardwert: None
description	str Eine Beschreibung für diesen Webdienst Standardwert: None
auth_enabled	bool Aktiviert oder deaktiviert die Authentifizierung für diesen Webdienst. Standardwert: None
ssl_enabled	bool Gibt an, ob für diesen Webdienst SSL aktiviert werden soll. Standardwert: None
ssl_cert_pem_file	str Die benötigte CERT-Datei, wenn SSL aktiviert ist. Standardwert: None
ssl_key_pem_file	str Die benötigte KEY-Datei, wenn SSL aktiviert ist. Standardwert: None
ssl_cname	str Der CNAME, wenn SSL aktiviert ist. Standardwert: None
enable_app_insights	bool Gibt an, ob für diesen Webdienst AppInsights aktiviert werden soll. Standardwert: None
models	list[Model] Eine Liste der Modellobjekte, die in den aktualisierten Dienst gepackt werden sollen. Standardwert: None
inference_config	InferenceConfig Ein InferenceConfig-Objekt, das zum Bereitstellen der erforderlichen Eigenschaften der Modellimplementierung verwendet wird. Standardwert: None

Gibt zurück

Typ	Beschreibung
None

Freigeben über

AciWebservice Klasse

Konstruktor

Parameter

Hinweise

Variablen

Methoden

add_properties

Parameter

add_tags

Parameter

Ausnahmen

deploy_configuration

Parameter

Gibt zurück

Ausnahmen

get_token

Gibt zurück

Ausnahmen

remove_tags

Parameter

run

Parameter

Gibt zurück

Ausnahmen

serialize

Gibt zurück

update

Parameter

Gibt zurück

Feedback

Zusätzliche Ressourcen