Skip to main content

Classe wandb.Settings

Paramètres de configuration du SDK W&B. Cette classe gère les paramètres de configuration du SDK W&B et garantit la sécurité des types ainsi que la validation de tous les paramètres. Les paramètres sont accessibles sous forme d’attributs et peuvent être initialisés par programmation, via des variables d’environnement (préfixe WANDB_), et à l’aide de fichiers de configuration. Les paramètres sont organisés en trois catégories :
  1. Paramètres publics : options de configuration principales que les utilisateurs peuvent modifier en toute sécurité pour personnaliser le comportement de W&B en fonction de leurs besoins spécifiques.
  2. Paramètres internes : paramètres préfixés par « x_ » qui gèrent le comportement du SDK à bas niveau. Ces paramètres sont principalement destinés à un usage interne et au débogage. Bien qu’ils puissent être modifiés, ils ne sont pas considérés comme faisant partie de l’API publique et peuvent changer sans préavis dans les futures versions.
  3. Paramètres calculés : paramètres en lecture seule automatiquement dérivés d’autres paramètres ou de l’environnement.
Les paramètres sont chargés à partir de plusieurs sources. Lorsqu’un même paramètre est fourni par plusieurs sources, celle qui apparaît le plus bas dans la liste l’emporte. Par ordre de priorité croissante :
  1. Les valeurs par défaut définies sur ce modèle Settings.
  2. Les fichiers de configuration (~/.config/wandb/settings, ou le fichier settings dans le répertoire désigné par la variable d’environnement WANDB_CONFIG_DIR).
  3. Les variables d’environnement (celles préfixées par WANDB_, par ex. WANDB_MODE).
  4. Les valeurs détectées à partir de l’environnement d’exécution, telles que le nom d’hôte, le chemin du programme/script en cours d’exécution, l’exécutable Python, l’image Docker et les détails du notebook Jupyter.
  5. Les paramètres SageMaker, lors d’une exécution dans un environnement Amazon SageMaker.
  6. Le paramètre settings de wandb.setup().
  7. Le paramètre settings de wandb.init().
  8. Certains paramètres de wandb.init() (par exemple, mode= redéfinit le paramètre mode).

Arguments

Indique si des liens symboliques vers les fichiers multimédias doivent être créés dans le répertoire du run.Si la valeur est true, les fichiers multimédias seront liés au répertoire du run par des liens symboliques ou physiques au lieu d’être copiés. Cela peut accélérer la journalisation et réduire l’utilisation du disque. Toutefois, toute suppression ou modification des fichiers d’origine avant leur téléversement vers le serveur W&B sera répercutée dans les données téléversées.
bool
Indicateur permettant de synchroniser les artefacts de tableau en mode hors ligne.Pour revenir à l’ancien comportement, définissez cette valeur sur False.
bool
Indicateur permettant de modifier les valeurs de Config après leur définition.
object
Obsolète et sera supprimé.
str | None
La clé API W&B.
dict[str, str] | None
Mappage des URL de comptes Azure vers leurs clés d’accès correspondantes pour l’intégration Azure.
str | None
Redéfinition de l’URL « app » pour l’interface W&B.L’app_url est normalement calculée à partir de base_url, mais cette option permet de la définir explicitement.WANDB_APP_URL est la variable d’environnement correspondante.
str
L’URL du backend W&B pour la synchronisation des données.
str | None
Répertoire contenant le code à suivre par W&B.
collections.abc.Sequence[str] | None
Chemins des fichiers à partir desquels charger la configuration dans l’objet Config.
Literal
Le type de capture de console à appliquer.Les valeurs possibles sont :
  • “auto” - Sélectionne automatiquement la méthode de capture de console selon l’environnement et les paramètres du système.
  • “off” - Désactive la capture de console.
  • “redirect” - Redirige les descripteurs de fichiers de bas niveau pour capturer la sortie.
  • “wrap” - Redéfinit les méthodes d’écriture de sys.stdout/sys.stderr. Est mappé vers “wrap_raw” ou “wrap_emu” selon l’état du système.
  • “wrap_raw” - Identique à “wrap”, mais capture directement la sortie brute au lieu de passer par un émulateur. Dérivé du paramètre wrap et ne doit pas être défini manuellement.
  • “wrap_emu” - Identique à “wrap”, mais capture la sortie via un émulateur. Dérivé du paramètre wrap et ne doit pas être défini manuellement.
