Tham khảo cấu hình Spaces

Spaces được cấu hình thông qua khối YAML ở đầu tệp README.md tại thư mục gốc của kho. Tất cả các tham số được chấp nhận được liệt kê bên dưới.

title : string
Tiêu đề hiển thị cho Space.

emoji : string
Emoji khoảng trắng (chỉ cho phép ký tự emoji).

colorFrom : string
Màu sắc cho gradient của Thumbnail (đỏ, vàng, xanh lá, xanh dương, chàm, tím, hồng, xám).

colorTo : string
Màu sắc cho gradient của Thumbnail (đỏ, vàng, xanh lá, xanh dương, chàm, tím, hồng, xám).

sdk : string
Có thể là gradio, docker hoặc static.

python_version: string
Bất kỳ phiên bản Python 3.x hoặc 3.x.x hợp lệ nào.
Mặc định là 3.10.

sdk_version : string
Chỉ định phiên bản Gradio cần sử dụng. Tất cả các phiên bản của Gradio đều được hỗ trợ.

suggested_hardware : string
Chỉ định phần cứng được đề xuất để chạy Space này.
Hữu ích cho các Space được thiết kế để người dùng khác sao chép.
Việc đặt giá trị này sẽ không tự động gán phần cứng cho Space.
Giá trị phải là một loại phần cứng hợp lệ. Các loại phần cứng hợp lệ hiện tại:

• CPU: "cpu-basic", "cpu-upgrade"
• GPU: "t4-small", "t4-medium", "l4x1", "l4x4", "l40sx1", "l40sx4", "l40sx8", "rtx-pro-6000", "rtx-pro-6000x2", "rtx-pro-6000x4", "rtx-pro-6000x8", "a10g-small", "a10g-large", "a10g-largex2", "a10g-largex4", "a100-large", "a100x4", "a100x8"

suggested_storage : string
Chỉ định lưu trữ vĩnh viễn được đề xuất mà Space này phải chạy trên đó.
Hữu ích cho các Space được thiết kế để người dùng khác sao chép.
Việc đặt giá trị này sẽ không tự động gán lưu trữ vĩnh viễn cho Space này.
Giá trị phải là một trong "small", "medium" hoặc "large".

Tính năng lưu trữ bền vững không còn khả dụng nên cài đặt này sẽ bị bỏ qua.

app_file : string
Đường dẫn đến tệp ứng dụng chính của bạn (chứa mã Python gradio hoặc mã html static).
Đường dẫn là tương đối so với gốc của kho lưu trữ.

app_build_command : string
Đối với Spaces tĩnh, lệnh được chạy đầu tiên để tạo HTML cần hiển thị. Ví dụ: npm run build.

Điều này được sử dụng cùng với app_file, trỏ đến tệp chỉ mục đã được xây dựng: ví dụ app_file: dist/index.html.

Mỗi lần cập nhật, lệnh build sẽ được chạy trong một Job và kết quả build sẽ được lưu trữ trong refs/convert/build, sau đó được phục vụ bởi Space. Xem một ví dụ tại https://huggingface.co/spaces/coyotte508/static-vite

app_port : int
Cổng mà ứng dụng của bạn đang chạy. Chỉ được sử dụng nếu sdk là docker. Cổng mặc định là 7860.

base_path: string Đối với Spaces không tĩnh, đây là url ban đầu để render. Cần phải bắt đầu bằng /. Đối với Spaces tĩnh, hãy dùng app_file thay thế.

fullWidth: boolean
Xác định xem Space của bạn được hiển thị trong cột có chiều rộng đầy đủ (khi true) hay cột có chiều rộng cố định (ví dụ: CSS “container”) bên trong iframe. Mặc định là true.

header: string
Có thể là mini hoặc default. Nếu header được đặt thành mini, không gian sẽ được hiển thị toàn màn hình với một header nổi mini.

short_description: string Mô tả ngắn gọn về Space. Nội dung này sẽ được hiển thị trong hình thu nhỏ của Space.

models : List[string]
Các ID model HF (như openai-community/gpt2 hoặc deepset/roberta-base-squad2) được sử dụng trong Space. Sẽ được phân tích tự động từ mã của bạn nếu không được chỉ định ở đây.

datasets : List[string]
Các ID dataset HF (như mozilla-foundation/common_voice_13_0 hoặc oscar-corpus/OSCAR-2109) được sử dụng trong Space. Nếu không được chỉ định ở đây, chúng sẽ được phân tích tự động từ mã của bạn.

tags : List[string]
Danh sách các từ khóa mô tả nhiệm vụ hoặc phạm vi của Space của bạn.

thumbnail: string
URL để định nghĩa hình thu nhỏ tùy chỉnh cho việc chia sẻ trên mạng xã hội.

