add docstring for functional_impl test

pytorch · Feb 25, 2022 · 8fcf33c · 8fcf33c
1 parent 62a859d
commit 8fcf33c
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/test/torchaudio_unittest/functional/functional_impl.py b/test/torchaudio_unittest/functional/functional_impl.py
@@ -584,6 +584,12 @@ def test_rnnt_loss_costs_and_gradients_random_data_with_numpy_fp32(self):
             self._test_costs_and_gradients(data=data, ref_costs=ref_costs, ref_gradients=ref_gradients)
 
     def test_apply_beamforming(self):
+        """Verify ``F.apply_beamforming`` method by numpy implementation.
+        Given the multi-channel complex-valued spectrum and complex-valued
+        beamforming weights (Tensor of dimension `(..., freq, channel)`) as inputs,
+        ``F.apply_beamforming`` outputs the single-channel complex-valued enhanced
+        spectrum, which should be identical to the output of ``apply_beamforming_numpy``.
+        """
         channel = 4
         n_fft_bin = 10
         frame = 5