Skip to content

Remove legacy sox effects #977

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 27, 2020
Merged

Remove legacy sox effects #977

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3b3d2ec
Remove SoxEffectsChain impl
mthrok Oct 21, 2020
03e4ed2
Remove SoxEffectsChain from doc
mthrok Oct 21, 2020
90f2b1e
Remove test for legacy SoxEffects
mthrok Oct 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 0 additions & 19 deletions docs/source/sox_effects.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ torchaudio.sox_effects

.. currentmodule:: torchaudio.sox_effects

.. warning::

The :py:class:`SoxEffect` and :py:class:`SoxEffectsChain` classes are deprecated. Please migrate to :func:`apply_effects_tensor` and :func:`apply_effects_file`.

Resource initialization / shutdown
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand All @@ -35,18 +31,3 @@ Applying effects on file
------------------------

.. autofunction:: apply_effects_file

Legacy
~~~~~~

SoxEffect
---------

.. autoclass:: SoxEffect
:members:

SoxEffectsChain
---------------

.. autoclass:: SoxEffectsChain
:members: append_effect_to_chain, sox_build_flow_effects, clear_chain, set_input_file
39 changes: 0 additions & 39 deletions test/torchaudio_unittest/dataloader_test.py
View file
Open in desktop

This file was deleted.

224 changes: 0 additions & 224 deletions test/torchaudio_unittest/sox_effect/sox_effects_chain_test.py
View file
Open in desktop

This file was deleted.

28 changes: 0 additions & 28 deletions torchaudio/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,36 +24,8 @@
SignalInfo,
EncodingInfo,
)
from torchaudio.sox_effects import (
init_sox_effects as _init_sox_effects,
shutdown_sox_effects as _shutdown_sox_effects,
)

try:
from .version import __version__, git_version # noqa: F401
except ImportError:
pass


@_mod_utils.deprecated(
"Please remove the function call to initialize_sox. "
"Resource initialization is now automatically handled.")
def initialize_sox():
"""Initialize sox effects.

This function is deprecated. See :py:func:`torchaudio.sox_effects.init_sox_effects`
"""
_init_sox_effects()


@_mod_utils.deprecated(
"Please remove the function call to torchaudio.shutdown_sox. "
"Resource clean up is now automatically handled. "
"In the unlikely event that you need to manually shutdown sox, "
"please use torchaudio.sox_effects.shutdown_sox_effects.")
def shutdown_sox():
"""Shutdown sox effects.

This function is deprecated. See :py:func:`torchaudio.sox_effects.shutdown_sox_effects`
"""
_shutdown_sox_effects()
Loading