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

# wandb sweep

export const GitHubLink = ({url, compact = false}) => <a href={url} target="_blank" rel="noopener noreferrer" className={compact ? "source-link" : "github-source-link"}>
    {compact ? "View source" : <>
    <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>
    GitHub source
      </>}
  </a>;

<GitHubLink compact url="https://github.com/wandb/wandb/blob/v0.30.0/wandb/cli/cli.py#L718" />

<h2 id="usage">
  Utilisation
</h2>

```bash theme={"system"}
sweep [OPTIONS] CONFIG_YAML_OR_SWEEP_ID
```

<h2 id="description">
  Description
</h2>

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

Pour créer un sweep, fournissez un fichier de configuration YAML. Définissez-y la stratégie
de recherche, les paramètres et la métrique à optimiser.
La commande enregistre le sweep auprès du serveur W\&B, puis affiche l’ID du sweep
ainsi qu’une commande permettant de démarrer un agent.

Pour gérer un sweep existant, fournissez son ID (ou le chemin complet entity/project/sweep\_id) avec un
indicateur d’état (`--stop`, `--cancel`, `--pause` ou `--resume`).

L’ID du sweep est un identifiant unique généré par
W\&B lors de la création du sweep. Vous le trouverez dans l’App W\&B
ou dans la sortie de la commande `wandb sweep` lorsque vous créez un nouveau sweep.

Par exemple, pour créer un sweep à partir de la configuration définie dans
sweep\_config.yaml, en utilisant l’entity et le projet par défaut de l’utilisateur actuel :

```bash theme={"system"}
wandb sweep sweep_config.yaml
```

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

```bash theme={"system"}
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 :

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

Pour arrêter le sweep abcd1234 de l’entity "team-awesome"
et du projet "foobar" :

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

Pour annuler le sweep abcd1234 dans l'entity et le projet par défaut de l'utilisateur actuel :

```bash theme={"system"}
wandb sweep --cancel abcd1234
```

Pour mettre en pause le sweep abcd1234 dans l'entity et le projet par défaut de l'utilisateur actuel, puis
le reprendre ultérieurement :

```bash theme={"system"}
wandb sweep --pause abcd1234
```

```bash theme={"system"}
wandb sweep --resume abcd1234
```

Pour créer un sweep avec un contrôleur local qui utilise la configuration
définie dans sweep\_config.yaml :

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

Pour créer un nouveau sweep et y inclure deux runs déjà terminés
(ID de run abcd1234 et ID de run efgh5678) afin que leurs résultats soient pris en compte
dans la recherche d'hyperparamètres du sweep :

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

<h2 id="arguments">
  Arguments
</h2>

| Nom | Par défaut | Type |
| - | - | - |
| `config_yaml_or_sweep_id` | STR | True |

<h2 id="options">
  Options
</h2>

| Flag | Type | Description |
| - | - | - |
| `--project, -p` | STR | Définit le projet des runs du sweep. Utilise « Uncategorized » si aucun projet n’est défini. **Par défaut** : None |
| `--entity, -e` | STR | Définit l’entity du sweep. Utilise l’entity par défaut de l’utilisateur actuel si aucune n’est définie. **Par défaut** : None |
| `--controller` | BOOL Flag | Démarre un contrôleur de sweep local après la création du sweep. **Par défaut** : False |
| `--verbose` | BOOL Flag | Affiche une sortie détaillée. **Par défaut** : False |
| `--name` | STR | Définit un nom d’affichage pour le sweep. Utilise l’ID du sweep si aucun nom n’est 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 la configuration d’un sweep encore en attente, avant le démarrage du moindre run. Transmettez l’ID du sweep. **Par défaut** : None |
| `--stop` | BOOL Flag | Arrête un sweep. Laisse les runs actifs se terminer, mais n’en démarre pas de nouveaux. **Par défaut** : False |
| `--cancel` | BOOL Flag | Annule un sweep. Interrompt les runs actifs et cesse d’en démarrer de nouveaux. **Par défaut** : False |
| `--pause` | BOOL Flag | Met un sweep en pause. Cesse temporairement de démarrer de nouveaux runs. **Par défaut** : False |
| `--resume` | BOOL Flag | Reprend un sweep en pause. **Par défaut** : False |
| `--prior_run, -R` | STR | Joint un run existant à ce sweep à partir de son ID. Répétez l’option pour joindre plusieurs runs. **Par défaut** : None |
