Run - Weights & Biases Documentation

Classe wandb.apis.public.Run

Un seul run associé à une entité et à un projet.

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

Arguments

ServiceApi

Interface du service wandb-core qui effectue les appels d’API W&B pour ce run.

str

L’entité associée au run.

str

Le projet associé au run.

str

L’ID unique du run.

Mapping | None

Les attributs du run.

bool

Indique s’il faut inclure les balayages dans le run.

bool

Aucune description fournie.

str | None

Aucune description fournie.

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

dict[str, Any]

Obtenir la configuration du run. Charge automatiquement les données complètes en mode lazy.

str

L’entité associée au run.

str

L’identifiant unique du run.

int

Renvoie la dernière étape enregistrée dans l’historique du run.

dict[str, Any] | None

Métadonnées du run provenant de wandb-metadata.json.Les métadonnées incluent la description du run, ses tags, son heure de début, l’utilisation de la mémoire et plus encore.

str | None

Le nom du run.

list[str]

Le chemin du run. Il s’agit d’une liste contenant l’entité, le projet et run_id.

dict[str, Any]

Obtenir la configuration brute du run, y compris les clés internes. Charge automatiquement les données complètes en mode lazy.

str

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

str

L’identifiant de stockage unique du run.

HTTPSummary

Obtenir les métriques de synthèse du run. Charge automatiquement les données complètes en mode lazy.

dict[str, Any]

Obtenir les métriques de synthèse du run. Charge automatiquement les données complètes en mode lazy.

public.Sweep | None

Le balayage associé à ce run. Charge les données du balayage si include_sweeps est False.

str | None

Obtenir le nom du balayage. Toujours disponible, car sweepName se trouve dans le fragment léger.

dict[str, Any]

Obtenir les métriques système du run. Charge automatiquement les données complètes en mode lazy.

str

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 SaaS, elle se présente sous la forme https://wandb.ai/entity/project/run_id.

str

Cette API est obsolète. Utilisez plutôt entity.

Méthodes

méthode Run.beta_scan_history()

self,
keys: 'list[str] | None' = None,
page_size: 'int' = 1000,
min_step: 'int' = 0,
max_step: 'int | None' = None,
use_cache: 'bool' = True

Arguments

list[str] | None

Aucune description fournie.

int

Aucune description fournie.

int

Aucune description fournie.

int | None

Aucune description fournie.

bool

Aucune description fournie.

méthode Run.console_logs()

self, *,
per_page: 'int' = 1000,
last: 'int | None' = None

Renvoie la sortie de console capturée du run. Pendant l’exécution d’un run, W&B capture ce que son processus écrit sur stdout et stderr et l’enregistre dans le journal de console du run — le même journal affiché dans l’onglet “Logs” de la page du run dans l’application W&B. Cette méthode relit ce journal, aussi bien pour les runs terminés que pour ceux encore en cours d’exécution.

Arguments

int

Nombre de lignes à récupérer par requête lors de la lecture du journal depuis le début. Ignoré lorsque last est spécifié.

int | None

Si défini, récupère uniquement les N dernières lignes du journal en une seule requête — utile pour vérifier un run en cours ou diagnostiquer un plantage. Le backend limite le nombre de lignes renvoyées par requête ; une portion finale plus importante est donc tronquée aux lignes les plus récentes.

Exceptions levées

CommError : si une requête échoue lors de l’itération. La lecture du journal depuis le début nécessite le serveur W&B 0.77 ou une version ultérieure ; sur les serveurs plus anciens, lisez plutôt les N dernières lignes.

Exemples

import wandb

run = wandb.Api().run("entity/project/run_id")

# Lire l'intégralité du journal, de la ligne la plus ancienne à la plus récente.
for line in run.console_logs():
    print(line.content)

# Lire uniquement les 100 dernières lignes.
for line in run.console_logs(last=100):
    print(line.timestamp, line.content)

méthode Run.create()

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

public.Api

L’instance de l’API W&B.

str | None

ID du run facultatif. S’il n’est pas fourni, un ID aléatoire est généré.

str | None

Nom du projet facultatif. Par défaut, il s’agit du projet défini dans les paramètres de l’API ou de « uncategorized ».

str | None

Nom de l’entité facultatif (utilisateur ou équipe).

Literal['running', 'pending']

État initial du run. Utilisez « pending » pour les runs qui seront repris ultérieurement, ou « running » pour une exécution immédiate.

Exemples

Création d’un run en attente pour une exécution ultérieure

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

self,
delete_artifacts: 'bool' = False

Supprime le run spécifié du backend wandb.

Arguments

bool

Indique s’il faut supprimer les artifacts associés au run.

méthode Run.download_history_exports()

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

pathlib.Path | str

Répertoire dans lequel télécharger les fichiers d’historique.

bool

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

self,
name: 'str'

Renvoie le chemin d’un fichier portant le nom indiqué dans l’artifact.

Arguments

str

nom du fichier demandé.

méthode Run.files()

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

list[str] | None

noms des fichiers demandés ; si vide, renvoie tous les fichiers

