"megatron/git@developer.sourcefind.cn:OpenDAS/megatron-lm.git" did not exist on "77efcccb93d3c4ef714932d3476090c300e7cadc"
Unverified Commit d08c4ed0 authored by Krishna Kalyan's avatar Krishna Kalyan Committed by GitHub
Browse files

Clarify `sox_effects.apply_effects_tensor` as CPU-only in Doc (#1459)

parent 9d50acf3
...@@ -61,14 +61,15 @@ def apply_effects_tensor( ...@@ -61,14 +61,15 @@ def apply_effects_tensor(
"""Apply sox effects to given Tensor """Apply sox effects to given Tensor
Note: Note:
This function only works on CPU Tensors.
This function works in the way very similar to ``sox`` command, however there are slight This function works in the way very similar to ``sox`` command, however there are slight
differences. For example, ``sox`` command adds certain effects automatically (such as differences. For example, ``sox`` command adds certain effects automatically (such as
``rate`` effect after ``speed`` and ``pitch`` and other effects), but this function does ``rate`` effect after ``speed`` and ``pitch`` and other effects), but this function does
only applies the given effects. (Therefore, to actually apply ``speed`` effect, you also only applies the given effects. (Therefore, to actually apply ``speed`` effect, you also
need to give ``rate`` effect with desired sampling rate.) need to give ``rate`` effect with desired sampling rate.).
Args: Args:
tensor (torch.Tensor): Input 2D Tensor. tensor (torch.Tensor): Input 2D CPU Tensor.
sample_rate (int): Sample rate sample_rate (int): Sample rate
effects (List[List[str]]): List of effects. effects (List[List[str]]): List of effects.
channels_first (bool): Indicates if the input Tensor's dimension is channels_first (bool): Indicates if the input Tensor's dimension is
......
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