Reformat docstring for get_timestep_embedding
#8811
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
The original docstring formatting was off (looks like a bad line-wrap mangling the parameters), but I figured I might as well reformat to match the same docstring style as the rest of the file.
yiyixuxu
reviewed
Jul 8, 2024
| These may be fractional. | ||
| :param embedding_dim: the dimension of the output. :param max_period: controls the minimum frequency of the | ||
| embeddings. :return: an [N x dim] Tensor of positional embeddings. | ||
| Args |
Collaborator
There was a problem hiding this comment.
thanks!
can we also add the other 2 arguments that are missing from the doc string?
Contributor
Author
There was a problem hiding this comment.
I can try -- TBH I haven't examined the function closely to really understand what downscale_freq_shift and scale actually do.
This simplifies the implementation (IMO) by getting rid of the redundant `torch.exp(-math.log(a) * b))` with `torch.pow(a, -b)` and updates the docstring to capture what each argument does.
yiyixuxu
reviewed
Jul 9, 2024
| assert len(timesteps.shape) == 1, "Timesteps should be a 1d-array" | ||
|
|
||
| half_dim = embedding_dim // 2 | ||
| exponent = -math.log(max_period) * torch.arange( |
Collaborator
There was a problem hiding this comment.
can we not change the implementation?
Contributor
Author
There was a problem hiding this comment.
Sure -- I find the current implementation to be needlessly complex, but hapy to revert.
yiyixuxu
reviewed
Jul 11, 2024
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
Collaborator
|
thank you for your contribution! |
sayakpaul
pushed a commit
that referenced
this pull request
Dec 23, 2024
* Reformat docstring for `get_timestep_embedding` --------- Co-authored-by: YiYi Xu <yixu310@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
The original docstring formatting was off (looks like a bad line-wrap mangling the parameters), but I figured I might as well reformat to match the same docstring style as the rest of the file.
What does this PR do?
Before submitting
documentation guidelines, and
here are tips on formatting docstrings.
Who can review?
Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.