Add docstrings for samplers #338
Merged
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
facebook-github-bot
added
the
CLA Signed
scotts
reviewed
Nov 6, 2024
| invalid indices, so the ``policy`` parameter defines how to replace | ||
| those frames, with valid indices: | ||
| - "repeat": repeats the last valid frame of the clip. We would get |
Contributor
There was a problem hiding this comment.
Really minor, but the left quotation mark for "repeat", "wrap" and "error" is facing the wrong way in the rendered docs. I'm not sure how or even if we can fix it. Uses of quotes in the middle of text seem fine (like "dilation" on line 240).
Contributor
Author
There was a problem hiding this comment.
I noticed this too lol, no idea why. This is likely related to the pytorch-sphinx-theme css style.
scotts
reviewed
Nov 6, 2024
scotts
reviewed
Nov 6, 2024
scotts
approved these changes
Nov 6, 2024
Contributor
|
This looks great, all of my comments are just minor improvements. On the code organization: makes sense to me, let's go with this and see how it feels to live with it. One thought: should we put a comment (not a docstring!) at the top of the functions themselves saying that the official docs are in _common.py? |
ahmadsharif1
approved these changes
Nov 6, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
This PR adds docstring to the samplers. This is just docstrings, not the entire docs. Tutorials / examples / user guides will come later.
This PR is best reviewed by checking it out locally, building and visualizing the docs on your own machine. Alternatively you can download the built docs artifacts from the CI job.
You'll see that I went for a non-classical way of specifying the docs. Similar setups exist in repos like pytorch/pytorch. The main advantage is that it can centralize the docs, avoids repetition, and makes edits easier. The main drawback is that docs are harder to figure out when browsing the code - getting the docs require going online to see the html files.
I don't mind reverting to a more conventional setup if you prefer, but I'll ask to do this only later, when the docs are a bit more stable. I will be writing tutorials in follow-up PRs, and I suspect I'll have to update the docstrings. It will be a lot easier to do so in the current setup.