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

# 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/main/wandb/apis/public/sweeps.py" />

## <kbd>class</kbd> `Sweep`

L’ensemble des runs associés au balayage.

**Attributs :**

* `runs` (Runs) :  Liste des runs
* `id` (str) :  ID du balayage
* `project` (str) :  Nom du projet auquel le balayage appartient
* `config` (dict) :  Dictionnaire contenant la configuration du balayage
* `state` (str) :  État du balayage. Peut être "Finished", "Failed",  "Crashed" ou "Running".
* `expected_run_count` (int) :  Nombre de runs attendus pour le balayage

### <kbd>méthode</kbd> `Sweep.__init__`

```python theme={null}
__init__(
    service_api: 'ServiceApi',
    entity: 'str',
    project: 'str',
    sweep_id: 'str',
    attrs: 'Mapping[str, Any] | None' = None
)
```

***

### <kbd>propriété</kbd> Sweep.config

Configuration du balayage utilisée pour ce balayage.

***

### <kbd>propriété</kbd> Sweep.entity

L’entité associée au balayage.

**Retourne :**

* `str` : La valeur de la propriété entité.

***

### <kbd>propriété</kbd> Sweep.expected\_run\_count

Retourne le nombre de runs attendus dans le balayage, ou None si le nombre de runs est infini.

**Retourne :**

* `int | None`: La valeur de propriété expected\_run\_count.

***

### <kbd>propriété</kbd> Sweep.name

Le nom du balayage.

Renvoie le premier nom disponible selon l’ordre de priorité suivant :

1. Nom d’affichage modifié par l’utilisateur 2. Nom défini lors de la création 3. ID du balayage

***

### <kbd>propriété</kbd> Sweep.order

Renvoie la clé d’ordre du balayage.

***

### <kbd>propriété</kbd> Sweep.path

Renvoie le chemin du projet.

Le chemin est une liste qui contient l’entité, le nom du projet et l’ID du balayage.

***

### <kbd>propriété</kbd> Sweep.url

L’URL du balayage.

L’URL du balayage est générée à partir de l’entité, du projet, du terme « sweeps » et de `ID du balayage.run_id`. Pour les utilisateurs SaaS, elle se présente sous la forme `https://wandb.ai/entity/project/sweeps/sweeps_ID`.

***

### <kbd>propriété</kbd> Sweep.username

Obsolète. Utilisez `Sweep.entity` à la place.

**Retourne :**

* `str` : La valeur de la propriété du nom d’utilisateur.

***

### <kbd>méthode</kbd> `Sweep.agent`

```python theme={null}
agent(agent_id: 'str') → Agent
```

Récupérer un agent à partir de son ID pour ce balayage.

**Arguments :**

* `agent_id` : l’ID de l’agent à récupérer.

***

### <kbd>méthode</kbd> `Sweep.agents`

```python theme={null}
agents() → list[Agent]
```

Récupérez la liste de tous les agents de ce balayage.

***

### <kbd>méthode</kbd> `Sweep.best_run`

```python theme={null}
best_run(order=None)
```

Retourne le meilleur run, trié selon la métrique définie dans la configuration ou l’ordre fourni.

***

### <kbd>méthode de classe</kbd> `Sweep.get`

```python theme={null}
get(
    api: 'Api',
    entity: 'str | None' = None,
    project: 'str | None' = None,
    sid: 'str | None' = None,
    order: 'str | None' = None,
    query: 'str | None' = None,
    **kwargs
)
```

Exécute une requête sur le backend cloud.

**Arguments :**

* `api`:  L’instance d’API W\&B.
* `entity`:  L’entité (nom d’utilisateur ou équipe) propriétaire du projet.
* `project`:  Le nom du projet depuis lequel récupérer le balayage.
* `sid`:  L’ID du balayage à interroger.
* `order`:  L’ordre dans lequel les runs du balayage sont renvoyés.
* `query`:  La requête à utiliser pour exécuter la requête.
* `**kwargs`:  Arguments nommés supplémentaires à transmettre à la requête.

***

### <kbd>méthode</kbd> `Sweep.to_html`

```python theme={null}
to_html(height: 'int' = 420, hidden: 'bool' = False) → str
```

Génère du HTML contenant une iframe qui affiche ce balayage.