Spaces are configured through the YAML
block at the top of the README.md file at the root of the repository. All the accepted parameters are listed below.
title
: string
Display title for the Space.
emoji
: string
Space emoji (emoji-only character allowed).
colorFrom
: string
Color for Thumbnail gradient (red, yellow, green, blue, indigo, purple, pink, gray).
colorTo
: string
Color for Thumbnail gradient (red, yellow, green, blue, indigo, purple, pink, gray).
sdk
: string
Can be either gradio
, streamlit
or static
.
python_version
: string
Any valid Python 3.x
or 3.x.x
version.
Defaults to 3.8.9
.
sdk_version
: string
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.10.0
.
app_file
: string
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.
models
: List[string]
HF model IDs (like gpt2
or deepset/roberta-base-squad2
) used in the Space.
Will be parsed automatically from your code if not specified here.
datasets
: List[string]
HF dataset IDs (like common_voice
or oscar-corpus/OSCAR-2109
) used in the Space.
Will be parsed automatically from your code if not specified here.
tags
: List[string]
List of terms that describe your Space task or scope.
pinned
: boolean
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.