Skip to content

Add beta warning to sox-io backend #769

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

Closed
wants to merge 1 commit into from
Closed

Add beta warning to sox-io backend #769

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions torchaudio/backend/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ def set_audio_backend(backend: Optional[str]) -> None:
elif backend == 'sox':
module = sox_backend
elif backend == 'sox_io':
warnings.warn('"sox_io" backend is currently beta. Function signatures might change.')
Copy link
Contributor

@vincentqb vincentqb Jul 7, 2020

Choose a reason for hiding this comment

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

Let's say "experimental" instead of "beta". Should go as far as marking the backend as "_sox_io"?

Copy link
Contributor Author

@mthrok mthrok Jul 7, 2020

Choose a reason for hiding this comment

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

What's the difference between "beta" and "experimental"?
To me "beta" sounds it's ready to use but not in the final form yet, "experimental" sounds like we are playing around with it, which does not quite fit to my feeling. I could be wrong though.

Copy link
Contributor

@vincentqb vincentqb Jul 8, 2020

Choose a reason for hiding this comment

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

We have not defined either one of them formally, but torchtext used "experimental" :)

Copy link
Contributor Author

@mthrok mthrok Jul 8, 2020

Choose a reason for hiding this comment

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

In this case, considering the feature lifecycle beta sounds more appropriate. The set of core features we want to provide is completed and confirmed to work. We are not going to change that, even though we refine some details and make small changes.

torchtext used "experimental"

That does not sound like a solid reasoning we should be based off of. That module is totally different nature.

module = sox_io_backend
elif backend == 'soundfile':
module = soundfile_backend
Expand Down