Deepinv

----------------

New Features
^^^^^^^^^^^^
- global path for datasets get_data_home() (:gh:`347` by `Julian Tachella`_ and `Thomas Moreau`_)
- New docs user guide (:gh:`347` by `Julian Tachella`_ and `Thomas Moreau`_)
- Added UNSURE loss (:gh:`313` by `Julian Tachella`_)
- Add transform symmetrisation, further transform arithmetic, and new equivariant denoiser (:gh:`259` by `Andrew Wang`_)
- New transforms: multi-axis reflect, time-shift and diffeomorphism (:gh:`259` by `Andrew Wang`_)


- Add wrapper classes for adapting models to take time-sequence 2D+t input (:gh:`296` by `Andrew Wang`_)
- Add sequential MRI operator (:gh:`296` by `Andrew Wang`_)
- Add multi-operator equivariant imaging loss (:gh:`296` by `Andrew Wang`_)
- Add loss schedulers (:gh:`296` by `Andrew Wang`_)
- Add transform symmetrisation, further transform arithmetic, and new equivariant denoiser (:gh:`259` by `Andrew Wang`_)
- New transforms: multi-axis reflect, time-shift and diffeomorphism (:gh:`259` by `Andrew Wang`_)
- Multi-coil MRI, 3D MRI, MRI Mixin (:gh:`287` by `Andrew Wang`_, Brett Levac)
- Add Metric baseclass, unified params (for complex, norm, reduce), typing, tests, L1L2 metric, QNR metric, metrics docs section, Metric functional wrapper (:gh:`309`, :gh:`343` by `Andrew Wang`_)
- generate_dataset features: complex numbers, save/load physics_generator params, overwrite bool (:gh:`324`, :gh:`352` by `Andrew Wang`_)
- Add the Köhler dataset (:gh:`271` by `Jérémy Scanvic`_)

Fixed
^^^^^
- Fixed sphinx warnings (:gh:`347` by `Julian Tachella`_ and `Thomas Moreau`_)
- Fix cache file initialization in FastMRI Dataloader (:gh:`300` by `Pierre-Antoine Comby`_)
- Fixed prox_l2 no learning option in Trainer (:gh:`304` by `Julian Tachella`_)

- Fixed SSIM to use lightweight torchmetrics function + add MSE and NMSE as metrics + allow PSNR & SSIM to set max pixel on the fly (:gh:`296` by `Andrew Wang`_)
- Fix generate_dataset error with physics_generator and batch_size != 1. (:gh:`315` by apolychronou)
- Fix generate_dataset error not using random physics generator (:gh:`324` by `Andrew Wang`_)
- Fix Scale transform rng device error (:gh:`324` by `Andrew Wang`_)
- Fix bug when using cuda device in dinv.datasets.generate_dataset (:gh:`334` by `Tobias Liaudat`_)
- Update outdated links in the readme (:gh:`366` by `Jérémy Scanvic`_)

Changed
^^^^^^^
- Added direct option to ArtifactRemoval (:gh:`347` by `Julian Tachella`_ and `Thomas Moreau`_)
- Sphinx template to pydata (:gh:`347` by `Julian Tachella`_ and `Thomas Moreau`_)
- Remove metrics from utils and consolidate complex and normalisation options (:gh:`309` by `Andrew Wang`_)
- get_freer_gpu falls back to torch.cuda when nvidia-smi fails (:gh:`352` by `Andrew Wang`_)
- libcpab now is a PyPi package for diffeomorphisms, add rngs and devices to transforms (:gh:`370` by `Andrew Wang`_)

----------------

