AI Notebooks - Bien démarrer avec Public Cloud AI

Si vous avez déjà créé un AI Notebook en utilisant la console OVHcloud (UI) sur ce projet Public Cloud, vous pouvez directement passer à l'étape suivante Lancer votre premier AI Notebook.

Cependant, si c'est la première fois que vous utilisez les produits AI sur votre projet Public Cloud, vous devrez compléter un processus d'autorisation avant d'utiliser l'API AI, la CLI ovhai ou le SDK Python. Pour ce faire, veuillez suivre ces étapes :

Dans le menu de gauche de votre projet Public Cloud, cliquez sur AI Notebooks sous AI.

Si le bandeau Autorisez ce projet pour les services IA s'affiche, cliquez sur Autoriser le projet. L'autorisation du projet donne à la plateforme AI Solutions l'accès à vos conteneurs Object Storage.

Vous pouvez ensuite quitter cette page et continuer à suivre cette documentation pour lancer votre AI Notebook en utilisant l'API, la CLI ou le SDK, comme vous le souhaitez. Vous n'avez pas besoin de créer un notebook dans la console OVHcloud.

Pour créer un AI Notebook en utilisant l'API AI OVHcloud, suivez ces étapes :

Tout d'abord, accédez au lien de l'API AI pour la région souhaitée parmi celles disponibles pour l'utilisation des produits AI :

• API AI GRA, pour Gravelines, France.
• API AI BHS, pour Beauharnois, Canada.

En visitant l'URL de l'API, vous remarquerez différentes catégories d'endpoints sur le côté gauche de l'écran. Cliquez sur la catégorie Notebook pour afficher les endpoints liés aux AI Notebooks.

Parmi eux, vous trouverez une méthode POST Submit a new notebook. C'est l'endpoint permettant de soumettre un nouvel AI Notebook.

Le lien exact pour cet endpoint sur la région GRA est le suivant : https://gra.training.ai.cloud.ovh.net/#/operations/notebookNew.

Sur la page de l'endpoint Submit a new notebook, vous trouverez le schéma détaillé de la Notebook Specification et de ses différents paramètres possibles. Des exemples de réponses (200, 400, 401, 402, 403) sont également fournis en cas de succès ou de différents scénarios d'erreur.

Avant d'utiliser cette méthode pour créer un AI Notebook, vous devrez vous authentifier. Cela peut se faire en fournissant un bearer token, que vous pouvez créer via l'onglet Token de la page Configuration d'AI Notebooks, d'AI Training ou d'AI Deploy, ou en utilisant la CLI ovhai. Pour des instructions plus détaillées sur la création d'un token, veuillez consulter la documentation Gérer les tokens d'accès.

Une fois votre token créé, indiquez-le dans le panneau 'Auth', dans le coin supérieur droit de la page de l'API.

Après vous être connecté(e), vous pouvez modifier le corps (spécifications du notebook) pour l'AI Notebook que vous souhaitez créer. Un exemple par défaut est fourni. N'hésitez pas à l'ajuster.

Une fois votre corps de requête rempli, cliquez sur le bouton Send API request. Si votre corps de requête est correctement rédigé, le notebook sera créé sur le projet Public Cloud dont provient le bearer token utilisé pour l'identification. Vous recevrez toutes les informations nécessaires sur le notebook créé (ID, access URL, etc.) dans le champ Responses.

En plus de l'interface de l'API, l'API fournit des exemples de code Python pour vous aider à utiliser l'endpoint et reproduire le même résultat de manière programmatique. Cependant, pour une expérience Python efficace, nous vous recommandons d'utiliser le SDK Python ovhai.

Si vous préférez utiliser l'interface en ligne de commande pour lancer votre AI Notebook, veuillez suivre ces étapes :

Tout d'abord, vous devrez installer la CLI ovhai et vous y connecter. Veuillez suivre cette documentation.

Après l'installation et une connexion réussie, consultez cette seconde documentation pour apprendre à créer votre AI Notebook à l'aide de commandes.

La bibliothèque ovhai est un client Python qui permet aux développeurs d'utiliser facilement l'API AI OVHcloud. Avec ce SDK, vous pouvez exécuter, gérer et automatiser vos AI Notebooks.

