Condividi tramite

LocalWebservice Classe

  • Riferimento

Rappresenta un modello di Machine Learning distribuito come endpoint servizio Web locale.

La distribuzione dei servizi Web in locale è utile per gli scenari di debug e test.

Costruttore del servizio Web locale.

Il costruttore LocalWebservice viene usato per recuperare una rappresentazione locale di un oggetto LocalWebservice associato all'area di lavoro specificata.

Ereditarietà
Webservice
LocalWebservice

Costruttore

LocalWebservice(*args, **kwargs)

Parametri

Nome Descrizione
workspace
Necessario
Workspace

Oggetto area di lavoro contenente tutti gli oggetti Model che verranno recuperati.
name
Necessario
str

Nome dell'oggetto Webservice da recuperare.
must_exist
Necessario
bool

Indica se il servizio Web deve esistere già durante la creazione dell'oggetto in memoria.
workspace
Necessario
Workspace

Oggetto area di lavoro contenente tutti gli oggetti Model che verranno recuperati.
name
Necessario
str

Nome dell'oggetto LocalWebservice da recuperare.
must_exist
Necessario
bool

Indica se il servizio Web deve esistere già durante la creazione dell'oggetto in memoria.

Commenti

Gli esempi di codice seguenti illustrano come creare un servizio Web Docker locale. Per altri dettagli, vedere il collegamento al notebook.


   from azureml.core.webservice import LocalWebservice

   # This is optional, if not provided Docker will choose a random unused port.
   deployment_config = LocalWebservice.deploy_configuration(port=6789)

   local_service = Model.deploy(ws, "test", [model], inference_config, deployment_config)

   local_service.wait_for_deployment()

L'esempio completo è disponibile da https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/deployment/deploy-to-local/register-model-deploy-local.ipynb

Metodi

delete

Eliminare questo LocalWebservice dal computer locale.

Questa chiamata di funzione non è asincrona; viene eseguito fino a quando il servizio non viene eliminato.
deploy_configuration

Creare un oggetto di configurazione per la distribuzione di un servizio Web locale.
deploy_to_cloud

Distribuire un servizio Web in base alla configurazione di LocalWebservice.
deserialize

Convertire un oggetto JSON di risposta del servizio di gestione modelli in un oggetto Webservice.

Nota

Non supportato per LocalWebservice.
get_keys

Recuperare le chiavi di autenticazione per questo servizio Web.

Nota

Non supportato per LocalWebservice.
get_logs

Recuperare i log per questo LocalWebservice.
get_token

Recuperare il token di autenticazione per questo servizio Web, con ambito all'utente corrente.

Nota

Non supportato per LocalWebservice.
list

Elencare i servizi LocalWeb associati all'area di lavoro corrispondente.

I risultati restituiti possono essere filtrati usando parametri.
regen_key

Rigenerare una delle chiavi del servizio Web.

Nota

Non supportato per LocalWebservice.
reload

Ricaricare lo script di esecuzione e le dipendenze di LocalWebservice.

In questo modo il contenitore del servizio viene riavviato con copie di asset aggiornati, inclusi lo script di esecuzione e le dipendenze locali, ma non ricompila l'immagine sottostante. Di conseguenza, le modifiche alle dipendenze Conda/pip o ai passaggi Docker personalizzati non verranno riflesse nel localwebservice ricaricato. Per gestire tali modifiche, chiamare invece il update metodo .
run

Chiamare questo LocalWebservice con l'input specificato.
serialize

Convertire questo oggetto Webservice in un dizionario serializzato JSON.
update

Aggiornare LocalWebservice con le proprietà specificate.

I valori lasciati come None rimarranno invariati in questo LocalWebservice.
update_deployment_state

Aggiornare lo stato corrente dell'oggetto in memoria.

Eseguire un aggiornamento sul posto delle proprietà dell'oggetto in base allo stato corrente del contenitore Docker locale corrispondente.
wait_for_deployment

Eseguire il polling della distribuzione LocalWebservice in esecuzione.

delete

Eliminare questo LocalWebservice dal computer locale.

Questa chiamata di funzione non è asincrona; viene eseguito fino a quando il servizio non viene eliminato.

delete(delete_cache=True, delete_image=False, delete_volume=True)

Parametri

Nome Descrizione
delete_cache
Necessario
bool

Indica se eliminare i file temporanei memorizzati nella cache per il servizio. (Impostazione predefinita: True)
delete_image
Necessario
bool

