release v1.9.0 #136

ShevchenkoRostyslav · 2025-08-04T16:05:11Z

Release Summary: Open-IRIS v1.9.0

Overview

This release introduces a major new feature - the Multiframe Iris Pipeline - along with significant infrastructure improvements for documentation deployment and PyPI publishing automation.

Version Information

Previous Version: 1.8.2
New Version: 1.9.0
Release Type: Minor Release (New Features + Infrastructure)

🚀 Major Features

1. Multiframe Iris Pipeline (AIC-5901)

New End-to-End Multiframe Iris Processing Pipeline

The most significant addition in this release is the new MultiframeIrisPipeline class that combines individual iris processing with template aggregation into a unified pipeline.

Key Components:

MultiframeIrisPipeline: Main pipeline class that orchestrates both iris processing and template aggregation
Enhanced TemplatesAggregationPipeline: Renamed from MultiframeAggregationPipeline for better clarity
Unified Configuration: Single YAML config file (multiframe_iris_pipeline.yaml) that manages both iris processing and template aggregation settings

New Error Types:

TemplatesAggregationPipelineError: Specific error handling for template aggregation failures

2. Enhanced Testing Infrastructure

Comprehensive Unit Tests: 783 lines of new unit tests for the multiframe pipeline
End-to-End Tests: Complete E2E test suite for both multiframe iris processing and template aggregation
Test Leakage Prevention: Fixed test leakage issues from patches
Improved Test Coverage: Enhanced testing for output builders and orchestration components

🔧 Infrastructure Improvements

1. Documentation Deployment Automation

New GitHub Actions Workflow: .github/workflows/deploy-docs.yml

Automated Documentation Build: Automatically builds and deploys documentation on releases
GitHub Pages Integration: Deploys to gh-pages branch with proper .nojekyll handling
Release-Triggered: Activates on release publication events
Manual Dispatch: Can be triggered manually for testing

2. PyPI Publishing Automation

New GitHub Actions Workflow: .github/workflows/publish_pypi_wheel.yml

Automated PyPI Publishing: Automatically publishes wheels and source distributions to PyPI
TestPyPI Support: Can publish to TestPyPI for testing before production
Release-Triggered: Activates on release publication and main branch pushes
Manual Dispatch: Can be triggered manually with TestPyPI option
Secure Credentials: Uses GitHub secrets for PyPI credentials

🔄 Breaking Changes

Pipeline Rename: MultiframeAggregationPipeline → TemplatesAggregationPipeline
Configuration Updates: Some pipeline configurations may need updates for the new unified structure

📚 Documentation

Updated pipeline documentation to reflect new multiframe capabilities
Enhanced error documentation with new error types
Updated configuration documentation for unified pipeline structure

🚨 Important Notes for Deployment

Security Considerations:

Template Quality Validation: Users must implement proper template quality filtering before using the multiframe pipeline
Identity Validation: Ensure templates are from the same user and same eye before aggregation
Quality Thresholds: Establish appropriate quality thresholds for production use

Migration Notes:

Pipeline Updates: Existing code using MultiframeAggregationPipeline should be updated to use TemplatesAggregationPipeline
Configuration Migration: Update pipeline configurations to use the new unified structure
Error Handling: Update error handling to use the new TemplatesAggregationPipelineError

Type

Checklist

I've made sure that my code works as expected by writing unit tests.
I've checked if my code doesn't generate warnings or errors.
I've performed a self-review of my code.
I've made sure that my code follows the style guidelines of the project.
I've commented hard-to-understand parts of my code.
I've made appropriate changes in the documentation.

Tech debt/aic 5935

* refactor multiframe iris pipeline * refactor and fix tests * fix test leakage from patches * upd e2e tests * fix broken tests * rename MultiframeAggregationPipeline -> TemplatesAggregation * Add user warning * bump the iris version

ycbiometrics

LGTM! Thank you for the great work!

TanguyJeanneau

LGTM - Nice changelog 😁

Co-authored-by: ycbiometrics <[email protected]>

