Docstrings arguments cleanup (#3229)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
This commit is contained in:
Glenn Jocher 2023-06-17 16:17:07 +02:00 committed by GitHub
parent 62916b3b0a
commit bd0f7ecf6f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
93 changed files with 1104 additions and 1102 deletions

View file

@ -3,137 +3,137 @@ description: Learn about YOLO's callback functions from on_train_start to add_in
keywords: YOLO, Ultralytics, callbacks, object detection, training, inference
---
# on_pretrain_routine_start
## on_pretrain_routine_start
---
:::ultralytics.yolo.utils.callbacks.base.on_pretrain_routine_start
### ::: ultralytics.yolo.utils.callbacks.base.on_pretrain_routine_start
<br><br>
# on_pretrain_routine_end
## on_pretrain_routine_end
---
:::ultralytics.yolo.utils.callbacks.base.on_pretrain_routine_end
### ::: ultralytics.yolo.utils.callbacks.base.on_pretrain_routine_end
<br><br>
# on_train_start
## on_train_start
---
:::ultralytics.yolo.utils.callbacks.base.on_train_start
### ::: ultralytics.yolo.utils.callbacks.base.on_train_start
<br><br>
# on_train_epoch_start
## on_train_epoch_start
---
:::ultralytics.yolo.utils.callbacks.base.on_train_epoch_start
### ::: ultralytics.yolo.utils.callbacks.base.on_train_epoch_start
<br><br>
# on_train_batch_start
## on_train_batch_start
---
:::ultralytics.yolo.utils.callbacks.base.on_train_batch_start
### ::: ultralytics.yolo.utils.callbacks.base.on_train_batch_start
<br><br>
# optimizer_step
## optimizer_step
---
:::ultralytics.yolo.utils.callbacks.base.optimizer_step
### ::: ultralytics.yolo.utils.callbacks.base.optimizer_step
<br><br>
# on_before_zero_grad
## on_before_zero_grad
---
:::ultralytics.yolo.utils.callbacks.base.on_before_zero_grad
### ::: ultralytics.yolo.utils.callbacks.base.on_before_zero_grad
<br><br>
# on_train_batch_end
## on_train_batch_end
---
:::ultralytics.yolo.utils.callbacks.base.on_train_batch_end
### ::: ultralytics.yolo.utils.callbacks.base.on_train_batch_end
<br><br>
# on_train_epoch_end
## on_train_epoch_end
---
:::ultralytics.yolo.utils.callbacks.base.on_train_epoch_end
### ::: ultralytics.yolo.utils.callbacks.base.on_train_epoch_end
<br><br>
# on_fit_epoch_end
## on_fit_epoch_end
---
:::ultralytics.yolo.utils.callbacks.base.on_fit_epoch_end
### ::: ultralytics.yolo.utils.callbacks.base.on_fit_epoch_end
<br><br>
# on_model_save
## on_model_save
---
:::ultralytics.yolo.utils.callbacks.base.on_model_save
### ::: ultralytics.yolo.utils.callbacks.base.on_model_save
<br><br>
# on_train_end
## on_train_end
---
:::ultralytics.yolo.utils.callbacks.base.on_train_end
### ::: ultralytics.yolo.utils.callbacks.base.on_train_end
<br><br>
# on_params_update
## on_params_update
---
:::ultralytics.yolo.utils.callbacks.base.on_params_update
### ::: ultralytics.yolo.utils.callbacks.base.on_params_update
<br><br>
# teardown
## teardown
---
:::ultralytics.yolo.utils.callbacks.base.teardown
### ::: ultralytics.yolo.utils.callbacks.base.teardown
<br><br>
# on_val_start
## on_val_start
---
:::ultralytics.yolo.utils.callbacks.base.on_val_start
### ::: ultralytics.yolo.utils.callbacks.base.on_val_start
<br><br>
# on_val_batch_start
## on_val_batch_start
---
:::ultralytics.yolo.utils.callbacks.base.on_val_batch_start
### ::: ultralytics.yolo.utils.callbacks.base.on_val_batch_start
<br><br>
# on_val_batch_end
## on_val_batch_end
---
:::ultralytics.yolo.utils.callbacks.base.on_val_batch_end
### ::: ultralytics.yolo.utils.callbacks.base.on_val_batch_end
<br><br>
# on_val_end
## on_val_end
---
:::ultralytics.yolo.utils.callbacks.base.on_val_end
### ::: ultralytics.yolo.utils.callbacks.base.on_val_end
<br><br>
# on_predict_start
## on_predict_start
---
:::ultralytics.yolo.utils.callbacks.base.on_predict_start
### ::: ultralytics.yolo.utils.callbacks.base.on_predict_start
<br><br>
# on_predict_batch_start
## on_predict_batch_start
---
:::ultralytics.yolo.utils.callbacks.base.on_predict_batch_start
### ::: ultralytics.yolo.utils.callbacks.base.on_predict_batch_start
<br><br>
# on_predict_batch_end
## on_predict_batch_end
---
:::ultralytics.yolo.utils.callbacks.base.on_predict_batch_end
### ::: ultralytics.yolo.utils.callbacks.base.on_predict_batch_end
<br><br>
# on_predict_postprocess_end
## on_predict_postprocess_end
---
:::ultralytics.yolo.utils.callbacks.base.on_predict_postprocess_end
### ::: ultralytics.yolo.utils.callbacks.base.on_predict_postprocess_end
<br><br>
# on_predict_end
## on_predict_end
---
:::ultralytics.yolo.utils.callbacks.base.on_predict_end
### ::: ultralytics.yolo.utils.callbacks.base.on_predict_end
<br><br>
# on_export_start
## on_export_start
---
:::ultralytics.yolo.utils.callbacks.base.on_export_start
### ::: ultralytics.yolo.utils.callbacks.base.on_export_start
<br><br>
# on_export_end
## on_export_end
---
:::ultralytics.yolo.utils.callbacks.base.on_export_end
### ::: ultralytics.yolo.utils.callbacks.base.on_export_end
<br><br>
# get_default_callbacks
## get_default_callbacks
---
:::ultralytics.yolo.utils.callbacks.base.get_default_callbacks
### ::: ultralytics.yolo.utils.callbacks.base.get_default_callbacks
<br><br>
# add_integration_callbacks
## add_integration_callbacks
---
:::ultralytics.yolo.utils.callbacks.base.add_integration_callbacks
### ::: ultralytics.yolo.utils.callbacks.base.add_integration_callbacks
<br><br>