Requisiti dei container personalizzati per la previsione

Per utilizzare un container personalizzato in modo da ottenere previsioni da un modello con addestramento personalizzato, devi fornire a Vertex AI un'immagine container Docker che esegue un server HTTP. Questo documento descrive i requisiti che un'immagine container deve soddisfare per essere compatibile con Vertex AI. Il documento descrive anche in che modo Vertex AI interagisce con il container personalizzato una volta avviata l'esecuzione. In altre parole, questo documento descrive cosa devi considerare quando progetti un'immagine container da utilizzare con Vertex AI.

Per informazioni dettagliate sull'utilizzo di un'immagine container personalizzata per la pubblicazione di previsioni, consulta Utilizzare un container personalizzato.

Requisiti delle immagini container

Quando l'immagine container Docker viene eseguita come container, quest'ultimo deve eseguire un server HTTP. Nello specifico, il container deve ascoltare e rispondere ai controlli di attività, ai controlli di integrità e alle richieste di previsione. Le seguenti sottosezioni descrivono in dettaglio questi requisiti.

Puoi implementare il server HTTP in qualsiasi modo e utilizzando qualsiasi linguaggio di programmazione, purché soddisfi i requisiti illustrati in questa sezione. Ad esempio, puoi scrivere un server HTTP personalizzato utilizzando un framework web come Flask o utilizzare un software di machine learning (ML) che esegue un server HTTP, come TensorFlow Serving, TorchServe o KServe Python Server.

Esegui il server HTTP.

Puoi eseguire un server HTTP utilizzando un'istruzione ENTRYPOINT, un'istruzione CMD o entrambe nel Dockerfile che utilizzi per creare l'immagine container. Scopri di più sull'interazione tra CMD e ENTRYPOINT.

In alternativa, puoi specificare i campi containerSpec.command e containerSpec.args quando crei la risorsa Model per eseguire l'override rispettivamente dei valori ENTRYPOINT e CMD dell'immagine container. Se specifichi uno di questi campi, puoi utilizzare un'immagine container che altrimenti non soddisferebbe i requisiti a causa di un valore ENTRYPOINT o CMD incompatibile (o inesistente).

Indipendentemente da quale sia il comando eseguito dal container all'avvio, assicurati che questo comando del punto di ingresso venga eseguito all'infinito. Ad esempio, non eseguire un comando che avvia un server HTTP in background e poi si chiude; in questo caso, il container si chiuderà subito dopo l'avvio.

Il tuo server HTTP deve rimanere in ascolto delle richieste su 0.0.0.0 su una porta a tua scelta. Quando crei un Model, specifica questa porta nel campo containerSpec.ports. Per informazioni su come il container può accedere a questo valore, leggi la sezione di questo documento sulla variabile di ambiente AIP_HTTP_PORT.

Controlli di attività

Vertex AI esegue un controllo di attività quando il container inizia per assicurarsi che il server sia in esecuzione. Quando esegui il deployment di un modello con addestramento personalizzato in una risorsa Endpoint, Vertex AI utilizza un probe di attività TCP per tentare di stabilire una connessione TCP al container sulla porta configurata. Il probe effettua fino a 4 tentativi di stabilire una connessione, attendendo 10 secondi dopo ogni errore. Se il probe non ha ancora stabilito una connessione a questo punto, Vertex AI riavvia il container.

Il server HTTP non deve eseguire alcun comportamento speciale per gestire questi controlli. Finché rimane in ascolto delle richieste sulla porta configurata, il probe di attività è in grado di stabilire una connessione.

Controlli di integrità

Facoltativamente, puoi specificare startup_probe o health_probe.

Il probe di avvio controlla se l'applicazione container è stata avviata. Se non viene fornito il probe di avvio, non è previsto alcun probe di avvio e i controlli di integrità vengono avviati immediatamente. Se viene fornito il probe di avvio, i controlli di integrità non vengono eseguiti fino al completamento del probe di avvio.

