Skip to content

Fix doc examples: cannot import name #14698

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

Merged
sgugger merged 3 commits into from
Dec 13, 2021
Merged

Fix doc examples: cannot import name #14698

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e654d5b
Fix doc examples: cannot import name
ydshieh Dec 9, 2021
aa0a143
remove copy because of some necessary minor changes (maybe add copy t…
ydshieh Dec 9, 2021
835d3db
Keep copy with some modifications
ydshieh Dec 11, 2021
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
10 changes: 5 additions & 5 deletions src/transformers/models/bigbird_pegasus/modeling_bigbird_pegasus.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2117,7 +2117,7 @@ def forward(
Indices of input sequence tokens in the vocabulary. Padding will be ignored by default should you
provide it.

Indices can be obtained using :class:`~transformers.BigBirdPegasusTokenizer`. See
Indices can be obtained using :class:`~transformers.PegasusTokenizer`. See
:meth:`transformers.PreTrainedTokenizer.encode` and :meth:`transformers.PreTrainedTokenizer.__call__`
for details.

Expand Down Expand Up @@ -2862,7 +2862,7 @@ def forward(self, *args, **kwargs):
return self.decoder(*args, **kwargs)


# Copied from transformers.models.bart.modeling_bart.BartForCausalLM with Bart->BigBirdPegasus, 'facebook/bart-large'->"google/bigbird-pegasus-large-arxiv"
Copy link
Collaborator Author

@ydshieh ydshieh Dec 9, 2021

Choose a reason for hiding this comment

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

can't keep copy here, because there is no BigBirdPegasusTokenizer

Copy link
Contributor

@patrickvonplaten patrickvonplaten Dec 10, 2021

Choose a reason for hiding this comment

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

could we try to keep the copy and change Bart->BigBirdPegasus to BartDecoderWrapper->BigBirdPegasusDecoderWrapper and BartForCausalLM->BigBirdPegasusForCausalLM? This way the tokenizer should stay the same :-)

Copy link
Collaborator Author

@ydshieh ydshieh Dec 10, 2021

Choose a reason for hiding this comment

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

Let me try it.

Copy link
Collaborator Author

@ydshieh ydshieh Dec 11, 2021

Choose a reason for hiding this comment

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

The following does the trick:

  • BartDecoderWrapper->BigBirdPegasusDecoderWrapper
  • BartForCausalLM->BigBirdPegasusForCausalLM
  • BartPreTrainedModel->BigBirdPegasusPreTrainedModel
  • BartTokenizer->PegasusTokenizer
  • 'facebook/bart-large'->"google/bigbird-pegasus-large-arxiv"

Copy link
Contributor

@patrickvonplaten patrickvonplaten Dec 13, 2021

Choose a reason for hiding this comment

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

perfect!

# Copied from transformers.models.bart.modeling_bart.BartForCausalLM with BartDecoderWrapper->BigBirdPegasusDecoderWrapper, BartForCausalLM->BigBirdPegasusForCausalLM, BartPreTrainedModel->BigBirdPegasusPreTrainedModel, BartTokenizer->PegasusTokenizer, 'facebook/bart-large'->"google/bigbird-pegasus-large-arxiv"
class BigBirdPegasusForCausalLM(BigBirdPegasusPreTrainedModel):
def __init__(self, config):
super().__init__(config)
Expand Down Expand Up @@ -2917,7 +2917,7 @@ def forward(
Indices of input sequence tokens in the vocabulary. Padding will be ignored by default should you
provide it.

Indices can be obtained using :class:`~transformers.BigBirdPegasusTokenizer`. See
Indices can be obtained using :class:`~transformers.PegasusTokenizer`. See
:meth:`transformers.PreTrainedTokenizer.encode` and :meth:`transformers.PreTrainedTokenizer.__call__`
for details.

Expand Down Expand Up @@ -2985,9 +2985,9 @@ def forward(

Example::

>>> from transformers import BigBirdPegasusTokenizer, BigBirdPegasusForCausalLM
>>> from transformers import PegasusTokenizer, BigBirdPegasusForCausalLM

>>> tokenizer = BigBirdPegasusTokenizer.from_pretrained("google/bigbird-pegasus-large-arxiv")
>>> tokenizer = PegasusTokenizer.from_pretrained("google/bigbird-pegasus-large-arxiv")
>>> model = BigBirdPegasusForCausalLM.from_pretrained("google/bigbird-pegasus-large-arxiv", add_cross_attention=False)
>>> assert model.config.is_decoder, f"{model.__class__} has to be configured as a decoder."
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
Expand Down