Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
OpenDAS
Torchaudio
Commits
d08c4ed0
Unverified
Commit
d08c4ed0
authored
Apr 22, 2021
by
Krishna Kalyan
Committed by
GitHub
Apr 22, 2021
Browse files
Clarify `sox_effects.apply_effects_tensor` as CPU-only in Doc (#1459)
parent
9d50acf3
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
3 additions
and
2 deletions
+3
-2
torchaudio/sox_effects/sox_effects.py
torchaudio/sox_effects/sox_effects.py
+3
-2
No files found.
torchaudio/sox_effects/sox_effects.py
View file @
d08c4ed0
...
@@ -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
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment