Passer au contenu principal

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.

Voir le code source

Lancez une expérience Launch de W&B.
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
ArgumentsDescription
jobréférence sous forme de chaîne à un wandb.Job, par ex. : wandb/test/my-job:latest
apiUne instance de l’API wandb issue de wandb.apis.internal.
entry_pointPoint d’entrée à exécuter dans le projet. Par défaut, utilise le point d’entrée du run original pour les URI wandb, ou main.py pour les URI de dépôt Git.
versionPour les projets basés sur Git, soit un hash de commit, soit un nom de branche.
nameNom du run sous lequel lancer le run.
resourceBackend d’exécution du run.
resource_argsArguments liés aux ressources pour lancer des runs sur un backend distant. Ils seront stockés dans la configuration Launch générée sous resource_args.
projectProjet cible vers lequel envoyer le run lancé
entityEntité cible vers laquelle envoyer le run lancé
configDictionnaire contenant la configuration du run. Peut aussi contenir des arguments spécifiques aux ressources sous la clé “resource_args”.
synchronousIndique s’il faut bloquer jusqu’à la fin d’un run. La valeur par défaut est True. Notez que si synchronous est False et que backend vaut “local-container”, cette méthode renverra bien la main, mais le processus en cours restera bloqué à la 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 est True et que le run échoue, le processus en cours renverra également une erreur.
run_idID du run (pour remplacer à terme le champ :name:)
repositorynom de chaîne 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)
RenvoieDescription
une instance de wandb.launch.SubmittedRun qui fournit des informations (par ex. l’ID du run) sur le run lancé.
Exceptions levéesDescription
wandb.exceptions.ExecutionError Si un run lancé en mode bloquant échoue.