New Features
^^^^^^^^^^^^
- Mirror Descent algorithm with Bregman potentials (:gh:`282` by `Samuel Hurault`_)
- Added Gaussian-weighted splitting mask (from Yaman et al.), Artifact2Artifact (Liu et al.) and Phase2Phase (Eldeniz et al.) (:gh:`279` by `Andrew Wang`_)
- Added time-agnostic network wrapper (:gh:`279` by `Andrew Wang`_)
- Add sinc filter (:gh:`280` by `Julian Tachella`_)
- Add Noise2Score method (:gh:`280` by `Julian Tachella`_)
- Add Gamma Noise (:gh:`280` by `Julian Tachella`_)
- Add 3D Blur physics operator, with 3D diffraction microscope blur generators (:gh: `277` by `Florian Sarron`_, `Pierre Weiss`_, `Paul Escande`_, `Minh Hai Nguyen`_) - 12/07/2024
- Add ICNN model (:gh:`281` by `Samuel Hurault`_)
- Dynamic MRI physics operator (:gh:`242` by `Andrew Wang`_)
- Add support for adversarial losses and models (GANs) (:gh:`183` by `Andrew Wang`_)
- Base transform class for transform arithmetic (:gh:`240` by `Andrew Wang`_) - 26/06/2024.
- Plot video/animation functionality (:gh:`245` by `Andrew Wang`_)
- Added update_parameters for parameter-dependent physics (:gh:`241` by Julian Tachella) - 11/06/2024
- Added evaluation functions for R2R and Splitting losses (:gh:`241` by Julian Tachella) - 11/06/2024
- Added a new `Physics` class for the Radio Interferometry problem (:gh:`230` by `Chao Tang`_, `Tobias Liaudat`_) - 07/06/2024
- Add projective and affine transformations for EI or data augmentation (:gh:`173` by `Andrew Wang`_)
- Add k-t MRI mask generators using Gaussian, random uniform and equispaced sampling stratgies (:gh:`206` by `Andrew Wang`_)
- Added Lidc-Idri buit-in datasets (:gh:`270` by Maxime SONG) - 12/07/2024
- Added Flickr2k / LSDIR / Fluorescent Microscopy Denoising buit-in datasets (:gh:`276` by Maxime SONG) - 15/07/2024
- Added `rng` a random number generator to each `PhysicsGenerator` and a `seed` number argument to `step()` function (by `Minh Hai Nguyen`)
- Added an equivalent of `numpy.random.choice()` in torch, available in `deepinv.physics.functional.random_choice()` (by `Minh Hai Nguyen`)
- Added stride, shape in `PatchDataset` (:gh:`308` by apolychronou)

Fixed
^^^^^
- Disable unecessary gradient computation to prevent memory explosion (:gh:`301` by `Dylan Sechet`, `Samuel Hurault`)
- Wandb logging (:gh:`280` by `Julian Tachella`_)
- SURE improvements (:gh:`280` by `Julian Tachella`_)
- Fixed padding in conv_transpose2d and made conv_2d a true convolution (by `Florian Sarron`_, `Pierre Weiss`_, `Paul Escande`_, `Minh Hai Nguyen`_) - 12/07/2024
- Fixed the gradient stopping in EILoss (:gh:`263` by `Jérémy Scanvic`_) - 27/06/2024
- Fixed averaging loss over epochs Trainer (:gh:`241` by Julian Tachella) - 11/06/2024
- Fixed Trainer save_path timestamp problem on Windows (:gh:`245` by `Andrew Wang`_)
- Fixed inpainting/SplittingLoss mask generation + more flexible tensor size handling + pixelwise masking (:gh:`267` by `Andrew Wang`_)
- Fixed the `deepinv.physics.generator.ProductConvolutionBlurGenerator`, allowing for batch generation (previously does not work) by (`Minh Hai Nguyen`)

Changed
^^^^^^^
- Redefine Prior, DataFidelity and Bregman with a common parent class Potential (:gh:`282` by `Samuel Hurault`_)
- Changed to Python 3.9+ (:gh:`280` by `Julian Tachella`_)
- Improved support for parameter-dependent operators (:gh:`227` by `Jérémy Scanvic`_) - 28/05/2024
- Added a divergence check in the conjugate gradient implementation (:gh:`225` by `Jérémy Scanvic`_) - 22/05/2024

----------------
Many of the features in this version were developed by `Minh Hai Nguyen`_,
`Pierre Weiss`_, `Florian Sarron`_, `Julian Tachella`_ and `Matthieu Terris`_ during the IDRIS hackathon.

