Commit 05d2580a authored by Zhaoheng Ni's avatar Zhaoheng Ni Committed by Facebook GitHub Bot
Browse files

Fix docstring (#2540)

Summary:
The docstring of `apply_beamforming` has warning when building the documentation page. Fix it in this PR.

Pull Request resolved: https://github.com/pytorch/audio/pull/2540

Reviewed By: mthrok

Differential Revision: D37763745

Pulled By: nateanl

fbshipit-source-id: 0e9f1e098865af032b00ac56d918cb9d2ffc5024
parent a7d1b31c
...@@ -2134,6 +2134,7 @@ def apply_beamforming(beamform_weights: Tensor, specgram: Tensor) -> Tensor: ...@@ -2134,6 +2134,7 @@ def apply_beamforming(beamform_weights: Tensor, specgram: Tensor) -> Tensor:
.. math:: .. math::
\hat{\textbf{S}}(f) = \textbf{w}_{\text{bf}}(f)^{\mathsf{H}} \textbf{Y}(f) \hat{\textbf{S}}(f) = \textbf{w}_{\text{bf}}(f)^{\mathsf{H}} \textbf{Y}(f)
where :math:`\textbf{w}_{\text{bf}}(f)` is the beamforming weight for the :math:`f`-th frequency bin, where :math:`\textbf{w}_{\text{bf}}(f)` is the beamforming weight for the :math:`f`-th frequency bin,
:math:`\textbf{Y}` is the multi-channel spectrum for the :math:`f`-th frequency bin. :math:`\textbf{Y}` is the multi-channel spectrum for the :math:`f`-th frequency bin.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment