Skip to content

Quantization: add API summary section #45093

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
vkuzo wants to merge 2 commits into from
Closed

Quantization: add API summary section #45093

vkuzo wants to merge 2 commits into from

Conversation

@vkuzo
Copy link
Contributor

@vkuzo vkuzo commented Sep 21, 2020 •
edited
Loading

Stack from ghstack:

This adds a tl;dr; style summary of the quantization API
to the documentation. Hopefully this will make this easier
for new folks to learn how to use quantization.

This is not meant to be all-encompassing. Future PRs
can improve the documentation further.

Test plan:

  1. build the doc as specified in https://github.com/pytorch/pytorch#building-the-documentation
  2. inspect the quantization page in Chrome, format looks good

Differential Revision: D23828257

@vkuzo
Quantization: add API summary section
08b3f0f 
This adds a tl;dr; style summary of the quantization API
to the documentation. Hopefully this will make this easier
for new folks to learn how to use quantization.

This is not meant to be all-encompassing.  Future PRs
can improve the documentation further.

Test plan:
1. build the doc as specified in https://github.com/pytorch/pytorch#building-the-documentation
2. inspect the quantization page in Chrome, format looks good

[ghstack-poisoned]
vkuzo added a commit that referenced this pull request Sep 21, 2020
@vkuzo
Quantization: add API summary section
101bcd0 
This adds a tl;dr; style summary of the quantization API
to the documentation. Hopefully this will make this easier
for new folks to learn how to use quantization.

This is not meant to be all-encompassing.  Future PRs
can improve the documentation further.

Test plan:
1. build the doc as specified in https://github.com/pytorch/pytorch#building-the-documentation
2. inspect the quantization page in Chrome, format looks good

ghstack-source-id: e4ea5e2
Pull Request resolved: #45093
@dr-ci
Copy link

dr-ci bot commented Sep 21, 2020 •
edited
Loading

💊 CI failures summary and remediations

As of commit c1a4003 (more details on the Dr. CI page):

  • 2/2 failures introduced in this PR

🕵️ 2 new failures recognized by patterns

The following CI failures do not appear to be due to upstream breakages:

See CircleCI build pytorch_doc_test (1/2)

Step: "Doc test" (full log | diagnosis details | 🔁 rerun)

Sep 24 21:34:27 caused by: Connection refused (os error 111) 
Sep 24 21:34:27 +++++ extract_trap_cmd 
Sep 24 21:34:27 +++++ printf '%s\n' '' 
Sep 24 21:34:27 ++++ printf '%s\n' cleanup 
Sep 24 21:34:27 +++ trap -- ' 
Sep 24 21:34:27 cleanup' EXIT 
Sep 24 21:34:27 +++ [[ pytorch-linux-xenial-py3.6-gcc5.4-build != *pytorch-win-* ]] 
Sep 24 21:34:27 +++ which sccache 
Sep 24 21:34:27 +++ sccache --stop-server 
Sep 24 21:34:27 Stopping sccache server... 
Sep 24 21:34:27 error: couldn't connect to server 
Sep 24 21:34:27 caused by: Connection refused (os error 111) 
Sep 24 21:34:27 +++ true 
Sep 24 21:34:27 +++ rm /var/lib/jenkins/sccache_error.log 
Sep 24 21:34:27 +++ [[ pytorch-linux-xenial-py3.6-gcc5.4-build == *rocm* ]] 
Sep 24 21:34:27 +++ SCCACHE_ERROR_LOG=/var/lib/jenkins/sccache_error.log 
Sep 24 21:34:27 +++ SCCACHE_IDLE_TIMEOUT=1200 
Sep 24 21:34:27 +++ RUST_LOG=sccache::server=error 
Sep 24 21:34:27 +++ sccache --start-server 
Sep 24 21:34:27 Starting sccache server... 
Sep 24 21:34:27 +++ sccache --zero-stats 
Sep 24 21:34:27 Compile requests                 0

See CircleCI build pytorch_python_doc_build (2/2)

Step: "Doc Build and Push" (full log | diagnosis details | 🔁 rerun)

