CLN warn user about unused parameters in Physics (deepinv#423)

tomMoral · Andrewwango · web-flow · commit 8d08d862a769 · 2025-07-27T16:06:10.000+01:00
* CLN warn user about unused parameters in Physics

* CLN move kwargs to physics

* TST check that the warning is raised

* FIX linting

* black

---------

Co-authored-by: Andrewwango &lt;andrew.wang27@gmail.com&gt;
diff --git a/deepinv/physics/forward.py b/deepinv/physics/forward.py
@@ -1,5 +1,6 @@
 from __future__ import annotations
 from typing import Union
+import warnings
 import copy
 import inspect
 import collections.abc
@@ -49,6 +50,7 @@ def __init__(
         solver="gradient_descent",
         max_iter=50,
         tol=1e-4,
+        **kwargs,
     ):
         super().__init__()
         self.noise_model = noise_model
@@ -59,6 +61,11 @@ def __init__(
         self.tol = tol
         self.solver = solver
 
+        if len(kwargs) > 0:
+            warnings.warn(
+                f"Arguments {kwargs} are passed to {self.__class__.__name__} but are ignored."
+            )
+
     def __mul__(self, other):
         r"""
         Concatenates two forward operators :math:`A = A_1\circ A_2` via the mul operation
@@ -411,6 +418,7 @@ def __init__(
             max_iter=max_iter,
             solver=solver,
             tol=tol,
+            **kwargs,
         )
         self.A_adj = A_adjoint
 
diff --git a/deepinv/tests/test_physics.py b/deepinv/tests/test_physics.py
@@ -1876,3 +1876,10 @@ def test_clone(name, device):
     # Restore original values
     physics = saved_physics
     physics_clone = saved_physics_clone
+
+
+def test_physics_warn_extra_kwargs():
+    with pytest.warns(
+        UserWarning, match="Arguments {'sigma': 0.5} are passed to Denoising"
+    ):
+        dinv.physics.Denoising(sigma=0.5)
