jacoblincool/Hugging Face Sync
Sync your GitHub repository to Hugging Face Spaces.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| user | The username (your username or organization name) of the Hugging Face. | yes | — |
| space | The space name of the Hugging Face. | yes | — |
| token | The Hugging Face access token. | yes | — |
| github | The GitHub Actions token. | yes | — |
| title | Title of the Space. | no | — |
| emoji | Space emoji (emoji-only character allowed). | no | 🦄 |
| colorFrom | Color for Thumbnail gradient (red, yellow, green, blue, indigo, purple, pink, gray). | no | indigo |
| colorTo | Color for Thumbnail gradient (red, yellow, green, blue, indigo, purple, pink, gray). | no | pink |
| sdk | Can be either gradio, streamlit, docker, or static. | no | gradio |
| python_version | Any valid Python 3.x or 3.x.x version. | no | — |
| sdk_version | Specify the version of the selected SDK (Streamlit or Gradio). All versions of Gradio are supported. Streamlit versions are supported from 0.79.0 to 1.19.0. | no | — |
| suggested_hardware | Specify the suggested hardware on which this Space must be run. Useful for Spaces that are meant to be duplicated by other users. Setting this value will not automatically assign an hardware to this Space. | no | — |
| suggested_storage | Specify the suggested permanent storage on which this Space must be run. Useful for Spaces that are meant to be duplicated by other users. Setting this value will not automatically assign a permanent storage to this Space. | no | — |
| app_file | Path to your main application file (which contains either gradio or streamlit Python code, or static html code). Path is relative to the root of the repository. | no | — |
| app_port | Port on which your application is running. Used only if sdk is docker. | no | — |
| base_path | For non-static spaces, initial url to render. Needs to start with /. For static spaces, use app_file instead. | no | — |
| fullWidth | Whether your Space is rendered inside a full-width (when true) or fixed-width column (ie. “container” CSS) inside the iframe. Defaults to false in gradio and streamlit, and to true for other sdks. | no | — |
| header | Can be either mini or default. If header is set to mini the space will be displayed full-screen with a mini floating header. | no | — |
| short_description | A short description of the Space. This will be displayed in the Space's thumbnail. (60 chars max) | no | — |
| models | HF model IDs (like gpt2 or deepset/roberta-base-squad2) used in the Space. | no | — |
| datasets | HF dataset IDs (like common_voice or oscar-corpus/OSCAR-2109) used in the Space. | no | — |
| tags | List of terms that describe your Space task or scope. | no | — |
| disable_embedding | Whether the Space iframe can be embedded in other websites. Defaults to false, i.e. Spaces can be embedded. | no | — |
| startup_duration_timeout | Set a custom startup duration timeout for your Space. This is the maximum time your Space is allowed to start before it times out and is flagged as unhealthy. Defaults to 30 minutes, but any valid duration (like 1h, 30m) is acceptable. | no | — |
| preload_from_hub | Specify a list of Hugging Face Hub models or other large files to be preloaded during the build time of your Space. This optimizes the startup time by having the files ready when your application starts. This is particularly useful for Spaces that rely on large models or datasets that would otherwise need to be downloaded at runtime. | no | — |
| pinned | Whether the Space stays on top of your profile. Can be useful if you have a lot of Spaces so you and others can quickly see your best Space. | no | — |
| configuration | Path to the configuration file for the Space. This file should be a valid YAML file without --- at the beginning and end. If specified, other configuration parameters will be ignored. | no | — |
Outputs
no outputs