-
Notifications
You must be signed in to change notification settings - Fork 739
Large re-amp on the torchaudio/docs #166
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.
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
Conversation
|
MelScale renders a little strange here. |
|
MelSpectrogram has inconsistent ":" in subtitles, see here. |
vincentqb
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One thing that we should add: just like in #169, we should give the mapping between shapes for transformations.
vincentqb
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me! Thanks for doing this!
|
On Spectrogram.forward, the shape is listed as "Channels x frequency x time (c, f, t)". I would stick with either convention, but not both. I would lean for "a tensor of shape (channels, frequency, time)", and not abbreviations to as explicit as possible for both input and output of |
|
Do we settle "(channel, ...)" or "(channels, ...)" ? :) I'm leaning for singular, since all other words are singular. Thoughts? |
|
Similarly, do we settle on "a tensor of size (...)" or "a tensor of shape (...)"? That's one of those size/shape/dimension discussions :) |
Also, I noticed we had agreed on |
|
Let's use the convention described in #169 for the comments quoted below now that we've settled on it.
channel, and singular words
dimensions (for "dimension names") and size for sizes (we'll avoid shape as much as we can)
n_freq, n_channel, n_time, etc. for sizes |
vincentqb
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See comment about #169
-With new features added and legacy code gets removed, the docs (rst) also have to be updated
-The current docs looks very shady/broken (some code missing e.g transforms forward) or formatted poorly
Preview: https://jamarshon.github.io/audio/