Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions tests/fixtures/performance/checker/zerograd.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import torch
import torch.nn as nn

x = torch.ones((100, 100))
model = nn.Sequential()
optimizer = torch.optim.Adam(model.parameters())

# This should raise flags
optimizer.zero_grad(set_to_none=False)
model.zero_grad(set_to_none=False)

# This should not raise flags
optimizer.zero_grad()
model.zero_grad()


2 changes: 2 additions & 0 deletions tests/fixtures/performance/checker/zerograd.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
9:1 TOR402 Detected gradient set to zero instead of None. Please add 'set_to_none=True' when calling zero_grad().
10:1 TOR402 Detected gradient set to zero instead of None. Please add 'set_to_none=True' when calling zero_grad().
2 changes: 2 additions & 0 deletions torchfix/torchfix.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
TorchVisionDeprecatedPretrainedVisitor,
TorchVisionDeprecatedToTensorVisitor,
TorchVisionSingletonImportVisitor,
TorchGradNotSetToNonePatternVisitor,
)

__version__ = "0.7.0"
Expand All @@ -43,6 +44,7 @@
TorchVisionDeprecatedPretrainedVisitor,
TorchVisionDeprecatedToTensorVisitor,
TorchVisionSingletonImportVisitor,
TorchGradNotSetToNonePatternVisitor,
]


Expand Down
6 changes: 5 additions & 1 deletion torchfix/visitors/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@
TorchRequireGradVisitor,
)
from .nonpublic import TorchNonPublicAliasVisitor
from .performance import TorchSynchronizedDataLoaderVisitor
from .performance import (
TorchSynchronizedDataLoaderVisitor,
TorchGradNotSetToNonePatternVisitor,
)
from .security import TorchUnsafeLoadVisitor
from .vision import (
TorchVisionDeprecatedPretrainedVisitor,
Expand All @@ -30,4 +33,5 @@
"TorchVisionDeprecatedPretrainedVisitor",
"TorchVisionDeprecatedToTensorVisitor",
"TorchVisionSingletonImportVisitor",
"TorchGradNotSetToNonePatternVisitor",
]
33 changes: 33 additions & 0 deletions torchfix/visitors/performance/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,36 @@ def visit_Call(self, node):
error_code=self.ERRORS[0].error_code,
message=self.ERRORS[0].message(),
)


class TorchGradNotSetToNonePatternVisitor(TorchVisitor):
"""
Reimplementation of GradNotSetToNonePattern from
https://github.com/pytorch/pytorch/blob/main/torch/profiler/_pattern_matcher.py
"""

ERRORS = [
TorchError(
"TOR402",
(
"Detected gradient set to zero instead of None. "
"Please add 'set_to_none=True' when calling zero_grad()."
),
)
]

def visit_Call(self, node):
qualified_name = self.get_qualified_name_for_call(node)

if qualified_name and qualified_name.endswith("zero_grad"):

set_to_none_arg = self.get_specific_arg(node, "set_to_none", 0)

# hasattr check to handle mypy error
if set_to_none_arg and hasattr(set_to_none_arg.value, "value"):
if set_to_none_arg.value.value == "False":
self.add_violation(
node,
error_code=self.ERRORS[0].error_code,
message=self.ERRORS[0].message(),
)