Passer au contenu principal

​
fonction login

login(
    key: 'str | None' = None,
    relogin: 'bool | None' = None,
    host: 'str | None' = None,
    force: 'bool | None' = None,
    timeout: 'int | None' = None,
    verify: 'bool' = False,
    referrer: 'str | None' = None,
    anonymous: 'DoNotSet' = <object object at 0x107d3d240>
) → bool
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 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 le paramètre identity_token_file est défini, par exemple via la variable d’environnement WANDB_IDENTITY_TOKEN_FILE, cette opération n’a aucun effet. 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)
Arguments :
  • key: La clé API à utiliser.
  • relogin: Si vrai, récupère la clé API via une invite interactive, sans lire .netrc, les variables d’environnement, etc.
  • host: L’URL du serveur W&B auquel se connecter.
  • force: Si vrai, empêche de sélectionner le mode hors ligne dans l’invite interactive.
  • timeout: Nombre de secondes à attendre pour une saisie utilisateur dans l’invite interactive. Cela peut servir de sécurité si une invite interactive s’affiche par erreur dans un environnement non interactif.
  • verify: Vérifie les identifiants auprès du serveur W&B et lève une AuthenticationError en cas d’échec.
  • referrer: Le référent à utiliser dans la requête de connexion par URL à des fins d’analyse.
Retourne :
  • bool: Si key est configurée.
Exceptions levées :
  • AuthenticationError: Si api_key échoue à la vérification auprès du serveur.
  • UsageError: Si api_key ne peut pas être configurée et qu’aucun tty n’est disponible.