Skip to content

Commit

Permalink
updated callback readme
Browse files Browse the repository at this point in the history
  • Loading branch information
klemen1999 committed Feb 16, 2024
1 parent 9fb1591 commit 6f409f3
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
9 changes: 9 additions & 0 deletions luxonis_train/callbacks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ List of all supported callbacks.
- [LuxonisProgressBar](#luxonisprogressbar)
- [MetadataLogger](#metadatalogger)
- [TestOnTrainEnd](#testontrainend)
- [UploadCheckpoint](#uploadcheckpoint)

## PytorchLightning Callbacks

Expand Down Expand Up @@ -51,3 +52,11 @@ Metadata include all defined hyperparameters together with git hashes of `luxoni
## TestOnTrainEnd

Callback to perform a test run at the end of the training.

## UploadCheckpoint

Callback that uploads currently best checkpoint (based on validation loss) to specified cloud directory after every validation epoch.

| Key | Type | Default value | Description |
| ----------- | ----------- | ------------- | ----------------------------------------------------------------------------------------------------------------------- |
| upload_directory | str | / | Path to cloud directory where checkpoints should be uploaded to. If you want to use current mlflow run set it to `mlflow://`. |
4 changes: 2 additions & 2 deletions luxonis_train/callbacks/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
from .metadata_logger import MetadataLogger
from .module_freezer import ModuleFreezer
from .test_on_train_end import TestOnTrainEnd
from .upload_checkpoint_on_train_end import UploadCheckpointOnTrainEnd
from .upload_checkpoint import UploadCheckpoint

CALLBACKS.register_module(module=EarlyStopping)
CALLBACKS.register_module(module=LearningRateMonitor)
Expand All @@ -28,5 +28,5 @@
"MetadataLogger",
"ModuleFreezer",
"TestOnTrainEnd",
"UploadCheckpointOnTrainEnd",
"UploadCheckpoint",
]

0 comments on commit 6f409f3

Please sign in to comment.