Summary
This release includes important bug fixes, usability improvements, and configuration enhancements. Key highlights include automatic video-specific output naming for multi-video predictions, improved progress tracking, better handling of edge cases in configuration files, and enhanced security for API key storage.
Major changes
New Features
Progress Bar for Tracking (#366)
Added visual progress tracking during tracking operations, providing real-time feedback on tracking progress for better user experience.
Video-Specific Output Paths (#378)
When running inference with the video_index parameter on multi-video .slp files, output files now automatically include the video name to prevent overwrites. Previously, all predictions would save to the same path (e.g., labels.predictions.slp), requiring users to
manually specify unique output paths. Now, predictions are saved with the format <labels_file>.<video_name>.predictions.slp, enabling seamless batch processing of multiple videos from the same project file.
Bug Fixes
Resume Checkpoint Mapping (#370)
Fixed checkpoint mapping when resuming training from PyTorch model checkpoints, ensuring proper state restoration for torch models.
Metrics Format Compatibility (#371)
Updated metrics saving format to match SLEAP 1.4 specifications and eliminated code duplication in metrics handling, ensuring cross-compatibility between SLEAP-NN and SLEAP 1.4.
Configuration Parameter Handling (#377)
Improved handling of run_name and ckpt_dir configuration parameters when set to empty strings or the string literal "None" in YAML files. This prevents unexpected behavior and ensures consistent defaults are applied.
Security Improvements
API Key Protection (#372)
WandB API keys are now automatically masked when saving initial_config.yaml files, preventing accidental exposure of sensitive credentials in saved configurations.
Configuration & Training Improvements
Optimized Default Parameters (#374, #375)
Updated default trainer configuration parameters based on extensive training experiments, improving training stability and convergence behavior out of the box.
Documentation
Dependency Update Instructions (#376)
Added comprehensive instructions for updating dependencies across all installation methods (GPU, CPU, and Apple Silicon), making it easier for users to maintain up-to-date environments.
Changelog
- Add progress bar to tracker by @gitttt-1234 in #366
- Fix resume checkpoint mapping for torch models only by @gitttt-1234 in #370
- Fix metrics saving format to match SLEAP 1.4 and eliminate code duplication by @gitttt-1234 in #371
- Mask wandb API key in initial_config.yaml by @gitttt-1234 in #372
- Update default trainer configuration parameters for improved training stability by @gitttt-1234 in #374
- Update default configuration values for improved training by @gitttt-1234 in #375
- Add dependency update instructions for all installation methods by @gitttt-1234 in #376
- Handle empty and "None" string values for run_name and ckpt_dir config parameters by @gitttt-1234 in #377
- Append video name to output path when video_index is specified by @gitttt-1234 in #378
- Bump version to 0.0.5 by @gitttt-1234 in #379
Full Changelog: v0.0.4...v0.0.5
