[src] Beamforming: fix doc references

darius522 · Apr 27, 2021 · e7cb31e · e7cb31e
1 parent e4618bc
commit e7cb31e
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/asteroid/dsp/beamforming.py b/asteroid/dsp/beamforming.py
@@ -11,6 +11,8 @@ def forward(self, x: torch.Tensor, mask: torch.Tensor = None, normalize: bool =
 
 
 class Beamformer(nn.Module):
+    """Base class for beamforming modules."""
+
     @staticmethod
     def apply_beamforming_vector(bf_vector: torch.Tensor, mix: torch.Tensor):
         """Apply the beamforming vector to the mixture. Output (batch, freqs, frames).

diff --git a/docs/source/package_reference/dsp.rst b/docs/source/package_reference/dsp.rst
@@ -8,12 +8,14 @@ DSP Modules
 
 :hidden:`Beamforming`
 ~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: asteroid.dsp.beamforming.MvdrBeamformer
-.. autoclass:: asteroid.dsp.beamforming.SdwMwfBeamformer
+
+.. autoclass:: asteroid.dsp.beamforming.Beamformer
+.. autoclass:: asteroid.dsp.beamforming.SDWMWFBeamformer
 .. autoclass:: asteroid.dsp.beamforming.GEVBeamformer
+.. autoclass:: asteroid.dsp.beamforming.RTFMVDRBeamformer
+.. autoclass:: asteroid.dsp.beamforming.SoudenMVDRBeamformer
 .. autoclass:: asteroid.dsp.beamforming.SCM
 
-
 :hidden:`LambdaOverlapAdd`
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 .. autoclass:: asteroid.dsp.LambdaOverlapAdd