Le applicazioni legacy che potrebbero richiedere tempi di avvio aggiuntivi alla prima inizializzazione devono configurare un probe di avvio. Ad esempio, se l'applicazione deve copiare gli artefatti del modello da un'origine esterna, è necessario configurare un probe di avvio in modo che restituisca un risultato positivo al termine dell'inizializzazione.

Il probe di integrità controlla se un container è pronto ad accettare il traffico. Se il probe di integrità non è fornito, Vertex AI utilizza i controlli di integrità predefiniti come descritto in Controlli di integrità predefiniti.

Le applicazioni legacy che non restituiscono 200 OK per indicare che il modello è caricato e pronto ad accettare il traffico devono configurare un probe di integrità. Ad esempio, un'applicazione potrebbe restituire 200 OK per indicare l'esito positivo anche se lo stato di caricamento del modello effettivo nel corpo della risposta indica che il modello potrebbe non essere caricato e, di conseguenza, non essere pronto ad accettare il traffico. In questo caso, un probe di integrità deve essere configurato in modo che restituisca un errore solo quando il modello viene caricato ed è pronto a gestire il traffico.

Per eseguire un probe, Vertex AI esegue il comando exec specificato nel container di destinazione. Se il comando ha esito positivo, restituisce 0 e il container è considerato attivo e integro.

Controlli di integrità predefiniti

Per impostazione predefinita, Vertex AI esegue a intermittenza controlli di integrità sul server HTTP mentre è in esecuzione per garantire che sia pronto a gestire le richieste di previsione. Il servizio utilizza un probe di integrità per inviare richieste GET HTTP a un percorso di controllo di integrità configurabile sul tuo server. Specifica questo percorso nel campo containerSpec.healthRoute quando crei un Model. Per informazioni su come il container può accedere a questo valore, leggi la sezione di questo documento sulla variabile di ambiente AIP_HEALTH_ROUTE.

