feat[next-dace]: Less Verbose Warnings

src/gt4py/next/program_processors/runners/dace/transformations/auto_optimize.py

@@ -9,7 +9,6 @@
 """Fast access to the auto optimization on DaCe."""
 
 import enum
-import warnings
 from typing import Any, Callable, Optional, Sequence, TypeAlias, Union
 
 import dace
@@ -280,15 +279,15 @@ def gt_auto_optimize(
         if demote_fields is not None:
             for field_to_demote in demote_fields:
                 if field_to_demote not in sdfg.arrays:
-                    warnings.warn(
+                    gtx_transformations.utils.warn(
                         f"Requested the demotion of field '{field_to_demote}' but the field is unknown.",
                         stacklevel=0,
                     )
                     continue
                 field_desc = sdfg.arrays[field_to_demote]
 
                 if field_desc.transient:
-                    warnings.warn(
+                    gtx_transformations.utils.warn(
                         f"Requested the demotion of field '{field_to_demote}' but the field is a transient.",
                         stacklevel=0,
                     )
@@ -369,7 +368,7 @@ def gt_auto_optimize(
                 sdfg.arrays[demoted_field].transient = False
 
             else:
-                warnings.warn(
+                gtx_transformations.utils.warn(
                     f"Could not restore the demoted field '{demoted_field}' back to a global.",
                     stacklevel=0,
                 )
@@ -876,7 +875,8 @@ def _gt_auto_configure_maps_and_strides(
 
     if gpu:
         if unit_strides_kind != gtx_common.DimensionKind.HORIZONTAL:
-            warnings.warn(
+            # TODO(reviewer): I am not sure if we should always print it.
+            gtx_transformations.utils.warn(
                 "The GT4Py DaCe GPU backend assumes that the leading dimension, i.e."
                 " where stride is 1, is of kind 'HORIZONTAL', however it was"
                 f" '{unit_strides_kind}'. Furthermore, it should be the last dimension."

src/gt4py/next/program_processors/runners/dace/transformations/concat_where_mapper.py

@@ -9,7 +9,6 @@
 import copy
 import dataclasses
 import functools
-import warnings
 from typing import Any, Collection, Literal, Mapping, Optional, Sequence, TypeAlias, Union, overload
 
 import dace
@@ -1353,18 +1352,16 @@ def _handle_special_case_of_gt4py_scan_point(
     if _handle_special_case_of_gt4py_scan_point_impl(
         state, descending_point, concat_node, consumed_subset
     ):
-        if __debug__:
-            warnings.warn(
-                f"Special rule applied to `concat_where`-inline `{concat_node.data}` into `{nsdfg.label}`.",
-                stacklevel=1,
-            )
+        gtx_transformations.utils.warn(
+            f"Special rule applied to `concat_where`-inline `{concat_node.data}` into `{nsdfg.label}`.",
+            stacklevel=1,
+        )
         return True
     else:
-        if __debug__:
-            warnings.warn(
-                f"Special rule applied to `concat_where`-inline `{concat_node.data}` into `{nsdfg.label}` was rejected.",
-                stacklevel=1,
-            )
+        gtx_transformations.utils.warn(
+            f"Special rule applied to `concat_where`-inline `{concat_node.data}` into `{nsdfg.label}` was rejected.",
+            stacklevel=1,
+        )
         return False
 
 

src/gt4py/next/program_processors/runners/dace/transformations/gpu_utils.py

@@ -11,7 +11,6 @@
 from __future__ import annotations
 
 import copy
-import warnings
 from typing import Any, Callable, Final, Optional, Sequence, Union
 
 import dace
@@ -622,14 +621,14 @@ def __init__(
         if block_size_1d is not None:
             self.block_size_1d = block_size_1d
             if self.block_size_1d[1] != 1 or self.block_size_1d[2] != 1:
-                warnings.warn(
+                gtx_transformations.utils.warn(
                     f"1D map block size specified with more than one dimension larger than 1. Configured 1D block size: {self.block_size_1d}.",
                     stacklevel=0,
                 )
         if block_size_2d is not None:
             self.block_size_2d = block_size_2d
             if self.block_size_2d[2] != 1:
-                warnings.warn(
+                gtx_transformations.utils.warn(
                     f"2D map block size specified with more than twi dimensions larger than 1. Configured 2D block size: {self.block_size_2d}.",
                     stacklevel=0,
                 )
@@ -707,7 +706,7 @@ def apply(
 
             if is_degenerated_1d_map:
                 num_map_params = 1
-                warnings.warn(
+                gtx_transformations.utils.warn(
                     f"Map '{gpu_map}', size '{map_size}', is a degenerated 1d Map. Handle it as a 1d Map.",
                     stacklevel=0,
                 )
@@ -728,7 +727,7 @@ def apply(
                 )
                 block_size[block_size_1D_index] = self.block_size_1d[0]
                 if block_size_1D_index != 0:
-                    warnings.warn(
+                    gtx_transformations.utils.warn(
                         f"Blocksize of 1d Map '{gpu_map}' was set to {block_size}, but the iteration index is not the x dimension.",
                         stacklevel=0,
                     )

src/gt4py/next/program_processors/runners/dace/transformations/inline_fuser.py

@@ -7,7 +7,6 @@
 # SPDX-License-Identifier: BSD-3-Clause
 
 import copy
-import warnings
 from typing import Final, Iterable, Optional, Sequence, TypeAlias
 
 import dace
@@ -564,7 +563,7 @@ def _populate_nested_sdfg(
                         "Connections to a non replicated node are only allowed if the source node is an AccessNode"
                     )
 
-                warnings.warn(
+                gtx_transformations.utils.warn(
                     "Detected computation of data that might not be needed in inline fuser.",
                     stacklevel=0,
                 )

src/gt4py/next/program_processors/runners/dace/transformations/map_promoter.py

@@ -7,7 +7,6 @@
 # SPDX-License-Identifier: BSD-3-Clause
 
 import copy
-import warnings
 from typing import Any, Callable, Mapping, Optional, TypeAlias, Union
 
 import dace
@@ -211,7 +210,7 @@ def __init__(
         self._bypass_fusion_test = False
 
         if not self.fuse_after_promotion:
-            warnings.warn(
+            gtx_transformations.utils.warn(
                 "Created a `MapPromoter` that does not fuse immediately, which might lead to borderline invalid SDFGs.",
                 stacklevel=1,
             )
@@ -286,7 +285,7 @@ def can_be_applied(
             if (second_map_iterations > 0) != True:  # noqa: E712 [true-false-comparison]  # SymPy fuzzy bools.
                 return False
         else:
-            warnings.warn(
+            gtx_transformations.utils.warn(
                 "Was unable to determine if the second Map ({second_map_entry}) is executed.",
                 stacklevel=0,
             )

src/gt4py/next/program_processors/runners/dace/transformations/remove_access_node_copies.py

@@ -14,7 +14,6 @@
 # be removed because the same data are copied from the first all the way to fourth node.
 # The split should be done using SplitAccessNode transformation.
 
-import warnings
 from typing import Any, Optional
 
 import dace
@@ -26,6 +25,7 @@
 from dace.sdfg import nodes as dace_nodes
 from dace.transformation.passes import analysis as dace_analysis
 
+from gt4py.next.program_processors.runners.dace import transformations as gtx_transformations
 from gt4py.next.program_processors.runners.dace.transformations import (
     splitting_tools as gtx_dace_split,
     strides as gtx_transformations_strides,
@@ -152,14 +152,15 @@ def can_be_applied(
 
         first_node_writes_subset = gtx_dace_split.subset_merger(ranges_written_to_first_node)
         if len(first_node_writes_subset) != 1:
-            warnings.warn(
+            # TODO(reviewer): I am actually not sure, if we should keep these warnings active all the times?
+            gtx_transformations.utils.warn(
                 "[RemoveAccessNodeCopies] The range of writes to the first node is not a single range.",
                 stacklevel=0,
             )
             return False
         fourth_node_writes_subset = gtx_dace_split.subset_merger(ranges_written_to_fourth_node)
         if len(fourth_node_writes_subset) != 1:
-            warnings.warn(
+            gtx_transformations.utils.warn(
                 "[RemoveAccessNodeCopies] The range of writes to the fourth node is not a single range.",
                 stacklevel=0,
             )
@@ -170,13 +171,13 @@ def can_be_applied(
             [union_written_to_first_node_data, union_written_to_fourth_node_data]
         )
         if len(union_written_to_common_data) != 1:
-            warnings.warn(
+            gtx_transformations.utils.warn(
                 "[RemoveAccessNodeCopies] The union of the ranges written to the first and fourth nodes is not a single range.",
                 stacklevel=0,
             )
             return False
         if union_written_to_common_data != first_node_range:
-            warnings.warn(
+            gtx_transformations.utils.warn(
                 "[RemoveAccessNodeCopies] The whole range of the first node is not written.",
                 stacklevel=0,
             )

src/gt4py/next/program_processors/runners/dace/transformations/simplify.py

@@ -11,7 +11,6 @@
 import collections
 import copy
 import uuid
-import warnings
 from typing import Any, Iterable, Optional, TypeAlias
 
 import dace
@@ -371,7 +370,7 @@ def gt_inline_nested_sdfg(
             nb_inlines_total += 1
             if nsdfg_node.label.startswith("scan_"):
                 # See `gtir_to_sdfg_scan.py::translate_scan()` for more information.
-                warnings.warn(
+                gtx_transformations.utils.warn(
                     f"Inlined '{nsdfg_node.label}' which might be a scan, this might leads to errors during simplification.",
                     stacklevel=0,
                 )

src/gt4py/next/program_processors/runners/dace/transformations/split_access_nodes.py

@@ -6,7 +6,6 @@
 # Please, refer to the LICENSE file in the root directory.
 # SPDX-License-Identifier: BSD-3-Clause
 
-import warnings
 from typing import Any, Iterable, Optional
 
 import dace
@@ -361,7 +360,7 @@ def _find_edge_reassignment(
         if unused_producers:
             # This situation is generated by MapFusion, if the intermediate
             #  AccessNode has to be kept alive.
-            warnings.warn(
+            gtx_transformations.utils.warn(
                 "'SplitAccessNode': found producers "
                 + ", ".join((str(p) for p in unused_producers))
                 + " that generates data but that is never read.",
@@ -413,7 +412,7 @@ def _find_producer(
             #  one Tasklet writes `T[__i, 0]` the other `T[__i, 10]`, where `__i`
             #  is the iteration index. Then Memlet propagation will set the subset
             #  to something like `T[:, 0:10]`. So it is not an error in that case.
-            warnings.warn(
+            gtx_transformations.utils.warn(
                 f"Found transient '{self.access_node.data}' that has multiple overlapping"
                 " incoming edges. Might indicate an error.",
                 stacklevel=0,

src/gt4py/next/program_processors/runners/dace/transformations/split_memlet.py

@@ -6,7 +6,6 @@
 # Please, refer to the LICENSE file in the root directory.
 # SPDX-License-Identifier: BSD-3-Clause
 
-import warnings
 from typing import Any, Optional
 
 import dace
@@ -94,7 +93,7 @@ def can_be_applied(
         # TODO(phimuell): For optimal result we should fuse these edges first.
         src_to_dest_edges = list(graph.edges_between(src_node, dst_node))
         if len(src_to_dest_edges) != 1:
-            warnings.warn(
+            gtx_transformations.utils.warn(
                 f"Found multiple edges between '{src_node.data}' and '{dst_node.data}'",
                 stacklevel=0,
             )

src/gt4py/next/program_processors/runners/dace/transformations/state_fusion.py

@@ -6,13 +6,14 @@
 # Please, refer to the LICENSE file in the root directory.
 # SPDX-License-Identifier: BSD-3-Clause
 
-import warnings
 from typing import Any
 
 import dace
 from dace import transformation as dace_transformation
 from dace.sdfg import nodes as dace_nodes, utils as dace_sdutils
 
+from gt4py.next.program_processors.runners.dace import transformations as gtx_transformations
+
 
 # Conditional import because `gt4py.cartesian` uses an older DaCe version without
 #  `explicit_cf_compatible`.
@@ -222,7 +223,7 @@ def _check_for_read_write_dependencies(
                 #   AccessNode to the same data. In case it is global this is most likely
                 #   valid. However, I think that simply allow it, is not okay, because
                 #   it might break some assumption in the fuse code.
-                warnings.warn(
+                gtx_transformations.utils.warn(
                     f"Detected that '{first_state}' writes to the data"
                     f" `{', '.join(all_data_producers.intersection(data_producers[-1]))}`"
                     " in multiple concurrent subgraphs. This might indicate an error.",

src/gt4py/next/program_processors/runners/dace/transformations/utils.py

@@ -8,8 +8,10 @@
 
 """Common functionality for the transformations/optimization pipeline."""
 
+import functools
 import uuid
-from typing import Optional, Sequence, TypeVar, Union
+import warnings
+from typing import Any, Optional, Sequence, TypeVar, Union
 
 import dace
 from dace import data as dace_data, libraries as dace_lib, subsets as dace_sbs, symbolic as dace_sym
@@ -21,6 +23,26 @@
 _PassT = TypeVar("_PassT", bound=dace_ppl.Pass)
 
 
+@functools.wraps(warnings.warn)
+def warn(
+    message: str,
+    category: type[Warning] | None = None,
+    stacklevel: int = 1,
+    source: Any | None = None,
+    *,
+    skip_file_prefixes: tuple[Any, ...] = (),
+) -> None:
+    """Wrapper around `warnings.warn()` function that is only enabled in debug mode."""
+    if __debug__:
+        warnings.warn(  # type: ignore[call-overload]  # For some reason MyPy complains about the last argument.
+            message=message,
+            category=category,
+            stacklevel=(stacklevel + 1),
+            source=source,
+            skip_file_prefixes=skip_file_prefixes,
+        )
+
+
 def unique_name(name: str) -> str:
     """Adds a unique string to `name`.