Skip to content

Updates to XLMR model documentation #1497

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

Updates to XLMR model documentation #1497

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 18 additions & 0 deletions torchtext/models/roberta/bundler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,15 @@ def encoderConf(self) -> RobertaEncoderConf:
'''
XLM-R Encoder with Base configuration

The XLM-RoBERTa model was proposed in `Unsupervised Cross-lingual Representation Learning
at Scale <https://arxiv.org/abs/1911.02116>`. It is a large multi-lingual language model,
trained on 2.5TB of filtered CommonCrawl data and based on the RoBERTa model architecture.

Originally published by the authors of XLM-RoBERTa under MIT License
and redistributed with the same license.
[`License <https://github.com/pytorch/fairseq/blob/main/LICENSE>`__,
`Source <https://github.com/pytorch/fairseq/tree/main/examples/xlmr#pre-trained-models>`__]

Please refer to :func:`torchtext.models.RobertaModelBundle` for the usage.
'''
)
Expand All @@ -189,6 +198,15 @@ def encoderConf(self) -> RobertaEncoderConf:
'''
XLM-R Encoder with Large configuration

The XLM-RoBERTa model was proposed in `Unsupervised Cross-lingual Representation Learning
at Scale <https://arxiv.org/abs/1911.02116>`. It is a large multi-lingual language model,
trained on 2.5TB of filtered CommonCrawl data and based on the RoBERTa model architecture.

Originally published by the authors of XLM-RoBERTa under MIT License
and redistributed with the same license.
[`License <https://github.com/pytorch/fairseq/blob/main/LICENSE>`__,
`Source <https://github.com/pytorch/fairseq/tree/main/examples/xlmr#pre-trained-models>`__]

Please refer to :func:`torchtext.models.RobertaModelBundle` for the usage.
'''
)
Expand Down