> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-locadex-parallel-t9n-main-cs60c8p4o6ik99tylxgp3.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Sweep
export const GitHubLink = ({url}) =>
Source GitHub
;
## classe wandb.apis.public.Sweep
```python theme={null}
(service_api: 'ServiceApi',
entity: 'str',
project: 'str',
sweep_id: 'str',
attrs: 'Mapping[str, Any] | None' = None)
```
L’ensemble des run associées au balayage.
* `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
## Propriétés
### propriété config
Configuration du balayage utilisée pour ce balayage.
### propriété entité
L’entité associée au balayage.
### propriété expected\_run\_count
Retourne le nombre de runs attendus dans le balayage, ou None si le nombre de runs est infini.
### propriété 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
### propriété order
Renvoie la clé d’ordre du balayage.
### propriété path
Renvoie le chemin du projet.
Le chemin est une liste qui contient l’entité, le nom du projet et l’ID du balayage.
### propriété 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`.
### propriété username
Obsolète. Utilisez `Sweep.entity` à la place.
## Méthodes
### méthode Sweep.agent()
```python theme={null}
self,
agent_id: 'str'
```
Récupérer un agent à partir de son ID pour ce balayage.
##### Arguments
* `agent_id`: l’ID de l’agent à récupérer.
### méthode Sweep.agents()
```python theme={null}
self
```
Récupérez la liste de tous les agents de ce balayage.
### méthode Sweep.best\_run()
```python theme={null}
(self, order=None)
```
Retourne le meilleur run, trié selon la métrique définie dans la configuration ou l’ordre fourni.
* `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`:
### méthode Sweep.to\_html()
```python theme={null}
self,
height: 'int' = 420,
hidden: 'bool' = False
```
Génère du HTML contenant une iframe qui affiche ce balayage.