Builtins¶
Builtins are ordinary modules with no special status. They are named by their full dotted path. There is no alias table, so "adamw" does not resolve and "gatle_ignite.optimizers.adamw" does. Swapping a builtin for your own is changing this string.
One exception
cfg.logger_name does accept short names: see the table at the bottom of this page, and Logging.
gatle_ignite.optimizers¶
Each module exposes get_optimizer.
| Dotted path | What it is | Params |
|---|---|---|
gatle_ignite.optimizers.adam |
Adam. No weight-decay grouping: use adamw if you want decay. | lr=0.001, betas=(0.9, 0.999), eps=1e-08, weight_decay=0.0, **kwargs |
gatle_ignite.optimizers.adamw |
AdamW, with bias and norm params excluded from weight decay. | lr=0.001, weight_decay=0.01, betas=(0.9, 0.999), eps=1e-08, no_decay_on_bias_and_norm=True, **kwargs |
gatle_ignite.optimizers.layer_decay |
Layer-wise LR decay (BEiT/ViT-style), for fine-tuning a pretrained backbone. | lr=0.0001, layer_decay=0.75, weight_decay=0.05, backbone_attr='', blocks_attr='blocks', betas=(0.9, 0.999), **kwargs |
gatle_ignite.optimizers.sgd |
SGD with momentum, Nesterov by default. | lr=0.1, momentum=0.9, weight_decay=0.0, nesterov=True, no_decay_on_bias_and_norm=True, **kwargs |
gatle_ignite.schedulers¶
Each module exposes get_scheduler.
| Dotted path | What it is | Params |
|---|---|---|
gatle_ignite.schedulers.cosine |
Cosine anneal the LR every iteration over the whole run. | engines, start_value=None, end_value=0.0, cycle_epochs=None, **kwargs |
gatle_ignite.schedulers.plateau |
Drop the LR when a validation metric stops improving. | engines, metric_name=None, mode='min', factor=0.1, patience=10, **kwargs |
gatle_ignite.schedulers.step |
Multiply the LR by gamma every step_size epochs. | engines, step_size=10, gamma=0.1, **kwargs |
gatle_ignite.schedulers.warmup_cosine |
Linear warmup, then cosine anneal to lr * lr_scale_factor. | engines, warmup_epochs=1, warmup_start_factor=0.01, lr_scale_factor=0.01, **kwargs |
gatle_ignite.callbacks.backends¶
Each module exposes Backend.
| Dotted path | What it is | Params |
|---|---|---|
gatle_ignite.callbacks.backends.discord |
Discord webhook backend. | |
gatle_ignite.callbacks.backends.text |
Print metrics to stdout. The default. | |
gatle_ignite.callbacks.backends.wandb |
Weights & Biases backend. |
cfg.logger_name¶
The one field that takes short names. It is a list of enabled sinks, not a component path, which is why it reads differently from everything above.
| Name | Resolves to |
|---|---|
"text" |
gatle_ignite.callbacks.backends.text |
"wandb" |
gatle_ignite.callbacks.backends.wandb |
"discord" |
gatle_ignite.callbacks.backends.discord |
"pbar" |
not a backend: a flag handled by the trainer |
Any name containing a dot is treated as a dotted path to your own module exposing Backend(cfg).