Skip to content

Commit 67f9f30

Browse files
vincentqbcpuhrsch
authored andcommitted
Mention complex number support in README. (#197)
1 parent 4542332 commit 67f9f30

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ dimension (channel, time)")
116116
* `min_freq`: the lowest frequency of the lowest band in a spectrogram
117117
* `max_freq`: the highest frequency of the highest band in a spectrogram
118118
* `win_length`: the length of the STFT window
119-
* `window_fn`: for functions that creates windows e.g. torch.hann_window
119+
* `window_fn`: for functions that creates windows e.g. `torch.hann_window`
120120

121121
Transforms expect the following dimensions.
122122

@@ -129,6 +129,8 @@ Transforms expect the following dimensions.
129129
* `MuLawDecode`: (channel, time) -> (channel, time)
130130
* `Resample`: (channel, time) -> (channel, time)
131131

132+
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.
133+
132134
Contributing Guidelines
133135
-----------------------
134136

0 commit comments

Comments
 (0)