Pour lancer un AI Notebook en utilisant le SDK Python ovhai, vous devez d'abord installer la bibliothèque ovhai. Vous pouvez le faire à l'aide de pip. Ouvrez votre terminal et exécutez la commande suivante :

pip install ovhai

Une fois installée, nous vous invitons à suivre les instructions fournies sur la page ovhai PyPI pour apprendre à créer un token d'authentification, comprendre le fonctionnement du SDK et lancer un AI Notebook en utilisant le SDK Python ovhai.

Voici un exemple simple pour vous aider à démarrer facilement :

from ovhai import AuthenticatedClient
from ovhai.api.notebook import notebook_new
from ovhai.models import NotebookSpec, Notebook
from ovhai.ovhai_types import Response

client = AuthenticatedClient(
    base_url="https://gra.training.ai.cloud.ovh.net",
    token="YOUR_AI_TOKEN",
)

# Define notebook parameters
editor_id = "jupyterlab"
framework_id = "conda"
framework_version = "conda-py311-cudaDevel11.8"
nb_cpu = 2

# Create the notebook creation request
notebook_specs = {
    "env": {"editorId": editor_id, "frameworkId": framework_id, "frameworkVersion": framework_version},
    "resources": {"cpu": nb_cpu},
}

with client as client:
    response: Response[Notebook] = notebook_new.sync_detailed(
        client=client, body=NotebookSpec.from_dict(notebook_specs)
    )
    
    import json
    response_content = response.content.decode('utf-8')  # Decode bytes to a string
    response_dict = json.loads(response_content)

    status_code = response.status_code
    id_ = response_dict['id']
    spec = response_dict['spec']
    status = response_dict['status']
    state = status['state']
    info = status['info']
    url = response_dict['status']['url']

    print(f"Status code: {status_code}")
    print(f"ID: {id_}")
    print(f"Spec: {spec}")
    print(f"State: {state}")
    print(f"Info: {info}")
    print(f"URL: {url}")

Assurez-vous de remplacer YOUR_AI_TOKEN par un bearer token. Les bearer tokens peuvent être créés via l'onglet Token de la page Configuration d'AI Notebooks, d'AI Training ou d'AI Deploy, ou en utilisant la CLI ovhai. Pour des instructions plus détaillées sur la création d'un token, veuillez consulter la documentation Gérer les tokens d'accès.

L'exécution de ce code lancera un nouvel AI Notebook basé sur les spécifications que vous avez fournies. N'hésitez pas à ajuster les spécifications selon le notebook que vous souhaitez créer.

À l'étape précédente, vous avez commandé la création de votre notebook. Cela devrait avoir affiché l'URL de votre notebook dans le panneau 'Response', vous permettant d'y accéder :

Si vous n'avez plus l'UUID et l'URL du notebook affichés sur la page de l'API, vous pouvez lister tous vos AI Notebooks en utilisant la méthode GET Paginated list of notebooks, dans la catégorie Notebook.

Cela vous permettra de récupérer l'URL du notebook auquel vous souhaitez accéder.

Vous pouvez également obtenir toutes les informations relatives à un notebook (spécifications, Access Url, Monitoring URL, ...) en utilisant la méthode GET Get notebook information. Il vous suffira de fournir l'UUID du notebook dont vous souhaitez obtenir les informations.

À l'étape précédente, vous avez commandé la création de votre notebook. Cela devrait avoir affiché l'URL de votre notebook dans votre terminal, vous permettant d'y accéder :

Si vous n'avez plus l'UUID et l'URL du notebook affichés dans votre terminal, vous pouvez facilement lister tous vos AI Notebooks existants en exécutant :

ovhai notebook list

Cela vous permettra de récupérer l'URL du notebook auquel vous souhaitez accéder.

Vous pouvez également obtenir toutes les informations relatives à un notebook (spécifications, Access Url, Monitoring URL, ...) en exécutant :

ovhai notebook get <NOTEBOOK_UUID>

Assurez-vous simplement de remplacer <NOTEBOOK_UUID> par l'UUID réel du notebook dont vous souhaitez récupérer les informations.

