Currently, IRISPipeline returns serialised version of generated IrisTemplate that causes confusions and make it less intuitive how one can use HammingDistanceMatcher. This PR simplifies IRISPipeline output such that together with metadata, unserialised IrisTemplate object is by default returned from IRISPipeline inference call.
Also, update ruff tool setup to remove it's warnings and apply code quality tools to unify code base style etc.
Issue
Without knowing more details about inner working of a code base, users find it difficult to simply take two IR images, generate IrisTemplates and use HammingDistanceMatcher to get final distance between two irises.
Solution
Introduce a new builder function that returns IrisTemplate object (if error wasn't raised during the IRISPipeline inference call) and metadata in a dictionary.
Type
[x] Feature
[x] Refactoring
Checklist
[x] I've made sure that my code works as expected by writing unit tests.
[x] I've checked if my code doesn't generate warnings or errors.
[x] I've performed a self-review of my code.
[x] I've made sure that my code follows the style guidelines of the project.
[x] I've commented hard-to-understand parts of my code.
[x] I've made appropriate changes in the documentation.
Simplify
IRISPipeline
output.PR description
Currently,
IRISPipeline
returns serialised version of generatedIrisTemplate
that causes confusions and make it less intuitive how one can useHammingDistanceMatcher
. This PR simplifiesIRISPipeline
output such that together withmetadata
, unserialisedIrisTemplate
object is by default returned fromIRISPipeline
inference call.Also, update
ruff
tool setup to remove it's warnings and apply code quality tools to unify code base style etc.Issue
Without knowing more details about inner working of a code base, users find it difficult to simply take two IR images, generate
IrisTemplate
s and useHammingDistanceMatcher
to get final distance between two irises.Solution
Introduce a new builder function that returns
IrisTemplate
object (if error wasn't raised during theIRISPipeline
inference call) andmetadata
in a dictionary.Type
Checklist