mirror of
https://github.com/ultralytics/ultralytics
synced 2026-04-21 14:07:18 +00:00
docs: add trackzone to solutions cli enum (#24194)
Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
This commit is contained in:
parent
bed8778ae4
commit
6ccdcf372d
3 changed files with 19 additions and 17 deletions
|
|
@ -141,7 +141,7 @@ For more details, refer to the [`SolutionResults` class documentation](https://d
|
|||
|
||||
Most of the Solutions can be used directly through the command-line interface, including:
|
||||
|
||||
`Count`, `Crop`, `Blur`, `Workout`, `Heatmap`, `Isegment`, `Visioneye`, `Speed`, `Queue`, `Analytics`, `Inference`
|
||||
`Count`, `Crop`, `Blur`, `Workout`, `Heatmap`, `Isegment`, `Visioneye`, `Speed`, `Queue`, `Analytics`, `Inference`, `Trackzone`
|
||||
|
||||
**Syntax**
|
||||
|
||||
|
|
|
|||
|
|
@ -87,22 +87,22 @@ Below are all the supported callbacks. For more details, refer to the callbacks
|
|||
|
||||
### Trainer Callbacks
|
||||
|
||||
| Callback | Description |
|
||||
| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `on_pretrain_routine_start` | Triggered at the beginning of the pre-training routine, before data loading and model setup. |
|
||||
| `on_pretrain_routine_end` | Triggered at the end of the pre-training routine, after data loading and model setup are complete. |
|
||||
| `on_train_start` | Triggered when the training starts, before the first [epoch](https://www.ultralytics.com/glossary/epoch) begins. |
|
||||
| `on_train_epoch_start` | Triggered at the start of each training [epoch](https://www.ultralytics.com/glossary/epoch), before batch iteration begins. |
|
||||
| `on_train_batch_start` | Triggered at the start of each training batch, before the forward pass. |
|
||||
| `optimizer_step` | Triggered during the optimizer step. Reserved for custom integrations; not called by the default training loop. |
|
||||
| `on_before_zero_grad` | Triggered before gradients are zeroed. Reserved for custom integrations; not called by the default training loop. |
|
||||
| `on_train_batch_end` | Triggered at the end of each training batch, after the backward pass. The optimizer step may be deferred due to gradient accumulation. |
|
||||
| `on_train_epoch_end` | Triggered at the end of each training epoch, after all batches are processed but **before** validation. Validation metrics and fitness may not be available yet. |
|
||||
| `on_model_save` | Triggered when the model checkpoint is saved, after validation. |
|
||||
| Callback | Description |
|
||||
| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `on_pretrain_routine_start` | Triggered at the beginning of the pre-training routine, before data loading and model setup. |
|
||||
| `on_pretrain_routine_end` | Triggered at the end of the pre-training routine, after data loading and model setup are complete. |
|
||||
| `on_train_start` | Triggered when the training starts, before the first [epoch](https://www.ultralytics.com/glossary/epoch) begins. |
|
||||
| `on_train_epoch_start` | Triggered at the start of each training [epoch](https://www.ultralytics.com/glossary/epoch), before batch iteration begins. |
|
||||
| `on_train_batch_start` | Triggered at the start of each training batch, before the forward pass. |
|
||||
| `optimizer_step` | Triggered during the optimizer step. Reserved for custom integrations; not called by the default training loop. |
|
||||
| `on_before_zero_grad` | Triggered before gradients are zeroed. Reserved for custom integrations; not called by the default training loop. |
|
||||
| `on_train_batch_end` | Triggered at the end of each training batch, after the backward pass. The optimizer step may be deferred due to gradient accumulation. |
|
||||
| `on_train_epoch_end` | Triggered at the end of each training epoch, after all batches are processed but **before** validation. Validation metrics and fitness may not be available yet. |
|
||||
| `on_model_save` | Triggered when the model checkpoint is saved, after validation. |
|
||||
| `on_fit_epoch_end` | Triggered at the end of each fit epoch (train + val), **after** validation and any checkpoint save. Validation metrics are available, and fitness is available for the per-epoch training call. This callback is also called during final best-model evaluation, where no checkpoint save occurs and fitness may not be present. |
|
||||
| `on_train_end` | Triggered when the training process ends, after final evaluation of the best model. |
|
||||
| `on_params_update` | Triggered when model parameters are updated. Reserved for custom integrations; not called by the default training loop. |
|
||||
| `teardown` | Triggered when the training process is being cleaned up. |
|
||||
| `on_train_end` | Triggered when the training process ends, after final evaluation of the best model. |
|
||||
| `on_params_update` | Triggered when model parameters are updated. Reserved for custom integrations; not called by the default training loop. |
|
||||
| `teardown` | Triggered when the training process is being cleaned up. |
|
||||
|
||||
### Validator Callbacks
|
||||
|
||||
|
|
|
|||
|
|
@ -43,7 +43,9 @@ def on_before_zero_grad(trainer):
|
|||
|
||||
|
||||
def on_train_batch_end(trainer):
|
||||
"""Called at the end of each training batch, after the backward pass. Optimizer step may be deferred by accumulation."""
|
||||
"""Called at the end of each training batch, after the backward pass. Optimizer step may be deferred by
|
||||
accumulation.
|
||||
"""
|
||||
pass
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue