Reference for ultralytics/utils/callbacks/platform.py
Improvements
This page is sourced from https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/platform.py. Have an improvement or example to add? Open a Pull Request — thank you! 🙏
Summary
function ultralytics.utils.callbacks.platform.on_pretrain_routine_start
def on_pretrain_routine_start(trainer)
Initialize and start console logging immediately at the very beginning.
Args
| Name | Type | Description | Default |
|---|---|---|---|
trainer | required |
Source code in ultralytics/utils/callbacks/platform.py
View on GitHubdef on_pretrain_routine_start(trainer):
"""Initialize and start console logging immediately at the very beginning."""
if RANK in {-1, 0}:
from ultralytics.utils.logger import DEFAULT_LOG_PATH, ConsoleLogger, SystemLogger
trainer.system_logger = SystemLogger()
trainer.console_logger = ConsoleLogger(DEFAULT_LOG_PATH)
trainer.console_logger.start_capture()
function ultralytics.utils.callbacks.platform.on_pretrain_routine_end
def on_pretrain_routine_end(trainer)
Handle pre-training routine completion event.
Args
| Name | Type | Description | Default |
|---|---|---|---|
trainer | required |
Source code in ultralytics/utils/callbacks/platform.py
View on GitHubdef on_pretrain_routine_end(trainer):
"""Handle pre-training routine completion event."""
pass
function ultralytics.utils.callbacks.platform.on_fit_epoch_end
def on_fit_epoch_end(trainer)
Handle end of training epoch event and collect system metrics.
Args
| Name | Type | Description | Default |
|---|---|---|---|
trainer | required |
Source code in ultralytics/utils/callbacks/platform.py
View on GitHubdef on_fit_epoch_end(trainer):
"""Handle end of training epoch event and collect system metrics."""
if RANK in {-1, 0} and hasattr(trainer, "system_logger"):
system_metrics = trainer.system_logger.get_metrics()
print(system_metrics) # for debug
function ultralytics.utils.callbacks.platform.on_model_save
def on_model_save(trainer)
Handle model checkpoint save event.
Args
| Name | Type | Description | Default |
|---|---|---|---|
trainer | required |
Source code in ultralytics/utils/callbacks/platform.py
View on GitHubdef on_model_save(trainer):
"""Handle model checkpoint save event."""
pass
function ultralytics.utils.callbacks.platform.on_train_end
def on_train_end(trainer)
Stop console capture and finalize logs.
Args
| Name | Type | Description | Default |
|---|---|---|---|
trainer | required |
Source code in ultralytics/utils/callbacks/platform.py
View on GitHubdef on_train_end(trainer):
"""Stop console capture and finalize logs."""
if logger := getattr(trainer, "console_logger", None):
logger.stop_capture()
function ultralytics.utils.callbacks.platform.on_train_start
def on_train_start(trainer)
Handle training start event.
Args
| Name | Type | Description | Default |
|---|---|---|---|
trainer | required |
Source code in ultralytics/utils/callbacks/platform.py
View on GitHubdef on_train_start(trainer):
"""Handle training start event."""
pass
function ultralytics.utils.callbacks.platform.on_val_start
def on_val_start(validator)
Handle validation start event.
Args
| Name | Type | Description | Default |
|---|---|---|---|
validator | required |
Source code in ultralytics/utils/callbacks/platform.py
View on GitHubdef on_val_start(validator):
"""Handle validation start event."""
pass
function ultralytics.utils.callbacks.platform.on_predict_start
def on_predict_start(predictor)
Handle prediction start event.
Args
| Name | Type | Description | Default |
|---|---|---|---|
predictor | required |
Source code in ultralytics/utils/callbacks/platform.py
View on GitHubdef on_predict_start(predictor):
"""Handle prediction start event."""
pass
function ultralytics.utils.callbacks.platform.on_export_start
def on_export_start(exporter)
Handle model export start event.
Args
| Name | Type | Description | Default |
|---|---|---|---|
exporter | required |
Source code in ultralytics/utils/callbacks/platform.py
View on GitHubdef on_export_start(exporter):
"""Handle model export start event."""
pass
📅 Created 3 months ago ✏️ Updated 2 days ago