bool
Active la journalisation de console multipart.Lorsque la valeur est True, le SDK écrit la sortie de la console dans des fichiers horodatés sous le répertoire logs/ au lieu d’un unique fichier output.log.Chaque partie est téléversée dès sa fermeture, offrant aux utilisateurs un accès aux journaux en temps réel pendant que le run est actif. La fréquence de rotation est contrôlée par console_chunk_max_bytes et/ou console_chunk_max_seconds. Si les deux limites sont définies sur 0, tous les journaux sont téléversés à la fin du run.Remarque : les fragments téléversés sont immuables ; les séquences de contrôle du terminal qui modifient les lignes précédentes (par ex., les barres de progression utilisant des retours chariot) n’affectent que le fragment actuel.
int
Seuil de rotation basé sur la taille pour les journaux de console multipart, en octets.Démarre un nouveau fichier journal de console lorsque la partie actuelle atteint cette taille. N’a d’effet que lorsque console_multipart est True. Peut être combiné avec console_chunk_max_seconds ; la première limite atteinte déclenche la rotation. Une valeur de 0 désactive la limite basée sur la taille.
int
Seuil de rotation basé sur le temps pour les journaux de console multipart, en secondes.Démarre un nouveau fichier journal de console après l’écoulement de ce nombre de secondes depuis le début de la partie actuelle. Nécessite que console_multipart soit True. Peut être utilisé avec console_chunk_max_bytes ; la première limite atteinte ferme la partie. Une valeur de 0 désactive la limite basée sur le temps.
dict[str, str] | None
Noms des loggers Python à capturer dans l’onglet Logs du run.Mappage entre les noms de loggers et les niveaux de journalisation minimaux. Lorsque ce paramètre est défini, wandb installe un logging.Handler sur chaque logger nommé et le supprime à la fin du run. Les enregistrements émis par ces loggers sont publiés dans le run en tant que sortie de console, de manière similaire à la capture de stdout/stderr.Les enregistrements sont formatés comme avec logging.basicConfig(), par exemple INFO:my_module:Some message. Ce format n’est actuellement pas personnalisable.Pour capturer tous les journaux, transmettez le nom du logger racine, à savoir ‘root’.Ce paramètre est indépendant du paramètre console : les deux peuvent être actifs simultanément.Exemple :
str
Chemin du fichier dans lequel écrire les jetons d’accès temporaires.
bool
Indique s’il faut désactiver la capture du code.
bool
Indique s’il faut désactiver la capture de l’état Git.
bool
Indique s’il faut désactiver la déduction du point de fork à partir des branches distantes.Lorsqu’il est défini sur True, le SDK utilisera le dernier commit de la branche en amont, si elle est définie. Sinon, il ignore la génération du patch diff.Lorsqu’il est défini sur False, le SDK essaiera d’utiliser le dernier commit de la branche en amont, si elle est définie. Sinon, il trouvera le commit le plus proche parmi toutes les branches distantes. Cela peut affecter les performances des dépôts comportant de nombreuses branches en amont.
bool
Indique s’il faut désactiver la création d’un artefact de job pour W&B Launch.
str | None
L’image Docker utilisée pour exécuter le script.
str | None
L’adresse e-mail de l’utilisateur.
str | None
L’entité W&B, telle qu’un utilisateur ou une équipe.
str | None
L’organisation W&B.
bool
Indique s’il faut transmettre l’indicateur force à wandb.login().
wandb.sdk.lib.run_moment.RunMoment | None
Spécifie un point d’une exécution précédente d’un run à partir duquel forker.Le point est défini par l’ID du run, une métrique et sa valeur. Actuellement, seule la métrique ‘_step’ est prise en charge.
str | None
Le hachage du commit Git à associer au run.
str
Le dépôt distant Git à associer au run.
str | None
L’URL du dépôt distant Git.
str | None
Répertoire racine du dépôt Git.
str | None
Nom d’hôte de la machine exécutant le script.
str | None
Serveurs proxy personnalisés pour les requêtes HTTP vers W&B.
str | None
Serveurs proxy personnalisés pour les requêtes HTTPS vers W&B.
str | None
Chemin du fichier contenant un jeton d’identité (JWT) pour l’authentification.
Sequence
Motifs glob Unix relatifs à files_dir spécifiant les fichiers à exclure du téléversement.
float
Durée, en secondes, pendant laquelle attendre la fin de l’appel à wandb.init avant l’expiration du délai.
float
Durée, en secondes, pendant laquelle attendre le téléversement des données à la fin d’une exécution.La définition de cette valeur peut limiter les coûts liés aux téléversements lents vers W&B à la fin d’une exécution, mais l’exécution sera alors marquée comme plantée et certaines données pourraient être manquantes. Par défaut, run.finish() bloque jusqu’à ce que toutes les données soient téléversées.Si cette valeur est supérieure à zéro, W&B abandonne le téléversement des données d’une exécution après ce nombre de secondes à la fin de celle-ci, ce qui libère votre script. Après un certain temps, l’exécution passe à l’état Crashed ou Failed dans l’interface utilisateur. Toutes les données non téléversées restent stockées sur le disque et peuvent être téléversées avec wandb sync.Utilisez le paramètre finish_timeout_raises pour lever une erreur en plus d’afficher un message d’avertissement.Les exécutions arrêtées par wandb.teardown() (qui s’exécute automatiquement à la fin d’un script via un hook atexit) respectent également ce paramètre.
bool
Indique s’il faut lever une TimeoutError si le délai finish_timeout expire.L’utilisation de ce paramètre avec finish_timeout entraîne la levée d’une TimeoutError par run.finish() à l’expiration du délai, en plus de l’affichage d’un message.Notez que run.finish() est appelé implicitement lorsqu’une Run est utilisée comme gestionnaire de contexte :with wandb.init() as run: … # run.finish() s’exécute à la fin du bloc withCela ne provoque pas la levée d’une erreur par wandb.teardown() (puisqu’il s’exécute de toute façon à la fin d’un script).
bool
Indique s’il faut désactiver de manière non sécurisée la vérification SSL.
str | None
Nom du job Launch qui exécute le script.
Optional
Type de source pour Launch.
bool
Indique s’il faut désactiver les fonctionnalités d’étiquetage automatique.
str | None
Chemin d’accès au fichier de configuration Launch.
float | None
Durée, en secondes, pendant laquelle attendre les opérations de connexion avant expiration du délai.
Literal
Mode de fonctionnement de la journalisation et de la synchronisation W&B.
str | None
Nom du notebook en cas d’exécution dans un environnement de type Jupyter.
str | None
Chemin d’accès au script qui a créé l’exécution, s’il est disponible.
str | None
Chemin absolu depuis le répertoire racine du dépôt jusqu’au script qui a créé l’exécution.Le répertoire racine du dépôt est le répertoire contenant le répertoire .git, s’il existe. Sinon, il s’agit du répertoire de travail actuel.
str | None
Chemin relatif vers le script qui a créé l’exécution.
str | None
ID du projet W&B.
bool
Indicateur permettant de supprimer les sorties non essentielles.
Union
Action à effectuer lorsque wandb.init() est appelé alors qu’une exécution est active.Options :
  • “default” : Utiliser “finish_previous” dans les notebooks et “return_previous” dans les autres cas.
  • “return_previous” : Renvoyer l’exécution créée la plus récemment qui n’est pas encore terminée. Cela ne met pas à jour wandb.run ; voir l’option “create_new”.
  • “finish_previous” : Terminer toutes les exécutions actives, puis renvoyer une nouvelle exécution.
  • “create_new” : Créer une nouvelle exécution sans modifier les autres exécutions actives. Ne met pas à jour wandb.run ni les fonctions de premier niveau comme wandb.log. Par conséquent, certaines intégrations plus anciennes qui dépendent de l’exécution globale ne fonctionneront pas.
