Variables d’environnement

Lorsque vous exécutez un script dans un environnement automatisé, vous pouvez contrôler W&B à l’aide de variables d’environnement définies avant l’exécution du script ou dans le script lui-même.

# Cette valeur est secrète et ne doit pas être versionnée dans le contrôle de version
WANDB_API_KEY=$YOUR_API_KEY
# Nom et notes facultatifs
WANDB_NAME="My first run"
WANDB_NOTES="Smaller learning rate, more regularization."

# Nécessaire uniquement si vous ne versionnez pas le fichier wandb/settings
WANDB_ENTITY=$username
WANDB_PROJECT=$project

# Si vous ne souhaitez pas que votre script se synchronise avec le cloud
os.environ["WANDB_MODE"] = "offline"

# Ajouter le suivi de l’ID du sweep aux objets Run et aux classes associées
os.environ["WANDB_SWEEP_ID"] = "b05fq58z"

Variables d’environnement facultatives

Ces variables d’environnement facultatives vous permettent, par exemple, de configurer l’authentification sur des machines distantes.

Nom de la variable	Utilisation
`WANDB_API_KEY`	Définit la clé d’authentification associée à votre compte. Créez une clé API dans les Paramètres utilisateur. Cette variable doit être définie si `wandb login` n’a pas été exécuté sur la machine distante.
`WANDB_BASE_URL`	Si vous utilisez wandb/local, vous devez définir cette variable d’environnement sur `http://YOUR_IP:YOUR_PORT`
`WANDB_CACHE_DIR`	La valeur par défaut est ~/.cache/wandb ; vous pouvez modifier cet emplacement avec cette variable d’environnement
`WANDB_CONFIG_DIR`	La valeur par défaut est ~/.config/wandb ; vous pouvez modifier cet emplacement avec cette variable d’environnement
`WANDB_CONFIG_PATHS`	Liste de fichiers yaml, séparés par des virgules, à charger dans wandb.config. Voir configuration.
`WANDB_CONSOLE`	Définissez cette variable sur “off” pour désactiver la journalisation de stdout / stderr. La valeur par défaut est “on” dans les environnements qui la prennent en charge.
`WANDB_DATA_DIR`	Emplacement de chargement des artifacts en préparation. L’emplacement par défaut dépend de votre plateforme, car il utilise la valeur de `user_data_dir` du package Python `platformdirs`. Assurez-vous que ce répertoire existe et que l’utilisateur qui exécute le processus dispose des droits d’écriture.
`WANDB_DIR`	Emplacement de stockage de tous les fichiers générés. Si elle n’est pas définie, la valeur par défaut est le répertoire `wandb` relatif à votre script d’entraînement. Assurez-vous que ce répertoire existe et que l’utilisateur qui exécute le processus dispose des droits d’écriture. Cette variable ne contrôle pas l’emplacement des artifacts téléchargés, que vous pouvez définir avec la variable d’environnement `WANDB_ARTIFACT_DIR`.
`WANDB_ARTIFACT_DIR`	Emplacement de stockage de tous les artifacts téléchargés. Si elle n’est pas définie, la valeur par défaut est le répertoire `artifacts` relatif à votre script d’entraînement. Assurez-vous que ce répertoire existe et que l’utilisateur qui exécute le processus dispose des droits d’écriture. Cette variable ne contrôle pas l’emplacement des fichiers de métadonnées générés, que vous pouvez définir avec la variable d’environnement `WANDB_DIR`.
`WANDB_DISABLE_GIT`	Empêche wandb de rechercher un dépôt git et de capturer le dernier commit / diff.
`WANDB_DISABLE_CODE`	Définissez cette variable sur true pour empêcher wandb d’enregistrer les notebooks ou les diffs git. Le commit actuel reste enregistré si vous vous trouvez dans un dépôt git.
`WANDB_DOCKER`	Définissez cette variable sur le digest d’une image Docker pour permettre la restauration des runs. Elle est définie automatiquement par la commande wandb docker. Vous pouvez obtenir le digest d’une image en exécutant `wandb docker my/image/name:tag --digest`
`WANDB_ENTITY`	L’entity associée à votre run. Si vous avez exécuté `wandb init` dans le répertoire de votre script d’entraînement, un répertoire nommé wandb est créé et une entity par défaut y est enregistrée ; celle-ci peut être versionnée dans votre gestionnaire de sources. Si vous ne souhaitez pas créer ce fichier ou si vous voulez redéfinir sa valeur, utilisez la variable d’environnement.
`WANDB_ERROR_REPORTING`	Définissez cette variable sur false pour empêcher wandb de journaliser les erreurs fatales dans son système de suivi des erreurs.
`WANDB_HOST`	Définissez cette variable sur le nom d’hôte à afficher dans l’interface wandb si vous ne souhaitez pas utiliser celui fourni par le système
`WANDB_IGNORE_GLOBS`	Définissez cette variable sur une liste de globs de fichiers à ignorer, séparés par des virgules. Ces fichiers ne seront pas synchronisés avec le cloud.
`WANDB_JOB_NAME`	Spécifie un nom pour tous les jobs créés par `wandb`.
`WANDB_JOB_TYPE`	Spécifie le type de job, par exemple “training” ou “evaluation”, pour distinguer différents types de runs. Voir regroupement pour plus d’informations.
`WANDB_MODE`	Si vous définissez cette variable sur “offline”, wandb enregistre les métadonnées de votre run localement sans les synchroniser avec le serveur. Si vous la définissez sur `disabled`, wandb est entièrement désactivé.
`WANDB_NAME`	Le nom lisible de votre run. S’il n’est pas défini, il est généré aléatoirement
`WANDB_NOTEBOOK_NAME`	Si vous travaillez dans jupyter, vous pouvez définir le nom du notebook avec cette variable. Nous essayons de le détecter automatiquement.
`WANDB_NOTES`	Notes plus détaillées sur votre run. Le Markdown est pris en charge et vous pourrez modifier ces notes ultérieurement dans l’interface utilisateur.
`WANDB_PROJECT`	Le projet associé à votre run. Il peut aussi être défini avec `wandb init`, mais la variable d’environnement a priorité sur cette valeur.
`WANDB_RESUME`	Par défaut, cette variable est définie sur never. Si elle est définie sur auto, wandb reprend automatiquement les runs en échec. Si elle est définie sur must, le run doit exister au démarrage. Si vous souhaitez toujours générer vos propres ID uniques, définissez-la sur allow et définissez systématiquement `WANDB_RUN_ID`.
`WANDB_RUN_GROUP`	Spécifie le nom de l’expérience afin de regrouper automatiquement les runs. Voir regroupement pour plus d’informations.
`WANDB_RUN_ID`	Définissez cette variable sur une chaîne unique au niveau global (par projet) correspondant à une exécution unique de votre script. Elle ne doit pas dépasser 64 caractères. Tous les caractères non alphanumériques sont convertis en tirets. Elle permet de reprendre un run existant en cas d’échec.
`WANDB_QUIET`	Définissez cette variable sur `true` pour limiter les messages journalisés sur la sortie standard aux seuls messages critiques. Si elle est définie, tous les journaux sont écrits dans `$WANDB_DIR/debug.log`.
`WANDB_SILENT`	Définissez cette variable sur `true` pour masquer les messages de journal de wandb. C’est utile pour les commandes scriptées. Si elle est définie, tous les journaux sont écrits dans `$WANDB_DIR/debug.log`.
`WANDB_SHOW_RUN`	Définissez cette variable sur `true` pour ouvrir automatiquement un navigateur avec l’URL du run, si votre système d’exploitation le permet.
`WANDB_SWEEP_ID`	Ajoute le suivi de l’ID de sweep aux objets `Run` et aux classes associées, et l’affiche dans l’interface utilisateur.
`WANDB_TAGS`	Liste de tags, séparés par des virgules, à appliquer au run.
`WANDB_USERNAME`	Nom d’utilisateur d’un membre de votre équipe associé au run. Peut s’utiliser avec la clé API d’un compte de service pour attribuer les runs automatisés à des membres de votre équipe.
`WANDB_USER_EMAIL`	Adresse e-mail d’un membre de votre équipe associé au run. Peut s’utiliser avec la clé API d’un compte de service pour attribuer les runs automatisés à des membres de votre équipe.

Environnements Singularity

Si vous exécutez des conteneurs dans Singularity, vous pouvez transmettre des variables d’environnement en ajoutant le préfixe SINGULARITYENV_ aux variables ci-dessus. Pour en savoir plus sur les variables d’environnement de Singularity, consultez cette page.

Exécution sur AWS

Si vous exécutez des tâches par lots dans AWS, vous pouvez facilement authentifier vos machines avec vos identifiants W&B. Créez une clé API dans les Paramètres utilisateur, puis définissez la variable d’environnement WANDB_API_KEY dans la spécification de la tâche AWS Batch.

​Variables d’environnement facultatives

​Environnements Singularity

​Exécution sur AWS

Variables d’environnement facultatives

Environnements Singularity

Exécution sur AWS