> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-dependabot-submodules-dot-claude-85784ca.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Run
export const GitHubLink = ({url}) =>
Source GitHub
;
## classe wandb.apis.public.Run
```python theme={null}
(service_api: 'ServiceApi',
entity: 'str',
project: 'str',
run_id: 'str',
attrs: 'Mapping | None' = None,
include_sweeps: 'bool' = False,
lazy: 'bool' = True,
api_key: 'str | None' = None)
```
Un seul run associé à une entité et à un projet.
## Arguments
* `service_api`: Interface vers le service wandb-core qui effectue les appels à l’API W\&B pour ce run.
* `entity`: L’entité associée au run.
* `project`: Le projet associé au run.
* `run_id`: L’identifiant unique du run.
* `attrs`: Les attributs du run.
* `include_sweeps`: Indique s’il faut inclure les balayages dans le run.
* `lazy`:
* `api_key`:
## Attributs
* `tags` (`[str]`) : une liste de tags associés au run
* `url` (`str`) : l’URL de ce run
* `id` (`str`) : identifiant unique du run (huit caractères par défaut)
* `name` (`str`) : le nom du run
* `state` (`str`) : l’une des valeurs suivantes : running, finished, crashed, killed, preempting, preempted
* `config` (`dict`) : un dictionnaire d’hyperparamètres associés au run
* `created_at` (`str`) : horodatage ISO au démarrage du run
* `system_metrics` (`dict`) : les dernières métriques système enregistrées pour le run
* `summary` (`dict`) : propriété mutable de type dictionnaire qui contient la synthèse actuelle. Tout appel à `update` persistera les modifications.
* `project` (`str`) : le projet associé au run
* `entity` (`str`) : le nom de l’entité associée au run
* `project_internal_id` (`int`) : l’ID interne du projet
* `user` (`str`) : le nom de l’utilisateur qui a créé le run
* `path` (`str`) : identifiant unique \[entity]/\[project]/\[run\_id]
* `notes` (`str`) : notes sur le run
* `read_only` (`boolean`) : indique si le run est modifiable
* `history_keys` (`str`) : clés des métriques de l’historique enregistrées avec `wandb.Run.log({"key": "value"})`
* `metadata` (`str`) : métadonnées sur le run issues de wandb-metadata.json
## Propriétés
### propriété config
Renvoie la configuration du run. Charge automatiquement l’ensemble des données en mode lazy.
### propriété entité
L’entité associée au run.
### propriété id
L’identifiant unique du run.
### propriété lastHistoryStep
Renvoie la dernière étape enregistrée dans l'historique du run.
### propriété metadata
Métadonnées du run issues de wandb-metadata.json.
Les métadonnées incluent la description du run, les tags, l'heure de début, l'utilisation de la mémoire, etc.
### propriété nom
Le nom du run.
### propriété path
Le chemin du run. Le chemin est une liste qui contient l’entité, le projet et le run\_id.
### propriété rawconfig
Renvoie la configuration brute du run, y compris les clés internes. Charge automatiquement toutes les données en mode lazy.
### propriété state
L’état du run.
Le tableau suivant décrit les états possibles d’un run :
| État | Description |
| -------------------- | --------------------------------------------------------------------------------------------------------------- |
| Planté | Le run a cessé d’envoyer des heartbeats via le processus interne, ce qui peut se produire si la machine plante. |
| Échoué | Le run s’est terminé avec un code de sortie non nul. |
| Terminé | Le run s’est terminé et a entièrement synchronisé les données, ou a appelé `wandb.Run.finish()`. |
| Interrompu | Le run a été arrêté de force avant de pouvoir se terminer. |
| En cours d’exécution | Le run est toujours en cours d’exécution et a récemment envoyé un heartbeat. |
| En attente | Le run est planifié, mais n’a pas encore démarré (fréquent dans les balayages et les jobs Launch). |
### propriété storage\_id
L’identifiant de stockage unique du run.
### propriété synthèse
Obtient les métriques de la synthèse du run. Charge automatiquement l’ensemble des données en mode lazy.
### propriété summary\_metrics
Obtient les métriques synthèse du run. Charge automatiquement les données complètes en mode lazy.
### propriété balayage
Le balayage associé à ce run. Charge les données du balayage si include\_sweeps vaut False.
### propriété sweep\_name
Obtient le nom du balayage. Toujours disponible, car sweepName se trouve dans le fragment léger.
### propriété system\_metrics
Renvoie les métriques système du run. Charge automatiquement toutes les données en mode lazy.
### propriété url
L’URL du run.
L’URL du run est générée à partir de l’entité, du projet et de `run_id`. Pour les utilisateurs du SaaS, elle se présente sous la forme `https://wandb.ai/entity/project/run_id`.
### propriété username
Cette API est obsolète. Utilisez plutôt `entity`.
* `keys`:
* `page_size`:
* `min_step`:
* `max_step`:
* `use_cache`:
### méthode Run.create()
```python theme={null}
api: 'public.Api',
run_id: 'str | None' = None,
project: 'str | None' = None,
entity: 'str | None' = None,
state: "Literal['running', 'pending']" = 'running'
```
Crée un run pour le projet donné.
Dans la plupart des cas, utilisez `wandb.init()`. `wandb.init()` offre un mécanisme plus robuste
pour créer et mettre à jour des runs. `wandb.apis.public.Run.create`
est destiné à des cas spécifiques, comme la création de runs à l’état
"pending" pour des jobs qui peuvent ne pas être planifiables
(par exemple, dans un cluster Kubernetes avec un nombre insuffisant de GPU ou une forte
contention). Ces runs en attente peuvent ensuite être repris et suivis par W\&B.
Les runs créés avec cette méthode ont des capacités limitées. L’appel à
`update()` sur un run créé de cette manière peut ne pas fonctionner comme prévu.
##### Arguments
* `api` : Instance de l’API W\&B.
* `run_id` : ID de run facultatif. S’il n’est pas fourni, un ID aléatoire sera généré.
* `project` : Nom du projet facultatif. Par défaut, le projet défini dans les paramètres de l’API est utilisé, ou "uncategorized".
* `entity` : Nom de l’entité facultatif (utilisateur ou équipe).
* `state` : État initial du run. Utilisez "pending" pour les runs qui seront repris plus tard, ou "running" pour une exécution immédiate.
##### Exemples
Création d’un run en attente pour une exécution ultérieure
```python theme={null}
import wandb
api = wandb.Api()
run_name = "my-pending-run"
run = Run.create(
api=api,
project="project",
entity="entity",
state="pending",
run_id=run_name,
)
```
### méthode Run.delete()
```python theme={null}
self,
delete_artifacts: 'bool' = False
```
Supprime le run spécifié du backend wandb.
##### Arguments
* `delete_artifacts`: Indique s’il faut supprimer les artifacts associés au run.
### méthode Run.download\_history\_exports()
```python theme={null}
self,
download_dir: 'pathlib.Path | str',
require_complete_history: 'bool' = True
```
Télécharge tous les fichiers parquet de l’historique du run dans le répertoire indiqué.
##### Arguments
* `download_dir`: Répertoire dans lequel télécharger les fichiers d’historique.
* `require_complete_history`: Indique s’il faut exiger le téléchargement de l’historique complet. Si cette valeur est `true` et que le run contient des données qui n’ont pas encore été exportées en fichiers parquet, une `IncompleteRunHistoryError` est levée.
##### Exceptions levées
* `IncompleteRunHistoryError`: Si `require_complete_history` vaut `True` et que le run contient des données qui n’ont pas encore été exportées en fichiers parquet.
* `WandbApiFailedError`: Si la requête API échoue pour une raison autre qu’un historique incomplet.
### méthode Run.file()
```python theme={null}
self,
name: 'str'
```
Renvoie le chemin d’un fichier portant le nom indiqué dans l’artifact.
##### Arguments
* `name`: nom du fichier demandé.
### méthode Run.files()
```python theme={null}
self,
names: 'list[str] | None' = None,
pattern: 'str | None' = None,
per_page: 'int' = 50
```
Renvoie un objet `Files` pour tous les fichiers du run qui correspondent aux critères spécifiés.
Vous pouvez spécifier une liste exacte de noms de fichiers à faire correspondre, ou un motif de correspondance.
Si les deux sont fournis, le motif sera ignoré.
##### Arguments
* `names` : noms des fichiers demandés ; si vide, renvoie tous les fichiers
* `pattern` : motif à utiliser pour renvoyer les fichiers depuis W\&B. Ce motif utilise la syntaxe LIKE de MySQL ; pour faire correspondre tous les fichiers se terminant par .json, utilisez "%.json". Si `names` et `pattern` sont tous deux fournis, une ValueError sera levée.
* `per_page` : nombre de résultats par page.
### méthode Run.history()
```python theme={null}
self,
samples: 'int' = 500,
keys: 'list[str] | None' = None,
x_axis: 'str' = '_step',
pandas: 'bool' = True,
stream: "Literal['default', 'system']" = 'default'
```
Renvoie un échantillon des métriques de l'historique pour un run.
Cette méthode est plus simple et plus rapide si vous acceptez que les enregistrements de l'historique soient échantillonnés.
##### Arguments
* `samples`: (int, facultatif) Le nombre d'échantillons à renvoyer
* `keys`: (liste, facultatif) Renvoie uniquement les métriques correspondant à des clés spécifiques
* `x_axis`: (str, facultatif) Utiliser cette métrique comme xAxis ; la valeur par défaut est \_step
* `pandas`: (bool, facultatif) Renvoie un dataframe pandas
* `stream`: (str, facultatif) "default" pour les métriques, "system" pour les métriques système
### méthode Run.load()
```python theme={null}
self,
force: 'bool' = False
```
Charge les données du run en utilisant le fragment approprié selon le mode lazy.
##### Arguments
* `force` : si la valeur est `True`, récupère de nouveau les données du run depuis le serveur, même si elles sont déjà chargées.
##### Exceptions levées
* `RunNotFoundError` : si le run est introuvable ou si les données du run ne peuvent pas être chargées.
### méthode Run.load\_full\_data()
```python theme={null}
self,
force: 'bool' = False
```
Chargez l’ensemble des données du run, y compris les champs volumineux comme config, systemMetrics et summaryMetrics.
Cette méthode est utile si vous avez initialement utilisé lazy=True pour lister des runs,
mais que vous devez accéder aux données complètes de certains runs.
##### Arguments
* `force` : Force le rechargement même si les données sont déjà chargées
### méthode Run.log\_artifact()
```python theme={null}
self,
artifact: 'wandb.Artifact',
aliases: 'Collection[str] | None' = None,
tags: 'Collection[str] | None' = None
```
Déclarer un artifact en tant que sortie d’un run.
##### Arguments
* `artifact`: Un artifact renvoyé par `wandb.Api().artifact(name)`.
* `aliases`: Alias à appliquer à cet artifact.
* `tags`: (liste, facultatif) Tags à appliquer à cet artifact, le cas échéant.
### méthode Run.logged\_artifacts()
```python theme={null}
self,
per_page: 'int' = 100
```
Récupère tous les artifacts enregistrés par ce run.
Récupère tous les artifacts de sortie qui ont été enregistrés pendant le run. Retourne un
résultat paginé qui peut être parcouru ou rassemblé dans une seule liste.
##### Arguments
* `per_page`: Nombre d'artifacts à récupérer par requête API.
##### Exemples
```python theme={null}
import wandb
import tempfile
with tempfile.NamedTemporaryFile(mode="w", delete=False, suffix=".txt") as tmp:
tmp.write("This is a test artifact")
tmp_path = tmp.name
run = wandb.init(project="artifact-example")
artifact = wandb.Artifact("test_artifact", type="dataset")
artifact.add_file(tmp_path)
run.log_artifact(artifact)
run.finish()
api = wandb.Api()
finished_run = api.run(f"{run.entity}/{run.project}/{run.id}")
for logged_artifact in finished_run.logged_artifacts():
print(logged_artifact.name)
```
### méthode Run.save()
```python theme={null}
self
```
Enregistrez les modifications apportées à l’objet run sur le backend W\&B.
### méthode Run.scan\_history()
```python theme={null}
self,
keys: 'list[str] | None' = None,
page_size: 'int' = 1000,
min_step: 'int' = 0,
max_step: 'int | None' = None,
use_cache: 'bool' = True
```
Renvoie une collection itérable de tous les enregistrements de l’historique d’un run.
##### Arguments
* `keys`: liste des métriques à lire dans l’historique du run. Si aucune clé n’est fournie, toutes les métriques sont renvoyées.
* `page_size`: le nombre d’enregistrements d’historique à lire à la fois.
* `min_step`: l’étape minimale à partir de laquelle commencer à lire l’historique (inclus).
* `max_step`: l’étape maximale jusqu’à laquelle lire l’historique (exclus).
* `use_cache`: lorsqu’il est défini sur True, vérifie si l’historique d’un run est présent dans WANDB\_CACHE\_DIR. Si l’historique du run n’est pas trouvé dans le cache, il sera téléchargé depuis le serveur. S’il est défini sur False, l’historique du run sera téléchargé à chaque fois.
### méthode Run.stop()
```python theme={null}
self
```
Demande l’arrêt propre de ce run.
Cette méthode définit l’indicateur d’arrêt de ce run sur le backend W\&B, c’est le même signal
que celui envoyé par le bouton "Stop run" dans l’interface de l’application W\&B. Le processus qui exécute
le run détecte cet indicateur lors de son heartbeat habituel, puis arrête
le run proprement. Cette méthode peut donc être utilisée en toute sécurité pour arrêter des runs distants
(par exemple, des runs exécutés sur des pods Kubernetes).
L’arrêt est asynchrone : cette méthode renvoie dès que le backend a
activé l’indicateur d’arrêt du run, et non lorsque le run est effectivement terminé. La rappeler, ou l’appeler
sur un run qui n’est plus en cours d’exécution, n’a aucun effet.
##### Exceptions levées
* `wandb.Error`: Si la requête échoue.
##### Exemples
```python theme={null}
import wandb
run = wandb.Api().run("entity/project/run_id")
run.stop()
```
### méthode Run.to\_html()
```python theme={null}
self,
height: 'int' = 420,
hidden: 'bool' = False
```
Générez le code HTML contenant une iframe qui affiche ce run.
##### Arguments
* `height`:
* `hidden`:
### méthode Run.update()
```python theme={null}
self
```
Enregistre les modifications de l’objet run sur le backend wandb.
### méthode Run.update\_state()
```python theme={null}
self,
state: 'str'
```
Met à jour l’état d’un run.
Transitions prises en charge :
* vers `pending` depuis `running`, `failed`, `crashed` ou `preempted`
(par ex. pour remettre en file d’attente un run terminé ou en cours)
* vers `failed` depuis `pending` ou `running`
(par ex. pour marquer un run préempté ou perdu comme failed)
L’état des runs de sweep ne peut pas être mis à jour.
Voir `Run.state` pour la liste des états de run possibles.
##### Arguments
* `state` : L’état cible du run. L’une des valeurs `"pending"` ou `"failed"`.
##### Exceptions levées
* `wandb.Error`: Si la transition d’état demandée n’est pas autorisée ou si le serveur ne prend pas en charge cette opération.
### méthode Run.upload\_file()
```python theme={null}
self,
path: 'str',
root: 'str' = '.'
```
Téléverse un fichier local sur W\&B et l’associe à ce run.
##### Arguments
* `path` : Chemin du fichier à téléverser. Il peut être absolu ou relatif.
* `root` : Chemin racine auquel le fichier est enregistré relativement. Par exemple, si vous souhaitez que le fichier soit enregistré dans le run sous la forme "my\_dir/file.txt" et que vous vous trouvez actuellement dans "my\_dir", vous devez définir `root` sur "../". La valeur par défaut est le répertoire courant (".").
### méthode Run.use\_artifact()
```python theme={null}
self,
artifact: 'wandb.Artifact',
use_as: 'str | None' = None
```
Déclarez un artifact comme entrée d’un run.
##### Arguments
* `artifact`: Un artifact renvoyé par `wandb.Api().artifact(name)`
* `use_as`: Une chaîne qui indique comment l’artifact est utilisé dans le script. Elle sert à différencier facilement les artifacts utilisés dans un run lors de l’utilisation de la fonctionnalité bêta d’échange d’artifacts de wandb Launch.
### méthode Run.used\_artifacts()
```python theme={null}
self,
per_page: 'int' = 100
```
Récupère les artifacts explicitement utilisés par ce run.
Récupère uniquement les artifacts d’entrée qui ont été explicitement déclarés comme utilisés lors du run, généralement via `run.use_artifact()`. Renvoie un résultat paginé qui peut être parcouru ou regroupé dans une seule liste.
##### Arguments
* `per_page`: Nombre d'artifacts à récupérer par requête API.
##### Exemples
```python theme={null}
import wandb
run = wandb.init(project="artifact-example")
run.use_artifact("test_artifact:latest")
run.finish()
api = wandb.Api()
finished_run = api.run(f"{run.entity}/{run.project}/{run.id}")
for used_artifact in finished_run.used_artifacts():
print(used_artifact.name)
test_artifact
```
### méthode Run.wait\_until\_finished()
```python theme={null}
self
```
Vérifiez l’état du run jusqu’à ce qu’il se termine.