Configuration

Ce tutoriel explique comment configurer une sandbox au démarrage en transmettant des options à Sandbox.run(). Il s’adresse aux développeurs qui ont déjà créé une sandbox de base et qui souhaitent maîtriser l’image de conteneur, l’allocation des ressources et les fichiers préchargés pour leur charge de travail.

Choisir l’authentification

Ces exemples s’exécutent sur une capacité sans serveur, sauf si une section indique CKS. Choisissez l’identifiant d’authentification du compte propriétaire de vos Sandbox. Consultez Choisir et obtenir des identifiants d’authentification pour obtenir une clé ou un jeton. Exécutez les commandes d’installation dans un environnement virtuel Python actif. Enregistrez le code Python de l’onglet correspondant à votre identifiant d’authentification sous le nom sandbox_auth.py, dans le même répertoire que les scripts Python que vous exécutez depuis cette page. Ce fichier contient le choix d’authentification, et non votre identifiant d’authentification. Les exemples importent AUTH depuis ce fichier et le transmettent explicitement à chaque nouvelle Sandbox ou session.

Clé API Forge
Jeton d’accès à l’API CoreWeave

Utilisez votre clé API Forge via la stratégie d’authentification W&B du SDK :

uv pip install 'cwsandbox[wandb]>=1.14.2'
export WANDB_API_KEY="[WANDB-API-KEY]"

sandbox_auth.py

from cwsandbox import AuthStrategy

AUTH = AuthStrategy.WANDB

Utilisez le jeton de votre organisation CoreWeave :

uv pip install 'cwsandbox>=1.14.2'
export CWSANDBOX_API_KEY="[API-ACCESS-TOKEN]"

sandbox_auth.py

from cwsandbox import AuthStrategy

AUTH = AuthStrategy.COREWEAVE_API_KEY

Pour un placement sur CKS, choisissez le jeton CoreWeave, activez un exécuteur et définissez placement_mode="cks" lors de la création de la Sandbox ou dans SandboxDefaults. Créer une session avec auth=AUTH authentifie également les Sandbox qui lui appartiennent. Conservez le même identifiant d’authentification pour vous reconnecter à vos Sandbox, les lister ou les nettoyer.

Transmettre la configuration à `Sandbox.run()`

Les options de configuration déterminent la manière dont la sandbox est provisionnée. Transmettez-les directement à Sandbox.run() sous forme d’arguments nommés :

from sandbox_auth import AUTH
from cwsandbox import Sandbox

with Sandbox.run(
    container_image="python:3.11",
    max_lifetime_seconds=300,
    tags=["my-app"],
    resources={"cpu": "1", "memory": "1Gi"},
    auth=AUTH,
) as sandbox:
    sandbox.exec(["python", "--version"]).result()

Ressources

Configurez le CPU et la mémoire en fonction des besoins de votre charge de travail afin d’éviter tout surprovisionnement ou sous-provisionnement. Utilisez ResourceOptions pour définir les demandes de ressources et les limites :

from sandbox_auth import AUTH
from cwsandbox import ResourceOptions, Sandbox

with Sandbox.run(
    resources=ResourceOptions(
        requests={"cpu": "2", "memory": "2Gi"},
        limits={"cpu": "2", "memory": "2Gi"},
    ),
    auth=AUTH,
) as sandbox:
    sandbox.exec(["python", "compute.py"]).result()

ResourceOptions utilise la syntaxe des ressources Kubernetes :

Ressource	Format	Exemples
CPU	Cœurs ou millicœurs	`"1"`, `"2"`, `"500m"` (0,5 CPU)
Mémoire	Octets avec suffixe d’unité	`"512Mi"`, `"1Gi"`, `"2Gi"`

Fichiers montés

Les fichiers montés vous permettent d’intégrer une configuration, des scripts ou tout autre contenu statique dans la sandbox avant son démarrage, afin que votre charge de travail dispose de tout le nécessaire dès son lancement. Préchargez des fichiers au démarrage de la sandbox :

from sandbox_auth import AUTH
with Sandbox.run(
    mounted_files=[
        {"mount_path": "/app/config.json", "file_content": b'{"debug": true}'},
        {"mount_path": "/app/script.py", "file_content": b"print('hello')"},
    ],
    resources={"cpu": "1", "memory": "1Gi"},
    auth=AUTH,
) as sandbox:
    sandbox.exec(["python", "/app/script.py"]).result()

Chaque entrée accepte mount_path, le chemin absolu dans la sandbox, et file_content, le contenu du fichier sous forme d’octets. Une valeur str est automatiquement encodée en UTF-8. Les fichiers montés sont en lecture seule. Utilisez write_file() pour les fichiers qui doivent être modifiés.

Étapes suivantes

Vous disposez maintenant d’une sandbox qui démarre avec l’image de conteneur, l’allocation des ressources et les fichiers prémontés dont votre charge de travail a besoin. Pour réutiliser une même configuration sur plusieurs bacs à sable, utilisez SandboxDefaults. Consultez le guide de configuration du bac à sable pour découvrir l’ensemble des champs de ResourceOptions, les ressources GPU, les classes de QoS et l’interopérabilité avec les bibliothèques de configuration.

Sandbox

Utiliser les Sandbox

Gérer les bacs à sable

Référence

Choisir l’authentification

Transmettre la configuration à `Sandbox.run()`

Ressources

Fichiers montés

Étapes suivantes

​Choisir l’authentification

​Transmettre la configuration à Sandbox.run()

​Ressources

​Fichiers montés

​Étapes suivantes

Choisir l’authentification

Transmettre la configuration à `Sandbox.run()`

Ressources

Fichiers montés

Étapes suivantes