Peut également être une valeur booléenne, mais cette utilisation est obsolète. False équivaut à “return_previous” et True équivaut à “finish_previous”.
bool
Indicateur permettant de forcer une nouvelle tentative de connexion.
Optional
Spécifie le comportement de reprise du run.Options :
  • “must” : Reprend un run existant portant le même ID. Si aucun run de ce type n’existe, l’opération échoue.
  • “allow” : Tente de reprendre un run existant portant le même ID. Si aucun n’est trouvé, un nouveau run est créé.
  • “never” : Démarre toujours un nouveau run. Si un run portant le même ID existe déjà, l’opération échoue.
  • “auto” : Reprend automatiquement le dernier run en échec sur la même machine.
wandb.sdk.lib.run_moment.RunMoment | None
Spécifie un point d’une exécution précédente du run à partir duquel reprendre.Ce point est défini par l’ID du run, une métrique et sa valeur. Actuellement, seule la métrique ‘_step’ est prise en charge.
str
Répertoire racine à utiliser comme base pour tous les chemins associés au run.Il permet notamment de déterminer le répertoire wandb et le répertoire du run.
str | None
Identifiant de groupe pour les runs associés.Utilisé pour regrouper les runs dans l’interface utilisateur.
str | None
ID du run.
str | None
Type de job exécuté (par exemple, entraînement ou évaluation).
str | None
Nom lisible du run.
str | None
Notes ou description supplémentaires du run.
tuple[str, ...] | None
Tags à associer au run pour l’organisation et le filtrage.
bool
Indicateur permettant de désactiver les fonctionnalités spécifiques à SageMaker.
bool | None
Indique s’il faut enregistrer le code associé au run.
str | None
Chemin vers le fichier de paramètres système.
collections.abc.Callable[[], None] | None
Fonction de rappel à exécuter pour arrêter le run.Un run peut être arrêté via l’interface utilisateur web ou après une erreur fatale (si cela est configuré dans un paramètre).Par défaut, pour arrêter un run, W&B envoie un SIGINT au thread principal. Définissez cette fonction de rappel pour redéfinir ce comportement, par exemple afin d’utiliser un autre signal ou d’effectuer une autre action avant l’interruption.La fonction de rappel s’exécute dans un thread distinct. Elle s’exécute peu après qu’un arrêt est demandé, mais pas immédiatement.
int
Nombre maximal de graphiques sparkline d’historique à afficher à la fin d’un run.
int
Nombre maximal de métriques de synthèse à afficher à la fin d’un run.
bool
Indique s’il faut afficher les messages d’erreur.
bool
Indique s’il faut afficher les messages d’information.
bool
Indique s’il faut afficher les messages d’avertissement.
bool
Indicateur permettant de supprimer toute sortie.
bool
Indique s’il faut arrêter le run après une erreur fatale.Lorsqu’une erreur irrécupérable survient pendant le téléversement de données, W&B affiche un message et arrête le téléversement, tout en vous permettant de continuer à journaliser des données. Ce comportement est généralement souhaitable : vos métriques d’entraînement sont stockées sur le disque et peuvent être récupérées à l’aide de wandb sync, même si elles ne sont pas téléversées.Cela n’est pas utile si vos fichiers sont supprimés après l’entraînement. Dans ce cas, définir cette valeur sur True arrête le run après une erreur fatale, comme si vous aviez cliqué sur le bouton d’arrêt dans l’interface utilisateur web.
bool | None
Indique s’il faut activer le mode strict pour la validation et la vérification des erreurs.
int
Durée, en secondes, d’attente des opérations de synthèse avant expiration du délai.
str | None
Identifiant du sweep auquel appartient ce run.
str | None
Chemin vers la configuration des paramètres du sweep.
Indique s’il faut utiliser des liens symboliques (True par défaut, sauf sous Windows).
bool | None
Indique s’il faut synchroniser les journaux TensorBoard avec W&B.
bool
Indique s’il faut lever une exception lorsque la limite du nombre de lignes du tableau est dépassée.
bool | None
Indique s’il faut utiliser un répertoire caché .wandb ou un répertoire visible wandb pour les données du run.Si True, le SDK utilise .wandb. Si False, wandb. Si cette option n’est pas définie, .wandb est utilisé s’il existe déjà, sinon wandb.
str | None
Nom d’utilisateur.
bool
Indicateur permettant de désactiver la collecte des métadonnées système.
bool
Indicateur permettant de désactiver la collecte des métriques système.
dict[str, str] | None
En-têtes supplémentaires à ajouter à toutes les requêtes HTTP sortantes.
str | None
Libellé à attribuer aux métriques système et aux journaux de console collectés pour le run.Il permet de regrouper les données dans le frontend et de distinguer les données de différents processus au sein d’une tâche d’entraînement distribuée.
bool
Détermine s’il faut enregistrer les fichiers internes de wandb et les métadonnées.Dans un environnement distribué, cette option permet d’éviter que les processus secondaires n’écrasent des fichiers lorsque seules les métriques système et les journaux sont nécessaires, car le processus principal assure la journalisation principale.
bool
Indicateur permettant d’enregistrer le fichier des exigences.
bool
Indicateur permettant de déléguer au serveur le calcul automatique de la synthèse à partir de l’historique.Cela ne désactive pas les mises à jour de synthèse fournies par l’utilisateur.
float
Durée d’attente, en secondes, du démarrage du service interne wandb-core.
bool
Indique s’il faut ignorer l’enregistrement des événements du run dans le journal des transactions.Cela ne concerne que les runs en ligne. Cette option peut être utilisée pour réduire la quantité de données écrites sur le disque.À utiliser avec prudence, car elle supprime les garanties de récupérabilité.
float
Intervalle d’échantillonnage du moniteur système, en secondes.
dict[str, str] | None
Points de terminaison OpenMetrics /metrics à surveiller pour les métriques système.
dict[str, dict[str, str]] | collections.abc.Sequence[str] | None
Filtre à appliquer aux métriques collectées depuis les points de terminaison OpenMetrics /metrics.Prend en charge deux formats :
  • {"metric regex pattern, including endpoint name as prefix": {"label": "label value regex pattern"}}
  • ("metric regex pattern 1", "metric regex pattern 2", ...)
