"tests/git@developer.sourcefind.cn:OpenDAS/fairscale.git" did not exist on "2e9a14e7ef9179653e7a091a995905aeb778f67f"
Unverified Commit 9535d83e authored by Chin-Yun Yu's avatar Chin-Yun Yu Committed by GitHub
Browse files

Refactor lfilter docs (#1698)

parent 4c57e1ba
...@@ -949,8 +949,8 @@ def lfilter( ...@@ -949,8 +949,8 @@ def lfilter(
Lower delays coefficients are first, e.g. ``[b0, b1, b2, ...]``. Lower delays coefficients are first, e.g. ``[b0, b1, b2, ...]``.
Must be same size as a_coeffs (pad with 0's as necessary). Must be same size as a_coeffs (pad with 0's as necessary).
clamp (bool, optional): If ``True``, clamp the output signal to be in the range [-1, 1] (Default: ``True``) clamp (bool, optional): If ``True``, clamp the output signal to be in the range [-1, 1] (Default: ``True``)
batching (bool, optional): Activate when coefficients are in 2D. If ``True``, then waveform should be at least batching (bool, optional): Effective only when coefficients are 2D. If ``True``, then waveform should be at
2D, and the size of second axis from last should equals to ``num_filters``. least 2D, and the size of second axis from last should equals to ``num_filters``.
The output can be expressed as ``output[..., i, :] = lfilter(waveform[..., i, :], The output can be expressed as ``output[..., i, :] = lfilter(waveform[..., i, :],
a_coeffs[i], b_coeffs[i], clamp=clamp, batching=False)``. (Default: ``True``) a_coeffs[i], b_coeffs[i], clamp=clamp, batching=False)``. (Default: ``True``)
......
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