Skip to content

Commit

Permalink
Add required example_inputs argument to prepare_fx and prepare_qat_fx…
Browse files Browse the repository at this point in the history
… (#77608)

Summary:
X-link: pytorch/pytorch#77608

X-link: pytorch/fx2trt#76

X-link: facebookresearch/d2go#249

X-link: fairinternal/ClassyVision#104

Pull Request resolved: #916

X-link: facebookresearch/ClassyVision#791

X-link: facebookresearch/mobile-vision#68

FX Graph Mode Quantization needs to know whether an fx node is a floating point Tensor before it can decide whether to
insert observer/fake_quantize module or not, since we only insert observer/fake_quantize module for floating point Tensors.
Currently we have some hacks to support this by defining some rules like NON_OBSERVABLE_ARG_DICT (https://github.com/pytorch/pytorch/blob/master/torch/ao/quantization/fx/utils.py#L496), but this approach is fragile and we do not plan to maintain it long term in the pytorch code base.

As we discussed in the design review, we'd need to ask users to provide sample args and sample keyword args
so that we can infer the type in a more robust way. This PR starts with changing the prepare_fx and prepare_qat_fx api to require user to either provide
example arguments thrugh example_inputs, Note this api doesn't support kwargs, kwargs can make pytorch/pytorch#76496 (comment) (comment) simpler, but
it will be rare, and even then we can still workaround with positional arguments, also torch.jit.trace(https://pytorch.org/docs/stable/generated/torch.jit.trace.html) and ShapeProp: https://github.com/pytorch/pytorch/blob/master/torch/fx/passes/shape_prop.py#L140 just have single positional args, we'll just use a single example_inputs argument for now.

If needed, we can extend the api with an optional example_kwargs. e.g. in case when there are a lot of arguments for forward and it makes more sense to
pass the arguments by keyword

BC-breaking Note:
Before:
```python
m = resnet18(...)
m = prepare_fx(m, qconfig_dict)
# or
m = prepare_qat_fx(m, qconfig_dict)
```
After:
```python
m = resnet18(...)
m = prepare_fx(m, qconfig_dict, example_inputs=(torch.randn(1, 3, 224, 224),))
# or
m = prepare_qat_fx(m, qconfig_dict, example_inputs=(torch.randn(1, 3, 224, 224),))
```

Reviewed By: vkuzo, andrewor14

Differential Revision: D35984526

fbshipit-source-id: 706c8df71722c9aa5082a6491734f0144f0dd670
  • Loading branch information
jerryzh168 authored and facebook-github-bot committed May 21, 2022
1 parent ae802fd commit 6f0d2fb
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 2 deletions.
4 changes: 4 additions & 0 deletions test.py
Expand Up @@ -120,6 +120,10 @@ def _load_tests():
devices.append('cuda')

for path in _list_model_paths():
# TODO: skipping quantized tests for now due to BC-breaking changes for prepare
# api, enable after PyTorch 1.13 release
if "quantized" in path:
continue
for device in devices:
_load_test(path, device)

Expand Down
8 changes: 8 additions & 0 deletions test_bench.py
Expand Up @@ -51,6 +51,10 @@ def test_train(self, model_path, device, compiler, benchmark):
if skip_by_metadata(test="train", device=device, jit=(compiler == 'jit'), \
extra_args=[], metadata=get_metadata_from_yaml(model_path)):
raise NotImplementedError("Test skipped by its metadata.")
# TODO: skipping quantized tests for now due to BC-breaking changes for prepare
# api, enable after PyTorch 1.13 release
if "quantized" in model_path:
return
task = ModelTask(model_path)
if not task.model_details.exists:
return # Model is not supported.
Expand All @@ -67,6 +71,10 @@ def test_eval(self, model_path, device, compiler, benchmark, pytestconfig):
if skip_by_metadata(test="eval", device=device, jit=(compiler == 'jit'), \
extra_args=[], metadata=get_metadata_from_yaml(model_path)):
raise NotImplementedError("Test skipped by its metadata.")
# TODO: skipping quantized tests for now due to BC-breaking changes for prepare
# api, enable after PyTorch 1.13 release
if "quantized" in model_path:
return
task = ModelTask(model_path)
if not task.model_details.exists:
return # Model is not supported.
Expand Down
Expand Up @@ -32,7 +32,7 @@ def __init__(self, test, device, jit=False, batch_size=None, extra_args=[]):
def prep_qat_train(self):
qconfig_dict = {"": torch.quantization.get_default_qat_qconfig('fbgemm')}
self.model.train()
self.model = quantize_fx.prepare_qat_fx(self.model, qconfig_dict)
self.model = quantize_fx.prepare_qat_fx(self.model, qconfig_dict, self.example_inputs)

def train(self, niter=3):
optimizer = optim.Adam(self.model.parameters())
Expand Down
2 changes: 1 addition & 1 deletion torchbenchmark/models/resnet50_quantized_qat/__init__.py
Expand Up @@ -32,7 +32,7 @@ def __init__(self, test, device, jit=False, batch_size=None, extra_args=[]):
def prep_qat_train(self):
qconfig_dict = {"": torch.quantization.get_default_qat_qconfig('fbgemm')}
self.model.train()
self.model = quantize_fx.prepare_qat_fx(self.model, qconfig_dict)
self.model = quantize_fx.prepare_qat_fx(self.model, qconfig_dict, self.example_inputs)

def get_module(self):
return self.model, self.example_inputs
Expand Down

0 comments on commit 6f0d2fb

Please sign in to comment.