dict[str, str] | None
En-têtes HTTP à ajouter aux requêtes OpenMetrics.
collections.abc.Sequence[str] | None
Chemins système à surveiller pour l’utilisation du disque.
int | None
Nombre de CPU du système.S’il est défini, redéfinit la valeur détectée automatiquement dans les métadonnées du run.
int | None
Nombre de CPU logiques.S’il est défini, redéfinit la valeur détectée automatiquement dans les métadonnées du run.
int | None
Nombre de périphériques GPU.S’il est défini, redéfinit la valeur détectée automatiquement dans les métadonnées du run.
str | None
Type de périphérique GPU.S’il est défini, redéfinit la valeur détectée automatiquement dans les métadonnées du run.
collections.abc.Sequence[int] | None
Indices des périphériques GPU à surveiller.S’ils ne sont pas définis, le moniteur système capture les métriques de tous les GPU. Suppose une indexation à partir de 0 correspondant à l’énumération des périphériques CUDA/ROCm.
bool
Surveille l’ensemble de l’arborescence des processus pour suivre l’utilisation des ressources à partir de x_stats_pid.Lorsque la valeur est True, le moniteur système agrège le RSS, le pourcentage d’utilisation du CPU et le nombre de threads du processus dont le PID est x_stats_pid ainsi que de tous ses descendants. Cette option peut dégrader les performances et est désactivée par défaut.
bool
Désactive les limites de CPU et de mémoire de cgroup v2 pour les pourcentages des métriques système.
str
Suffixe à ajouter au nom du répertoire de l’exécution (sync_dir).Cette valeur est définie dans wandb.init() pour éviter les conflits de nommage. Si elle est définie, elle est ajoutée au nom par défaut, séparée par un tiret.
bool
Indicateur précisant si ce processus peut mettre à jour l’état final de l’exécution sur le serveur.Définissez cette valeur sur False lors d’un entraînement distribué, lorsque seul le processus principal doit déterminer l’état final.

