Skip to content

AISHELL recipe fixes for TransformerASR causality, warn if the user doesn't specify causal#2606

Merged
TParcollet merged 2 commits intospeechbrain:developfrom
asumagic:transformerasr-causal-fixes
Jul 12, 2024
Merged

AISHELL recipe fixes for TransformerASR causality, warn if the user doesn't specify causal#2606
TParcollet merged 2 commits intospeechbrain:developfrom
asumagic:transformerasr-causal-fixes

Conversation

@asumagic
Copy link
Copy Markdown
Collaborator

What does this PR do?

See #2604. The issue may only be closed when relevant HF PRs are merged.

This PR:

  1. Sets causal: False for affected AISHELL recipes, as this is how they were originally trained (TransformerASR causality was broken for the MHA masks). This should be safe to change because, for the model configurations in AISHELL, the causal parameter doesn't affect anything but the MHA.
  2. Basically very strongly encourages the user to set causal appropriately, by warning if it is unspecified when constructing the TransformerASR. It still defaults to True, and links to the above issue with all the details. I figure this is OK because virtually all recipes define causal manually anyway, it should be worth it.
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

Copy link
Copy Markdown
Collaborator

@TParcollet TParcollet left a comment

Choose a reason for hiding this comment

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

LGTM!

@TParcollet TParcollet merged commit 7174156 into speechbrain:develop Jul 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants