Skip to content
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.

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

Encoder decoder config docs #6195

Merged
7 changes: 7 additions & 0 deletions src/transformers/configuration_encoder_decoder.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,13 @@ class EncoderDecoderConfig(PretrainedConfig):
>>> # Accessing the model configuration
>>> config_encoder = model.config.encoder
>>> config_decoder = model.config.decoder
patrickvonplaten marked this conversation as resolved.
Show resolved Hide resolved

>>> Saving the model, including its configuration
patrickvonplaten marked this conversation as resolved.
Show resolved Hide resolved
>>> model.save_pretrained('my-model')

>>> # loading model and config from pretrained folder
>>> encoder_decoder_config = EncoderDecoderConfig.from_pretrained('my-model')
>>> model = EncoderDecoderModel.from_pretrained('my-model', config=encoder_decoder_config)
"""
model_type = "encoder_decoder"

Expand Down
7 changes: 7 additions & 0 deletions src/transformers/modeling_encoder_decoder.py
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,13 @@ def from_encoder_decoder_pretrained(

>>> from transformers import EncoderDecoderModel
>>> model = EncoderDecoderModel.from_encoder_decoder_pretrained('bert-base-uncased', 'bert-base-uncased') # initialize Bert2Bert
patrickvonplaten marked this conversation as resolved.
Show resolved Hide resolved

Example loading pretrained configs separately::
patrickvonplaten marked this conversation as resolved.
Show resolved Hide resolved
>>> from transformers import BertConfig, EncoderDecoderModel
patrickvonplaten marked this conversation as resolved.
Show resolved Hide resolved

patrickvonplaten marked this conversation as resolved.
Show resolved Hide resolved
>>> pretrained_model_name_or_path = 'bert-base-multilingual-cased'
patrickvonplaten marked this conversation as resolved.
Show resolved Hide resolved
>>> model = EncoderDecoderModel.from_encoder_decoder_pretrained(pretrained_model_name_or_path, pretrained_model_name_or_path)
patrickvonplaten marked this conversation as resolved.
Show resolved Hide resolved

patrickvonplaten marked this conversation as resolved.
Show resolved Hide resolved
"""

kwargs_encoder = {
Expand Down