abidlabs HF staff commited on
Commit
b3d29f2
1 Parent(s): a65d2c5

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +21 -34
README.md CHANGED
@@ -12,58 +12,45 @@ pinned: false
12
  <img class="lg:col-span-2" src="https://huggingface.co/spaces/Gradio-Themes/README/resolve/main/theme_header.png" alt="Gradio Theme Party Banner" style="margin:10px"><br>
13
 
14
 
15
- - We would like to extend an invitation to the **Gradio Themes Party**, a community event aimed at designing visually stunning and personalized themes for Gradio apps. The event will take place over a two-week period, **starting from Monday, March 20th** and **ending on Sunday, April 2nd**. We are thrilled to invite and witness what the community builds with Gradio Themes, as they develop attractive themes to enhance the user experience of Gradio applications.
16
- - We will be organizing this event here on <a href="https://huggingface.co/Gradio-Themes" target="_blank" style="text-decoration: underline">Hugging Face Hub</a> and would be engaging through <a href="https://discord.gg/bMz9zKFB" target="_blank" style="text-decoration: underline">Huggingface Discord Server</a>. Check the dedicated Gradio channel to stay updated with the event (need to set up a channel(or not?)). Prizes will be given at the end of the event. See the <a href="#Prizes" target="_blank" style="text-decoration: underline">Prizes section</a>
17
- - Gradio is a widely used platform for creating demos of machine learning models, enabling the creation of web-based user interfaces solely using Python. As the interface of a Gradio application has a direct impact on the user experience, we recognize the importance of creating an aesthetically pleasing interface to enhance the app's value. As such, we have introduced **Gradio Themes**, a new feature that enables users to add themes and customize and beautify their applications. Additionally, we are hosting the **Gradio Themes Party** to encourage developers to design stunning and impressive themes for their Gradio apps and front-ends.
18
- - Gradio can be installed via pip and comes preinstalled in Hugging Face Spaces, the latest version of Gradio that supports Themes is 3.22, and it can be set in the README in Spaces by setting the sdk_version, for example <code>sdk_version: 3.22.0</code>. To learn more about Gradio, see the Getting Started Guide: <a href="https://gradio.app/getting_started/" target="_blank" style="text-decoration: underline">https://gradio.app/getting_started/</a>
19
- - By using Gradio Themes, you can enhance the user experience of your app. You can achieve this by adding default themes such as Base, Soft, Glass, Monochrome, among others. Additionally, you can also extend and personalize existing themes, or create your own themes from scratch. There are a multitude of options available to customize the user interface of your app to suit your needs. To learn more about Gradio Themes, see the Themes Guide at: <a href="https://gradio.app/getting_started/" target="_blank" style="text-decoration: underline">https://gradio.app/themes_guide/</a>
20
  - If there is something you would like to style via the theming API but it isn't currently supported, please use this <a href="https://github.com/gradio-app/gradio/issues/3544" target="_blank">Github Issue</a> to report it. You can add a reply to this issue detailing what you would like to style and how you would like to style it and we will get back to you on it.
21
 
22
  ## Hackathon Tracks :
23
- Participants can take part in different tracks of the Themes Hackathon. Each track will have winners announced at the end of the event! These events are:-
24
- 1. The **Theme Creation Contest** - Participants would compete to create the most creative or visually stunning theme for a Gradio app. We would add the best/most creative theme to our set of default themes as a prize, plus the top three winners will get some goodies.
25
- 2. **Building Sector-specific themes** - Participants would create Gradio themes targeting specific sectors like finance/health/education/art. Here participants can also choose to create themes specific to different companies - for example, an openai green theme / huggingface emoji theme / meta blue theme, etc.
26
  3. **Inclusivity and Accessibility** focused themes - Participants can submit apps built around themes that prioritize inclusivity and accessibility. This segment places a strong emphasis on accessibility, for example, building an app with themes that are tailored to those who are colorblind or creating apps that support causes related to diversity and inclusion.
27
- 4. **Best Dark Toggle** - In this segment, participants will be tasked with designing a theme that provides the most optimal effects when using a dark mode toggle.
28
- 5. **Gradio in disguise🥸** themes - Under this extremely interesting track, we encourage participants to design themes that give Gradio a completely different look and feel from its default theme. This involves creating unique combinations of colors, button designs, fonts, backgrounds, and other design elements to disguise Gradio's appearance and create a fresh and distinct user experience.
29
- 6. **Gradio App redesign challenge** - Participants will be challenged to redesign an existing trending Gradio app using new and creative themes. Participants will have to pick up an existing Gradio application and improve its user experience using Themes. Apps that would be rendered more visually appealing and user-friendly would be considered for this prize.
30
- 7. **Build new Gradio Apps that utilize Themes** - Under this category, we invite participants to create impressive demos that utilize themes. Whether it's using default themes, extending them, or creating new ones from scratch, we encourage participants to incorporate themes into their Gradio demos to make them more visually appealing and engaging.
31
 
