Reference for ultralytics/utils/callbacks/neptune.py
Note
This file is available at https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/neptune.py. If you spot a problem please help fix it by contributing a Pull Request 🛠️. Thank you 🙏!
ultralytics.utils.callbacks.neptune._log_scalars
Log scalars to the NeptuneAI experiment logger.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
scalars
|
dict
|
Dictionary of scalar values to log to NeptuneAI. |
required |
step
|
int
|
The current step or iteration number for logging. |
0
|
Examples:
Source code in ultralytics/utils/callbacks/neptune.py
ultralytics.utils.callbacks.neptune._log_images
Log images to the NeptuneAI experiment logger.
This function logs image data to Neptune.ai when a valid Neptune run is active. Images are organized under the specified group name.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
imgs_dict
|
dict
|
Dictionary of images to log, with keys as image names and values as image data. |
required |
group
|
str
|
Group name to organize images under in the Neptune UI. |
''
|
Examples:
Source code in ultralytics/utils/callbacks/neptune.py
ultralytics.utils.callbacks.neptune._log_plot
Log plots to the NeptuneAI experiment logger.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
title
|
str
|
Title of the plot. |
required |
plot_path
|
str
|
Path to the saved image file. |
required |
Source code in ultralytics/utils/callbacks/neptune.py
ultralytics.utils.callbacks.neptune.on_pretrain_routine_start
Callback function called before the training routine starts.
Source code in ultralytics/utils/callbacks/neptune.py
ultralytics.utils.callbacks.neptune.on_train_epoch_end
Callback function called at end of each training epoch.
Source code in ultralytics/utils/callbacks/neptune.py
ultralytics.utils.callbacks.neptune.on_fit_epoch_end
Callback function called at end of each fit (train+val) epoch.
Source code in ultralytics/utils/callbacks/neptune.py
ultralytics.utils.callbacks.neptune.on_val_end
Callback function called at end of each validation.
ultralytics.utils.callbacks.neptune.on_train_end
Callback function called at end of training.