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

# Runs

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/runs.py" />

## <kbd>class</kbd> `Runs`

Un itérateur paresseux d’objets `Run` associés à un projet et à un filtre facultatif.

Les Runs sont récupérés par pages depuis le serveur W\&B selon les besoins.

Cette classe s’utilise généralement de manière indirecte via l’espace de noms `Api.runs`.

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

```python theme={null}
__init__(
    service_api: 'ServiceApi',
    entity: 'str',
    project: 'str',
    filters: 'dict[str, Any] | None' = None,
    order: 'str' = '+created_at',
    per_page: 'int' = 50,
    include_sweeps: 'bool' = False,
    lazy: 'bool' = True,
    api_key: 'str | None' = None
)
```

**Arguments :**

* `service_api`:  L’API de service à utiliser pour les requêtes.
* `entity`:  L’entité (nom d’utilisateur ou équipe) propriétaire du projet.
* `project`:  Le nom du projet depuis lequel récupérer les runs.
* `filters`:  Filtres à appliquer à la requête de runs.
* `order`:  L’ordre peut être `created_at`, `heartbeat_at`, `config.*.value` ou `summary_metrics.*`.  Si l’ordre est précédé de `+`, le tri est croissant (par défaut).  Si l’ordre est précédé de `-`, le tri est décroissant.  Par défaut, l’ordre est `run.created&#95;at`, du plus ancien au plus récent.
* `per_page`:  Le nombre de runs à récupérer par requête (50 par défaut).
* `include_sweeps`:  Indique s’il faut inclure les informations sur les Sweeps dans les runs. La valeur par défaut est `True`.

***

### <kbd>propriété</kbd> Runs.length

***

### <kbd>méthode</kbd> `Runs.histories`

```python theme={null}
histories(
    samples: 'int' = 500,
    keys: 'list[str] | None' = None,
    x_axis: 'str' = '_step',
    format: "Literal['default', 'pandas', 'polars']" = 'default',
    stream: "Literal['default', 'system']" = 'default'
) → list[dict[str, Any]] | pd.DataFrame | pl.DataFrame
```

Renvoie des métriques d’historique échantillonnées pour tous les runs qui satisfont aux conditions des filtres.

**Arguments :**

* `samples` :  Nombre d’échantillons à renvoyer par run
* `keys` :  Renvoie uniquement les métriques pour des clés spécifiques
* `x_axis` :  Utilisez cette métrique comme xAxis ; la valeur par défaut est \_step
* `format` :  Format dans lequel renvoyer les données ; les options sont "default", "pandas",  "polars"
* `stream` :  "default" pour les métriques, "system" pour les métriques système

**Retourne :**

* `pandas.DataFrame` :  Si `format="pandas"`, renvoie un `pandas.DataFrame`  de métriques d’historique.
* `polars.DataFrame` :  Si `format="polars"`, renvoie un `polars.DataFrame`  de métriques d’historique.
* `list of dicts` :  Si `format="default"`, renvoie une liste de dicts  contenant des métriques d’historique avec une clé `run_id`.

***

### <kbd>méthode</kbd> `Runs.upgrade_to_full`

```python theme={null}
upgrade_to_full() → None
```

Met à niveau cette collection de Runs du mode paresseux au mode complet.

Bascule vers la récupération des données complètes des runs et met à niveau tous les objets Run déjà chargés afin qu'ils contiennent l'ensemble des données. Utilise le chargement en parallèle pour de meilleures performances lors de la mise à niveau de plusieurs runs.
