Skip to content

Commit

Permalink
Explain that PYTHONPATH must be updated
Browse files Browse the repository at this point in the history
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
  • Loading branch information
meg-huggingface authored Nov 10, 2024
1 parent c0cf80b commit 2b9210c
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,9 @@ if __name__ == "__main__":
demo.launch()
```

Make sure your `PYTHONPATH` includes the directory where this repository is cloned, e.g.,
`export PYTHONPATH="./"`

then run:

```
Expand Down Expand Up @@ -348,5 +351,18 @@ Run `scripts/build_frontend.sh` with the environment variable `NODE_OPTIONS=--ma

---

In the case of:
- Unexpected Exceptions being thrown;
- The following warning:
`IMPORTANT: You are using gradio version <earlier version>, however version <later version> is available, please upgrade.`

Make sure your `PYTHONPATH` includes the directory where this 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!_

0 comments on commit 2b9210c

Please sign in to comment.