@@ -1011,24 +1011,25 @@ def apply_codec(
10111011 bits_per_sample : Optional [int ] = None ,
10121012) -> Tensor :
10131013 r"""
1014- Applies codecs as a form of augmentation
1014+ Apply codecs as a form of augmentation.
1015+
10151016 Args:
1016- waveform (Tensor): Audio data. Must be 2 dimensional. See also ```channels_first```
1017- sample_rate (int): Sample rate of the audio waveform
1018- format (str): file format
1017+ waveform (Tensor): Audio data. Must be 2 dimensional. See also ```channels_first```.
1018+ sample_rate (int): Sample rate of the audio waveform.
1019+ format (str): File format.
10191020 channels_first (bool):
10201021 When True, both the input and output Tensor have dimension ``[channel, time]``.
10211022 Otherwise, they have dimension ``[time, channel]``.
10221023 compression (float): Used for formats other than WAV.
1023- For mor details see :py:func:`torchaudio.backend.sox_io_backend.save`
1024+ For mor details see :py:func:`torchaudio.backend.sox_io_backend.save`.
10241025 encoding (str, optional): Changes the encoding for the supported formats.
1025- For more details see :py:func:`torchaudio.backend.sox_io_backend.save`
1026+ For more details see :py:func:`torchaudio.backend.sox_io_backend.save`.
10261027 bits_per_sample (int, optional): Changes the bit depth for the supported formats.
1027- For more details see :py:func:`torchaudio.backend.sox_io_backend.save`
1028+ For more details see :py:func:`torchaudio.backend.sox_io_backend.save`.
10281029
10291030 Returns:
10301031 torch.Tensor: Resulting Tensor.
1031- If ``channels_first=True``, it has ``[channel, time]`` else ``[time, channel]``
1032+ If ``channels_first=True``, it has ``[channel, time]`` else ``[time, channel]``.
10321033 """
10331034 bytes = io .BytesIO ()
10341035 torchaudio .backend .sox_io_backend .save (bytes ,
0 commit comments