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

# Aperçu de l’API publique

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

L’API publique de W\&B permet d’interroger, d’exporter et de mettre à jour par programmation 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. Tandis que le SDK principal gère la journalisation 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’analyser des expériences terminées. La classe principale `Api` constitue le point d’entrée de la plupart des fonctionnalités.

> Pour entraîner des modèles et en effectuer le fine-tuning, utilisez [le SDK Python W\&B](/fr/products/wandb/ref/python). Utilisez l’API publique pour interroger et gérer les données *après* les avoir journalisées dans W\&B.

<h2 id="available-components">
  Composants disponibles
</h2>

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

<h2 id="common-use-cases">
  Cas d’utilisation courants
</h2>

<h3 id="data-export-and-analysis">
  Exportation et analyse des données
</h3>

* Exporter l’historique des runs sous forme de DataFrames pour les analyser dans des notebooks Jupyter
* Télécharger des métriques pour créer des visualisations ou des rapports personnalisés
* Agréger les résultats de plusieurs expériences

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

* Mettre à jour les métadonnées d’un run une fois celui-ci terminé
* Ajouter des tags ou des notes aux expériences terminées
* Modifier la configuration ou le résumé des runs

<h3 id="artifact-management">
  Gestion des artifacts
</h3>

* Interroger les artifacts par version ou par alias
* Télécharger des points de contrôle de modèle par programmation
* Suivre la traçabilité et les dépendances des artifacts

<h3 id="sweep-analysis">
  Analyse des sweeps
</h3>

* Accéder aux résultats des sweeps et aux runs les plus performants
* Exporter les résultats de la recherche d’hyperparamètres
* Analyser l’importance des paramètres

<h2 id="authentication">
  Authentification
</h2>

L’API publique utilise le même mécanisme d’authentification que le SDK Python. Il existe plusieurs façons de vous authentifier :

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

```bash theme={"system"}
export WANDB_API_KEY=your_api_key
```

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

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

Vous pouvez aussi utiliser `wandb.login()` pour authentifier la session en cours :

```python theme={"system"}
import wandb

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

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

<h3 id="download-an-artifact-by-name-and-alias">
  Télécharger un artifact à partir de son nom et de son alias
</h3>

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

```python theme={"system"}
import wandb

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

<h3 id="download-an-artifact-from-a-registry">
  Télécharger un artifact depuis un registre
</h3>

L’exemple suivant montre comment récupérer un artifact lié à partir d’un registre :

```python theme={"system"}
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 d’accès au contenu téléchargé
downloaded_path = fetched_artifact.download()
```

<h3 id="query-registry">
  Interroger le registre
</h3>

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

```python theme={"system"}
import wandb

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

# Filtrer toutes les collections, tous registres confondus, dont 
# le nom contient la chaîne `yolo`
collection_filters = {
    "name": {"$regex": "yolo"}
}

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

Pour plus d’informations sur la façon d’interroger un registre, une collection ou un artifact, consultez la page [Trouver des éléments du registre](/fr/products/registry/search_registry).


## Related topics

- [Aperçu de l’API](/fr/model-distillation/reference/overview.md)