Installer les bibliothèques clientes Vertex AI

Les bibliothèques clientes offrent une expérience développeur optimisée pour appeler l'API AI Vertex. Les bibliothèques clientes utilisent les conventions naturelles de chaque langage compatible et réduisent la quantité de code récurrent que vous devez écrire. Le guide suivant explique comment les installer.

Avant de commencer

1. Connectez-vous à votre compte Google Cloud. Si vous débutez sur Google Cloud, créez un compte pour évaluer les performances de nos produits en conditions réelles. Les nouveaux clients bénéficient également de 300 $ de crédits gratuits pour exécuter, tester et déployer des charges de travail.

2. Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.

   Remarque : Si vous ne comptez pas conserver les ressources créées dans cette procédure, créez un projet au lieu de sélectionner un projet existant. Après avoir suivi ces étapes, vous pouvez supprimer le projet. Cela entraîne la suppression de toutes les ressources qui lui sont associées.

   Accéder au sélecteur de projet

3. Activez Vertex AI API.

   Activer l'API

4. Créez un compte de service :

   1. Dans Cloud Console, accédez à la page Créer un compte de service.

      Accéder à la page "Créer un compte de service"
   2. Sélectionnez votre projet.

   3. Dans le champ Nom du compte de service, saisissez un nom. Cloud Console remplit le champ ID du compte de service en fonction de ce nom.

      Dans le champ Description du compte de service, saisissez une description. Exemple : Service account for quickstart.

   4. Cliquez sur Créer et continuer.

   5. Pour accorder l'accès à votre projet, attribuez le ou les rôles suivants à votre compte de service : Projet > Propriétaire.

      Dans la liste Sélectinoner un rôle, sélectionnez un rôle.

      Pour ajouter des rôles supplémentaires, cliquez sur Ajouter un autre rôle et ajoutez chaque rôle supplémentaire.

      Remarque : Le champ Rôle détermine les ressources auxquelles votre compte de service peut accéder dans votre projet. Vous pouvez révoquer ces rôles ou attribuer des rôles supplémentaires ultérieurement. Dans les environnements de production, n'attribuez pas les rôles Propriétaire, Éditeur et Lecteur. Attribuez plutôt un rôle prédéfini ou un rôle personnalisé répondant à vos besoins.
   6. Cliquez sur Continuer.

   7. Cliquez sur OK pour terminer la création du compte de service.

      Ne fermez pas la fenêtre de votre navigateur. Vous en aurez besoin lors de la tâche suivante.

5. Créez une clé de compte de service :

   1. Dans Cloud Console, cliquez sur l'adresse e-mail du compte de service que vous avez créé.
   2. Cliquez sur Keys (Clés).
   3. Cliquez sur Ajouter une clé, puis sur Créer une clé.
   4. Cliquez sur Create (Créer). Un fichier de clé JSON est téléchargé sur votre ordinateur.
   5. Cliquez sur Close (Fermer).

6. Définissez la variable d'environnement GOOGLE_APPLICATION_CREDENTIALS pour qu'elle pointe vers le chemin du fichier JSON contenant la clé de votre compte de service. Cette variable ne s'applique qu'à la session de shell actuelle. Par conséquent, si vous ouvrez une nouvelle session, vous devez de nouveau la définir.

   Exemple : Linux ou macOS

   export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

   Remplacez KEY_PATH par le chemin du fichier JSON contenant la clé de votre compte de service.

   Exemple :

   export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

   Exemple : Windows

   Pour PowerShell :

   $env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

   Remplacez KEY_PATH par le chemin du fichier JSON contenant la clé de votre compte de service.

   Exemple :

   $env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"

   Pour l'invite de commande :

   set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH

   Remplacez KEY_PATH par le chemin du fichier JSON contenant la clé de votre compte de service.

7. Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.

   Remarque : Si vous ne comptez pas conserver les ressources créées dans cette procédure, créez un projet au lieu de sélectionner un projet existant. Après avoir suivi ces étapes, vous pouvez supprimer le projet. Cela entraîne la suppression de toutes les ressources qui lui sont associées.

   Accéder au sélecteur de projet

8. Activez Vertex AI API.

   Activer l'API

9. Créez un compte de service :

   1. Dans Cloud Console, accédez à la page Créer un compte de service.

      Accéder à la page "Créer un compte de service"
   2. Sélectionnez votre projet.

   3. Dans le champ Nom du compte de service, saisissez un nom. Cloud Console remplit le champ ID du compte de service en fonction de ce nom.

      Dans le champ Description du compte de service, saisissez une description. Exemple : Service account for quickstart.

   4. Cliquez sur Créer et continuer.

   5. Pour accorder l'accès à votre projet, attribuez le ou les rôles suivants à votre compte de service : Projet > Propriétaire.

      Dans la liste Sélectinoner un rôle, sélectionnez un rôle.

      Pour ajouter des rôles supplémentaires, cliquez sur Ajouter un autre rôle et ajoutez chaque rôle supplémentaire.

      Remarque : Le champ Rôle détermine les ressources auxquelles votre compte de service peut accéder dans votre projet. Vous pouvez révoquer ces rôles ou attribuer des rôles supplémentaires ultérieurement. Dans les environnements de production, n'attribuez pas les rôles Propriétaire, Éditeur et Lecteur. Attribuez plutôt un rôle prédéfini ou un rôle personnalisé répondant à vos besoins.
   6. Cliquez sur Continuer.

   7. Cliquez sur OK pour terminer la création du compte de service.

      Ne fermez pas la fenêtre de votre navigateur. Vous en aurez besoin lors de la tâche suivante.

