add dummy wrapper for stg public api #1093
Closed
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
|
(not sure if sphinx provides better way to do this. It is a little bit annoying that I have to copy the same docstring into multiple places) |
|
@aobo-y has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator. |
NarineK
approved these changes
Dec 17, 2022
| gate_values (Tensor): value of each gate in shape(n_gates) | ||
|
|
||
| clamp (bool): if clamp the gate values. As smoothed Bernoulli | ||
| variables, gate values are clamped withn 0 and 1 by defautl. |
| gate_values (Tensor): value of each gate in shape(n_gates) | ||
|
|
||
| clamp (bool): if clamp the gate values. As smoothed Bernoulli | ||
| variables, gate values are clamped withn 0 and 1 by defautl. |
| Returns: | ||
| gate_values (Tensor): value of each gate in shape(n_gates) | ||
|
|
||
| clamp (bool): if clamp the gate values. As smoothed Bernoulli |
There was a problem hiding this comment.
nit: maybe indicates whether to clamp the gate values or not ? (also in gaussian stochastic gates)
| clamp (bool): if clamp the gate values. As smoothed Bernoulli | ||
| variables, gate values are clamped withn 0 and 1 by defautl. | ||
| Turn this off to get the raw means of the underneath | ||
| distribution (e.g., conrete, gaussian), which can be useful to |
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.
These functions are actually implemented in the abstract parent class
StochasticGatesBase, but need to create these dummy wrappers in children so that sphinx can correctly generate documentation for these methods.