Référence de l'espace de nommage aidge_in_space.train

CLI d'entraînement : python -m aidge_in_space.train (–config FICHIER.yaml | –job-id N). Plus de détails...

Classes
class	StopWatcher
	Demande d'arrêt de l'entraînement : annulation dans la base, fin de stdin ou signal. Plus de détails...

Fonctions
None	_say (*args)
	print() immédiat (la sortie est redirigée vers train.log).
argparse.ArgumentParser	build_parser ()
	Analyseur d'arguments de la CLI.
str	_describe (TrainConfig cfg, job_id=None)
	Première ligne du journal : job, nom, λ, N, mode et auteur.
str	_device_line (device)
	Ligne « Appareil : ... » avec le nom du GPU le cas échéant.
int	_start_step (Path ckpt_path)
	Pas de départ : celui du checkpoint repris, 0 s'il n'existe pas ou est illisible (train() tranchera).
int	stop_code (watcher)
	Code de retour d'un arrêt : EXIT_CANCELLED si l'annulation est demandée dans la base, sinon EXIT_STOPPED.
int	run (args)
	Exécute l'entraînement demandé par les arguments.
int	main (argv=None)
	Point d'entrée de la CLI.

Variables
float	CANCEL_POLL_S = 5.0
	Période minimale, en secondes, entre deux lectures du drapeau d'annulation dans la base.

Description détaillée

CLI d'entraînement : python -m aidge_in_space.train (–config FICHIER.yaml | –job-id N).

Mode --config : entraîne depuis un fichier YAML, sans base de données. Mode --job-id : exécute un job de la file (statut running, fixé par le worker) et écrit ses métriques dans la base ; le statut final du job n'est jamais écrit ici, c'est le worker qui le déduit du code de retour. Contrat : docs/conception_entrainement.md (§ 2.4).

Documentation des fonctions

main()

int aidge_in_space.train.main

(

argv = None

)

Point d'entrée de la CLI.

Paramètres

argv	Arguments (défaut : sys.argv). Une erreur d'arguments lève SystemExit(2) (argparse).

Renvoie

EXIT_DONE (0), EXIT_FAILED (1), EXIT_CONFIG (2), EXIT_CANCELLED (3) ou EXIT_STOPPED (4).

run()

int aidge_in_space.train.run

(

args

)

Exécute l'entraînement demandé par les arguments.

Paramètres

args	Arguments analysés par build_parser().

Renvoie

Code de retour (EXIT_DONE, EXIT_CONFIG, EXIT_CANCELLED ou EXIT_STOPPED ; les autres erreurs sont traitées par main()).

Exceptions

ConfigError

si la configuration, le job ou les données sont invalides.

stop_code()

int aidge_in_space.train.stop_code

(

watcher

)

Code de retour d'un arrêt : EXIT_CANCELLED si l'annulation est demandée dans la base, sinon EXIT_STOPPED.

L'annulation l'emporte sur les autres causes (fin de stdin, signal) quand elles surviennent ensemble.

Paramètres

watcher

StopWatcher dont l'arrêt a été constaté.