Allow dataloader_idx_ in log names when add_dataloader_idx=False (#20987)

rittik9 · web-flow · commit 37f559e3bee7 · 2025-07-18T22:56:47.000+02:00
diff --git a/src/lightning/pytorch/core/module.py b/src/lightning/pytorch/core/module.py
@@ -466,10 +466,10 @@ def log(
         )
 
         # make sure user doesn't introduce logic for multi-dataloaders
-        if "/dataloader_idx_" in name:
+        if add_dataloader_idx and "/dataloader_idx_" in name:
             raise MisconfigurationException(
                 f"You called `self.log` with the key `{name}`"
-                " but it should not contain information about `dataloader_idx`"
+                " but it should not contain information about `dataloader_idx` when `add_dataloader_idx=True`"
             )
 
         value = apply_to_collection(value, (Tensor, numbers.Number), self.__to_tensor, name)

Original file line number	Diff line number	Diff line change
`@@ -466,10 +466,10 @@ def log(`
`466`	`466`	`)`
`467`	`467`
`468`	`468`	`# make sure user doesn't introduce logic for multi-dataloaders`
`469`		`- if "/dataloader_idx_" in name:`
	`469`	`+ if add_dataloader_idx and "/dataloader_idx_" in name:`
`470`	`470`	`raise MisconfigurationException(`
`471`	`471`	f"You called `self.log` with the key `{name}`"
`472`		- " but it should not contain information about `dataloader_idx`"
	`472`	+ " but it should not contain information about `dataloader_idx` when `add_dataloader_idx=True`"
`473`	`473`	`)`
`474`	`474`
`475`	`475`	`value = apply_to_collection(value, (Tensor, numbers.Number), self.__to_tensor, name)`