From cb006b52069c5279ff09f290c21f710909a19cd8 Mon Sep 17 00:00:00 2001 From: Vincent Quenneville-Belair Date: Thu, 1 Aug 2019 11:44:36 -0400 Subject: [PATCH 1/2] mention complex numbers. --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f5207a791c..85f0c2bacf 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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 provide `magphase` to convert such a tensor into its magnitude and phase, and also `complex_norm` and `angle`. + Contributing Guidelines ----------------------- From 195d5e05d777f7f12b631b3a190ec4e6731bd1c8 Mon Sep 17 00:00:00 2001 From: Vincent QB Date: Thu, 1 Aug 2019 13:56:25 -0400 Subject: [PATCH 2/2] Only need to mention complex_norm and angle. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 85f0c2bacf..69eea93db0 100644 --- a/README.md +++ b/README.md @@ -127,7 +127,7 @@ 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 provide `magphase` to convert such a tensor into its magnitude and phase, and also `complex_norm` and `angle`. +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. Contributing Guidelines -----------------------