Model resources contribution

[stevhliu]

Hi friends! 👋

There are a lot of cool existing resources for how to do x with x model, and we’d like to showcase and aggregate these resources on a model’s documentation. This’ll help users see how they can get started with a model for their own tasks since we know a lot of users check out the model documentation first. Take a look at a completed resource section for DistilBERT as an example.

I’ve identified the top 20 models by pageviews, and now I’d like to open it up to the community if anyone is interested in helping!

Anyone can contribute; you just need to comment and claim one of the models on this list. Contributing is super easy:

1. Once you've claimed a model from the list, collect the existing resources from:

   • the Hugging Face blog
   • relevant materials from the 🤗 Hugging Face Course
   • the Hugging Face example scripts and notebooks
   • @NielsRogge's Transformers Tutorials repository
   • @philschmid's blog
   • notebooks from the community ❤️

2. Organize the resources by model tasks or applications (like inference or deployment):

   • Use the corresponding icons for each task (you can find the names for each icon here):

     <PipelineTag pipeline=”name-of-task”/>

   • For certain categories, you can just do: 🚀 Deploy, ⚡️ Inference, or ⚗️ Optimization, etc.
   • For community resources, add the 🌎 emoji at the end to indicate it’s not an official Hugging Face resource.
   • Use this DistilBERT file as a template. You can copy and paste the intro text and just replace DistilBERT with the name of the model you're working on.

3. Open a Pull Request with the new resources for your chosen model and ping me for a review (if you’re just getting started with contributing to an open-source project, check out @merveenoyan's awesome GitHub Contribution Guide).

4. Congratulations, you just merged a PR into 🤗 Transformers, and your contribution will now help anyone who is looking at the model docs! 🎉

If you have any questions or need any help, don’t hesitate to ping me! 🤗❤️

[ahtashamilyas]

ok

[ajaitly11]

@stevhliu Hello, I would like to put together some resources for Longformer, willing to look into CamemBERT as well if Longformer has already been taken.

[debrupf2946]

Hi @stevhliu can I work on LLaMA, can you please assign me?

[stevhliu]

Hi @debrupf2946, we already have a resource section for Llama. Feel free to work on another model if you're interested!

[siddharth1012]

Hi @stevhliu Can I work on ALBERT, which is the only left model in the list?

[ENate]

Hi @siddharth1012 I am almost done with ALBERT and about to open a PR. Issue is due to a doc-builder issue I encountered. Also the problem on Cython version.

[ENate]

So I am working on ALBERT thanks

[jaykhatri0875]

Hi, is there anything that i can help with? i can see lot of diff models are being talked above, where can find open list ? thanks,

[stevhliu]

Hi, thanks for your interest @jaykhatri0875! The open model list is here but I think we're close to completing it. If you're interested in making other contributions, feel free to check out the Good First Issues 🤗

[stevhliu]

All finished now! 🥳