Sep 24 21:45:48 Makefile:38: recipe for target 'html' failed 
Sep 24 21:45:47 copying images... [ 96%] _static/img/tensorboard/add_hparam.png 
Sep 24 21:45:47 copying images... [100%] scripts/activation_images/ReLU6.png 
Sep 24 21:45:47  
Sep 24 21:45:47 copying static files... ... done 
Sep 24 21:45:47 copying extra files... done 
Sep 24 21:45:47 dumping search index in English (code: en)... done 
Sep 24 21:45:47 dumping object inventory... done 
Sep 24 21:45:47 build finished with problems, 2 warnings. 
Sep 24 21:45:47 /var/lib/jenkins/workspace/docs/src/pytorch-sphinx-theme/pytorch_sphinx_theme/search.html:21: RemovedInSphinx30Warning: To modify script_files in the theme is deprecated. Please insert a <script> tag directly in your theme instead. 
Sep 24 21:45:47   {% trans %}Please activate JavaScript to enable the search 
Sep 24 21:45:48 Makefile:38: recipe for target 'html' failed 
Sep 24 21:45:48 make: *** [html] Error 1
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 on the GitHub issue tracker or post in the (internal) Dr. CI Users group.

See how this bot performed.

This comment has been revised 8 times.

This was referenced Sep 22, 2020
Closed
Closed
@vkuzo
Update on "Quantization: add API summary section"
c1a4003 
This adds a tl;dr; style summary of the quantization API
to the documentation. Hopefully this will make this easier
for new folks to learn how to use quantization.

This is not meant to be all-encompassing.  Future PRs
can improve the documentation further.

Test plan:
1. build the doc as specified in https://github.com/pytorch/pytorch#building-the-documentation
2. inspect the quantization page in Chrome, format looks good

Differential Revision: [D23828257](https://our.internmc.facebook.com/intern/diff/D23828257)

[ghstack-poisoned]
This was referenced Sep 24, 2020
Closed
Closed
@vkuzo
Copy link
Contributor Author

vkuzo commented Sep 26, 2020

note: looks like the

> make doctest

...

Sep 24 22:03:11 make: *** [doctest] Error 1
Sep 24 22:03:11 Makefile:38: recipe for target 'doctest' failed

error reproes locally on master as well without this PR, so assuming this is not related to my changes.

@facebook-github-bot
Copy link
Contributor

facebook-github-bot commented Sep 26, 2020

@vkuzo merged this pull request in d2bd556.

@facebook-github-bot facebook-github-bot deleted the gh/vkuzo/146/head branch September 29, 2020 14:23
@vkuzo vkuzo mentioned this pull request Oct 5, 2020
Closed
vkuzo added a commit that referenced this pull request Oct 5, 2020
@vkuzo
quant docs: add API summary section
8104b57 
This is a resubmit of the following stack:
* start: #45093
* end: #45306

The original stack was reverted due to build failure,
resubmitting.

[ghstack-poisoned]
vkuzo added a commit that referenced this pull request Oct 5, 2020
@vkuzo
quant docs: add API summary section
9a98422 
This is a resubmit of the following stack:
* start: #45093
* end: #45306

The original stack was reverted due to build failure,
resubmitting.

ghstack-source-id: 6790c20
Pull Request resolved: #45848
facebook-github-bot pushed a commit that referenced this pull request Oct 5, 2020
@vkuzo @facebook-github-bot
quant docs: add API summary section (#45848)
a83696a 
Summary:
Pull Request resolved: #45848

This is a resubmit of the following stack:
* start: #45093
* end: #45306

The original stack was reverted due to build failure,
resubmitting.

Test Plan: Imported from OSS

Reviewed By: jerryzh168

Differential Revision: D24117781

Pulled By: vkuzo

fbshipit-source-id: fb767fff2b044cfbba695ca3949221904fc8931f
vkuzo added a commit that referenced this pull request Oct 6, 2020
@vkuzo
quant docs: add API summary section (#45848)
ebe8b21 
Summary:
Pull Request resolved: #45848

This is a resubmit of the following stack:
* start: #45093
* end: #45306

The original stack was reverted due to build failure,
resubmitting.

Test Plan: Imported from OSS

Reviewed By: jerryzh168

Differential Revision: D24117781

Pulled By: vkuzo

fbshipit-source-id: fb767fff2b044cfbba695ca3949221904fc8931f
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jerryzh168 jerryzh168 jerryzh168 approved these changes

@gottbrath gottbrath Awaiting requested review from gottbrath

@raghuramank100 raghuramank100 Awaiting requested review from raghuramank100

@supriyar supriyar Awaiting requested review from supriyar

@z-a-f z-a-f Awaiting requested review from z-a-f

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@vkuzo @facebook-github-bot @jerryzh168