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

# Aperçu de l’API publique

> Utilisez l’API publique de W&B pour accéder aux données W&B par programmation et les gérer

L’API publique W\&B offre un accès programmatique permettant d’effectuer des requêtes, d’exporter et de mettre à jour les données stockées dans W\&B. Utilisez cette API pour l’analyse a posteriori, l’exportation de données et la gestion programmatique des runs, des artifacts et des sweeps. Alors que le SDK principal gère le logging en temps réel pendant l’entraînement, l’API publique vous permet de récupérer des données historiques, de mettre à jour des métadonnées, de gérer des artifacts et d’effectuer des analyses sur des expériences terminées. La classe principale `Api` constitue le point d’entrée de la plupart des fonctionnalités.

> Pour entraîner et effectuer le Fine-tuning des modèles, utilisez [W\&B Python SDK](/fr/models/ref/python). Utilisez l’API publique pour interroger et gérer les données *une fois* qu’elles ont été consignées dans W\&B.

<div id="available-components">
  ## Composants disponibles
</div>

| Composant                                                | Description                                                                                                                                      |
| -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| [`Api`](/fr/models/ref/python/public-api/api/)           | Point d’entrée principal de l’API publique. Effectuez des requêtes sur les runs, les projets et les Artifacts à l’échelle de votre organisation. |
| [`Runs`](/fr/models/ref/python/public-api/runs/)         | Accédez aux runs d’entraînement individuels et gérez-les, y compris leur historique, leurs journaux et leurs métriques.                          |
| [`Artifacts`](/fr/models/artifacts/)                     | Effectuez des requêtes sur et téléchargez des artifacts de modèle, des Datasets et d’autres fichiers versionnés.                                 |
| [`Sweeps`](/fr/models/sweeps/)                           | Accédez aux données de balayage d’hyperparamètres et analysez les résultats d’optimisation.                                                      |
| [`Projects`](/fr/models/ref/python/public-api/projects/) | Gérez les projets et accédez aux métadonnées et aux paramètres au niveau du projet.                                                              |
| [`Reports`](/fr/models/reports/create-a-report/)         | Accédez aux Reports W\&B et gérez-les par programmation.                                                                                         |
| [`Team`](/fr/models/ref/python/public-api/team)          | Effectuez des requêtes sur les informations de l’équipe et gérez les ressources au niveau de l’équipe.                                           |
| [`User`](/fr/models/ref/python/public-api/user)          | Accédez aux profils des utilisateurs et aux données propres à chaque utilisateur.                                                                |
| [`Files`](/fr/models/ref/python/public-api/files/)       | Téléchargez et gérez les fichiers associés aux runs.                                                                                             |
| `History`                                                | Accédez aux métriques détaillées de séries temporelles enregistrées pendant l’entraînement (voir `Run.history`).                                 |
| [`Automations`](./automations/)                          | Gérez les flux de travail et les actions automatisés.                                                                                            |
| [`Integrations`](/fr/models/integrations)                | Configurez et gérez les intégrations tierces.                                                                                                    |

<div id="common-use-cases">
  ## Cas d’usage courants
</div>

<div id="data-export-and-analysis">
  ### Export et analyse des données
</div>

* Exportez l'historique des runs sous forme de DataFrames pour les analyser dans des notebooks Jupyter
* Téléchargez des métriques pour une visualisation ou la création de rapports personnalisés
* Agrégez les résultats de plusieurs expériences

<div id="post-hoc-updates">
  ### Mises à jour a posteriori
</div>

* Mettez à jour les métadonnées du run une fois terminé
* Ajoutez des tags ou des notes aux expériences terminées
* Modifiez la configuration ou le résumé du run

<div id="artifact-management">
  ### Gestion des Artifacts
</div>

* Effectuer une requête sur des Artifacts par version ou alias
* Télécharger des points de contrôle du modèle par programmation
* Suivre la traçabilité et les dépendances des Artifacts

<div id="sweep-analysis">
  ### Analyse du balayage
</div>

* Accédez aux résultats du balayage et aux meilleurs runs
* Exportez les résultats de la recherche d'hyperparamètres
* Analysez l'importance des paramètres

<div id="authentication">
  ## Authentification
</div>

L’API publique utilise le même mécanisme d’authentification que le SDK Python. Vous pouvez vous authentifier de plusieurs manières :

Utilisez la variable d’environnement `WANDB_API_KEY` pour définir votre clé API :

```bash theme={null}
export WANDB_API_KEY=your_api_key
```

Passez la clé API directement lors de l’initialisation de la classe `Api` :

```python theme={null}
api = Api(api_key="your_api_key")
```

Ou utilisez `wandb.login()` pour authentifier la session actuelle :

```python theme={null}
import wandb

wandb.login()
api = Api()
```

<div id="example-usage">
  ## Exemple d’utilisation
</div>

<div id="download-an-artifact-by-name-and-alias">
  ### Télécharger un Artifact par son nom et son alias
</div>

L’exemple suivant montre comment récupérer un Artifact enregistré dans W\&B à partir de son nom et de son alias, puis en télécharger le contenu.

```python theme={null}
import wandb

api = wandb.Api()
artifact = api.artifact("entity/project/artifact:alias")
artifact.download()
```

<div id="download-an-artifact-from-a-registry">
  ### Télécharger un Artifact à partir d’un registre
</div>

L’exemple suivant montre comment récupérer un artifact lié à partir d’un registre W\&B

```python theme={null}
import wandb

REGISTRY = "<registry_name>"
COLLECTION = "<collection_name>"
VERSION = "<version>"

api = wandb.Api()
artifact_name = f"wandb-registry-{REGISTRY}/{COLLECTION}:{VERSION}"

# Récupérer l'artifact
fetched_artifact = api.artifact(name = artifact_name)

# Télécharger l'artifact. Renvoie le chemin vers le contenu téléchargé
downloaded_path = fetched_artifact.download()
```

<div id="query-wb-registry">
  ### requête le registre W\&B
</div>

Utilisez des filtres de type Mongo pour interroger les registres, les collections et les Artifacts W\&B. L’exemple suivant montre comment filtrer les collections par nom à l’aide d’une expression régulière.

```python theme={null}
import wandb

# Initialiser l'API wandb
api = wandb.Api()

# Filtrer toutes les collections, indépendamment du registre, qui
# contiennent la chaîne `yolo` dans le nom de la collection
collection_filters = {
    "name": {"$regex": "yolo"}
}

# Renvoie un itérable de toutes les collections correspondant aux filtres
collections = api.registries().collections(filter=collection_filters)
```

Pour plus d’informations sur la requête d’un registre, d’une collection ou d’un artifact, voir [Rechercher des éléments du registre](/fr/models/registry/search_registry).