mirror of
https://github.com/gradio-app/gradio.git
synced 2024-11-27 01:40:20 +08:00
22c87d4b59
* Update README.md * add comment to readme * fixed links * made changes to readme template Co-authored-by: Abubakar Abid <abubakar@huggingface.co> |
||
|---|---|---|
| .. | ||
| adding_rich_descriptions_to_your_demo.md | ||
| advanced_interface_features.md | ||
| building_a_pictionary_app.md | ||
| create_your_own_friends_with_a_gan.md | ||
| creating_a_chatbot.md | ||
| getting_started.md | ||
| Gradio_and_ONNX_on_Hugging_Face.md | ||
| image_classification_in_pytorch.md | ||
| image_classification_in_tensorflow.md | ||
| image_classification_with_vision_transformers.md | ||
| introduction_to_blocks.md | ||
| README.md | ||
| real_time_speech_recognition.md | ||
| using_flagging.md | ||
| using_hugging_face_integrations.md | ||
Contributing a Guide
Want to help teach Gradio? Consider contributing a Guide! 🤗
Broadly speaking, there are two types of guides:
- Use cases: guides that cover step-by-step how to build a particular type of machine learning demo or app using Gradio. Here's an example: Creating a Chatbot
- Feature explanation: guides that describe in detail a particular feature of Gradio. Here's an example: Using Flagging
We encourage you to submit either type of Guide! (Looking for ideas? We may also have open issues where users have asked for guides on particular topics)
Guide Structure
As you can see with the previous examples, Guides are standard markdown documents. They usually:
- start with an Introduction section describing the topic
- include subheadings to make articles easy to navigate
- include real code snippets that make it easy to follow along and implement the Guide
- include embedded Gradio demos to make them more interactive and provide immediate demonstrations of the topic being discussed. These Gradio demos are hosted on Hugging Face Spaces and are embedded using the standard <iframe> tag.
How to Contribute a Guide
- Clone or fork this
gradiorepo - Add a new markdown document with a descriptive title to the
/guidesfolder - Write your Guide in standard markdown! Embed Gradio demos wherever helpful
- Add a list of
related_spacesat the top of the markdown document (see the previously linked Guides for how to do this) - Add 3
tagsat the top of the markdown document to help users find your guide (again, see the previously linked Guides for how to do this) - Open a PR to have your guide reviewed
That's it! We're looking forward to reading your Guide 🥳