function wandb.login()
Se connecter à W&B. En règle générale, vous n’avez pas besoin d’utiliser cette fonction, car la plupart des méthodes W&B qui nécessitent une authentification peuvent se connecter implicitement. Il s’agit de l’équivalent programmatique de la commande CLIwandb login.
Cette fonction met à jour les identifiants d’authentification globaux de la session (ce qui affecte toute utilisation de wandb
dans le processus Python en cours après cet appel) et, le cas échéant, le fichier .netrc.
Si un fichier de jeton d’identité est configuré, par exemple via la
variable d’environnement WANDB_IDENTITY_TOKEN_FILE, ce jeton est utilisé pour la
session (identité fédérée) et aucune clé API n’est lue ni enregistrée.
Sinon, si une clé API est explicitement fournie, elle est utilisée et écrite dans
le fichier .netrc du système. Si aucune clé n’est fournie, mais que la session est déjà
authentifiée, la clé de la session est utilisée pour la vérification (si verify
vaut True) et le fichier .netrc n’est pas mis à jour.
Si aucune de ces conditions n’est remplie, la clé API est récupérée à partir de la première source disponible parmi les suivantes :
- La variable d’environnement WANDB_API_KEY
- Le paramètre api_key dans un fichier de paramètres du système ou du workspace
- Le fichier .netrc (~/.netrc, ~/_netrc ou le chemin indiqué par la variable d’environnement NETRC)
- Une invite interactive, si elle est disponible et si
promptvaut True
Arguments
str | None
La clé API à utiliser.
bool | None
Si true, obtient la clé API via une invite interactive, sans lire le fichier .netrc, les variables d’environnement, etc.
str | None
L’URL du serveur W&B auquel se connecter.
bool | None
Si true, empêche de sélectionner le mode hors ligne dans l’invite interactive.
int | None
Délai d’attente, en secondes, de la saisie de l’utilisateur dans l’invite interactive. Ce paramètre peut servir de garde-fou si une invite interactive s’affiche par erreur dans un environnement non interactif.
bool
Vérifie les identifiants d’authentification auprès du serveur W&B et lève une AuthenticationError en cas d’échec. Fonctionne aussi bien avec les clés API qu’avec les jetons d’identité.
str | None
Le référent à utiliser dans la requête de connexion par URL, à des fins d’analyse.
bool
Indique s’il faut demander une clé API de manière interactive lorsqu’aucune n’est configurée. Si False, renvoie False sans modifier la session ni les paramètres.
DoNotSet
Aucune description fournie.
Renvoie
True si la session dispose d’identifiants d’authentification après cet appel.Exceptions levées
AuthenticationError: si le serveur rejette les identifiants d’authentification lors de la vérification.UsageError: si aucun identifiant d’authentification n’est configuré, quepromptvaut True et qu’aucun terminal n’est disponible pour demander une clé API.