Reference for ultralytics/utils/callbacks/clearml.py
Note
This file is available at https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/clearml.py. If you spot a problem please help fix it by contributing a Pull Request 🛠️. Thank you 🙏!
ultralytics.utils.callbacks.clearml._log_debug_samples
_log_debug_samples(files, title: str = 'Debug Samples') -> None
Log files (images) as debug samples in the ClearML task.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
files
|
List[Path]
|
A list of file paths in PosixPath format. |
required |
title
|
str
|
A title that groups together images with the same values. |
'Debug Samples'
|
Source code in ultralytics/utils/callbacks/clearml.py
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 |
|
ultralytics.utils.callbacks.clearml._log_plot
_log_plot(title: str, plot_path: str) -> None
Log an image as a plot in the plot section of ClearML.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
title
|
str
|
The title of the plot. |
required |
plot_path
|
str
|
The path to the saved image file. |
required |
Source code in ultralytics/utils/callbacks/clearml.py
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
|
ultralytics.utils.callbacks.clearml.on_pretrain_routine_start
on_pretrain_routine_start(trainer) -> None
Runs at start of pretraining routine; initializes and connects/logs task to ClearML.
Source code in ultralytics/utils/callbacks/clearml.py
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 |
|
ultralytics.utils.callbacks.clearml.on_train_epoch_end
on_train_epoch_end(trainer) -> None
Logs debug samples for the first epoch of YOLO training and reports current training progress.
Source code in ultralytics/utils/callbacks/clearml.py
87 88 89 90 91 92 93 94 95 96 97 |
|
ultralytics.utils.callbacks.clearml.on_fit_epoch_end
on_fit_epoch_end(trainer) -> None
Reports model information to logger at the end of an epoch.
Source code in ultralytics/utils/callbacks/clearml.py
100 101 102 103 104 105 106 107 108 109 110 111 112 113 |
|
ultralytics.utils.callbacks.clearml.on_val_end
on_val_end(validator) -> None
Logs validation results including labels and predictions.
Source code in ultralytics/utils/callbacks/clearml.py
116 117 118 119 120 |
|
ultralytics.utils.callbacks.clearml.on_train_end
on_train_end(trainer) -> None
Logs final model and its name on training completion.
Source code in ultralytics/utils/callbacks/clearml.py
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 |
|