Commit aa4772ed authored by engineerchuan's avatar engineerchuan Committed by Vincent QB
Browse files

Small documentation tweak of [0, 1] to [-1, 1] (#283)

parent a2d35df2
...@@ -34,7 +34,7 @@ def load(filepath, ...@@ -34,7 +34,7 @@ def load(filepath,
filepath (str or pathlib.Path): Path to audio file filepath (str or pathlib.Path): Path to audio file
out (torch.Tensor, optional): An output tensor to use instead of creating one. (Default: ``None``) out (torch.Tensor, optional): An output tensor to use instead of creating one. (Default: ``None``)
normalization (bool, number, or callable, optional): If boolean `True`, then output is divided by `1 << 31` normalization (bool, number, or callable, optional): If boolean `True`, then output is divided by `1 << 31`
(assumes signed 32-bit audio), and normalizes to `[0, 1]`. (assumes signed 32-bit audio), and normalizes to `[-1, 1]`.
If `number`, then output is divided by that number If `number`, then output is divided by that number
If `callable`, then the output is passed as a parameter If `callable`, then the output is passed as a parameter
to the given function, then the output is divided by to the given function, then the output is divided by
......
...@@ -31,7 +31,7 @@ class SoxEffectsChain(object): ...@@ -31,7 +31,7 @@ class SoxEffectsChain(object):
Args: Args:
normalization (bool, number, or callable, optional): If boolean `True`, then output is divided by `1 << 31` normalization (bool, number, or callable, optional): If boolean `True`, then output is divided by `1 << 31`
(assumes signed 32-bit audio), and normalizes to `[0, 1]`. If `number`, then output is divided by that (assumes signed 32-bit audio), and normalizes to `[-1, 1]`. If `number`, then output is divided by that
number. If `callable`, then the output is passed as a parameter to the given function, then the number. If `callable`, then the output is passed as a parameter to the given function, then the
output is divided by the result. (Default: ``True``) output is divided by the result. (Default: ``True``)
channels_first (bool, optional): Set channels first or length first in result. (Default: ``True``) channels_first (bool, optional): Set channels first or length first in result. (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