* 1.8.3 -> 1.9.0 * release v1.9.0 (#136) * tets workflow * upd * add prod workflow * correct the repo name * upd name * add a workflow to create docs * address PR comments * debugging * add requirements * upd deploy docs * docs branch * fix bug * cleaning * new way * fake upd of docds * upd * upd * rollback * upd * upd * revert * worktree * another approach * upd * keep some files * final version * swap the order * upd * upd * upd * remove .buildinfo * remove .buildinfo * cleaning * Iris multiview/aic 5901: e2e Multiframe Iris Pipeline (#123) * refactor multiframe iris pipeline * refactor and fix tests * fix test leakage from patches * upd e2e tests * fix broken tests * rename MultiframeAggregationPipeline -> TemplatesAggregation * Add user warning * bump the iris version * 1.8.3 -> 1.9.0 (#137) Co-authored-by: ycbiometrics <[email protected]> --------- Co-authored-by: ycbiometrics <[email protected]> * bugfix serialization data type * add speciofic e2e test for multiframe * revert the doc file from 1.9.0 releqase * update iris version * upd --------- Co-authored-by: ycbiometrics <[email protected]>

* tets workflow * upd * add prod workflow * correct the repo name * upd name * add a workflow to create docs * address PR comments * debugging * add requirements * upd deploy docs * docs branch * fix bug * cleaning * new way * fake upd of docds * upd * upd * rollback * upd * upd * revert * worktree * another approach * upd * keep some files * final version * swap the order * upd * upd * upd * remove .buildinfo * remove .buildinfo * cleaning * Iris multiview/aic 5901: e2e Multiframe Iris Pipeline (#123) * refactor multiframe iris pipeline * refactor and fix tests * fix test leakage from patches * upd e2e tests * fix broken tests * rename MultiframeAggregationPipeline -> TemplatesAggregation * Add user warning * bump the iris version * 1.8.3 -> 1.9.0 (#137) Co-authored-by: ycbiometrics <[email protected]> * Make sure that NodeWritterResult callback is always first in callbacks list of every node. * Hotfix/output builders type (#139) * 1.8.3 -> 1.9.0 * bugfix serialization data type * add speciofic e2e test for multiframe * revert the doc file from 1.9.0 releqase * Hotfix/output builders type (#141) * 1.8.3 -> 1.9.0 * release v1.9.0 (#136) * tets workflow * upd * add prod workflow * correct the repo name * upd name * add a workflow to create docs * address PR comments * debugging * add requirements * upd deploy docs * docs branch * fix bug * cleaning * new way * fake upd of docds * upd * upd * rollback * upd * upd * revert * worktree * another approach * upd * keep some files * final version * swap the order * upd * upd * upd * remove .buildinfo * remove .buildinfo * cleaning * Iris multiview/aic 5901: e2e Multiframe Iris Pipeline (#123) * refactor multiframe iris pipeline * refactor and fix tests * fix test leakage from patches * upd e2e tests * fix broken tests * rename MultiframeAggregationPipeline -> TemplatesAggregation * Add user warning * bump the iris version * 1.8.3 -> 1.9.0 (#137) Co-authored-by: ycbiometrics <[email protected]> --------- Co-authored-by: ycbiometrics <[email protected]> * bugfix serialization data type * add speciofic e2e test for multiframe * revert the doc file from 1.9.0 releqase * update iris version * upd --------- Co-authored-by: ycbiometrics <[email protected]> --------- Co-authored-by: ycbiometrics <[email protected]> Co-authored-by: Wiktor Łazarski <[email protected]>

* tets workflow * upd * add prod workflow * correct the repo name * upd name * add a workflow to create docs * address PR comments * debugging * add requirements * upd deploy docs * docs branch * fix bug * cleaning * new way * fake upd of docds * upd * upd * rollback * upd * upd * revert * worktree * another approach * upd * keep some files * final version * swap the order * upd * upd * upd * remove .buildinfo * remove .buildinfo * cleaning * Iris multiview/aic 5901: e2e Multiframe Iris Pipeline (#123) * refactor multiframe iris pipeline * refactor and fix tests * fix test leakage from patches * upd e2e tests * fix broken tests * rename MultiframeAggregationPipeline -> TemplatesAggregation * Add user warning * bump the iris version * 1.8.3 -> 1.9.0 (#137) Co-authored-by: ycbiometrics <[email protected]> * Make sure that NodeWritterResult callback is always first in callbacks list of every node. * Hotfix/output builders type (#139) * 1.8.3 -> 1.9.0 * bugfix serialization data type * add speciofic e2e test for multiframe * revert the doc file from 1.9.0 releqase * Hotfix/output builders type (#141) * 1.8.3 -> 1.9.0 * release v1.9.0 (#136) * tets workflow * upd * add prod workflow * correct the repo name * upd name * add a workflow to create docs * address PR comments * debugging * add requirements * upd deploy docs * docs branch * fix bug * cleaning * new way * fake upd of docds * upd * upd * rollback * upd * upd * revert * worktree * another approach * upd * keep some files * final version * swap the order * upd * upd * upd * remove .buildinfo * remove .buildinfo * cleaning * Iris multiview/aic 5901: e2e Multiframe Iris Pipeline (#123) * refactor multiframe iris pipeline * refactor and fix tests * fix test leakage from patches * upd e2e tests * fix broken tests * rename MultiframeAggregationPipeline -> TemplatesAggregation * Add user warning * bump the iris version * 1.8.3 -> 1.9.0 (#137) Co-authored-by: ycbiometrics <[email protected]> --------- Co-authored-by: ycbiometrics <[email protected]> * bugfix serialization data type * add speciofic e2e test for multiframe * revert the doc file from 1.9.0 releqase * update iris version * upd --------- Co-authored-by: ycbiometrics <[email protected]> * Preserve ndarray in safe serialization; bump IRIS to 1.9.2 (#145) * fix: not to cast ndarray to list * fix tests * bump the version * rollback docs * Yichen1 aic 6094 pr for new interpolation fusion method (#144) * improve the fusion methold on boundary extrapolation * update more config files * update unit tests --------- Co-authored-by: ycbiometrics <[email protected]> --------- Co-authored-by: ycbiometrics <[email protected]> Co-authored-by: Wiktor Łazarski <[email protected]> Co-authored-by: ycbiometrics <[email protected]>

ShevchenkoRostyslav added 30 commits July 21, 2025 13:26

tets workflow

fb93446

upd

5cc52d2

add prod workflow

ff59988

correct the repo name

3dcbb05

upd name

32f62cb

add a workflow to create docs

f349dff

address PR comments

26acfca

debugging

d68b6a4

add requirements

9ff57d0

upd deploy docs

a8f4cfc

docs branch

c1c2601

fix bug

b533b3a

cleaning

dddd316

new way

23f7d9a

fake upd of docds

af97b8a

upd

070a4cd

upd

1ed8879

rollback

3902e05

upd

15adee6

upd

a7bdb8f

revert

5cbc97c

worktree

615003f

another approach

29ac216

upd

5110cc7

keep some files

7018afb

final version

bf0389f

swap the order

d07f85c

upd

89a32e0

upd

6229e2e

upd

e61d815

ShevchenkoRostyslav added 5 commits July 22, 2025 08:13

remove .buildinfo

5ae9407

remove .buildinfo

0142f92

cleaning

1a73956

Merge pull request #124 from worldcoin/tech_debt/AIC-5935

017ca81

Tech debt/aic 5935

ShevchenkoRostyslav requested a review from a team as a code owner August 4, 2025 16:05

ShevchenkoRostyslav changed the title ~~release v1.8.3~~ release v1.9.0 Aug 4, 2025

ShevchenkoRostyslav requested review from TanguyJeanneau and ycbiometrics August 4, 2025 17:31

ycbiometrics approved these changes Aug 4, 2025

View reviewed changes

TanguyJeanneau approved these changes Aug 4, 2025

View reviewed changes

1.8.3 -> 1.9.0 (#137)

ae4ce4a

Co-authored-by: ycbiometrics <[email protected]>

ShevchenkoRostyslav merged commit e7141c4 into main Aug 4, 2025
14 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

release v1.9.0 #136

release v1.9.0 #136

Uh oh!

ShevchenkoRostyslav commented Aug 4, 2025 •

edited

Loading

Uh oh!

ycbiometrics left a comment

Uh oh!

TanguyJeanneau left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

release v1.9.0 #136

release v1.9.0 #136

Uh oh!

Conversation

ShevchenkoRostyslav commented Aug 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Release Summary: Open-IRIS v1.9.0

Overview

Version Information

🚀 Major Features

1. Multiframe Iris Pipeline (AIC-5901)

Key Components:

New Error Types:

2. Enhanced Testing Infrastructure

🔧 Infrastructure Improvements

1. Documentation Deployment Automation

2. PyPI Publishing Automation

🔄 Breaking Changes

📚 Documentation

🚨 Important Notes for Deployment

Security Considerations:

Migration Notes:

Type

Checklist

Uh oh!

ycbiometrics left a comment

Choose a reason for hiding this comment

Uh oh!

TanguyJeanneau left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ShevchenkoRostyslav commented Aug 4, 2025 •

edited

Loading