Prequisites:
More than 80 awesome developers have contributed to the gradio
library, and we'd be thrilled if you would like be the next gradio
contributor! Start by cloning this repo and installing Gradio locally:
main
branchbash scripts/install_gradio.sh
bash scripts/build_frontend.sh
In order to be able to run the Python unit tests, do the following:
bash scripts/install_test_requirements.sh
bash scripts/create_test_requirements.sh
gradio
folder and reload the app if changes are made.gradio app.py
bash scripts/run_frontend.sh
bash scripts/run_all_tests.sh
It's helpful to know the overall structure of the repository so that you can focus on the part of the source code you'd like to contribute to
/gradio
: contains the Python source code for the library
/gradio/interface.py
: contains the Python source code for the core Interface
class/gradio/blocks.py
: contains the Python source code for the core Blocks
class/gradio/components.py
: contains the Python source code for the components
, you can add your custom components here./ui
: contains the HTML/JS/CSS source code for the library (start here for frontend changes)/test
: contains Python unit tests for the library/demo
: contains demos that are used in the documentation, you can find Gradio
examples over here./website
: contains the code for the Gradio website (www.gradio.app). See the README in the /website
folder for more detailsAll PRs must pass the continuous integration tests before merging. To test locally, you can run python -m unittest
from the repo directory.
All PRs should be against main
. Direct commits to main are blocked, and PRs require an approving review to merge into main. By convention, the Gradio maintainers will review PRs when:
We ask that you make sure initial CI checks are passing before requesting a review. One of the Gradio maintainers will merge the PR when all the checks are passing.
Do not forget the format the backend before pushing.
bash scripts/format_backend.sh
bash scripts/format_frontend.sh
You can run the circleci checks locally as well.
bash scripts/run_circleci.sh
Could these guidelines be clearer? Feel free to open a PR to help us faciltiate open-source contributions!
Dear OpenI User
Thank you for your continuous support to the Openl Qizhi Community AI Collaboration Platform. In order to protect your usage rights and ensure network security, we updated the Openl Qizhi Community AI Collaboration Platform Usage Agreement in January 2024. The updated agreement specifies that users are prohibited from using intranet penetration tools. After you click "Agree and continue", you can continue to use our services. Thank you for your cooperation and understanding.
For more agreement content, please refer to the《Openl Qizhi Community AI Collaboration Platform Usage Agreement》