mirror of
https://github.com/gradio-app/gradio.git
synced 2025-04-12 12:40:29 +08:00
Include instructions on starting from someone else's custom component repository (#8386)
* Add guide * add changeset * Fix link * add changeset * Add code --------- Co-authored-by: gradio-pr-bot <gradio-pr-bot@users.noreply.github.com>
This commit is contained in:
parent
a373b0edd3
commit
e738e26a5d
5
.changeset/cute-ducks-fail.md
Normal file
5
.changeset/cute-ducks-fail.md
Normal file
@ -0,0 +1,5 @@
|
||||
---
|
||||
"gradio": patch
|
||||
---
|
||||
|
||||
feat:Include instructions on starting from someone else's custom component repository
|
@ -76,7 +76,7 @@ def _build(
|
||||
except ModuleNotFoundError as e:
|
||||
raise ValueError(
|
||||
f"Your custom component package ({package_name}) is not installed! "
|
||||
"Please install it with the gradio cc install command before buillding it."
|
||||
"Please install it with the gradio cc install command before building it."
|
||||
) from e
|
||||
if bump_version:
|
||||
pyproject_toml = parse((path / "pyproject.toml").read_text())
|
||||
|
@ -26,7 +26,7 @@ The Custom Components workflow consists of 4 steps: create, dev, build, and publ
|
||||
|
||||
Each of these steps is done via the Custom Component CLI. You can invoke it with `gradio cc` or `gradio component`
|
||||
|
||||
Tip: Run `gradio cc --help` to get a help menu of all available commands. You can also append `--help` to any command name to bring up a help page for that command, e.g. `gradio cc create --help`.
|
||||
Tip: Run `gradio cc --help` to get a help menu of all available commands. There are some commands that are not covered in this guide. You can also append `--help` to any command name to bring up a help page for that command, e.g. `gradio cc create --help`.
|
||||
|
||||
## 1. create
|
||||
|
||||
@ -121,4 +121,4 @@ Here is an example of what publishing looks like:
|
||||
Now that you know the high-level workflow of creating custom components, you can go in depth in the next guides!
|
||||
After reading the guides, check out this [collection](https://huggingface.co/collections/gradio/custom-components-65497a761c5192d981710b12) of custom components on the HuggingFace Hub so you can learn from other's code.
|
||||
|
||||
|
||||
Tip: If you want to start off from someone else's custom component see this [guide](./frequently-asked-questions#do-i-always-need-to-start-my-component-from-scratch).
|
||||
|
@ -35,6 +35,11 @@ If the `window.__GRADIO__CC` variable is not empty (see below for an example), t
|
||||
It is highly recommended you use a virtual environment to prevent conflicts with other python dependencies installed in your system.
|
||||
|
||||
|
||||
## Do I always need to start my component from scratch?
|
||||
No! You can start off from an existing gradio component as a template, see the [five minute guide](./custom-components-in-five-minutes).
|
||||
You can also start from an existing custom component if you'd like to tweak it further. Once you find the source code of a custom component you like, clone the code to your computer and run `gradio cc install`. Then you can run the development server to make changes.If you run into any issues, contact the author of the component by opening an issue in their repository. The [gallery](https://www.gradio.app/custom-components/gallery) is a good place to look for published components. For example, to start from the [PDF component](https://www.gradio.app/custom-components/gallery?id=freddyaboulton%2Fgradio_pdf), clone the space with `git clone https://huggingface.co/spaces/freddyaboulton/gradio_pdf`, `cd` into the `src` directory, and run `gradio cc install`.
|
||||
|
||||
|
||||
## Do I need to host my custom component on HuggingFace Spaces?
|
||||
You can develop and build your custom component without hosting or connecting to HuggingFace.
|
||||
If you would like to share your component with the gradio community, it is recommended to publish your package to PyPi and host a demo on HuggingFace so that anyone can install it or try it out.
|
||||
|
Loading…
x
Reference in New Issue
Block a user