close
The Wayback Machine - https://web.archive.org/web/20220322202221/https://github.com/huggingface/transformers/issues/16135
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

Improve EncoderDecoderModel docs #16135

Open
patrickvonplaten opened this issue Mar 14, 2022 · 3 comments
Open

Improve EncoderDecoderModel docs #16135

patrickvonplaten opened this issue Mar 14, 2022 · 3 comments

Comments

@patrickvonplaten
Copy link
Member

@patrickvonplaten patrickvonplaten commented Mar 14, 2022

First good issue

There have been quite some issues/questions with how to use the Encoder-Decoder model, e.g.: #4483 and #15479 . The main reason for this is that the model docs are quite outdated and we could need a nice How-to-guide.

So I think we have two action items here:

  1. Improve https://huggingface.co/docs/transformers/v4.17.0/en/model_doc/encoder-decoder#encoder-decoder-models a.k.a.: https://github.com/huggingface/transformers/blob/master/docs/source/model_doc/encoder-decoder.mdx

We should mention here:
a) How to create a model ? We should show how to use the from_encoder_decoder_pretrained(...) and then how to save the model?
b) How to fine-tune this model? We should mention that this model can then be fine-tuned just like any other encoder-decoder model (Bart, T5, ...)
c) Put a big warning that the config values have to be correctly set and how to set them, e.g. read: #15479

This should be an EncoderDecoderModel specific text and be very concise and short.

In a second step, we should then write a How-to-guide that includes much more details.

More than happy to help someone tackle this first good issue

@silvererudite
Copy link

@silvererudite silvererudite commented Mar 15, 2022

Hi...I would love to contribute to this.

@patrickvonplaten
Copy link
Member Author

@patrickvonplaten patrickvonplaten commented Mar 17, 2022

Awesome! Would you like to open a PR and give it a try? :-) I think it would be great if we could put some example code on how to create an EncoderDecoderModel on this model doc: https://github.com/huggingface/transformers/blob/master/docs/source/model_doc/encoder-decoder.mdx which will then be displayed here: https://huggingface.co/docs/transformers/v4.17.0/en/model_doc/encoder-decoder#encoder-decoder-models :-)

Let me know if you have any questions! Happy to help :-)

@silvererudite
Copy link

@silvererudite silvererudite commented Mar 21, 2022

Yes..definitely...Will open a PR shortly and ask for help when I'm stuck..thanks a lot.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants