From 1555321f6faa17b6fa2fe102c5157790bf35525c Mon Sep 17 00:00:00 2001 From: meg <90473723+meg-huggingface@users.noreply.github.com> Date: Tue, 12 Nov 2024 12:44:57 -0800 Subject: [PATCH] Explain that PYTHONPATH must be updated (#9925) * Explain that PYTHONPATH must be updated Cloning this repository, then building & running scripts, can run into the issue of the `import gradio` call pulling `gradio` in from somewhere else (such as the virtual environment). To address this, users need to tell python where to look in order to use the cloned git repo for `gradio`. Further details in https://huggingface.slack.com/archives/C02SPHC1KD1/p1731207233633159?thread_ts=1731206608.882719&cid=C02SPHC1KD1 for more * tweaks --------- Co-authored-by: Abubakar Abid --- CONTRIBUTING.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2f502f421823d..bea944895ff25 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -117,6 +117,9 @@ gradio app.py This will start the backend server in reload mode, which will watch for changes in the `gradio` folder and reload the app if changes are made. By default, Gradio will launch on port 7860. You can also just use `python app.py`, but this won't automatically trigger updates. +Note: if you have `gradio` installed elsewhere in your system, you may need to uninstall it or at least make sure your `PYTHONPATH` includes the directory where the Gradio repository is cloned, e.g., +`export PYTHONPATH="./"` + If you're making frontend changes, start the frontend server: @@ -348,5 +351,18 @@ Run `scripts/build_frontend.sh` with the environment variable `NODE_OPTIONS=--ma --- +In the case of: +- Unexpected exceptions being thrown, or +- The following warning: +`IMPORTANT: You are using gradio version , however version is available, please upgrade.` + +ensure your `PYTHONPATH` includes the directory where the Gradio repository is cloned, e.g.: + +```export PYTHONPATH="./"``` + +This ensures that when `gradio` is imported in a python program, it is this current version from this repository. + +--- + _Could these guidelines be clearer? Feel free to open a PR to help us facilitate open-source contributions!_