> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wandb.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# login()

export const GitHubLink = ({url}) => <a href={url} target="_blank" rel="noopener noreferrer" className="github-source-link">
    <svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
      <path d="M12 0C5.37 0 0 5.37 0 12c0 5.31 3.435 9.795 8.205 11.385.6.105.825-.255.825-.57 0-.285-.015-1.23-.015-2.235-3.015.555-3.795-.735-4.035-1.41-.135-.345-.72-1.41-1.23-1.695-.42-.225-1.02-.78-.015-.795.945-.015 1.62.87 1.845 1.23 1.08 1.815 2.805 1.305 3.495.99.105-.78.42-1.305.765-1.605-2.67-.3-5.46-1.335-5.46-5.925 0-1.305.465-2.385 1.23-3.225-.12-.3-.54-1.53.12-3.18 0 0 1.005-.315 3.3 1.23.96-.27 1.98-.405 3-.405s2.04.135 3 .405c2.295-1.56 3.3-1.23 3.3-1.23.66 1.65.24 2.88.12 3.18.765.84 1.23 1.905 1.23 3.225 0 4.605-2.805 5.625-5.475 5.925.435.375.81 1.095.81 2.22 0 1.605-.015 2.895-.015 3.3 0 .315.225.69.825.57A12.02 12.02 0 0024 12c0-6.63-5.37-12-12-12z" />
    </svg>
    Source GitHub
  </a>;

<GitHubLink url="https://github.com/wandb/wandb/blob/main/wandb/sdk/wandb_login.py" />

### <kbd>fonction</kbd> `login`

```python theme={null}
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 0x109b16dd0>
) → 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.