New Features
^^^^^^^^^^^^
- Added a parameterization of the operators and noiselevels for the physics class
- Added a physics.functional submodule
- Modified the Blur class to handle color, grayscale, single and multi-batch images
- Added a PhysicsGenerator class to synthetize parameters for the forward operators
- Added the possibility to sum generators
- Added a MotionBlur generator
- Added a DiffractionBlur generator
- Added a MaskGenerator for MRI
- Added a SigmaGenerator for the Gaussian noise
- Added a tour of blur operators
- Added ProductConvolution expansions
- Added a ThinPlateSpline interpolation function
- Added d-dimensional histograms
- Added GeneratorMixture to mix physics generators
- Added the SpaceVarying blur class
- Added the SpaceVarying blur generators
- Added pytests and examples for all the new features
- A few speed ups by carefully profiling the training codes
- made sigma in drunet trainable
- Added Trainer, Loss class and eval metric (LPIPS, NIQE, SSIM) (:gh:`181` by `Julian Tachella`_) - 02/04/2024
- PhaseRetrieval class (:gh:`176` by `Zhiyuan Hu`_) - 20/03/2024
- Added 3D wavelets (:gh:`164` by `Matthieu Terris`_) - 07/03/2024
- Added patch priors loss (:gh:`164` by `Johannes Hertrich`_) - 07/03/2024
- Added Restormer model (:gh:`185` by Antoine Regnier and Maxime SONG) - 18/04/2024
- Added DIV2K built-in dataset (:gh:`203` by Maxime SONG) - 03/05/2024
- Added Urban100 built-in dataset (:gh:`237` by Maxime SONG) - 07/06/2024
- Added Set14 / CBSD68 / fastMRI buit-in datasets (:gh:`248` :gh:`249` :gh:`229` by Maxime SONG) - 25/06/2024

Fixed
^^^^^
- Fixed the None prior (:gh:`233` by `Samuel Hurault`_) - 04/06/2024
- Fixed the conjugate gradient torch.nograd for teh demos, accelerated)
- Fixed torch.nograd in demos for faster generation of the doc
- Corrected the padding for the convolution
- Solved pan-sharpening issues
- Many docstring fixes
- Fixed slow drunet sigma and batched conjugate gradient (:gh:`181` by `Minh Hai Nguyen`_) - 02/04/2024
- Fixed g dependence on sigma in optim docs (:gh:`165` by `Julian Tachella`_) - 28/02/2024



Changed
^^^^^^^
- Refactored the documentation completely for the physics
- Refactor unfolded docs (:gh:`181` by `Julian Tachella`_) - 02/04/2024
- Refactor model docs (:gh:`172` by `Julian Tachella`_) - 12/03/2024
- Changed WaveletPrior to WaveletDenoiser (:gh:`165` by `Julian Tachella`_) - 28/02/2024
- Move from torchwavelets to ptwt (:gh:`162` by `Matthieu Terris`_) - 22/02/2024

----------------

New Features
^^^^^^^^^^^^
- Added r2r loss (:gh:`148` by `Brayan Monroy`_) - 30/01/2024
- Added scale transform (:gh:`135` by `Jérémy Scanvic`_) - 19/12/2023
- Added priors for total variation and l12 mixed norm (:gh:`156` by `Nils Laurent`_) - 09/02/2023


Fixed
^^^^^
- Fixed issue in noise forward of Decomposable class (:gh:`154` by `Matthieu Terris`_) - 08/02/2024
- Fixed new black version 24.1.1 style changes (:gh:`151` by `Julian Tachella`_) - 31/01/2024
- Fixed test for sigma as torch tensor with gpu enable (:gh:`145` by `Brayan Monroy`_) - 23/12/2023
- Fixed :gh:`139` BM3D tensor format grayscale (:gh:`140` by `Matthieu Terris`_) - 23/12/2023
- Fixed :gh:`136` noise additive model for DecomposablePhysics (:gh:`138` by `Matthieu Terris`_) - 22/12/2023
- Importing `deepinv` does not modify matplotlib config anymore (:gh`1501` by `Thomas Moreau`_) - 30/01/2024


Changed
^^^^^^^
- Rephrased the README (:gh:`142` by `Jérémy Scanvic`_) - 09/01/2024

----------------

