CAREamics / careamics

A deep-learning library for N2V and friends
https://careamics.github.io/
BSD 3-Clause "New" or "Revised" License
30 stars 6 forks source link

Add custom transforms to convenience functions, and other API improvement #239

Closed jdeschamps closed 2 months ago

jdeschamps commented 2 months ago

Description

Following https://github.com/CAREamics/careamics/issues/231, there is a lack of flexibility in the way users can specify the transforms in the config convenience functions. The choice to users comes down to using only the default augmentations or no augmentation at all.

In passing, I also added the dataloader_params parameter by request of students during the MBL course.

This PR does a few things:

Summary:

Changes Made

Related Issues

Breaking changes

Any call that uses the convenience functions together with the parameter model_kwargs.

This PR will require an update to the doc and the examples.


Please ensure your PR meets the following requirements:

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 87.06%. Comparing base (929b9b8) to head (2963f62).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #239 +/- ## ========================================== - Coverage 87.20% 87.06% -0.15% ========================================== Files 131 129 -2 Lines 4956 4940 -16 ========================================== - Hits 4322 4301 -21 - Misses 634 639 +5 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

jdeschamps commented 2 months ago

I typed the transforms differently in the end, and added further refactoring and some error raising!