Skip to content

Mention complex number support in README. #197

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Aug 2, 2019
Merged

Mention complex number support in README. #197

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cb006b5
mention complex numbers.
vincentqb Aug 1, 2019
195d5e0
Only need to mention complex_norm and angle.
vincentqb Aug 1, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ dimension (channel, time)")
* `min_freq`: the lowest frequency of the lowest band in a spectrogram
* `max_freq`: the highest frequency of the highest band in a spectrogram
* `win_length`: the length of the STFT window
* `window_fn`: for functions that creates windows e.g. torch.hann_window
* `window_fn`: for functions that creates windows e.g. `torch.hann_window`

Transforms expect the following dimensions.

Expand All @@ -127,6 +127,8 @@ Transforms expect the following dimensions.
* `MuLawDecode`: (channel, time) -> (channel, time)
* `Resample`: (channel, time) -> (channel, time)

Complex numbers are supported via tensors of dimension (..., 2), and torchaudio provides `complex_norm` and `angle` to convert such a tensor into its magnitude and phase.

Copy link
Contributor

@jamarshon jamarshon Aug 1, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe "its magnitude through complex_norm and phase through angle."

Copy link
Contributor Author

@vincentqb vincentqb Aug 1, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree we can simplify this. Let's only talk about complex_norm and angle then. How does that sound?

Contributing Guidelines
-----------------------

Expand Down