> ## 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.

# wandb sweep

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/v0.28.0/wandb/cli/cli.py#L931" />

<div id="usage">
  ## Utilisation
</div>

```bash theme={null}
sweep [OPTIONS] CONFIG_YAML_OR_SWEEP_ID
```

<div id="description">
  ## Description
</div>

Créez, mettez à jour ou gérez un sweep d'hyperparamètres.

Fournissez un fichier de configuration YAML pour créer un sweep. Définissez la
stratégie de recherche, les paramètres et la métrique à optimiser dans la configuration.
Enregistrez le sweep sur le serveur W\&B et affichez l'ID du sweep
ainsi qu'une commande pour démarrer un agent.

Fournissez un ID de sweep (ou le chemin complet entité/project/sweep\_id) avec une
option d'état (`--stop`, `--cancel`, `--pause` ou `--resume`) pour gérer
un sweep existant.

L'ID du sweep est un ID unique du sweep, généré par
W\&B lors de sa création. Vous pouvez trouver l'ID du sweep dans la W\&B App
ou dans la sortie de la commande `wandb sweep` lorsque vous créez un nouveau sweep.

Par exemple, pour créer un sweep à l'aide de la configuration définie dans
sweep\_config.yaml. Utilisez l'entité et le projet par défaut de l'utilisateur actuel :

```bash theme={null}
wandb sweep sweep_config.yaml
```

Pour créer un sweep et stocker les résultats dans l’entité "team-awesome"
et le projet "foobar" :

```bash theme={null}
wandb sweep -p foobar -e team-awesome sweep_config.yaml
```

Pour mettre à jour le sweep abcd1234 avec une nouvelle configuration issue de sweep\_config.yaml.
Cela est utile pour modifier les paramètres ou la stratégie de recherche d'un
sweep actif :

```bash theme={null}
wandb sweep --update abcd1234 sweep_config.yaml
```

Pour arrêter le sweep abcd1234 dans l’entité "team-awesome"
et le projet "foobar" :

```bash theme={null}
wandb sweep --stop team-awesome/foobar/abcd1234
```

Pour annuler le sweep abcd1234 dans l’entité et le projet par défaut de l’utilisateur courant :

```bash theme={null}
wandb sweep --cancel abcd1234
```

Pour mettre en pause le sweep abcd1234 dans l’entité et le projet par défaut de l’utilisateur actuel.
Plus tard, reprenez le sweep :

```bash theme={null}
wandb sweep --pause abcd1234
```

```bash theme={null}
wandb sweep --resume abcd1234
```

Pour créer un sweep avec un contrôleur local utilisant la configuration
de sweep\_config.yaml :

```bash theme={null}
wandb sweep --controller sweep_config.yaml
```

Pour créer un nouveau sweep et y inclure deux exécutions déjà terminées
(ID de l’exécution abcd1234 et ID de l’exécution efgh5678) afin d'intégrer leurs résultats
à la recherche d'hyperparamètres du sweep :

```bash theme={null}
wandb sweep -R abcd1234 -R efgh5678 sweep_config.yaml
```

<div id="arguments">
  ## Arguments
</div>

| Nom                       | Valeur par défaut | Type |
| ------------------------- | ----------------- | ---- |
| `config_yaml_or_sweep_id` | STR               | True |

<div id="options">
  ## Options
</div>

| Flag              | Type            | Description                                                                                                                                       |
| ----------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--project, -p`   | STR             | Définit le projet des exécutions du sweep. Utilisez 'Uncategorized' s'il n'est pas défini. **Par défaut** : None                                  |
| `--entity, -e`    | STR             | Définit l'entité du sweep. Utilisez l'entité par défaut de l'utilisateur actuel si elle n'est pas définie. **Par défaut** : None                  |
| `--controller`    | indicateur BOOL | Démarre un contrôleur de sweep local après la création du sweep. **Par défaut** : False                                                           |
| `--verbose`       | indicateur BOOL | Affiche une sortie détaillée. **Par défaut** : False                                                                                              |
| `--name`          | STR             | Définit un nom d'affichage pour le sweep. Utilisez l'ID du sweep s'il n'est pas spécifié. **Par défaut** : None                                   |
| `--program`       | STR             | Redéfinit le programme d'entraînement spécifié dans la configuration du sweep. **Par défaut** : None                                              |
| `--update`        | STR             | Met à jour une configuration de sweep existante. Indiquez l'ID du sweep. **Par défaut** : None                                                    |
| `--stop`          | indicateur BOOL | Arrête un sweep. Laisse les exécutions actives se terminer, mais n'en démarre pas de nouvelles. **Par défaut** : False                            |
| `--cancel`        | indicateur BOOL | Annule un sweep. Interrompt les exécutions actives et empêche le démarrage de nouvelles exécutions. **Par défaut** : False                        |
| `--pause`         | indicateur BOOL | Met un sweep en pause. Empêche temporairement le démarrage de nouvelles exécutions. **Par défaut** : False                                        |
| `--resume`        | indicateur BOOL | Reprend un sweep en pause. **Par défaut** : False                                                                                                 |
| `--prior_run, -R` | STR             | Associe une exécution existante à ce sweep par ID. Indiquez cette option plusieurs fois pour associer plusieurs exécutions. **Par défaut** : None |