Move hybrid demucs model out of prototype (#2668)

Summary: Pull Request resolved: https://github.com/pytorch/audio/pull/2668

Reviewed By: nateanl, mthrok

Differential Revision: D39433671

Pulled By: carolineechen

fbshipit-source-id: 3545a5b4019832861c34fd8c05e5f8600fd80d5c

docs/source/models.rst

@@ -41,6 +41,37 @@ Emformer
 
   .. automethod:: infer
 
+Hybrid Demucs
+~~~~~~~~~~~~~
+
+Model
+-----
+
+HDemucs
+^^^^^^^
+
+.. autoclass:: HDemucs
+
+  .. automethod:: forward
+
+Factory Functions
+-----------------
+
+hdemucs_low
+^^^^^^^^^^^
+
+.. autofunction:: hdemucs_low
+
+hdemucs_medium
+^^^^^^^^^^^^^^
+
+.. autofunction:: hdemucs_medium
+
+hdemucs_high
+^^^^^^^^^^^^
+
+.. autofunction:: hdemucs_high
+
 RNN-T
 ~~~~~
 

docs/source/prototype.models.rst

@@ -28,37 +28,6 @@ ConvEmformer
 
   .. automethod:: infer
 
-Hybrid Demucs
-~~~~~~~~~~~~~
-
-Model
------
-
-HDemucs
-^^^^^^^
-
-.. autoclass:: HDemucs
-
-  .. automethod:: forward
-
-Factory Functions
------------------
-
-hdemucs_low
-^^^^^^^^^^^
-
-.. autofunction:: hdemucs_low
-
-hdemucs_medium
-^^^^^^^^^^^^^^
-
-.. autofunction:: hdemucs_medium
-
-hdemucs_high
-^^^^^^^^^^^^
-
-.. autofunction:: hdemucs_high
-
 References
 ~~~~~~~~~~
 

test/torchaudio_unittest/prototype/hdemucs_cpu_test.py → test/torchaudio_unittest/models/hdemucs/hdemucs_cpu_test.py

 import torch
 from torchaudio_unittest.common_utils import PytorchTestCase
-from torchaudio_unittest.prototype.hdemucs_test_impl import CompareHDemucsOriginal, HDemucsTests
+from torchaudio_unittest.models.hdemucs.hdemucs_test_impl import CompareHDemucsOriginal, HDemucsTests
 
 
 class HDemucsFloat32CPUTest(HDemucsTests, CompareHDemucsOriginal, PytorchTestCase):

test/torchaudio_unittest/prototype/hdemucs_gpu_test.py → test/torchaudio_unittest/models/hdemucs/hdemucs_gpu_test.py

 import torch
 from torchaudio_unittest.common_utils import PytorchTestCase, skipIfNoCuda
-from torchaudio_unittest.prototype.hdemucs_test_impl import CompareHDemucsOriginal, HDemucsTests
+from torchaudio_unittest.models.hdemucs.hdemucs_test_impl import CompareHDemucsOriginal, HDemucsTests
 
 
 @skipIfNoCuda

test/torchaudio_unittest/prototype/hdemucs_test_impl.py → test/torchaudio_unittest/models/hdemucs/hdemucs_test_impl.py

@@ -3,7 +3,7 @@ from typing import List
 
 import torch
 from parameterized import parameterized
-from torchaudio.prototype.models.hdemucs import _HDecLayer, _HEncLayer, HDemucs, hdemucs_high, hdemucs_low
+from torchaudio.models._hdemucs import _HDecLayer, _HEncLayer, HDemucs, hdemucs_high, hdemucs_low
 from torchaudio_unittest.common_utils import skipIfNoModule, TestBaseMixin, TorchaudioTestCase
 
 

torchaudio/models/__init__.py

+from ._hdemucs import HDemucs, hdemucs_high, hdemucs_low, hdemucs_medium
 from .conformer import Conformer
 from .conv_tasnet import ConvTasNet
 from .deepspeech import DeepSpeech
@@ -50,4 +51,8 @@ __all__ = [
     "RNNTBeamSearch",
     "emformer_rnnt_base",
     "emformer_rnnt_model",
+    "HDemucs",
+    "hdemucs_low",
+    "hdemucs_medium",
+    "hdemucs_high",
 ]

torchaudio/prototype/models/__init__.py

 from .conv_emformer import ConvEmformer
 from .conv_tasnet import conv_tasnet_base
-from .hdemucs import HDemucs, hdemucs_high, hdemucs_low, hdemucs_medium
 from .rnnt import conformer_rnnt_base, conformer_rnnt_model
 
 __all__ = [
@@ -8,8 +7,4 @@ __all__ = [
     "conformer_rnnt_model",
     "conv_tasnet_base",
     "ConvEmformer",
-    "HDemucs",
-    "hdemucs_high",
-    "hdemucs_medium",
-    "hdemucs_low",
 ]

torchaudio/prototype/models/hdemucs/__init__.py

+import torchaudio
+
+functions = ["HDemucs", "hdemucs_high", "hdemucs_medium", "hdemucs_low"]
+
+
+def __getattr__(name: str):
+    if name in functions:
+        import warnings
+
+        warnings.warn(
+            f"{__name__}.{name} has been moved to torchaudio.models.hdemucs",
+            DeprecationWarning,
+        )
+
+        return getattr(torchaudio.models, name)
+
+    raise AttributeError(f"module {__name__} has no attribute {name}")
+
+
+def __dir__():
+    return functions

torchaudio/prototype/pipelines/source_separation_pipeline.py

@@ -5,7 +5,8 @@ from typing import Callable
 import torch
 import torchaudio
 
-from torchaudio.prototype.models import conv_tasnet_base, hdemucs_high
+from torchaudio.models import hdemucs_high
+from torchaudio.prototype.models import conv_tasnet_base
 
 
 @dataclass