[FX][1/2] Make docstrings pretty when rendered #48738
Closed
Conversation
This file contains 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
[ghstack-poisoned]
jamesr66a
pushed a commit
that referenced
this pull request
Dec 2, 2020
ghstack-source-id: 8e92ce5211ea2c709a06679188a06cbb9ef65746 Pull Request resolved: #48738
💊 CI failures summary and remediationsAs of commit a782908 (more details on the Dr. CI page):
🚧 1 ongoing upstream failure:These were probably caused by upstream breakages that are not fixed yet:
ci.pytorch.org: 1 failedThis 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. This comment has been revised 37 times. |
This adds an FX page to the docs and fixes up a bunch of the docstrings to conform to the RST/sphinx style. Still need to do this to the `Node` and `Tracer` classes, but cutting this PR now. Rendered: [fx docs.pdf](https://github.com/pytorch/pytorch/files/5631885/fx.docs.pdf) Differential Revision: [D25280867](https://our.internmc.facebook.com/intern/diff/D25280867) [ghstack-poisoned]
jamesr66a
pushed a commit
that referenced
this pull request
Dec 3, 2020
ghstack-source-id: b5dd38772175ea35a42bc16fdc386a6bddd7b9e9 Pull Request resolved: #48738
This adds an FX page to the docs and fixes up a bunch of the docstrings to conform to the RST/sphinx style. Still need to do this to the `Node` and `Tracer` classes, but cutting this PR now. Rendered: [fx docs.pdf](https://github.com/pytorch/pytorch/files/5631885/fx.docs.pdf) Differential Revision: [D25280867](https://our.internmc.facebook.com/intern/diff/D25280867) [ghstack-poisoned]
jamesr66a
pushed a commit
that referenced
this pull request
Dec 3, 2020
ghstack-source-id: ed63675e1df90a7b70c276a3c9f8582011c22c15 Pull Request resolved: #48738
This adds an FX page to the docs and fixes up a bunch of the docstrings to conform to the RST/sphinx style. Still need to do this to the `Node` and `Tracer` classes, but cutting this PR now. Rendered: [fx docs.pdf](https://github.com/pytorch/pytorch/files/5631885/fx.docs.pdf) Differential Revision: [D25280867](https://our.internmc.facebook.com/intern/diff/D25280867) [ghstack-poisoned]
This adds an FX page to the docs and fixes up a bunch of the docstrings to conform to the RST/sphinx style. Still need to do this to the `Node` and `Tracer` classes, but cutting this PR now. Rendered: [fx docs.pdf](https://github.com/pytorch/pytorch/files/5631885/fx.docs.pdf) Differential Revision: [D25280867](https://our.internmc.facebook.com/intern/diff/D25280867) [ghstack-poisoned]
zdevito
approved these changes
Dec 4, 2020
This adds an FX page to the docs and fixes up a bunch of the docstrings to conform to the RST/sphinx style. Still need to do this to the `Node` and `Tracer` classes, but cutting this PR now. Differential Revision: [D25280867](https://our.internmc.facebook.com/intern/diff/D25280867) [ghstack-poisoned]
jamesr66a
pushed a commit
that referenced
this pull request
Dec 4, 2020
ghstack-source-id: a199e04befa9e69b2b939817fe64e39ee9e9e747 Pull Request resolved: #48738
added 2 commits
December 4, 2020 13:02
This adds an FX page to the docs and fixes up a bunch of the docstrings to conform to the RST/sphinx style. Still need to do this to the `Node` and `Tracer` classes, but cutting this PR now. Differential Revision: [D25280867](https://our.internmc.facebook.com/intern/diff/D25280867) [ghstack-poisoned]
This adds an FX page to the docs and fixes up a bunch of the docstrings to conform to the RST/sphinx style. Still need to do this to the `Node` and `Tracer` classes, but cutting this PR now. Differential Revision: [D25280867](https://our.internmc.facebook.com/intern/diff/D25280867) [ghstack-poisoned]
Codecov Report
@@ Coverage Diff @@
## gh/jamesr66a/326/base #48738 +/- ##
==========================================================
+ Coverage 32.93% 80.68% +47.74%
==========================================================
Files 492 1866 +1374
Lines 66523 201431 +134908
==========================================================
+ Hits 21912 162520 +140608
+ Misses 44611 38911 -5700 |
This adds an FX page to the docs and fixes up a bunch of the docstrings to conform to the RST/sphinx style. Still need to do this to the `Node` and `Tracer` classes, but cutting this PR now. Differential Revision: [D25280867](https://our.internmc.facebook.com/intern/diff/D25280867) [ghstack-poisoned]
|
@jamesr66a merged this pull request in ae9f39e. |
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:
This adds an FX page to the docs and fixes up a bunch of the docstrings to conform to the RST/sphinx style.
Still need to do this to the
NodeandTracerclasses, but cutting this PR now.Differential Revision: D25280867