facebookresearch / ClassyVision

An end-to-end PyTorch framework for image and video classification
https://classyvision.ai
MIT License
1.59k stars 278 forks source link

Add required example_args argument to prepare_fx and prepare_qat_fx #791

Closed jerryzh168 closed 2 years ago

jerryzh168 commented 2 years ago

Summary: 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 https://github.com/pytorch/pytorch/pull/76496#discussion_r861230047 (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: m = resnet18(...) m = prepare_fx(m, qconfig_dict)

After: m = resnet18(...) m = prepare_fx(m, qconfig_dict, example_inputs=(torch.randn(1, 3, 224, 224),))

Reviewed By: vkuzo, andrewor14

Differential Revision: D35984526

facebook-github-bot commented 2 years ago

This pull request was exported from Phabricator. Differential Revision: D35984526

facebook-github-bot commented 2 years ago

This pull request was exported from Phabricator. Differential Revision: D35984526

facebook-github-bot commented 2 years ago

This pull request was exported from Phabricator. Differential Revision: D35984526

facebook-github-bot commented 2 years ago

This pull request was exported from Phabricator. Differential Revision: D35984526

facebook-github-bot commented 2 years ago

This pull request was exported from Phabricator. Differential Revision: D35984526

facebook-github-bot commented 2 years ago

This pull request was exported from Phabricator. Differential Revision: D35984526

facebook-github-bot commented 2 years ago

This pull request was exported from Phabricator. Differential Revision: D35984526

facebook-github-bot commented 2 years ago

This pull request was exported from Phabricator. Differential Revision: D35984526

facebook-github-bot commented 2 years ago

This pull request was exported from Phabricator. Differential Revision: D35984526

facebook-github-bot commented 2 years ago

This pull request was exported from Phabricator. Differential Revision: D35984526

facebook-github-bot commented 2 years ago

This pull request was exported from Phabricator. Differential Revision: D35984526