Skip to content

Remove prototype files #4048

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.

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

Open
wants to merge 8 commits into
base: remove_torio_docs
Choose a base branch
from
Open

Conversation

samanklesaria
Copy link
Collaborator

@samanklesaria samanklesaria commented Aug 19, 2025

This PR removes the prototype directory from src along with prototype references in docs. It currently depends on, and should be merged after, the CUTC wrapper removal PR, because sphinx now breaks on our deprecation-wrapped classes. Specifically, we get the docs build error:

Traceback (most recent call last):
  File "/home/samanklesaria/world/.pixi/envs/default/lib/python3.12/site-packages/sphinx/util/inspect.py", line 461, in safe_getattr
    return getattr(obj, name, *defargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/samanklesaria/world/.pixi/envs/default/lib/python3.12/site-packages/torchaudio/models/decoder/__init__.py", line 42, in __getattr__
    item = dropping_support(orig_item)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/samanklesaria/world/.pixi/envs/default/lib/python3.12/site-packages/torchaudio/_internal/module_utils.py", line 84, in decorator
    wrapped = wrap_deprecated(func, f"{func.__module__}.{func.__name__}", direction, version=version, remove=remove)
TypeError: __type_params__ must be set to a tuple

This suggests that if we just merged the CUTC PR first, this error would go away. Note that this error does not show up in the CI: the CI logs for sphinx only show the exit code and suppress all other output.

Copy link

pytorch-bot bot commented Aug 19, 2025

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/audio/4048

Note: Links to docs will display an error until the docs builds have been completed.

❌ 8 New Failures

As of commit 370ad64 with merge base a645da6 (image):

NEW FAILURES - The following jobs have failed:

This comment was automatically generated by Dr. CI and updates every 15 minutes.

@meta-cla meta-cla bot added the CLA Signed label Aug 19, 2025
@samanklesaria samanklesaria marked this pull request as ready for review August 19, 2025 16:32
@samanklesaria samanklesaria requested review from hwangjeff and a team as code owners August 19, 2025 16:32
@@ -1,107 +0,0 @@
#!/usr/bin/env python3
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's not touch the examples folder for now. It would require more work. For example this pipeline_demo.py file is mentioned in the README, so removing it would mean updating the readme. We'll do that as follow-ups

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This example used functionality from the prototype files, which is why I included it here. If you like, I can do a separate PR for the examples first, before merging this one?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or should I just update the readme for this single demo first?

Copy link
Member

@NicolasHug NicolasHug left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

approving to unblock but please see other comments

@samanklesaria samanklesaria changed the base branch from main to no_wrap_ctc_decoder August 21, 2025 20:09
@samanklesaria
Copy link
Collaborator Author

samanklesaria commented Aug 21, 2025

As written elsewhere in the PR, I changed the target to be the no_wrap_ctc_decoder branch because sphinx recently became unable to handle the wrapped CUTC decoder. Unfortunately, this isn't quite sufficient for docs building to work yet. Now we're getting a large number of errors like libtorio.stream_writer.rst:40: ERROR: Unknown directive type "doxygenfunction". Of course, we're eventually going to delete these anyway. But my PR for removing libtorio is currently set up to depend on this one! What a mess! So here's an intermediate solution: I'll make a separate PR based on the no_wrap_cyc_decoder branch just to delete the documentation for libtorio rather than all of libtorio. This shouldn't break anything. This PR will depend on that one. And then the final libtorio removal PR will depend on this one.

@samanklesaria samanklesaria changed the base branch from no_wrap_ctc_decoder to remove_torio_docs August 21, 2025 21:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants