🔥[Community Event] Doc Tests Sprint - Configuration files🔥

[ydshieh]

This sprint is similar to #16292 - but for model configuration files, i.e. configuration_[model_name].py. For example, src/transformers/models/bert/configuration_bert.py

The expected changes

The changes we expect could be find #19485:

1. Change the import order of the model and configuration classes
2. Add (with random weights) in the comment before model initialization line
3. Add configuration_[model_name].py to utils/documentation_tests.txt (respecting the order)

Please do step 3. only after Running the doctest and make sure all tests pass (see below) 🙏

How to run doctests

Suppose you are working on src/transformers/models/bert/configuration_bert.py. The steps to run the test are:

0. Stage your changes

   git add src/transformers/models/bert/configuration_bert.py

1. Prepare the files to be tested

   python utils/prepare_for_doc_test.py src

   or if you prefer to be more specific

   python utils/prepare_for_doc_test.py src/transformers/models/bert/configuration_bert.py

   This will change some files (doc-testing needs to add additional lines that we don't include in the doc source files).

2. Launch the test:

   python -m pytest --doctest-modules src/transformers/models/bert/configuration_bert.py -sv --doctest-continue-on-failure

3. Cleanup git status

   git checkout -- .

   to clean up the changes in step 1.

Ready (or not)?

If all tests pass, you can commit, push and open a PR 🔥 🚀 , otherwise iterate the above steps 💯 !

[daspartho]

I'd like to work on this; I'll start with YOLOS and open a PR :)

[daspartho]

I'll take on Whisper!

[daspartho]

I'll work on Beit!

[imarekkus]

FYI Bart #19524 and Albert #19541 are already done :)

[daspartho]

I'll take on GPT2 next!

[RamitPahwa]

I can take imageGPT

[grgkaran03]

i'll work on yoso

[daspartho]

I'll work on

• RoBERTa
• ViT
• DeiT
• Reformer

and open up PR soon :)

[RamitPahwa]

Also will raise for Transformer-XL !

[imarekkus]

I'll work on bloom

[imarekkus]

I'll work on ctrl

[SD-13]

Hi @ydshieh, I am new here and want to contribute to this issue. Can you please help me to find the remaining files? Thanks,

[ydshieh]

Hi @ydshieh, I am new here and want to contribute to this issue. Can you please help me to find the remaining files? Thanks,

Hi @SD-13 You can check the latest file https://github.com/IzicTemi/transformers/blob/main/utils/documentation_tests.txt

Any configuration file that is not on that list (on main branch) and [not claimed here yet, no PR opened yet] are all welcome :-)

[IzicTemi]

Hey @ydshieh, could I fix multiple models in a single PR, or do I have to open a single PR for each fix?

[grgkaran03]

I will be taking blenderbots as well

[ydshieh]

Hey @ydshieh, could I fix multiple models in a single PR, or do I have to open a single PR for each fix?

2 or 3 might be good. But don't take more in a single PR - the sprint is for everyone to contribute, so leave some to others :-)

[SD-13]

Hi @ydshieh, I am new here and want to contribute to this issue. Can you please help me to find the remaining files? Thanks,

Hi @SD-13 You can check the latest file https://github.com/IzicTemi/transformers/blob/main/utils/documentation_tests.txt

Any configuration file that is not on that list (on main branch) and [not claimed here yet, no PR opened yet] are all welcome :-)

Thanks @ydshieh , that was helpful. I can take vision_text_dual_encoder.py

[SD-13]

Hey @ydshieh, I am getting this error can you please help me to understand the reason and fix it? Thanks,

[ydshieh]

@SD-13 Could you open a PR (even if it is not complete yet), and post the command you run and the complete error message in that PR? Using image is not very convivence to search and debug 🙏

[SD-13]

@SD-13 Could you open a PR (even if it is not complete yet), and post the command you run and the complete error message in that PR? Using image is not very convivence to search and debug pray

Yeah true. I created this PR and let's leave those errors since all checks are passing. Thanks,

[SD-13]

I will also take time_series_transformer.py, vision_encoder_decoder.py, and trajectory_transformer.py. Thanks,

[grgkaran03]

took up blenderbot_small too.

[daspartho]

I'll take on

• SEW
• SEW-D
• Swin
• Swin V2
• UniSpeech

and will open up PR :)

[SaurabhBudhwani26]

Hi @ydshieh , I want to contribute to this issue. Can you please help me to find the remaining files?

[SD-13]

Hi @ydshieh , I want to contribute to this issue. Can you please help me to find the remaining files?

Hey @SaurabhBudhwani26 , please check this. I hope it will be helpful. Thanks,

[ztjhz]

I'll work on configuration_visual_bert.py

[Xabilahu]

I will work on:

• big_bird
• bigbird_pegasus

[ztjhz]

I will work on

• configuration_xlm_roberta.py
• configuration_xlm_roberta_xl.py

[AShreyam]

Can I work on this? @ydshieh

[AShreyam]

I will work on flava

[AShreyam]

Now, I will work on Longformer, Pegasus and VisualBERT.

[ydshieh]

@AShreyam You didn't open a PR, and you merged your branch into your own main branch.

[AShreyam]

I am really sorry for the inconvenience.

[AShreyam]

Here is the actual pull request. Thank You :)

[lappemic]

Work on configuration_big_bird.py

[daspartho]

I'll take on

• LeViT
• DistilBERT
• ResNet

and open up PR :)

[AymenBer99]

I'll take on CodeGen

[daspartho]

I'll take on Data2Vec ones :)

[AymenBer99]

I'll take on conditional_detr

[ak04p]

I'll take on realm

[AymenBer99]

I'll take on convbert

[daspartho]

I'll take on CLIP =)

[AymenBer99]

I'll take XLNet

[juancopi81]

I can take the wav2vec2 ones if that is ok, is someone else working on those?

[AymenBer99]

I'll take XLM

[AymenBer99]

I'll take cvt

[mukesh663]

I'll take pegasus and pegasus_x

[ndrohith09]

I will take fnet and flava.

[soma2000-lang]

@ydshieh Added config files for convnext

[ydshieh]

Oh it will close this ...?

The previous merged PRs didn't close this issue. Strange!