Voir le code source
launch(
api: Api,
job: Optional[str] = None,
entry_point: Optional[List[str]] = None,
version: Optional[str] = None,
name: Optional[str] = None,
resource: Optional[str] = None,
resource_args: Optional[Dict[str, Any]] = None,
project: Optional[str] = None,
entity: Optional[str] = None,
docker_image: Optional[str] = None,
config: Optional[Dict[str, Any]] = None,
synchronous: Optional[bool] = (True),
run_id: Optional[str] = None,
repository: Optional[str] = None
) -> AbstractRun
| Arguments | Description |
|---|---|
job | Référence string vers un wandb.Job, par ex. : wandb/test/my-job:latest |
api | Une instance d’Api wandb provenant de wandb.apis.internal. |
entry_point | Point d’entrée à exécuter dans le projet. Par défaut, il s’agit du point d’entrée utilisé par le run d’origine pour les URI wandb, ou de main.py pour les URI de dépôt Git. |
version | Pour les projets basés sur Git, un hash de commit ou un nom de branche. |
name | Nom sous lequel lancer le run. |
resource | Backend d’exécution du run. |
resource_args | Arguments propres à la ressource pour lancer des runs sur un backend distant. Ils seront stockés sous resource_args dans la configuration de lancement générée. |
project | Projet cible vers lequel envoyer le run lancé |
entity | Entity cible vers laquelle envoyer le run lancé |
config | Un dictionnaire contenant la configuration du run. Peut également contenir des arguments propres à la ressource sous la clé “resource_args”. |
synchronous | Indique s’il faut bloquer l’exécution en attendant la fin d’un run. Par défaut : True. Notez que si synchronous vaut False et que backend vaut “local-container”, cette méthode rend la main, mais le processus en cours restera bloqué à sa sortie jusqu’à la fin du run local. Si le processus en cours est interrompu, tous les runs asynchrones lancés via cette méthode seront arrêtés. Si synchronous vaut True et que le run échoue, le processus en cours échouera également. |
run_id | ID du run (destiné à remplacer à terme le champ :name:) |
repository | Nom (string) du chemin du dépôt pour le registre distant |
Exemple :
from wandb.sdk.launch import launch
job = "wandb/jobs/Hello World:latest"
params = {"epochs": 5}
# Exécuter le projet W&B et créer un environnement Docker reproductible
# sur un hôte local
api = wandb.apis.internal.Api()
launch(api, job, parameters=params)
| Renvoie | Description |
|---|---|
une instance dewandb.launch.SubmittedRun qui fournit des informations (par exemple, l’ID du run) sur le run lancé. |
| Exceptions levées | Description |
|---|---|
wandb.exceptions.ExecutionError si un run lancé en mode bloquant échoue. |