KEMBAR78
Remove device parameter from create_extended_attention_mask_for_decoder by pbelevich · Pull Request #16894 · huggingface/transformers · GitHub
Skip to content

Remove device parameter from create_extended_attention_mask_for_decoder #16894

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
merged 1 commit into from
May 3, 2022
Merged

Remove device parameter from create_extended_attention_mask_for_decoder #16894

merged 1 commit into from
May 3, 2022

Conversation

@pbelevich
Copy link
Contributor

What does this PR do?

This RP removes redundant device parameter from create_extended_attention_mask_for_decoder that may cause potential issues if passed device is not equal attention_mask.device, see line modeling_utils.py#L610. Explanation: tracing logic from line 610 to method signature:
causal_mask.device == attention_mask.device => seq_ids.device == attention_mask.device => device == attention_mask.device

@michaelbenayoun

Fixes # (issue)

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline,
    Pull Request section?
  • Was this discussed/approved via a Github issue or the forum? Please add a link
    to it if that's the case.
  • Did you make sure to update the documentation with your changes? Here are the
    documentation guidelines, and
    here are tips on formatting docstrings.
  • Did you write any new necessary tests?

Who can review?

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.

@pbelevich pbelevich force-pushed the remove_device_from_create_extended_attention_mask_for_decoder branch from 9eaea11 to 5d59df5 Compare April 22, 2022 15:10
@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Apr 22, 2022 •
edited
Loading

The documentation is not available anymore as the PR was closed or merged.

@pbelevich pbelevich marked this pull request as ready for review April 22, 2022 15:27
@michaelbenayoun
Copy link
Member

This seems legit for me, pinging @LysandreJik, @sgugger and @ydshieh to comment on this.

@michaelbenayoun michaelbenayoun requested review from LysandreJik, michaelbenayoun, sgugger and ydshieh and removed request for michaelbenayoun and ydshieh April 25, 2022 08:41
@ydshieh
Copy link
Collaborator

ydshieh commented Apr 25, 2022 •
edited
Loading

LGTM, as it uses the device from the argument attention_mask.

https://github.com/huggingface/transformers/blob/5d59df5e880cba38b1f2aa69acb8e5db0d84841f/src/transformers/modeling_utils.py#L592-L594

Thank you for reducing the potential issue!

(Please wait the approvals from sgugger or LysandreJik before merge 🙏 )

sgugger
sgugger approved these changes Apr 25, 2022
View reviewed changes
Copy link
Collaborator

@sgugger sgugger left a comment

Choose a reason for hiding this comment

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

Thanks for your PR. Removing arguments from public methods is a bit of a breaking change (even if I don't expect many users to use those directly) so since it's very easy to avoid it here and raise a proper deprecation warning, I would like to this added before we merge.

Also, the first two research projects should not be touched.

examples/research_projects/bert-loses-patience/pabee/modeling_pabee_bert.py Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

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

This example is pinned to Transformers == 3.5.1 so don't make any change there.

examples/research_projects/deebert/src/modeling_highway_bert.py Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same here.

examples/research_projects/deebert/src/modeling_highway_bert.py Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same here.

examples/research_projects/longform-qa/eli5_utils.py Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

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

This one can be updated as it's not pinned.

examples/research_projects/longform-qa/eli5_utils.py Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

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

This one can be updated as it's not pinned.

src/transformers/modeling_utils.py Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

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

Removing an argument from a public method like this is a breaking change, so we should continue to accept if with a default of None than raise a deprecation warning if we detect it's not None telling the user that argument is not used anymore and will be removed in v5 of Transformers.

src/transformers/modeling_utils.py Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

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

Removing an argument from a public method like this is a breaking change, so we should continue to accept if with a default of None than raise a deprecation warning if we detect it's not None telling the user that argument is not used anymore and will be removed in v5 of Transformers.

src/transformers/modeling_utils.py Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same here.

src/transformers/modeling_utils.py Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same here.

@pbelevich pbelevich force-pushed the remove_device_from_create_extended_attention_mask_for_decoder branch 3 times, most recently from 1326012 to 994597c Compare April 29, 2022 15:19
sgugger
sgugger reviewed Apr 29, 2022
View reviewed changes
examples/research_projects/bert-loses-patience/pabee/modeling_pabee_bert.py Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

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

This example is pinned to Transformers == 3.5.1 so don't make any change there.

src/transformers/modeling_utils.py Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
warnings.warn("`device` is deprecated and will be removed in v5 of Transformers.")
warnings.warn("The `device` argument is deprecated and will be removed in v5 of Transformers.", FutureWarning)

src/transformers/modeling_utils.py Outdated
Comment on lines 633 to 635
Copy link
Collaborator

Choose a reason for hiding this comment

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

Remove the documentation entirely for a deprecated argument.

src/transformers/modeling_utils.py Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
warnings.warn("`device` is deprecated and will be removed in v5 of Transformers.")
warnings.warn("The `device` argument is deprecated and will be removed in v5 of Transformers.", FutureWarning)

@pbelevich pbelevich force-pushed the remove_device_from_create_extended_attention_mask_for_decoder branch from 994597c to 91758cf Compare April 29, 2022 15:31
@pbelevich pbelevich force-pushed the remove_device_from_create_extended_attention_mask_for_decoder branch from 91758cf to 209647b Compare April 29, 2022 15:43
@pbelevich
Copy link
Contributor Author

@sgugger thanks for the code review! all comments have been addressed

@sgugger
Copy link
Collaborator

sgugger commented Apr 29, 2022

Thanks! Pinging @LysandreJik for final review :-)

LysandreJik
LysandreJik approved these changes May 3, 2022
View reviewed changes
Copy link
Member

@LysandreJik LysandreJik left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @pbelevich!

@LysandreJik LysandreJik merged commit 39f8eaf into huggingface:main May 3, 2022
stevhliu pushed a commit to stevhliu/transformers that referenced this pull request May 3, 2022
@pbelevich @stevhliu
Remove device parameter from create_extended_attention_mask_for_decod…
4dbd9ef 
…er (huggingface#16894)
elusenji pushed a commit to elusenji/transformers that referenced this pull request Jun 12, 2022
@pbelevich @elusenji
Remove device parameter from create_extended_attention_mask_for_decod…
43d3466 
…er (huggingface#16894)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ydshieh ydshieh ydshieh approved these changes

@LysandreJik LysandreJik LysandreJik approved these changes

+1 more reviewer

@sgugger sgugger sgugger approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@pbelevich @HuggingFaceDocBuilderDev @michaelbenayoun @ydshieh @sgugger @LysandreJik