Create separate documentation pages for quantization observers and fake_quants #66125
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ke_quants Summary: Before this PR, the documentation for observers and fake_quants was inlined in the Eager mode quantization page. This was hard to discover, especially since that page is really long, and we now have FX graph mode quantization reusing all of this code. This PR moves observers and fake_quants into their own documentation pages. It also adds docstrings to all user facing module attributes such as the default observers and fake_quants, so people can discover them from documentation without having to inspect the source code. For now, enables autoformatting (which means all public classes, functions, members with docstrings will get docs). If we need to exclude something in these files from docs in the future, we can go back to manual docs. Test plan: ``` cd docs make html python -m server.http // inspect docs on localhost, renders correctly ``` [ghstack-poisoned]
CI Flow Status⚛️ CI FlowRuleset - Version:
You can add a comment to the PR and tag @pytorchbot with the following commands: # ciflow rerun, "ciflow/default" will always be added automatically
@pytorchbot ciflow rerun
# ciflow rerun with additional labels "-l <ciflow/label_name>", which is equivalent to adding these labels manually and trigger the rerun
@pytorchbot ciflow rerun -l ciflow/scheduled -l ciflow/slowFor more information, please take a look at the CI Flow Wiki. |
🔗 Helpful links
💊 CI failures summary and remediationsAs of commit 7a8d38c (more details on the Dr. CI page): 💚 💚 Looks good so far! There are no failures yet. 💚 💚 This comment was automatically generated by Dr. CI (expand for details).Follow this link to opt-out of these comments for your Pull Requests.Please report bugs/suggestions to the (internal) Dr. CI Users group. |
vkuzo
added a commit
that referenced
this pull request
Oct 5, 2021
…ke_quants Summary: Before this PR, the documentation for observers and fake_quants was inlined in the Eager mode quantization page. This was hard to discover, especially since that page is really long, and we now have FX graph mode quantization reusing all of this code. This PR moves observers and fake_quants into their own documentation pages. It also adds docstrings to all user facing module attributes such as the default observers and fake_quants, so people can discover them from documentation without having to inspect the source code. For now, enables autoformatting (which means all public classes, functions, members with docstrings will get docs). If we need to exclude something in these files from docs in the future, we can go back to manual docs. Test plan: ``` cd docs make html python -m server.http // inspect docs on localhost, renders correctly ``` ghstack-source-id: ad9c4d3 Pull Request resolved: #66125
This was referenced Oct 5, 2021
jerryzh168
approved these changes
Oct 6, 2021
|
@vkuzo has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator. |
…vers and fake_quants" Summary: Before this PR, the documentation for observers and fake_quants was inlined in the Eager mode quantization page. This was hard to discover, especially since that page is really long, and we now have FX graph mode quantization reusing all of this code. This PR moves observers and fake_quants into their own documentation pages. It also adds docstrings to all user facing module attributes such as the default observers and fake_quants, so people can discover them from documentation without having to inspect the source code. For now, enables autoformatting (which means all public classes, functions, members with docstrings will get docs). If we need to exclude something in these files from docs in the future, we can go back to manual docs. Test plan: ``` cd docs make html python -m server.http // inspect docs on localhost, renders correctly ``` Differential Revision: [D31447613](https://our.internmc.facebook.com/intern/diff/D31447613) [ghstack-poisoned]
…vers and fake_quants" Summary: Before this PR, the documentation for observers and fake_quants was inlined in the Eager mode quantization page. This was hard to discover, especially since that page is really long, and we now have FX graph mode quantization reusing all of this code. This PR moves observers and fake_quants into their own documentation pages. It also adds docstrings to all user facing module attributes such as the default observers and fake_quants, so people can discover them from documentation without having to inspect the source code. For now, enables autoformatting (which means all public classes, functions, members with docstrings will get docs). If we need to exclude something in these files from docs in the future, we can go back to manual docs. Test plan: ``` cd docs make html python -m server.http // inspect docs on localhost, renders correctly ``` Differential Revision: [D31447613](https://our.internmc.facebook.com/intern/diff/D31447613) [ghstack-poisoned]
…vers and fake_quants" Summary: Before this PR, the documentation for observers and fake_quants was inlined in the Eager mode quantization page. This was hard to discover, especially since that page is really long, and we now have FX graph mode quantization reusing all of this code. This PR moves observers and fake_quants into their own documentation pages. It also adds docstrings to all user facing module attributes such as the default observers and fake_quants, so people can discover them from documentation without having to inspect the source code. For now, enables autoformatting (which means all public classes, functions, members with docstrings will get docs). If we need to exclude something in these files from docs in the future, we can go back to manual docs. Test plan: ``` cd docs make html python -m server.http // inspect docs on localhost, renders correctly ``` Differential Revision: [D31447613](https://our.internmc.facebook.com/intern/diff/D31447613) [ghstack-poisoned]
…vers and fake_quants" Summary: Before this PR, the documentation for observers and fake_quants was inlined in the Eager mode quantization page. This was hard to discover, especially since that page is really long, and we now have FX graph mode quantization reusing all of this code. This PR moves observers and fake_quants into their own documentation pages. It also adds docstrings to all user facing module attributes such as the default observers and fake_quants, so people can discover them from documentation without having to inspect the source code. For now, enables autoformatting (which means all public classes, functions, members with docstrings will get docs). If we need to exclude something in these files from docs in the future, we can go back to manual docs. Test plan: ``` cd docs make html python -m server.http // inspect docs on localhost, renders correctly ``` Differential Revision: [D31447613](https://our.internmc.facebook.com/intern/diff/D31447613) [ghstack-poisoned]
|
@vkuzo has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator. |
|
This pull request has been reverted by b85fd4c. To re-land this change, follow these steps. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Stack from ghstack:
torch.ao.quantization.QConfig#66129 Create a documentation page fortorch.ao.quantization.QConfigSummary:
Before this PR, the documentation for observers and fake_quants was inlined in the
Eager mode quantization page. This was hard to discover, especially
since that page is really long, and we now have FX graph mode quantization reusing
all of this code.
This PR moves observers and fake_quants into their own documentation pages. It also
adds docstrings to all user facing module attributes such as the default observers
and fake_quants, so people can discover them from documentation without having
to inspect the source code.
For now, enables autoformatting (which means all public classes, functions, members
with docstrings will get docs). If we need to exclude something in these files from
docs in the future, we can go back to manual docs.
Test plan:
Differential Revision: D31447613