v1.9.0

Open IRIS v1.9.0 Release Notes

🚀 New Features

✨ Multiframe Iris Pipeline

• New MultiframeIrisPipeline class: A comprehensive pipeline that combines individual iris processing with template aggregation
• Unified configuration system: Single YAML configuration file that manages both iris processing and template aggregation phases
• Multi-image processing: Process multiple iris images and aggregate the resulting templates into a single high-quality template
• Enhanced output builders: New output builders specifically designed for multiframe pipeline results

🔧 Pipeline Architecture Improvements

• Renamed MultiframeAggregationPipeline to TemplatesAggregationPipeline: More descriptive naming for better clarity
• Enhanced output builders: Extended output_builders.py with new functions for multiframe pipeline outputs
• Improved error classes: Added new error types for better exception handling in template aggregation scenarios

🛠️ Infrastructure & DevOps

📚 Documentation Deployment

• Automated documentation deployment: New GitHub Actions workflow for automatic docs deployment on releases
• Enhanced build process: Improved documentation building with better handling of hidden files and build artifacts
• GitHub Pages integration: Streamlined deployment to GitHub Pages with proper .nojekyll file handling

📦 PyPI Publishing

• Automated PyPI publishing: New workflow for automatic wheel and source distribution publishing
• TestPyPI support: Support for publishing to TestPyPI for testing purposes
• Release-triggered publishing: Automatic publishing on GitHub releases and main branch pushes

🔍 Technical Details

Testing Improvements

• Comprehensive test coverage: Added extensive unit tests for the new multiframe pipeline (783+ lines of test code)
• End-to-end testing: New e2e tests for multiframe iris pipeline functionality
• Test refactoring: Improved existing tests to work with the new pipeline architecture

⚠️ Important Notes

Template Quality Requirements

The new multiframe pipeline includes important warnings about template quality and validation requirements. Users must ensure:

• Templates are from the same user and same eye
• Templates meet quality thresholds (no off-gaze, occlusion, poor focus)
• Appropriate validation criteria are established before production use

🔗 Migration Guide

For users upgrading from v1.8.x:

• The MultiframeAggregationPipeline has been renamed to TemplatesAggregationPipeline
• New MultiframeIrisPipeline class is available for combined processing
• Enhanced error handling provides better debugging capabilities
• Automated deployment workflows reduce manual intervention

What's Changed

• release v1.9.0 by @ShevchenkoRostyslav in #136

Full Changelog: v1.8.2...v1.9.0