Si vous n'avez plus l'UUID et l'URL du notebook affichés dans votre IDE Python, vous pouvez facilement lister tous vos AI Notebooks en exécutant :

from ovhai.api.notebook import notebook_get_all
from ovhai.models import NotebookList
from ovhai.ovhai_types import Response

from ovhai import AuthenticatedClient

client = AuthenticatedClient(
    base_url="https://gra.training.ai.cloud.ovh.net",
    token="YOUR_AI_TOKEN",
)

with client as client:
    response: Response[NotebookList] = notebook_get_all.sync_detailed(client=client)
    import json
    response = json.loads(response.content.decode())
    for notebook_info in response["items"]:
        print(f"ID: {notebook_info['id']}")
        print(f"Name: {notebook_info['spec']['name']}")
        print(f"Status: {notebook_info['status']['state']}")
        print(f"Framework: {notebook_info['spec']['env']['frameworkId']}")
        print(f"Framework version: {notebook_info['spec']['env']['frameworkVersion']}")
        print(f"Editor: {notebook_info['spec']['env']['editorId']}")
        print(f"Access link: {notebook_info['status']['url']}")
        print("---------------")

Cela vous permettra de récupérer l'URL du notebook auquel vous souhaitez accéder. Assurez-vous simplement d'utiliser la bonne URL d'API, et remplacez YOUR_AI_TOKEN par votre token AI réel.

Vous pouvez également obtenir toutes les informations relatives à un notebook (spécifications, Access Url, Monitoring URL, ...) en exécutant le code suivant :

from ovhai.api.notebook import notebook_get
from ovhai import AuthenticatedClient
import json

client = AuthenticatedClient(
    base_url="https://gra.training.ai.cloud.ovh.net",
    token="YOUR_AI_TOKEN",
)
id = "YOUR_NOTEBOOK_UUID"

with client as client:
    response = notebook_get.sync_detailed(
        id=id, client=client
    )

print(json.loads(response.content.decode()))

Utiliser un token est un moyen efficace de partager l'AI Notebook avec n'importe qui, sans avoir besoin de lui fournir les identifiants de l'un des utilisateurs de votre projet Public Cloud. Ceci est utile lorsque vous souhaitez fournir un accès au notebook en dehors de votre projet Public Cloud.

Pour vous authentifier avec un token d'accès, veuillez suivre ces étapes :

Cliquez sur le bouton Login with token, situé sous les champs utilisateur et mot de passe. Cela basculera le mode d'accès vers une méthode d'authentification basée sur un token.

Assurez-vous d'utiliser un token que vous avez créé depuis l'onglet Token de la page Configuration d'AI Notebooks, d'AI Training ou d'AI Deploy, ou depuis la CLI, l'API ou le SDK ovhai. Vous pouvez utiliser des tokens créés sans sélecteur de label. Si vous avez spécifié un sélecteur de label lors de la création du notebook, vous pouvez également utiliser le token correspondant au sélecteur de label spécifié. Pour plus d'informations sur la création d'un token d'accès, veuillez vous référer à cette documentation.

Saisissez le token d'accès dans le champ 'Access Token', comme indiqué dans la capture d'écran ci-dessous.

Cliquez sur le bouton Connect pour vous connecter à votre AI Notebook.

Sélectionnez l'endpoint Stop a running notebook, qui est une méthode PUT. Fournissez l'UUID du notebook que vous souhaitez arrêter comme paramètre d'entrée. Ensuite, cliquez sur le bouton Send API request pour envoyer la requête.

Si la requête réussit, le notebook sera arrêté et un message 'No content' s'affichera dans le panneau 'Response'. Si la requête échoue, un message d'erreur s'y affichera.

Vous pouvez facilement arrêter votre notebook en utilisant la commande suivante :

ovhai notebook stop `<NOTEBOOK_UUID>`

Assurez-vous de remplacer <NOTEBOOK_UUID> par l'UUID du notebook que vous souhaitez arrêter.

Si vous ne connaissez pas son UUID, rappelez-vous que vous pouvez facilement lister tous vos AI Notebooks existants en exécutant :

ovhai notebook list

Voici un exemple montrant comment arrêter un notebook en cours d'exécution en utilisant le SDK Python :

