rupal009 commited on
Commit
3515732
·
verified ·
1 Parent(s): e20d361

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +121 -0
README.md ADDED
@@ -0,0 +1,121 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: openrail
3
+ title: animetoon
4
+ sdk: streamlit
5
+ emoji: 🚀
6
+ colorFrom: red
7
+ colorTo: red
8
+ pinned: true
9
+ thumbnail: >-
10
+ https://cdn-uploads.huggingface.co/production/uploads/66ec704e6b665725dc862a8a/ldr4X6RUvLB7VPCNJEGsA.jpeg
11
+ short_description: test site
12
+ ---
13
+ 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.
14
+
15
+ title : string
16
+ Display title for the Space.
17
+
18
+ emoji : string
19
+ Space emoji (emoji-only character allowed).
20
+
21
+ colorFrom : string
22
+ Color for Thumbnail gradient (red, yellow, green, blue, indigo, purple, pink, gray).
23
+
24
+ colorTo : string
25
+ Color for Thumbnail gradient (red, yellow, green, blue, indigo, purple, pink, gray).
26
+
27
+ sdk : string
28
+ Can be either gradio, streamlit, docker, or static.
29
+
30
+ python_version: string
31
+ Any valid Python 3.x or 3.x.x version.
32
+ Defaults to 3.10.
33
+
34
+ sdk_version : string
35
+ Specify the version of the selected SDK (Streamlit or Gradio).
36
+ All versions of Gradio are supported.
37
+ All versions of Streamlit from 0.79.0 are supported.
38
+
39
+ suggested_hardware : string
40
+ Specify the suggested hardware on which this Space must be run.
41
+ Useful for Spaces that are meant to be duplicated by other users.
42
+ Setting this value will not automatically assign an hardware to this Space.
43
+ Value must be a valid hardware flavor. Current valid hardware flavors:
44
+
45
+ CPU: "cpu-basic", "cpu-upgrade"
46
+ GPU: "t4-small", "t4-medium", "l4x1", "l4x4", "a10g-small", "a10g-large", "a10g-largex2", "a10g-largex4","a100-large"
47
+ TPU: "v5e-1x1", "v5e-2x2", "v5e-2x4"
48
+ suggested_storage : string
49
+ Specify the suggested permanent storage on which this Space must be run.
50
+ Useful for Spaces that are meant to be duplicated by other users.
51
+ Setting this value will not automatically assign a permanent storage to this Space.
52
+ Value must be one of "small", "medium" or "large".
53
+
54
+ app_file : string
55
+ Path to your main application file (which contains either gradio or streamlit Python code, or static html code).
56
+ Path is relative to the root of the repository.
57
+
58
+ app_port : int
59
+ Port on which your application is running. Used only if sdk is docker. Default port is 7860.
60
+
61
+ base_path: string For non-static Spaces, initial url to render. Needs to start with /. For static Spaces, use app_file instead.
62
+
63
+ fullWidth: boolean
64
+ Whether your Space is rendered inside a full-width (when true) or fixed-width column (ie. “container” CSS) inside the iframe. Defaults to true.
65
+
66
+ header: string
67
+ Can be either mini or default. If header is set to mini the space will be displayed full-screen with a mini floating header .
68
+
69
+ short_description: string A short description of the Space. This will be displayed in the Space’s thumbnail.
70
+
71
+ models : List[string]
72
+ HF model IDs (like openai-community/gpt2 or deepset/roberta-base-squad2) used in the Space. Will be parsed automatically from your code if not specified here.
73
+
74
+ datasets : List[string]
75
+ HF dataset IDs (like mozilla-foundation/common_voice_13_0 or oscar-corpus/OSCAR-2109) used in the Space. Will be parsed automatically from your code if not specified here.
76
+
77
+ tags : List[string]
78
+ List of terms that describe your Space task or scope.
79
+
80
+ thumbnail: string
81
+ URL for defining a custom thumbnail for social sharing.
82
+
83
+ pinned : boolean
84
+ 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.
85
+
86
+ hf_oauth : boolean
87
+ Whether a connected OAuth app is associated to this Space. See Adding a Sign-In with HF button to your Space for more details.
88
+
89
+ hf_oauth_scopes : List[string] Authorized scopes of the connected OAuth app. openid and profile are authorized by default and do not need this parameter. See Adding a Sign-In with HF button to your space for more details.
90
+
91
+ hf_oauth_expiration_minutes : int Duration of the OAuth token in minutes. Defaults to 480 minutes (8 hours). Maximum duration is 43200 minutes (30 days). See Adding a Sign-In with HF button to your space for more details.
92
+
93
+ disable_embedding : boolean
94
+ Whether the Space iframe can be embedded in other websites. Defaults to false, i.e. Spaces can be embedded.
95
+
96
+ startup_duration_timeout: string
97
+ 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.
98
+
99
+ custom_headers : Dict[string, string]
100
+ Set custom HTTP headers that will be added to all HTTP responses when serving your Space.
101
+ For now, only the cross-origin-embedder-policy (COEP), cross-origin-opener-policy (COOP), and cross-origin-resource-policy (CORP) headers are allowed. These headers can be used to set up a cross-origin isolated environment and enable powerful features like SharedArrayBuffer, for example:
102
+
103
+ Copied
104
+ custom_headers:
105
+ cross-origin-embedder-policy: require-corp
106
+ cross-origin-opener-policy: same-origin
107
+ cross-origin-resource-policy: cross-origin
108
+ Note: all headers and values must be lowercase.
109
+
110
+ preload_from_hub: List[string] 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.
111
+
112
+ The format for each item is "repository_name" to download all files from a repository, or "repository_name file1,file2" for downloading specific files within that repository. You can also specify a specific commit to download using the format "repository_name file1,file2 commit_sha256".
113
+
114
+ Example usage:
115
+
116
+ Copied
117
+ preload_from_hub:
118
+ - warp-ai/wuerstchen-prior text_encoder/model.safetensors,prior/diffusion_pytorch_model.safetensors
119
+ - coqui/XTTS-v1
120
+ - openai-community/gpt2 config.json 11c5a3d5811f50298f278a704980280950aedb10
121
+ In this example, the Space will preload specific .safetensors files from warp-ai/wuerstchen-prior, the complete coqui/XTTS-v1 repository, and a specific revision of the config.json file in the openai-community/gpt2 repository from the Hugging Face Hub during build time.