32
 
33
  ## How to Participate :
34
 
35
- To participate in any track in the Themes Hackathon -
36
 
37
- - For tracks 1 to 5, you have to submit a new Theme:
38
- - Step 1: Join the Gradio-Theme Party organization on Hub.
39
  - Step 2: Read up about Gradio's new theming capabilities here - [Theming Guide](https://gradio.app/theming-guide/ )
40
- - Step 3: Create a brand new theme - Either by extending the default or other user-generated themes or creating a new theme from scratch (WIP for code sample)
41
  - Step 4: Upload the theme to the Theme Gallery in the Hub, e.g. `my_theme.push_to_hub(repo_name="my_theme")`. For more information on uploading themes, see the [Sharing Themes](https://gradio.app/theming-guide/#sharing-themes) section of the guide.
42
- - Step 5: Share your themes with the community on social media and spread the good word about the Hackathon 🤗
43
 
44
- - For Track 6, the Gradio app redesign challenge, you have to <u>submit a Gradio demo</u>:
45
  - Step 1: Join the Gradio-Theme Party organization on Hub.
46
  - Step 2: Read up about Gradio's new theming capabilities here - [Theming Guide](https://gradio.app/theming-guide/ )
47
  - Step 3: Duplicate any existing Gradio demo (kudos if it is trending 👑)
48
- - Step 4: Add your theme effects to the demo; for example, add color, background, etc.
49
  - Step 5: Publish the demo back on the Hub. Note that the redesigned app must be submitted to the themes-party organization so that team can find it and others can see it. This will ensure the highest visibility for your effort.
50
 
51
- - For Track 7, the Gradio app-building challenge, you have to <u>submit a Gradio demo</u> as well:
52
- - Step 1: Join the Gradio-Theme Party organization on Hub.
53
- - Step 2: Read up about Gradio's new theming capabilities here - [Theming Guide](https://gradio.app/theming-guide/ )
54
- - Step 3: Build a new Gradio demo (extra kudos if it is from making demos Discord channel 👷🏻‍♀️👷🏻)
55
- - Step 4: Make sure to utilize Gradio Themes in the demo; for example, add color, background, etc.
56
- - Step 5: Publish the demo on the Hub to the themes-party organization so that the team can find it and others can see it. This will ensure the highest visibility for your effort.
57
-
58
 
59
  ## Prizes
60
 
61
- Are you ready to win big? We're bringing the excitement to this Hackathon with some incredible prizes up for grabs! You're free to submit as many entries as you want, so get ready to have a great time unleashing your creativity.
62
- - For the themes submitted for categories 1 to 5 - The top 3 winners in each track will be decided based on the number of likes and the winners each will each get
63
- - 🤩 We'll add the most liked theme to our set of default ones as a top prize
64
- - Hugging Face PRO subscription for x time (need to conform this)
65
- - Huggingface goodies for the top three winners from our merch store
66
- - For categories 6 and 7 - The top 3 Gradio Apps in each track will be decided by Huggingface and Gradio team based on aesthetics. Winners will each get -
67
  - Swag from Hugging Face merch shop: t-shirt, hoodie, or mug of your choice
68
- - Hugging Face PRO subscription for one month
69
- - 🎉 Themes event badge on HF for all participants!
 
12
  <img class="lg:col-span-2" src="https://huggingface.co/spaces/Gradio-Themes/README/resolve/main/theme_header.png" alt="Gradio Theme Party Banner" style="margin:10px"><br>
13
 
14
 
15
+ - We would like to invite you to the **Gradio Themes Party**, a community event aimed at designing visually stunning and personalized themes for Gradio apps. The event will take place over roughly a two-week period, **starting from Tuesday, March 21st** and **ending on Sunday, April 2nd**.
16
+ - We will be organizing this event here on <a href="https://huggingface.co/Gradio-Themes" target="_blank" style="text-decoration: underline">Hugging Face Hub</a> and will be communicating with participants through the <a href="https://discord.gg/bMz9zKFB" target="_blank" style="text-decoration: underline">Huggingface Discord Server</a>. Check the dedicated Gradio channel to stay updated with the event (need to set up a channel(or not?)). Prizes will be given at the end of the event. See the <a href="#Prizes" target="_blank" style="text-decoration: underline">Prizes section</a>
 
 
 
17
  - If there is something you would like to style via the theming API but it isn't currently supported, please use this <a href="https://github.com/gradio-app/gradio/issues/3544" target="_blank">Github Issue</a> to report it. You can add a reply to this issue detailing what you would like to style and how you would like to style it and we will get back to you on it.
18
 
19
  ## Hackathon Tracks :
20
+ Participants can take part in different tracks of the Themes Hackathon. Each track will have winners announced at the end of the event! These tracks are:
21
+ 1. **General Theme Creation** - Participants compete to create the most creative or visually stunning theme for a Gradio app. We will add the best/most creative theme to our set of default themes as a prize, plus the top three winners will get prizes.
22
+ 2. **Sector-specific Themes** - Participants create Gradio themes targeting specific sectors like finance/health/education/art, or specific companies -- for example, a huggingface emoji theme or a meta blue theme, etc.
23
  3. **Inclusivity and Accessibility** focused themes - Participants can submit apps built around themes that prioritize inclusivity and accessibility. This segment places a strong emphasis on accessibility, for example, building an app with themes that are tailored to those who are colorblind or creating apps that support causes related to diversity and inclusion.
24
+ 4. **Gradio in Disguise🥸** themes - In this track, we encourage participants to design themes that give Gradio a completely different look and feel from its default theme. This involves creating unique combinations of colors, button designs, fonts, backgrounds, and other design elements to disguise Gradio's appearance and create a fresh and distinct user experience.
25
+ 5. **Gradio App Redesign Challenge** - Participants will be challenged to redesign an existing trending Gradio app using new and creative themes. Participants will have to pick up an existing Gradio application and improve its user experience using Themes. Apps that would be rendered more visually appealing and user-friendly would be considered for this prize.
 
 
26
 
27
 
28
  ## How to Participate :
29
 
30
+ To participate in any track in the Themes Hackathon, first make sure that you have installed the latest version of the Gradio library (at least 3.23 or later): `pip install --upgrade gradio`
31
 
32
+ - For tracks 1 to 4, create and submit a new Theme:
33
+ - Step 1: Join the Gradio-Theme Party organization (this org) on Hub.
34
  - Step 2: Read up about Gradio's new theming capabilities here - [Theming Guide](https://gradio.app/theming-guide/ )
35
+ - Step 3: Create a brand new theme - Either by extending the default or other user-generated themes or creating a new theme from scratch
36
  - Step 4: Upload the theme to the Theme Gallery in the Hub, e.g. `my_theme.push_to_hub(repo_name="my_theme")`. For more information on uploading themes, see the [Sharing Themes](https://gradio.app/theming-guide/#sharing-themes) section of the guide.
37
+ - Step 5: Share your themes with the community on social media and spread the word about the Hackathon 🤗
38
 
39
+ - For Track 5, the Gradio app redesign challenge, you have to <u>submit a Gradio demo</u>:
40
  - Step 1: Join the Gradio-Theme Party organization on Hub.
41
  - Step 2: Read up about Gradio's new theming capabilities here - [Theming Guide](https://gradio.app/theming-guide/ )
42
  - Step 3: Duplicate any existing Gradio demo (kudos if it is trending 👑)
43
+ - Step 4: Add your theme effects to the demo; for example, change color, modify the font, add a background, etc.
44
  - Step 5: Publish the demo back on the Hub. Note that the redesigned app must be submitted to the themes-party organization so that team can find it and others can see it. This will ensure the highest visibility for your effort.
45
 
 
 
 
 
 
 
 
46
 
47
  ## Prizes
48
 
49
+ Are you ready to win big? You're free to submit as many entries as you want, so get ready to have a great time unleashing your creativity.
50
+ - For track 1, we'll add our favorite new theme to our set of default ones as a top prize 🤩. The top 3 winners, based on the number of likes, will get
51
+ - Swag from Hugging Face merch shop: t-shirt, hoodie, or mug of your choice
52
+ - Hugging Face PRO subscription for one year (need to confirm this)
53
+ - For tracks 2-4, we will be awarding prizes to the top 3 winners per track:
 
54
  - Swag from Hugging Face merch shop: t-shirt, hoodie, or mug of your choice
55
+ - Hugging Face PRO subscription for one year (need to confirm this)
56
+ - 🎉 Themes Event badge on HF for all participants!