from ovhai.api.notebook import notebook_stop
from ovhai import AuthenticatedClient
client = AuthenticatedClient(
    base_url="https://gra.training.ai.cloud.ovh.net",
    token="YOUR_AI_TOKEN",
)
id = "YOUR_NOTEBOOK_UUID"

with client as client:
    response = notebook_stop.sync_detailed(client=client, id=id)

Remplacez YOUR_AI_TOKEN par votre token AI réel et YOUR_NOTEBOOK_UUID par l'UUID du notebook que vous souhaitez arrêter.

Sélectionnez l'endpoint Start a stopped notebook, qui est une méthode PUT. Fournissez l'UUID du notebook que vous souhaitez démarrer comme paramètre d'entrée. Ensuite, cliquez sur le bouton Send API request pour envoyer la requête.

Si la requête réussit, le notebook sera démarré et un message 'No content' s'affichera dans le panneau 'Response'. Si la requête échoue, un message d'erreur s'y affichera.

Utilisez la commande suivante en remplaçant <NOTEBOOK_UUID> par l'UUID de votre notebook pour démarrer votre notebook arrêté :

ovhai notebook start `<NOTEBOOK_UUID>`

Voici un exemple montrant comment arrêter un notebook en cours d'exécution en utilisant le SDK Python :

from ovhai.api.notebook import notebook_start
from ovhai import AuthenticatedClient
client = AuthenticatedClient(
    base_url="https://gra.training.ai.cloud.ovh.net",
    token="YOUR_AI_TOKEN",
)
id = "YOUR_NOTEBOOK_UUID"

with client as client:
    response = notebook_start.sync_detailed(
        id=id, client=client
    )

Remplacez YOUR_AI_TOKEN par votre token AI réel et YOUR_NOTEBOOK_UUID par l'UUID du notebook que vous souhaitez arrêter.

Sélectionnez l'endpoint Restart a stopped notebook, qui est une méthode PUT. Fournissez l'UUID du notebook que vous souhaitez démarrer comme paramètre d'entrée. Ensuite, cliquez sur le bouton Send API request pour envoyer la requête.

Si la requête réussit, le notebook sera démarré et un message 'No content' s'affichera dans le panneau 'Response'. Si la requête échoue, un message d'erreur s'y affichera.

Utilisez la commande suivante en remplaçant <NOTEBOOK_UUID> par l'UUID de votre notebook pour redémarrer votre notebook en cours d'exécution :

ovhai notebook restart `<NOTEBOOK_UUID>`

Sélectionnez l'endpoint Delete permanently a notebook, qui est une méthode DELETE. Fournissez l'UUID du notebook que vous souhaitez supprimer. Utilisez le paramètre force si votre notebook n'est pas STOPPED et est toujours RUNNING. Ensuite, cliquez sur le bouton Send API request pour envoyer la requête.

Si la requête réussit, le notebook sera supprimé et un message 'No content' s'affichera dans le panneau 'Response'. Si la requête échoue, un message d'erreur s'y affichera.

Si vous souhaitez supprimer complètement votre AI Notebook, exécutez simplement la commande suivante :

ovhai notebook delete `<NOTEBOOK_UUID>`

Si le notebook est toujours à l'état RUNNING, un message de confirmation apparaîtra, vous demandant de confirmer l'action. Ne confirmez que si vous êtes sûr(e) de vouloir supprimer le notebook.

Voici un exemple montrant comment supprimer un notebook en utilisant le SDK Python :

from ovhai.api.notebook import notebook_delete
from ovhai import AuthenticatedClient

client = AuthenticatedClient(
    base_url="https://gra.training.ai.cloud.ovh.net",
    token="YOUR_AI_TOKEN",
)
id = "YOUR_NOTEBOOK_UUID"

with client as client:
    response = notebook_delete.sync_detailed(
        id=id, client=client, force=False
    )

    print(response.content.decode())

Remplacez YOUR_AI_TOKEN par votre token AI réel et YOUR_NOTEBOOK_UUID par l'UUID du notebook que vous souhaitez supprimer. Si le notebook est toujours à l'état RUNNING, vous devrez définir le paramètre force sur True pour supprimer le notebook.