Propriétés

str
L’URL de l’interface W&B, généralement https://wandb.ai.Elle diffère de base_url (par exemple https://api.wandb.ai), utilisée pour accéder aux API W&B par programmation.
str | None
L’URL du notebook Colab, en cas d’exécution dans Colab.
Literal['local', 'cloud']
Aucune description fournie.
str
Chemin absolu vers le répertoire local où sont stockés les fichiers du run.
bool
Aucune description fournie.
str
Répertoire où stocker les fichiers journaux.
str
Chemin vers le fichier à utiliser pour les journaux internes.
Chemin vers le lien symbolique du fichier journal interne du run le plus récent.
Chemin vers le lien symbolique du fichier journal du processus utilisateur du run le plus récent.
str
Chemin vers le fichier à utiliser pour les journaux du processus utilisateur.
str
L’URL W&B où le projet peut être consulté.
str
Chemin vers le fichier de reprise.
Literal['run', 'offline-run']
Mode du run : « run » ou « offline-run ».
str
L’URL W&B où le run peut être consulté.
str
Chemin vers le fichier de paramètres du workspace.
str
L’URL W&B où le sweep peut être consulté.
str
Répertoire où stocker les fichiers du run.
str
Chemin vers le fichier journal binaire de transactions en ajout seul.
Chemin vers le lien symbolique du fichier journal de transactions du run le plus récent.
str
Spécification temporelle du run.
str
Chemin complet vers le répertoire wandb.

Méthodes

méthode Settings.validate_anonymous()

Arguments
object
Aucune description fournie.

méthode Settings.validate_x_extra_http_headers()

Arguments
_empty
Aucune description fournie.

méthode Settings.validate_x_stats_coreweave_metadata_base_url()

Arguments
_empty
Aucune description fournie.