pinned : boolean
Xác định xem Space có được giữ ở đầu hồ sơ của bạn hay không. Tính năng này hữu ích nếu bạn có nhiều Space, giúp bạn và người khác nhanh chóng nhìn thấy Space tốt nhất của bạn.

hf_oauth : boolean
Xác định xem có ứng dụng OAuth nào được kết nối và liên kết với Space này không. Xem Thêm nút Đăng nhập bằng HF vào Space của bạn để biết thêm chi tiết.

hf_oauth_scopes : List[string] Các phạm vi (scopes) được ủy quyền của ứng dụng OAuth đã kết nối. openid và profile được ủy quyền mặc định và không cần tham số này. Xem Thêm nút Đăng nhập với HF vào space của bạn để biết thêm chi tiết.

hf_oauth_expiration_minutes : int Thời hạn của token OAuth tính bằng phút. Mặc định là 480 phút (8 giờ). Thời hạn tối đa là 43200 phút (30 ngày). Xem Thêm nút Đăng nhập bằng HF vào space của bạn để biết thêm chi tiết.

hf_oauth_authorized_org : string hoặc List[string] Giới hạn quyền truy cập OAuth cho các thành viên của các tổ chức cụ thể. Xem Thêm nút Đăng nhập bằng HF vào space của bạn để biết thêm chi tiết.

disable_embedding : boolean Xác định xem iframe của Space có thể được nhúng vào các trang web khác hay không. Mặc định là false, tức là Spaces có thể được nhúng.

startup_duration_timeout: string Đặt thời gian chờ khởi động tùy chỉnh cho Space của bạn. Đây là thời gian tối đa mà Space của bạn được phép khởi động trước khi hết thời gian chờ và bị đánh dấu là không khỏe mạnh. Mặc định là 30 phút, nhưng bất kỳ thời lượng hợp lệ nào (như 1h, 30m) đều được chấp nhận.

custom_headers : Dict[string, string]
Đặt các tiêu đề HTTP tùy chỉnh sẽ được thêm vào tất cả các phản hồi HTTP khi phục vụ Space của bạn.
Hiện tại, chỉ các tiêu đề cross-origin-embedder-policy (COEP), cross-origin-opener-policy (COOP) và cross-origin-resource-policy (CORP) được cho phép. Các tiêu đề này có thể được sử dụng để thiết lập môi trường cách ly cross-origin và bật các tính năng mạnh mẽ như SharedArrayBuffer, ví dụ:

custom_headers:
  cross-origin-embedder-policy: require-corp
  cross-origin-opener-policy: same-origin
  cross-origin-resource-policy: cross-origin

Lưu ý: tất cả các tiêu đề và giá trị phải viết chữ thường.

preload_from_hub: List[string] Chỉ định một danh sách các mô hình Hugging Face Hub hoặc các tệp lớn khác cần được nạp trước trong quá trình build Space của bạn. Điều này tối ưu hóa thời gian khởi động bằng cách đảm bảo các tệp đã sẵn sàng khi ứng dụng của bạn bắt đầu chạy. Tính năng này đặc biệt hữu ích cho các Space phụ thuộc vào các mô hình hoặc bộ dữ liệu lớn, vốn nếu không sẽ phải tải xuống vào thời gian chạy.

Định dạng cho mỗi mục là "repository_name" để tải xuống tất cả các tệp từ một kho lưu trữ, hoặc "repository_name file1,file2" để tải xuống các tệp cụ thể trong kho lưu trữ đó. Bạn cũng có thể chỉ định một commit cụ thể để tải xuống bằng định dạng "repository_name file1,file2 commit_sha256".

Cách sử dụng ví dụ:

preload_from_hub:
  - warp-ai/wuerstchen-prior text_encoder/model.safetensors,prior/diffusion_pytorch_model.safetensors
  - coqui/XTTS-v1
  - openai-community/gpt2 config.json 11c5a3d5811f50298f278a704980280950aedb10

Trong ví dụ này, Space sẽ tải trước các tệp .safetensors cụ thể từ warp-ai/wuerstchen-prior, toàn bộ kho coqui/XTTS-v1, và một phiên bản cụ thể của tệp config.json trong kho openai-community/gpt2 từ Hugging Face Hub trong quá trình build.

Các tệp được lưu trong bộ nhớ đệm đĩa mặc định của huggingface_hub tại ~/.cache/huggingface/hub. Nếu ứng dụng của bạn kỳ vọng chúng ở vị trí khác hoặc bạn đã thay đổi biến HF_HOME, quá trình nạp trước này hiện tại không theo dõi điều đó.

Chưa hỗ trợ tải trước các kho riêng tư.