Configura il server HTTP in modo che risponda a ogni richiesta di controllo di integrità come segue:

  • Se il server è pronto a gestire le richieste di previsione, rispondi alla richiesta di controllo di integrità entro 10 secondi con il codice di stato 200 OK. I contenuti del corpo della risposta non sono importanti; Vertex AI li ignora.

    Questa risposta indica che il server è integro.

  • Se il server non è pronto a gestire le richieste di previsione, non rispondere alla richiesta di controllo di integrità entro 10 secondi e non rispondere con un codice di stato ad eccezione di 200 OK. Ad esempio, rispondi con il codice di stato 503 Service Unavailable.

    Questa risposta (o l'assenza di una risposta) indica che il server non è integro.

Se il probe di integrità riceve una risposta non integro dal server (inclusa nessuna risposta entro 10 secondi), invia fino a tre controlli di integrità aggiuntivi a intervalli di 10 secondi. Durante questo periodo, Vertex AI considera comunque il tuo server integro. Se il probe riceve una risposta integro a uno di questi controlli, torna immediatamente alla programmazione intermittente dei controlli di integrità. Tuttavia, se il probe riceve quattro risposte non integre consecutive, Vertex AI interrompe l'indirizzamento del traffico di previsione al container. Se la risorsa DeployedModel è scalata per l'utilizzo di più nodi di previsione, Vertex AI instrada le richieste di previsione ad altri container integre.

Vertex AI non riavvia il container, ma il probe di integrità continua a inviare richieste di controllo di integrità intermittente al server in stato non integro. Se riceve una risposta integro, contrassegna il container come integro e inizia a instradare nuovamente il traffico di previsione.

Indicazioni pratiche

In alcuni casi, è sufficiente che il server HTTP nel tuo container risponda sempre con il codice di stato 200 OK ai controlli di integrità. Se il container carica le risorse prima di avviare il server, significa che non è integro durante il periodo di avvio e in tutti i periodi in cui si verifica un errore del server HTTP. In tutti gli altri momenti, risponde come salutare.

Per una configurazione più sofisticata, potrebbe essere utile progettare intenzionalmente il server HTTP in modo che risponda ai controlli di integrità con stato non integro in determinati momenti. Ad esempio, potresti voler bloccare il traffico di previsione verso un nodo per un periodo per consentire al container di eseguire la manutenzione.

Richieste di previsione

Quando un client invia una richiesta projects.locations.endpoints.predict all'API Vertex AI, Vertex AI inoltra questa richiesta come richiesta HTTP POST a un percorso di previsione configurabile sul tuo server. Specifica questo percorso nel campo containerSpec.predictRoute quando crei un Model. Per informazioni su come il container può accedere a questo valore, leggi la sezione di questo documento sulla variabile di ambiente AIP_PREDICT_ROUTE.

Requisiti per le richieste

Se viene eseguito il deployment del modello in un endpoint pubblico, ogni richiesta di previsione deve essere pari o inferiore a 1,5 MB. Il server HTTP deve accettare richieste di previsione che hanno l'intestazione HTTP Content-Type: application/json e il corpo JSON con il seguente formato:

{
  "instances": INSTANCES,
  "parameters": PARAMETERS
}

In queste richieste:

  • INSTANCES è un array di uno o più valori JSON di qualsiasi tipo. Ogni valore rappresenta un'istanza per cui stai fornendo una previsione.

  • PARAMETERS è un oggetto JSON contenente tutti i parametri richiesti dal container per fornire previsioni sulle istanze. Vertex AI considera il campo parameters facoltativo, quindi puoi progettare il tuo container in modo da richiederlo, usarlo solo se fornito o ignorarlo.

Scopri di più sui requisiti del corpo della richiesta.

Requisiti per la risposta

Se viene eseguito il deployment del modello in un endpoint pubblico, ogni risposta di previsione deve essere pari o inferiore a 1,5 MB. Il server HTTP deve inviare le risposte con corpi JSON nel formato seguente:

{
  "predictions": PREDICTIONS
}

In queste risposte, sostituisci PREDICTIONS con un array di valori JSON che rappresenta le previsioni che il container ha generato per ciascuno degli INSTANCES nella richiesta corrispondente.

Dopo che il server HTTP ha inviato questa risposta, Vertex AI aggiunge un campo deployedModelId alla risposta prima di restituirla al client. Questo campo specifica quale DeployedModel su un Endpoint sta inviando la risposta. Scopri di più sul formato del corpo della risposta.

Requisiti di pubblicazione delle immagini container

Devi eseguire il push dell'immagine container in Artifact Registry per utilizzarla con Vertex AI. Scopri come eseguire il push di un'immagine container ad Artifact Registry.

In particolare, devi eseguire il push dell'immagine container a un repository che soddisfi i seguenti requisiti di posizione e autorizzazione.

Località

Quando utilizzi Artifact Registry, il repository deve utilizzare una regione che corrisponda all'endpoint regionale in cui prevedi di creare un Model. Ad esempio, se prevedi di creare un Model sull'endpoint us-central1-aiplatform.googleapis.com, il nome completo dell'immagine container deve iniziare con us-central1-docker.pkg.dev/. Non utilizzare un repository multiregionale per l'immagine container.

Autorizzazioni

Vertex AI deve disporre dell'autorizzazione per eseguire il pull dell'immagine container quando crei un Model. In particolare, l'agente di servizio Vertex AI per il progetto deve disporre delle autorizzazioni del ruolo Lettore Artifact Registry (roles/artifactregistry.reader) per il repository dell'immagine container.

Vertex AI utilizza l'agente di servizio Vertex AI affinché il tuo progetto interagisca con altri servizi Google Cloud. Questo account di servizio ha l'indirizzo email service-PROJECT_NUMBER@gcp-sa-aiplatform.iam.gserviceaccount.com, dove PROJECT_NUMBER viene sostituito con il numero di progetto del tuo progetto Vertex AI.

Se hai eseguito il push dell'immagine container nello stesso progetto Google Cloud in cui utilizzi Vertex AI, non devi configurare alcuna autorizzazione. Le autorizzazioni predefinite concesse all'agente di servizio Vertex AI sono sufficienti.

Se invece hai eseguito il push dell'immagine container a un progetto Google Cloud diverso da quello in cui utilizzi Vertex AI, devi concedere il ruolo Lettore Artifact Registry per il repository Artifact Registry all'agente di servizio Vertex AI.

Accedi agli artefatti del modello

Quando crei un Model con addestramento personalizzato senza un container personalizzato, devi specificare l'URI di una directory Cloud Storage con artefatti del modello come campo artifactUri. Quando crei un Model con un container personalizzato, l'inserimento di artefatti del modello in Cloud Storage è facoltativo.

Se l'immagine container include gli artefatti del modello necessari per fornire le previsioni, non è necessario caricare file da Cloud Storage. Tuttavia, se fornisci gli artefatti del modello specificando il campo artifactUri, il container deve caricare questi artefatti all'avvio. Quando Vertex AI avvia il container, imposta la variabile di ambiente AIP_STORAGE_URI su un URI Cloud Storage che inizia con gs://. Il comando entrypoint del container può scaricare la directory specificata da questo URI per accedere agli artefatti del modello.

Tieni presente che il valore della variabile di ambiente AIP_STORAGE_URI non è identico all'URI Cloud Storage specificato nel campo artifactUri quando crei Model. Piuttosto, AIP_STORAGE_URI punta a una copia della directory degli artefatti del modello in un altro bucket Cloud Storage gestito da Vertex AI. Vertex AI compila questa directory quando crei un Model. Non puoi aggiornare il contenuto della directory. Se vuoi utilizzare nuovi artefatti del modello, devi creare un nuovo Model.

L'account di servizio utilizzato dal container per impostazione predefinita ha l'autorizzazione a leggere da questo URI.

Se invece specifichi un account di servizio personalizzato quando esegui il deployment di Model in un Endpoint, Vertex AI concede automaticamente all'account di servizio specificato il ruolo Visualizzatore oggetti Storage (roles/storage.objectViewer) per il bucket Cloud Storage dell'URI.

Utilizza qualsiasi libreria che supporti Credenziali predefinite dell'applicazione (ADC) per caricare gli artefatti del modello. Non è necessario configurare esplicitamente l'autenticazione.

Variabili di ambiente disponibili nel container

Durante l'esecuzione, il comando del punto di ingresso del container può fare riferimento alle variabili di ambiente che hai configurato manualmente e alle variabili di ambiente impostate automaticamente da Vertex AI. Questa sezione descrive tutti i modi in cui puoi impostare le variabili di ambiente e fornisce dettagli sulle variabili impostate automaticamente da Vertex AI.

Variabili impostate nell'immagine container

Per impostare le variabili di ambiente nell'immagine container quando la crei, utilizza l'istruzione ENV di Docker. Non impostare variabili di ambiente che iniziano con il prefisso AIP_.

Il comando del punto di ingresso del container può utilizzare queste variabili di ambiente, ma non puoi farvi riferimento in nessuno dei campi API di Model.

Variabili impostate da Vertex AI

Quando Vertex AI inizia a eseguire il container, imposta le seguenti variabili di ambiente nell'ambiente del container. Ogni variabile inizia con il prefisso AIP_. Non impostare manualmente variabili di ambiente che utilizzano questo prefisso.

Il comando del punto di ingresso del container può accedere a queste variabili. Per scoprire quali campi dell'API Vertex AI possono fare riferimento anche a queste variabili, leggi il Riferimento API per ModelContainerSpec.

Nome variabile Valore predefinito Come configurare il valore Dettagli
AIP_ACCELERATOR_TYPE Non impostato Quando esegui il deployment di un Model come DeployedModel in una risorsa Endpoint, imposta il campo dedicatedResources.machineSpec.acceleratorType. Se applicabile, questa variabile specifica il tipo di acceleratore utilizzato dall'istanza della macchina virtuale (VM) su cui è in esecuzione il container.
AIP_DEPLOYED_MODEL_ID Una stringa di cifre che identifica DeployedModel in cui è stato eseguito il deployment di Model di questo container. Non configurabile Questo valore è il campo id di DeployedModel.
AIP_ENDPOINT_ID Una stringa di cifre che identifica Endpoint in cui è stato eseguito il deployment di Model del container. Non configurabile Questo valore è l'ultimo segmento del campo name di Endpoint (dopo endpoints/).
AIP_FRAMEWORK CUSTOM_CONTAINER Non configurabile
AIP_HEALTH_ROUTE /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL

In questa stringa, sostituisci ENDPOINT con il valore della variabile AIP_ENDPOINT_ID e sostituisci DEPLOYED_MODEL con il valore della variabile AIP_DEPLOYED_MODEL_ID.		 Quando crei un Model, imposta il campo containerSpec.healthRoute. Questa variabile specifica il percorso HTTP sul container a cui Vertex AI invia i controlli di integrità.
AIP_HTTP_PORT 8080 Quando crei un Model, imposta il campo containerSpec.ports. La prima voce in questo campo diventa il valore di AIP_HTTP_PORT. Vertex AI invia controlli di attività, controlli di integrità e richieste di previsione a questa porta del container. Il server HTTP del container deve rimanere in ascolto delle richieste su questa porta.
AIP_MACHINE_TYPE Nessun valore predefinito, deve essere configurato Quando esegui il deployment di un Model come DeployedModel in una risorsa Endpoint, imposta il campo dedicatedResources.machineSpec.machineType. Questa variabile specifica il tipo di VM su cui è in esecuzione il container.
AIP_MODE PREDICTION Non configurabile Questa variabile indica che il container è in esecuzione su Vertex AI per pubblicare previsioni online. Puoi utilizzare questa variabile di ambiente per aggiungere logica personalizzata al container, in modo che possa essere eseguito in più ambienti di elaborazione, ma utilizzare solo determinati percorsi del codice quando viene eseguito su Vertex AI.
AIP_MODE_VERSION 1.0.0 Non configurabile Questa variabile indica la versione dei requisiti dei container personalizzati (questo documento) che Vertex AI prevede che vengano soddisfatti dal container. Questo documento viene aggiornato in base al controllo delle versioni semantico.
AIP_MODEL_NAME Il valore della variabile AIP_ENDPOINT_ID Non configurabile Visualizza la riga AIP_ENDPOINT_ID. Questa variabile esiste per motivi di compatibilità.
AIP_PREDICT_ROUTE /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL:predict

In questa stringa, sostituisci ENDPOINT con il valore della variabile AIP_ENDPOINT_ID e sostituisci DEPLOYED_MODEL con il valore della variabile AIP_DEPLOYED_MODEL_ID.		 Quando crei un Model, imposta il campo containerSpec.predictRoute. Questa variabile specifica il percorso HTTP sul container a cui Vertex AI inoltra le richieste di previsione.
AIP_PROJECT_NUMBER Il numero di progetto del progetto Google Cloud in cui stai utilizzando Vertex AI Non configurabile
AIP_STORAGE_URI
  • Se non imposti il campo artifactUri quando crei una Model: una stringa vuota
  • Se imposti il campo artifactUri durante la creazione di un Model: un URI Cloud Storage (a partire da gs://) che specifica una directory in un bucket gestito da Vertex AI
 Non configurabile Questa variabile specifica la directory che contiene una copia degli artefatti del modello, se applicabile.
AIP_VERSION_NAME Il valore della variabile AIP_DEPLOYED_MODEL_ID Non configurabile Visualizza la riga AIP_DEPLOYED_MODEL_ID. Questa variabile esiste per motivi di compatibilità.

Variabili impostate nella risorsa Model

Quando crei un Model, puoi impostare altre variabili di ambiente nel campo containerSpec.env.

Il comando del punto di ingresso del container può accedere a queste variabili. Per scoprire quali campi dell'API Vertex AI possono fare riferimento anche a queste variabili, leggi il Riferimento API per ModelContainerSpec.

Passaggi successivi