10. Créez une clé de compte de service :

    1. Dans Cloud Console, cliquez sur l'adresse e-mail du compte de service que vous avez créé.
    2. Cliquez sur Keys (Clés).
    3. Cliquez sur Ajouter une clé, puis sur Créer une clé.
    4. Cliquez sur Create (Créer). Un fichier de clé JSON est téléchargé sur votre ordinateur.
    5. Cliquez sur Close (Fermer).

11. Définissez la variable d'environnement GOOGLE_APPLICATION_CREDENTIALS pour qu'elle pointe vers le chemin du fichier JSON contenant la clé de votre compte de service. Cette variable ne s'applique qu'à la session de shell actuelle. Par conséquent, si vous ouvrez une nouvelle session, vous devez de nouveau la définir.

    Exemple : Linux ou macOS

    export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

    Remplacez KEY_PATH par le chemin du fichier JSON contenant la clé de votre compte de service.

    Exemple :

    export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

    Exemple : Windows

    Pour PowerShell :

    $env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

    Remplacez KEY_PATH par le chemin du fichier JSON contenant la clé de votre compte de service.

    Exemple :

    $env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"

    Pour l'invite de commande :

    set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH

    Remplacez KEY_PATH par le chemin du fichier JSON contenant la clé de votre compte de service.

Bibliothèques clientes

Vertex AI fournit des bibliothèques clientes pour les langages suivants. Sélectionnez le langage que vous souhaitez utiliser.

Java

Si vous utilisez Maven, ajoutez les éléments suivants à vos dépendances :

<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-aiplatform</artifactId>
  <version>0.4.0</version>
</dependency>

Si vous utilisez Gradle, ajoutez les éléments suivants à vos dépendances :

compile 'com.google.cloud:google-cloud-aiplatform:0.4.0'

Si vous utilisez sbt, ajoutez les éléments suivants à vos dépendances :

libraryDependencies += "com.google.cloud" % "google-cloud-aiplatform" % "0.4.0"

Essayer des exemples de code

Pour afficher ou obtenir des exemples de code individuels, accédez au dépôt GitHub java-aiplatform.

Documentation de la bibliothèque cliente

Pour plus d'informations, consultez la documentation sur la bibliothèque cliente Vertex AI pour Java.

Node.js

Avant d'installer la bibliothèque, préparez votre environnement pour le développement Node.js.

Exécutez la commande suivante dans votre environnement pour installer la bibliothèque cliente :

npm install @google-cloud/aiplatform

Documentation de la bibliothèque cliente

Pour en savoir plus, consultez la documentation sur la bibliothèque cliente Vertex AI pour Node.js.

Python

SDK Vertex AI pour Python

La bibliothèque cliente Python pour Vertex AI s'appelle désormais SDK Vertex AI pour Python. Avec le lancement de la version 0.7 (bêta), le SDK Vertex AI pour Python fournit deux niveaux d'assistance. La bibliothèque de haut niveau aiplatform est conçue pour simplifier les workflows de science des données courants à l'aide de classes wrapper et de valeurs par défaut imposées. La bibliothèque aiplatform.gapic de niveau inférieur reste disponible pour les périodes où vous avez besoin de plus de flexibilité ou de contrôle, ou pour les méthodes non compatibles avec la bibliothèque de haut niveau.

Lorsque vous installez le SDK Vertex AI pour Python, vous pouvez utiliser les deux niveaux d'assistance. Si vous combinez des appels aiplatform et aiplatform.gapic dans le même workflow, sachez que ces deux approches utilisent des procédures d'initialisation différentes. Par conséquent, vous devez les initialiser indépendamment l'une de l'autre.

Pour voir un exemple d'utilisation du SDK Vertex AI pour Python dans le cadre d'un workflow plus complet, exécutez le notebook Jupyter "Entraînement personnalisé et prédiction en ligne" dans l'un des environnements suivants :

• Exécutez le notebook dans Colab.
• Exécutez le notebook dans une instance de notebook gérée par l'utilisateur Vertex AI Workbench.
• Affichez le notebook sur GitHub.

Avant d'installer

Avant d'installer le SDK Vertex AI pour Python, nous vous recommandons de créer un environnement Python isolé pour chaque projet. Activez un environnement venv ou utilisez une autre méthode pour créer un environnement Python isolé.

Découvrez comment configurer un environnement de développement Python pour travailler avec Google Cloud.

Une autre option consiste à créer une instance de notebooks gérés par l'utilisateur pour ce projet. Si vous travaillez dans un notebook, installez le SDK Vertex AI pour Python sur l'instance ou l'environnement de notebook.

Installer et initialiser le SDK Vertex AI pour Python

Exécutez la commande suivante dans votre environnement virtuel pour installer le SDK Vertex AI pour Python :

YOUR_ENVIRONMENT/bin/pip install google-cloud-aiplatform

L'exemple de code suivant montre comment initialiser la bibliothèque dans votre code Python :

Afficher sur GitHub

def init_sample(
    project: Optional[str] = None,
    location: Optional[str] = None,
    experiment: Optional[str] = None,
    staging_bucket: Optional[str] = None,
    credentials: Optional[auth_credentials.Credentials] = None,
    encryption_spec_key_name: Optional[str] = None,
):
    aiplatform.init(
        project=project,
        location=location,
        experiment=experiment,
        staging_bucket=staging_bucket,
        credentials=credentials,
        encryption_spec_key_name=encryption_spec_key_name,
    )

Essayer des exemples de code

Certains tutoriels sous forme de notebooks Jupyter montrent comment utiliser le SDK Vertex AI pour Python dans le cadre d'un workflow plus important.

Pour afficher ou obtenir des exemples de code individuels, accédez au dépôt GitHub python-aiplatform.

Documentation de la bibliothèque cliente

Pour plus d'informations, consultez la documentation du SDK Vertex AI pour Python.