New Features
^^^^^^^^^^^^
- Added autoadjoint capabilities (:gh:`151` by `Julian Tachella`_) - 31/01/2024
- Added equivariant transforms (:gh:`125` by `Matthieu Terris`_) - 07/12/2023
- Moved datasets and weights to HuggingFace (:gh:`121` by `Samuel Hurault`_) - 01/12/2023
- Added L1 prior, change distance in DataFidelity (:gh:`108` by `Samuel Hurault`_) - 03/11/2023
- Added Kaiming init (:gh:`102` by `Matthieu Terris`_) - 29/10/2023
- Added Anderson Acceleration (:gh:`86` by `Samuel Hurault`_) - 23/10/2023
- Added `DPS` diffusion method (:gh:`92` by `Julian Tachella`_ and `Hyungjin Chung`_) - 20/10/2023
- Added on-the-fly physics computations in training (:gh:`88` by `Matthieu Terris`_) - 10/10/2023
- Added `no_grad` parameter (:gh:`80` by `Jérémy Scanvic`_) - 20/08/2023
- Added prox of TV (:gh:`79` by `Matthieu Terris`_) - 16/08/2023
- Added diffpir demo + model (:gh:`77` by `Matthieu Terris`_) - 08/08/2023
- Added SwinIR model (:gh:`76` by `Jérémy Scanvic`_) - 02/08/2023
- Added hard-threshold (:gh:`71` by `Matthieu Terris`_) - 18/07/2023
- Added discord server (:gh:`64` by `Julian Tachella`_) - 10/07/2023
- Added changelog file (:gh:`64` by `Julian Tachella`_) - 10/07/2023

Fixed
^^^^^
- doc fixes + training fixes (:gh:`124` by `Julian Tachella`_) - 06/12/2023
- Add doc weights (:gh:`97` by `Matthieu Terris`_) - 24/10/2023
- Fix BlurFFT adjoint (:gh:`89` by `Matthieu Terris`_) - 15/10/2023
- Doc typos (:gh:`88` by `Matthieu Terris`_) - 10/10/2023
- Minor fixes DiffPIR + other typos (:gh:`81` by `Matthieu Terris`_) - 10/09/2023
- Call `wandb.init` only when needed (:gh:`78` by `Jérémy Scanvic`_) - 09/08/2023
- Log epoch loss instead of batch loss (:gh:`73` by `Jérémy Scanvic`_) - 21/07/2023
- Automatically disable backtracking is no explicit cost (:gh:`68` by `Samuel Hurault`_) - 12/07/2023
- Added missing indent (:gh:`63` by `Jérémy Scanvic`_) - 12/07/2023
- Fixed get_freer_gpu grep statement to work for different versions of nvidia-smi (:gh: `82` by `Alexander Mehta`_) - 20/09/2023
- Fixed get_freer_gpu to work on different operating systems (:gh: `87` by `Andrea Sebastiani`_) - 10/10/2023
- Fixed Discord server and contributiong links (:gh: `87` by `Andrea Sebastiani`_) - 10/10/2023


Changed
^^^^^^^
- Update CI (:gh:`95` :gh:`99` by `Thomas Moreau`_) - 24/10/2023
- Changed normalization CS and SPC to 1/m (:gh:`72` by `Julian Tachella`_) - 21/07/2023
- Update docstring (:gh:`68` by `Samuel Hurault`_) - 12/07/2023


Authors
^^^^^^^

.. _Julian Tachella: https://github.com/tachella
.. _Jérémy Scanvic: https://github.com/jscanvic
.. _Samuel Hurault: https://github.com/samuro95
.. _Matthieu Terris: https://github.com/matthieutrs
.. _Alexander Mehta: https://github.com/alexmehta
.. _Andrea Sebastiani: https://github.com/sedaboni
.. _Thomas Moreau: https://github.com/tomMoral
.. _Hyungjin Chung: https://www.hj-chung.com/
.. _Eliott Bourrigan: https://github.com/eliottbourrigan
.. _Riyad Chamekh: https://github.com/riyadchk
.. _Jules Dumouchel: https://github.com/Ruli0
.. _Brayan Monroy: https://github.com/bemc22
.. _Nils Laurent: https://nils-laurent.github.io/
.. _Johannes Hertrich: https://johertrich.github.io/
.. _Minh Hai Nguyen: https://fr.linkedin.com/in/minh-hai-nguyen-7120
.. _Florian Sarron: https://fsarron.github.io/
.. _Pierre Weiss: https://www.math.univ-toulouse.fr/~weiss/
.. _Zhiyuan Hu: https://github.com/zhiyhu1605
.. _Chao Tang: https://github.com/ChaoTang0330
.. _Tobias Liaudat: https://github.com/tobias-liaudat
.. _Andrew Wang: https://andrewwango.github.io/about/
.. _Pierre-Antoine Comby: https://github.com/paquiteau