Skip to content

Reference for ultralytics/utils/callbacks/raytune.py

Note

This file is available at https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/raytune.py. If you spot a problem please help fix it by contributing a Pull Request 🛠️. Thank you 🙏!


ultralytics.utils.callbacks.raytune.on_fit_epoch_end

on_fit_epoch_end(trainer)

Sends training metrics to Ray Tune at end of each epoch.

This function checks if a Ray Tune session is active and reports the current training metrics along with the epoch number to Ray Tune's session.

Parameters:

Name Type Description Default
trainer BaseTrainer

The Ultralytics trainer object containing metrics and epochs.

required

Examples:

>>> # Called automatically by the Ultralytics training loop
>>> on_fit_epoch_end(trainer)
Source code in ultralytics/utils/callbacks/raytune.py
def on_fit_epoch_end(trainer):
    """
    Sends training metrics to Ray Tune at end of each epoch.

    This function checks if a Ray Tune session is active and reports the current training metrics along with the
    epoch number to Ray Tune's session.

    Args:
        trainer (ultralytics.engine.trainer.BaseTrainer): The Ultralytics trainer object containing metrics and epochs.

    Examples:
        >>> # Called automatically by the Ultralytics training loop
        >>> on_fit_epoch_end(trainer)
    """
    if ray.train._internal.session.get_session():  # check if Ray Tune session is active
        metrics = trainer.metrics
        session.report({**metrics, **{"epoch": trainer.epoch + 1}})



📅 Created 1 year ago ✏️ Updated 7 months ago