Skip to content

Create legacy redirection from speechbrain.pretrained to .inference #2485

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

Jump to bottom
Merged
Adel-Moumen merged 7 commits into from
Apr 7, 2024
Merged

Create legacy redirection from speechbrain.pretrained to .inference #2485

Adel-Moumen merged 7 commits into from
Apr 7, 2024

Conversation

@asumagic
Copy link
Collaborator

@asumagic asumagic commented Apr 2, 2024 •
edited
Loading

What does this PR do?

When the user attempts to import using speechbrain.pretrained, emit a deprecation warning and automatically import speechbrain.inference instead. This should help consumers of the API migrate faster and reduce confusion.

Blocked by #2484 (technically can still be merged without, but this is an extra layer of confusion).

Related to #2480.

Before submitting
  • Did you read the contributor guideline?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • Does your code adhere to project-specific code style and conventions?

PR review

Reviewer checklist
  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified
  • Confirm that the changes adhere to compatibility requirements (e.g., Python version, platform)
  • Review the self-review checklist to ensure the code is ready for review

@asumagic asumagic force-pushed the module-redirection branch from 3dda270 to 28cfd50 Compare April 5, 2024 10:41
@asumagic
Move deprecated_redirects into a function
5c3fc27 
Avoid polluting the package with the debug strings etc
@asumagic asumagic marked this pull request as ready for review April 5, 2024 13:06
@asumagic asumagic requested a review from Adel-Moumen April 5, 2024 13:06
Adel-Moumen
Adel-Moumen approved these changes Apr 7, 2024
View reviewed changes
Copy link
Collaborator

@Adel-Moumen Adel-Moumen left a comment

Choose a reason for hiding this comment

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

LGTM. It works as intended. Thanks Sylvain :)

@Adel-Moumen Adel-Moumen merged commit ae51e2c into speechbrain:develop Apr 7, 2024
@Adel-Moumen Adel-Moumen mentioned this pull request Apr 7, 2024
Merged
pchampio pushed a commit to pchampio/speechbrain that referenced this pull request Apr 17, 2024
@asumagic @pchampio
Create legacy redirection from speechbrain.pretrained to `.inferenc…
64ae7ee 
…e` (speechbrain#2485)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Adel-Moumen Adel-Moumen Adel-Moumen approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@asumagic @Adel-Moumen