> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-docs-2516.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Sweep

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

<GitHubLink compact url="https://github.com/wandb/wandb/blob/main/wandb/apis/public/sweeps.py#L272" />

## <Badge color="yellow" size="lg" shape="rounded">Classe</Badge> wandb.apis.public.Sweep

L’ensemble des run associées au balayage.

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

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

<ResponseField name="service_api" type="ServiceApi">
  Aucune description fournie.
</ResponseField>

<ResponseField name="entity" type="str">
  Aucune description fournie.
</ResponseField>

<ResponseField name="project" type="str">
  Aucune description fournie.
</ResponseField>

<ResponseField name="sweep_id" type="str">
  Aucune description fournie.
</ResponseField>

<ResponseField name="attrs" type="Mapping[str, Any] | None">
  Aucune description fournie.
</ResponseField>

<div id="attributes">
  ## Attributs
</div>

* `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

<div id="properties">
  ## Propriétés
</div>

<ResponseField name="config" type="">
  La configuration de balayage utilisée pour le balayage.
</ResponseField>

<ResponseField name="entity" type="str">
  L’entité associée au balayage.
</ResponseField>

<ResponseField name="expected_run_count" type="int | None">
  Renvoyer le nombre de runs attendus dans le balayage, ou None si le nombre de runs est illimité.
</ResponseField>

<ResponseField name="name" type="">
  Le nom du balayage.

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

  1. Nom d’affichage modifié par l’utilisateur
  2. Nom configuré lors de la création
  3. ID du balayage
</ResponseField>

<ResponseField name="order" type="">
  Renvoyer la clé d’ordre du balayage.
</ResponseField>

<ResponseField name="path" type="">
  Renvoyer le chemin du projet.

  Le chemin est une liste contenant l’entité, le nom du projet et l’ID du balayage.
</ResponseField>

<ResponseField name="url" type="">
  L’URL du balayage.

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

<ResponseField name="username" type="str">
  Obsolète. Utilisez plutôt `Sweep.entity`.
</ResponseField>

<div id="methods">
  ## Méthodes
</div>

### <Badge color="blue" size="lg" shape="rounded">méthode</Badge> Sweep.agent()

```python theme={null}
self,
agent_id: 'str'
```

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

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

<ResponseField name="agent_id" type="str">
  l’ID de l’agent à récupérer.
</ResponseField>

### <Badge color="blue" size="lg" shape="rounded">méthode</Badge> Sweep.agents()

```python theme={null}
self
```

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

### <Badge color="blue" size="lg" shape="rounded">méthode</Badge> Sweep.best\_run()

```python theme={null}
(self, order=None)
```

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

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

<ResponseField name="order" type="_empty">
  Aucune description fournie.
</ResponseField>

### <Badge color="blue" size="lg" shape="rounded">méthode</Badge> Sweep.enqueue\_run()

```python theme={null}
self,
config: 'dict',
display_name: 'str | None' = None
```

Mettre un run en file d'attente pour le balayage.

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

<ResponseField name="config" type="dict">
  La configuration de l’exécution.
</ResponseField>

<ResponseField name="display_name" type="str | None">
  Le nom d’affichage facultatif de l’exécution.
</ResponseField>

<div id="raises">
  ##### Exceptions levées
</div>

* `UnsupportedError` : Si le serveur ne prend pas en charge la mise en file d’attente de runs de balayage.

### <Badge color="blue" size="lg" shape="rounded">méthode</Badge> Sweep.get()

```python theme={null}
(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.

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

<ResponseField name="api" type="Api">
  L’instance de l’API W\&B.
</ResponseField>

<ResponseField name="entity" type="str | None">
  L’entité (nom d’utilisateur ou équipe) propriétaire du projet.
</ResponseField>

<ResponseField name="project" type="str | None">
  Le nom du projet dont récupérer le balayage.
</ResponseField>

<ResponseField name="sid" type="str | None">
  L’ID du balayage à interroger.
</ResponseField>

<ResponseField name="order" type="str | None">
  L’ordre dans lequel les runs du balayage sont renvoyés.
</ResponseField>

<ResponseField name="query" type="str | None">
  La requête à utiliser pour effectuer la requête.
</ResponseField>

<ResponseField name="kwargs" type="_empty">
  Aucune description fournie.
</ResponseField>

### <Badge color="blue" size="lg" shape="rounded">méthode</Badge> 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.

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

<ResponseField name="height" type="int">
  Aucune description n’est fournie.
</ResponseField>

<ResponseField name="hidden" type="bool">
  Aucune description n’est fournie.
</ResponseField>