Indica se eliminare l'immagine Docker del servizio. (Impostazione predefinita: False)
delete_volume
Necessario
bool

Indica se eliminare il volume Docker del servizio. (Impostazione predefinita: True)

Eccezioni

Tipo Descrizione
WebserviceException

deploy_configuration

Creare un oggetto di configurazione per la distribuzione di un servizio Web locale.

static deploy_configuration(port=None)

Parametri

Nome Descrizione
port
int

La porta locale su cui esporre l'endpoint HTTP del servizio.

Valore predefinito: None

Restituisce

Tipo Descrizione
LocalWebserviceDeploymentConfiguration

Oggetto di configurazione da utilizzare per la distribuzione di un oggetto Servizio Web.

Eccezioni

Tipo Descrizione
WebserviceException

deploy_to_cloud

Distribuire un servizio Web in base alla configurazione di LocalWebservice.

deploy_to_cloud(name=None, deployment_config=None, deployment_target=None)

Parametri

Nome Descrizione
name
str

Nome da assegnare al servizio distribuito. Deve essere univoco per l'area di lavoro.

Valore predefinito: None
deployment_config
WebserviceDeploymentConfiguration

Oggetto WebserviceDeploymentConfiguration usato per configurare il servizio Web. Se non ne viene specificato uno, verrà usato un oggetto di configurazione vuoto in base alla destinazione desiderata.

Valore predefinito: None
deployment_target
ComputeTarget

Oggetto ComputeTarget in cui distribuire il servizio Web. Poiché ACI non ha associato ComputeTarget, lasciare questo parametro come Nessuno per la distribuzione in ACI.

Valore predefinito: None

Restituisce

Tipo Descrizione
Webservice

Oggetto Servizio Web corrispondente al servizio Web distribuito.

Eccezioni

Tipo Descrizione
WebserviceException

deserialize

Convertire un oggetto JSON di risposta del servizio di gestione modelli in un oggetto Webservice.

Nota

Non supportato per LocalWebservice.

deserialize(workspace, webservice_payload)

Parametri

Nome Descrizione
cls
Necessario
workspace
Necessario
Workspace

L'oggetto area di lavoro in cui è registrato il servizio Web.
webservice_payload
Necessario
dict

Oggetto JSON da convertire in un oggetto Webservice.

Eccezioni

Tipo Descrizione
azureml.exceptions.NotImplementedError

get_keys

Recuperare le chiavi di autenticazione per questo servizio Web.

Nota

Non supportato per LocalWebservice.

get_keys()

Restituisce

Tipo Descrizione

Chiavi di autenticazione per questo servizio Web.

Eccezioni

Tipo Descrizione
azureml.exceptions.NotImplementedError

get_logs

Recuperare i log per questo LocalWebservice.

get_logs(num_lines=5000, raw=False)

Parametri

Nome Descrizione
num_lines
Necessario
int

Numero massimo di righe di log da recuperare. (Impostazione predefinita: 5000)
raw
Necessario
bool

Restituisce l'output del contenitore Docker non elaborato senza tentare di formattarlo. (Impostazione predefinita: False)

Restituisce

Tipo Descrizione
str

Log per questo LocalWebservice.

Eccezioni

Tipo Descrizione
WebserviceException

get_token

Recuperare il token di autenticazione per questo servizio Web, con ambito all'utente corrente.

Nota

Non supportato per LocalWebservice.

get_token()

Restituisce

Tipo Descrizione
str, datetime

Token di autenticazione per questo servizio Web e quando deve essere aggiornato dopo.

Eccezioni

Tipo Descrizione
azureml.exceptions.NotImplementedError

list

Elencare i servizi LocalWeb associati all'area di lavoro corrispondente.

I risultati restituiti possono essere filtrati usando parametri.

static list(workspace, model_name=None, model_id=None, all=None)

Parametri

Nome Descrizione
workspace
Necessario
Workspace

Oggetto Workspace associato a LocalWebservices.
model_name
str

Elenco di filtri per includere solo LocalWebservices distribuiti con il nome del modello specifico.

Valore predefinito: None
model_id
str

Elenco di filtri per includere solo LocalWebservices distribuiti con l'ID modello specifico.

Valore predefinito: None
all
bool

Mostra tutti i servizi. Per impostazione predefinita, vengono visualizzati solo i servizi in esecuzione.

Valore predefinito: None

Restituisce

Tipo Descrizione
list[LocalWebservice]

Elenco filtrato di LocalWebservices associati all'area di lavoro specificata.

