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

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

<h2 id="class-wandbapispublicsweep">
  <Badge color="yellow" size="lg" shape="rounded">Classe</Badge> wandb.apis.public.Sweep
</h2>

L’ensemble des runs associés au sweep.

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

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

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

<h2 id="attributes">
  Attributs
</h2>

* `runs` (`Runs`) : liste des runs
* `id` (`str`) : ID du sweep
* `project` (`str`) : nom du projet auquel appartient le sweep
* `config` (`dict`) : dictionnaire contenant la configuration de sweep
* `state` (`str`) : état du sweep. Valeurs possibles : « Finished », « Failed », « Crashed » ou « Running ».
* `expected_run_count` (`int`) : nombre de runs attendus pour le sweep

<h2 id="properties">
  Propriétés
</h2>

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

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

<ResponseField name="expected_run_count" type="int | None">
  Renvoie le nombre de runs attendus dans le sweep, ou None pour un nombre infini de runs.
</ResponseField>

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

  Renvoie le premier nom existant, 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 sweep
</ResponseField>

<ResponseField name="order" type="">
  Renvoie la clé de tri du sweep.
</ResponseField>

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

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

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

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

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

<h2 id="methods">
  Méthodes
</h2>

<h3 id="method-sweepagent">
  <Badge color="blue" size="lg" shape="rounded">méthode</Badge> Sweep.agent()
</h3>

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

Interroge un agent de ce sweep à partir de son ID.

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

<ResponseField name="agent_id" type="str">
  L’ID de l’agent à rechercher.
</ResponseField>

<h3 id="method-sweepagents">
  <Badge color="blue" size="lg" shape="rounded">méthode</Badge> Sweep.agents()
</h3>

```python theme={"system"}
self
```

Récupère la liste de tous les agents de ce sweep.

<h3 id="method-sweepbest_run">
  <Badge color="blue" size="lg" shape="rounded">méthode</Badge> Sweep.best\_run()
</h3>

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

Renvoie le meilleur run, trié selon la métrique définie dans la configuration ou selon l’ordre spécifié.

<h5 id="arguments-2">
  Arguments
</h5>

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

<h3 id="method-sweepenqueue_run">
  <Badge color="blue" size="lg" shape="rounded">méthode</Badge> Sweep.enqueue\_run()
</h3>

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

Ajoute un run à la file d'attente du sweep.

<h5 id="arguments-3">
  Arguments
</h5>

<ResponseField name="config" type="dict">
  La configuration du run.
</ResponseField>

<ResponseField name="display_name" type="str | None">
  Le nom d’affichage facultatif du run.
</ResponseField>

<h5 id="raises">
  Exceptions levées
</h5>

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

<h3 id="method-sweepget">
  <Badge color="blue" size="lg" shape="rounded">méthode</Badge> Sweep.get()
</h3>

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

<h5 id="arguments-4">
  Arguments
</h5>

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

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

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

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

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

<ResponseField name="query" type="str | None">
  La requête à exécuter.
</ResponseField>

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

<h3 id="method-sweepto_html">
  <Badge color="blue" size="lg" shape="rounded">méthode</Badge> Sweep.to\_html()
</h3>

```python theme={"system"}
self,
height: 'int' = 420,
hidden: 'bool' = False
```

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

<h5 id="arguments-5">
  Arguments
</h5>

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

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


## Related topics

- [sweep()](/fr/products/wandb/ref/python/functions/sweep.md)
