Skip to main content

​
fonction wandb.login()

Connectez-vous à W&B. En général, vous n’avez pas besoin d’utiliser ceci, 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 CLI wandb login. Cette opération 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, éventuellement, le fichier .netrc. Si un fichier de jeton d’identité est configuré, par exemple via la variable d’environnement WANDB_IDENTITY_TOKEN_FILE, il 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 explicite est fournie, elle est utilisée et écrite dans le fichier système .netrc. Si aucune clé n’est fournie, mais que la session est déjà authentifiée, la clé de session est utilisée pour la vérification (si verify vaut True) et le fichier .netrc n’est pas mis à jour. Si aucun des cas ci-dessus ne s’applique, cette opération récupère la clé API depuis la première des sources suivantes :
  • La variable d’environnement WANDB_API_KEY
  • Le paramètre api_key dans un fichier de paramètres système ou de Workspace
  • Le fichier .netrc (soit ~/.netrc, ~/_netrc ou le chemin spécifié par la variable d’environnement NETRC)
  • Une invite interactive, si disponible et si prompt vaut True

​
Arguments

​
str | None
La clé API à utiliser.
​
bool | None
Si la valeur est true, récupère la clé API via une invite interactive, sans lire .netrc, les variables d’environnement, etc.
​
str | None
L’URL du serveur W&B auquel se connecter.
​
bool | None
Si la valeur est true, empêche de sélectionner le mode hors ligne dans l’invite interactive.
​
int | None
Nombre de secondes pendant lesquelles attendre une saisie de l’utilisateur dans l’invite interactive. Peut servir de mécanisme de sécurité 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 avec les clés API comme 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 la valeur est False, renvoie False et laisse la session et les paramètres inchangés.
​
DoNotSet
Aucune description fournie.

​
Renvoie

True si la session dispose d’identifiants d’authentification après cet appel.

​
Exceptions levées

  • AuthenticationError: Si les identifiants d’authentification échouent à la vérification auprès du serveur.
  • UsageError: Si aucun identifiant d’authentification n’est configuré, que prompt vaut True et qu’aucun terminal n’est disponible pour demander une clé API.