Eccezioni

Tipo Descrizione
WebserviceException

regen_key

Rigenerare una delle chiavi del servizio Web.

Nota

Non supportato per LocalWebservice.

regen_key(key)

Parametri

Nome Descrizione
key
Necessario
str

Chiave da rigenerare. Le opzioni sono 'Primary' o 'Secondary'

Eccezioni

Tipo Descrizione
NotImplementedError

reload

Ricaricare lo script di esecuzione e le dipendenze di LocalWebservice.

In questo modo il contenitore del servizio viene riavviato con copie di asset aggiornati, inclusi lo script di esecuzione e le dipendenze locali, ma non ricompila l'immagine sottostante. Di conseguenza, le modifiche alle dipendenze Conda/pip o ai passaggi Docker personalizzati non verranno riflesse nel localwebservice ricaricato. Per gestire tali modifiche, chiamare invece il update metodo .

reload(wait=False)

Parametri

Nome Descrizione
wait
Necessario
bool

Attendere che il contenitore del servizio raggiunga uno stato integro. (Impostazione predefinita: False)

Eccezioni

Tipo Descrizione
WebserviceException

run

Chiamare questo LocalWebservice con l'input specificato.

run(input_data)

Parametri

Nome Descrizione
input_data
Necessario
<xref:varies>

Input con cui chiamare LocalWebservice.

Restituisce

Tipo Descrizione
<xref:varies>

Risultato della chiamata a LocalWebservice.

Eccezioni

Tipo Descrizione
WebserviceException

serialize

Convertire questo oggetto Webservice in un dizionario serializzato JSON.

serialize()

Restituisce

Tipo Descrizione
dict

Rappresentazione serializzata dell'oggetto Webservice.

Eccezioni

Tipo Descrizione
WebserviceException

update

Aggiornare LocalWebservice con le proprietà specificate.

I valori lasciati come None rimarranno invariati in questo LocalWebservice.

update(models=None, image_config=None, deployment_config=None, wait=False, inference_config=None)

Parametri

Nome Descrizione
models
Necessario
list[Model]

Nuovo elenco di modelli contenuti in LocalWebservice.
image_config
Necessario
ContainerImageConfig

Opzioni di configurazione delle immagini da applicare a LocalWebservice.
deployment_config
Necessario
LocalWebserviceDeploymentConfiguration

Opzioni di configurazione della distribuzione da applicare a LocalWebservice.
inference_config
Necessario
InferenceConfig

Oggetto InferenceConfig usato per fornire le proprietà di distribuzione del modello necessarie.
wait
Necessario
bool

Attendere che il contenitore del servizio raggiunga uno stato integro. (Impostazione predefinita: False)

Restituisce

Tipo Descrizione
None

Eccezioni

Tipo Descrizione
WebserviceException

update_deployment_state

Aggiornare lo stato corrente dell'oggetto in memoria.

Eseguire un aggiornamento sul posto delle proprietà dell'oggetto in base allo stato corrente del contenitore Docker locale corrispondente.

update_deployment_state(must_exist=False)

Parametri

Nome Descrizione
must_exist
bool

Indica se il servizio Web deve esistere già durante la creazione dell'oggetto in memoria.

Valore predefinito: False

Eccezioni

Tipo Descrizione
WebserviceException

wait_for_deployment

Eseguire il polling della distribuzione LocalWebservice in esecuzione.

wait_for_deployment(show_output=False)

Parametri

Nome Descrizione
show_output
Necessario
bool

Opzione per stampare un output più dettagliato. (Impostazione predefinita: False)

Eccezioni

Tipo Descrizione
WebserviceException

Attributi

port

Ottenere la porta del servizio Web locale.

Restituisce

Tipo Descrizione
int

Numero porta.

scoring_uri

Ottenere l'URI di assegnazione dei punteggi del servizio Web locale.

Restituisce

Tipo Descrizione
str

URI di assegnazione dei punteggi.

swagger_uri

Ottenere l'URI Swagger del servizio Web locale.

Restituisce

Tipo Descrizione
str

URI di Swagger.

NETWORK_NAME 

NETWORK_NAME = 'azureml-local'

STATE_DELETED 

STATE_DELETED = 'deleted'

STATE_DEPLOYING 

STATE_DEPLOYING = 'deploying'

STATE_FAILED 

STATE_FAILED = 'failed'

STATE_RUNNING 

STATE_RUNNING = 'running'

STATE_UNKNOWN 

STATE_UNKNOWN = 'unknown'