str | None

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.

int

nombre de résultats par page.

méthode Run.history()

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

int

(int, facultatif) Nombre d’échantillons à renvoyer

list[str] | None

(list, facultatif) Renvoyer uniquement les métriques associées à des clés spécifiques

str

(str, facultatif) Métrique à utiliser comme axe des x. La valeur par défaut est _step

bool

(bool, facultatif) Renvoyer un dataframe pandas

Literal['default', 'system']

(str, facultatif) « default » pour les métriques, « system » pour les métriques système

méthode Run.load()

self,
force: 'bool' = False

Charge les données du run en utilisant le fragment approprié selon le mode lazy.

Arguments

bool

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

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

bool

Force le rechargement même si les données sont déjà chargées

méthode Run.log_artifact()

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

wandb.Artifact

Un artifact renvoyé par wandb.Api().artifact(name).

Collection[str] | None

Les alias à appliquer à cet artifact.

Collection[str] | None

(liste, facultatif) Les tags à appliquer à cet artifact, le cas échéant.

méthode Run.logged_artifacts()

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. Renvoie un résultat paginé qui peut être parcouru ou rassemblé dans une seule liste.

Arguments

int

Nombre d’artifacts à récupérer par requête API.

Exemples

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

self

Enregistrez les modifications apportées à l’objet run sur le backend W&B.

méthode Run.scan_history()

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

list[str] | None

liste des métriques à lire dans l’historique du run. L’analyse ne renvoie que les lignes contenant toutes les clés demandées. Si les clés ont été enregistrées à des étapes différentes, utilisez des appels distincts pour chaque clé ou omettez cet argument. Si aucune clé n’est fournie, toutes les métriques sont renvoyées.

int

le nombre d’enregistrements d’historique à lire à la fois.

int

l’étape minimale à partir de laquelle commencer à lire l’historique (inclus).

int | None

l’étape maximale jusqu’à laquelle lire l’historique (exclus).

bool

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

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

import wandb

run = wandb.Api().run("entity/project/run_id")
run.stop()

méthode Run.to_html()

self,
height: 'int' = 420,
hidden: 'bool' = False

Générez le code HTML contenant une iframe qui affiche ce run.

Arguments

int

Aucune description fournie.

bool

Aucune description fournie.

méthode Run.update()

self

Enregistre les modifications de l’objet run sur le backend wandb.

méthode Run.update_state()

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 balayage ne peut pas être mis à jour. Voir Run.state pour la liste des états de run possibles.

Arguments

str

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

self,
path: 'str',
root: 'str' = '.'

Téléverse un fichier local sur W&B et l’associe à ce run.

Arguments

str

Chemin du fichier à téléverser. Il peut être absolu ou relatif.

str

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

self,
artifact: 'wandb.Artifact',
use_as: 'str | None' = None

Déclarez un artifact comme entrée d’un run.

Arguments

wandb.Artifact

Un artifact renvoyé par wandb.Api().artifact(name)

str | None

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

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

int

Nombre d’artifacts à récupérer par requête API.

Exemples

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

self

Vérifiez l’état du run jusqu’à ce qu’il se termine.

​Classe wandb.apis.public.Run

​Arguments

​Attributs

​Propriétés

​Méthodes

​méthode Run.beta_scan_history()

Arguments

​méthode Run.console_logs()

Arguments

Exceptions levées

Exemples

​méthode Run.create()

Arguments

Exemples

​méthode Run.delete()

Arguments

​méthode Run.download_history_exports()

Arguments

Exceptions levées

​méthode Run.file()

Arguments

​méthode Run.files()

Arguments

​méthode Run.history()

Arguments

​méthode Run.load()

Arguments

Exceptions levées

​méthode Run.load_full_data()

Arguments

​méthode Run.log_artifact()

Arguments

​méthode Run.logged_artifacts()

Arguments

Exemples

​méthode Run.save()

​méthode Run.scan_history()

Arguments

​méthode Run.stop()

Exceptions levées

Exemples

​méthode Run.to_html()

Arguments

​méthode Run.update()

​méthode Run.update_state()

Arguments

Exceptions levées

​méthode Run.upload_file()

Arguments

​méthode Run.use_artifact()

Arguments

​méthode Run.used_artifacts()

Arguments

Exemples

​méthode Run.wait_until_finished()

Classe wandb.apis.public.Run

Arguments

Attributs

Propriétés

Méthodes

méthode Run.beta_scan_history()

méthode Run.console_logs()

méthode Run.create()

méthode Run.delete()

méthode Run.download_history_exports()

méthode Run.file()

méthode Run.files()

méthode Run.history()

méthode Run.load()

méthode Run.load_full_data()

méthode Run.log_artifact()

méthode Run.logged_artifacts()

méthode Run.save()

méthode Run.scan_history()

méthode Run.stop()

méthode Run.to_html()

méthode Run.update()

méthode Run.update_state()

méthode Run.upload_file()

méthode Run.use_artifact()

méthode Run.used_artifacts()

méthode Run.wait_until_finished()