Skip to content

Commit

Permalink
docs: add EMACallback to README
Browse files Browse the repository at this point in the history
  • Loading branch information
sokovninn committed Oct 14, 2024
1 parent c875e6e commit 22bba41
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions luxonis_train/callbacks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,3 +65,16 @@ Callback to perform a test run at the end of the training.
## `UploadCheckpoint`

Callback that uploads currently the best checkpoint (based on validation loss) to the tracker location - where all other logs are stored.

## `EMACallback`

Callback that updates the stored parameters using a moving average.

**Parameters:**

| Key | Type | Default value | Description |
| ------------------- | ------- | ------------- | ----------------------------------------------------------------------------------------------- |
| `decay` | `float` | `0.5` | Decay factor for the moving average. |
| `use_dynamic_decay` | `bool` | `True` | Whether to use dynamic decay. |
| `decay_tau` | `float` | `2000` | Decay tau for dynamic decay. |
| `device` | `str` | `None` | Device to use for the moving average. If `None`, the device is inferred from the model's device |

0 comments on commit 22bba41

Please sign in to comment.