Model resources contribution
See original GitHub issueHi 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:
- 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 ā¤ļø
- 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.
-
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).
-
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! š¤ā¤ļø
Issue Analytics
- State:
- Created a year ago
- Reactions:3
- Comments:14 (14 by maintainers)
Hi @stevhliu, I want to work on OpenAI GPT!
Hi, I would like to work on XLM-RoBERTa! @stevhliu