Hugging Face's logo

Hub documentation

Danh sách kiểm tra phát hành Mô hình

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Danh sách kiểm tra phát hành Mô hình

Hugging Face Hub là nền tảng hàng đầu để chia sẻ các mô hình machine learning. Một bản phát hành được thực hiện tốt có thể tăng khả năng hiển thị và tác động của mô hình của bạn. Phần này bao gồm các bước cần thiết cho một bản phát hành mô hình ngắn gọn, cung cấp thông tin đầy đủ và thân thiện với người dùng.

Phát hành với một tác nhân lập trình? Cài đặt hf CLI Skill để tác nhân của bạn tự động xử lý việc tải lên, thẻ mô hình và metadata cho bạn.

⏳ Chuẩn bị Mô hình của Bạn để Phát hành

Tải lên trọng số mô hình

Khi tải các mô hình lên Hub, hãy tuân thủ các thực hành tốt nhất sau:

  • Sử dụng các kho lưu trữ riêng cho các bộ trọng số mô hình khác nhau: Tạo các kho lưu trữ riêng cho từng biến thể của cùng một kiến trúc. Điều này cho phép bạn nhóm chúng thành một bộ sưu tập, dễ điều hướng hơn so với danh sách thư mục. Nó cũng cải thiện khả năng hiển thị vì mỗi mô hình có URL riêng (hf.co/org/model-name), giúp tìm kiếm dễ dàng hơn và cung cấp số lượt tải xuống cho từng mô hình của bạn. Một ví dụ tuyệt vời là bộ sưu tập Qwen3-VL gần đây, bao gồm các biến thể khác nhau của kiến trúc VL.

  • Ưu tiên safetensors hơn pickle để serialize trọng số.: safetensors an toàn và nhanh hơn pickle hoặc pth của Python. Nếu bạn có tệp pickle .bin, hãy dùng công cụ chuyển đổi trọng số để chuyển đổi.

Viết Thẻ Mô Hình Chi Tiết

Một thẻ mô tả model được viết kỹ lưỡng (tức là README.md trong kho của bạn) là yếu tố thiết yếu để tăng khả năng tìm thấy, tái lập và chia sẻ hiệu quả. Hãy đảm bảo bao gồm các nội dung sau:

  1. Cấu hình Metadata: Phần metadata (YAML) ở đầu thẻ mô hình của bạn đóng vai trò then chốt cho việc tìm kiếm và phân loại. Bao gồm:

    ---
pipeline_tag: text-generation    # Specify the task
library_name: transformers       # Specify the library
language:
  - en                           # List languages your model supports
license: apache-2.0              # Specify a license
datasets:
  - username/dataset             # List datasets used for training
base_model: username/base-model  # If applicable (your model is a fine-tune, quantized, merged version of another model)
tags:                            # Add extra tags which would make the repo searchable using the tag
  - tag1 
  - tag2
---

    Nếu bạn tạo README.md trong Web UI, bạn sẽ thấy một biểu mẫu chứa các trường metadata quan trọng nhất mà chúng tôi khuyến nghị 🤗.

    metadata template on the hub ui
    Biểu mẫu Metadata trên giao diện Hub

  2. Mô tả chi tiết về Mô hình: Cung cấp giải thích rõ ràng về những gì mô hình của bạn thực hiện, kiến trúc của nó và các trường hợp sử dụng dự kiến. Giúp người dùng nhanh chóng quyết định xem nó có phù hợp với nhu cầu của họ hay không.

  3. Ví dụ sử dụng: Cung cấp các đoạn mã rõ ràng, có thể sao chép và chạy ngay cho suy luận, tinh chỉnh hoặc các tác vụ phổ biến khác. Giữ cho các chỉnh sửa cần thiết từ phía người dùng ở mức tối thiểu.

    Phần thưởng: Thêm một notebook.ipynb được cấu trúc tốt trong repo, minh họa việc suy luận hoặc tinh chỉnh, để người dùng có thể mở trực tiếp trong Google Colab và Kaggle Notebooks.

    colab and kaggle button
    Nút sử dụng Google và Kaggle

  4. Thông số kỹ thuật: Bao gồm các tham số huấn luyện, yêu cầu phần cứng và các chi tiết khác giúp người dùng chạy mô hình một cách hiệu quả.

  5. Chỉ số hiệu năng: Chia sẻ các kết quả chuẩn (benchmark) và đánh giá. Bao gồm các chỉ số định lượng và ví dụ định tính để thể hiện điểm mạnh và hạn chế.

  6. Hạn chế và Thiên kiến: Tài liệu hóa các hạn chế, thiên kiến và các cân nhắc đạo đức đã biết để người dùng có thể đưa ra lựa chọn sáng suốt.

Để quá trình diễn ra liền mạch hơn, hãy nhấp vào Import model card template để tự động điền các README.md với các giá trị thay thế.

model card template button on the hub uimodel card template on the hub
Nút để nhập mẫu thẻ mô hìnhMột phần của mẫu được nhập

Nâng cao khả năng tìm kiếm và sử dụng mô hình

Để tối đa hóa phạm vi tiếp cận và khả năng sử dụng:

  1. Tích hợp thư viện: Thêm hỗ trợ cho một trong nhiều thư viện được tích hợp với Hugging Face Hub (chẳng hạn như transformers, diffusers, sentence-transformers, timm). Việc tích hợp này tăng đáng kể khả năng tiếp cận mô hình của bạn và cung cấp cho người dùng các đoạn mã để làm việc với mô hình của bạn.

    Ví dụ, để chỉ định rằng mô hình của bạn hoạt động với thư viện transformers:

    ---
library_name: transformers
---
    code snippet tab
    Tab đoạn mã

    Bạn cũng có thể đăng ký thư viện mô hình của riêng mình hoặc thêm hỗ trợ Hub vào thư viện và mã nguồn của bạn, để người dùng biết cách tải trọng số mô hình từ Hub.

    Chúng tôi đã viết một hướng dẫn chi tiết về các thực hành tốt nhất khi tải lên tại đây.

    Việc sử dụng một thư viện đã đăng ký cũng cho phép bạn theo dõi số lượt tải xuống mô hình của mình theo thời gian.

  2. Metadata chính xác:

    • Thẻ Pipeline: Chọn thẻ pipeline chính xác để mô hình của bạn xuất hiện trong các tìm kiếm và widget phù hợp.

    Các ví dụ về thẻ pipeline phổ biến:

    • text-generation - Dành cho các mô hình ngôn ngữ tạo văn bản

    • text-to-image - Dành cho các mô hình tạo ảnh từ văn bản

    • image-text-to-text - Dành cho các mô hình thị giác-ngôn ngữ (VLM) tạo ra văn bản

    • text-to-speech - Dành cho các mô hình tạo âm thanh từ văn bản

    • Giấy phép: Thông tin giấy phép rất quan trọng để người dùng hiểu cách họ có thể sử dụng mô hình.

  3. Bài báo nghiên cứu: Nếu mô hình của bạn có các bài báo liên quan, hãy trích dẫn chúng trong thẻ mô hình. Chúng sẽ được liên kết chéo tự động.

    ## References

* [Model Paper](https://arxiv.org/abs/xxxx.xxxxx)

  4. Bộ sưu tập: Nếu bạn phát hành nhiều mô hình hoặc biến thể liên quan, hãy tổ chức chúng thành một bộ sưu tập. Bộ sưu tập giúp người dùng khám phá các mô hình liên quan và hiểu mối quan hệ giữa các phiên bản.

  5. Các bản demo: Tạo một Hugging Face Space với bản demo tương tác. Điều này cho phép người dùng thử nghiệm mô hình của bạn mà không cần viết mã. Bạn cũng có thể liên kết mô hình từ Space để nó xuất hiện trên giao diện trang mô hình.

    ## Demo

Try this model directly in your browser: [Space Demo](https://huggingface.co/spaces/username/model-demo)

    Khi bạn tạo một demo, hãy tải mô hình từ kho Hub của nó (không phải từ các nguồn bên ngoài như Google Drive). Điều này tạo liên kết chéo giữa các sản phẩm và cải thiện khả năng hiển thị

  6. Các phiên bản lượng tử hóa: Hãy cân nhắc tải lên các phiên bản lượng tử hóa (ví dụ: GGUF) trên một kho lưu trữ riêng để cải thiện khả năng tiếp cận cho người dùng có tài nguyên tính toán hạn chế. Liên kết các phiên bản này bằng trường metadata base_model trên các thẻ mô hình lượng tử hóa, và tài liệu hóa các khác biệt về hiệu suất.

    ---
base_model: username/original-model
base_model_relation: quantized
---
    model tree showcasing relations
    Cây mô hình hiển thị các phiên bản lượng tử hóa

  7. Liên kết Datasets trên Trang Model: Liên kết các dataset trong metadata của bạn để chúng hiển thị trực tiếp trên trang model của bạn.

    ---
datasets:
- username/dataset
- username/dataset-2
---

  8. Phiên bản Mô hình Mới: Nếu mô hình của bạn là bản cập nhật của một mô hình hiện có, hãy chỉ định điều này trên thẻ của mô hình cũ. Thao tác này sẽ hiển thị một banner trên trang cũ, liên kết đến bản cập nhật.

    ---
new_version: username/updated-model
---

  9. Ví dụ trực quan: Đối với các mô hình tạo ảnh hoặc video, hãy bao gồm các ví dụ trực tiếp trên trang mô hình của bạn bằng cách sử dụng thành phần thẻ <Gallery>.

    <Gallery>
![Example 1](./images/example1.png)
![Example 2](./images/example2.png)
</Gallery>

  10. Khí thải carbon: Nếu có thể, hãy chỉ rõ lượng khí thải carbon từ quá trình huấn luyện.

    ---
co2_eq_emissions:
  emissions: 123.45
  source: "CodeCarbon"
  training_type: "pre-training"
  geographical_location: "US-East"
  hardware_used: "8xA100 GPUs"
---

Kiểm soát truy cập và khả năng hiển thị

  1. Cài đặt hiển thị: Khi sẵn sàng chia sẻ mô hình của bạn, hãy chuyển nó sang công khai trong cài đặt mô hình. Trước khi thực hiện, hãy kiểm tra kỹ tất cả tài liệu và ví dụ mã để đảm bảo chúng chính xác và đầy đủ.

  2. Truy cập có kiểm soát: Nếu mô hình của bạn cần truy cập có kiểm soát, hãy sử dụng chức năng truy cập có kiểm soát và nêu rõ các điều kiện mà người dùng phải đáp ứng. Điều này rất quan trọng đối với các mô hình có lo ngại về sử dụng kép hoặc các hạn chế thương mại.

🏁 Sau khi phát hành mô hình của bạn

Việc phát hành mô hình thành công không dừng lại ở lần công bố ban đầu. Để duy trì chất lượng và tối đa hóa tác động:

Bảo trì và Tương tác Cộng đồng

  1. Đảm bảo chức năng: Sau khi phát hành, hãy kiểm tra tất cả các đoạn mã trong một môi trường sạch để xác nhận chúng hoạt động như mong đợi. Điều này đảm bảo người dùng có thể chạy mô hình của bạn mà không gặp lỗi hay nhầm lẫn.

    Ví dụ, nếu mô hình của bạn là một LLM tương thích với transformers:

    from transformers import pipeline

# This should run without errors
pipe = pipeline("text-generation", model="your-username/your-model")
result = pipe("Your test prompt")
print(result)

  2. Chia sẻ Chia sẻ Chia sẻ: Hầu hết người dùng khám phá các mô hình thông qua mạng xã hội, các kênh trò chuyện (như Slack hoặc Discord), hoặc bản tin. Hãy chia sẻ liên kết mô hình của bạn trong các không gian này, đồng thời thêm chúng vào trang web hoặc kho GitHub của bạn.

    Mô hình của bạn càng nhận được nhiều lượt truy cập và lượt thích, nó càng xuất hiện cao hơn trong phần Hugging Face Trending, từ đó mang lại thêm độ phủ

  3. Tương tác với cộng đồng: Sử dụng tab Cộng đồng để trả lời câu hỏi, xử lý phản hồi và giải quyết sự cố một cách kịp thời. Làm rõ những điểm gây nhầm lẫn, chấp nhận các đề xuất hữu ích và đóng các luồng thảo luận lạc đề để giữ cho cuộc thảo luận tập trung.

Thêm Kết Quả Đánh Giá

Nếu bạn đánh giá trên bất kỳ dataset chuẩn được hỗ trợ trên Hub, bạn có thể thêm kết quả đánh giá vào kho model của mình. Điều này sẽ hiển thị điểm chuẩn trực tiếp trên trang model và bảng xếp hạng chuẩn trong kho dataset. Xem tài liệu về Kết quả đánh giá để biết thông số kỹ thuật đầy đủ.

Để thêm kết quả đánh giá, hãy tạo các tệp YAML trong thư mục .eval_results/ của kho lưu trữ mô hình của bạn. Mỗi tệp tham chiếu đến một bộ dữ liệu Hub Benchmark:

# .eval_results/gpqa.yaml
- dataset:
    id: Idavidrein/gpqa
    task_id: diamond
  value: 76.1
  date: "2026-03-19"
  source:
    url: https://huggingface.co/your-org/your-model
    name: Model Card
    user: your-username

task_id phải khớp với một tác vụ được định nghĩa trong eval.yaml của bộ dữ liệu benchmark. Bạn có thể tìm các benchmark khả dụng và ID tác vụ của chúng bằng cách kiểm tra tệp eval.yaml trong các kho dữ liệu benchmark như HLE.

Bất kỳ ai trong cộng đồng cũng có thể gửi kết quả đánh giá cho bất kỳ model nào bằng cách mở một Pull Request. Điểm do cộng đồng gửi sẽ hiển thị huy hiệu “community” trên trang của model. Để đơn giản hóa quy trình này, bạn có thể sử dụng kho community-evals, nơi cung cấp các script và một agent skill để trích xuất điểm từ model cards và tạo PR tự động.

Theo dõi mức sử dụng và tác động

  1. Chỉ số sử dụng: Theo dõi lượt tải xuống và lượt thích để hiểu phạm vi tiếp cận và mức độ áp dụng của mô hình của bạn. Bạn có thể xem các chỉ số tổng về lượt tải xuống trong cài đặt của mô hình.

  2. Đánh giá các đóng góp từ cộng đồng: Thường xuyên kiểm tra kho lưu trữ mô hình của bạn để xem các đóng góp từ người dùng khác. Các yêu cầu kéo (pull request) và thảo luận từ cộng đồng có thể cung cấp phản hồi hữu ích, ý tưởng và cơ hội hợp tác.

🏢 Tính năng dành cho doanh nghiệp

Gói đăng ký Hugging Face Team & Enterprise cung cấp các tính năng bổ sung cho các nhóm và tổ chức:

  1. Quản lý truy cập: Cài đặt các nhóm tài nguyên để quản lý quyền truy cập cho các nhóm hoặc người dùng cụ thể. Điều này đảm bảo các quyền phù hợp và hợp tác an toàn trong toàn tổ chức của bạn.

  2. Khu vực lưu trữ: Chọn khu vực lưu trữ dữ liệu (Mỹ hoặc EU) cho các tệp mô hình của bạn để đáp ứng các quy định và yêu cầu tuân thủ về dữ liệu theo khu vực.

  3. Phân tích nâng cao: Sử dụng Publisher Analytics để có được những hiểu biết sâu hơn về các mẫu sử dụng mô hình, lượt tải xuống và xu hướng áp dụng trong tổ chức của bạn.

  4. Lưu trữ mở rộng: Truy cập thêm dung lượng lưu trữ riêng tư để lưu trữ nhiều mô hình và các sản phẩm lớn hơn khi danh mục mô hình của bạn mở rộng.

  5. Bài đăng trên blog của tổ chức: Các tổ chức doanh nghiệp giờ đây có thể đăng tải bài viết blog trực tiếp trên Hugging Face. Tính năng này cho phép bạn chia sẻ các bản phát hành mô hình, cập nhật nghiên cứu và thông báo với cộng đồng rộng lớn hơn, tất cả đều từ hồ sơ tổ chức của bạn.

Bằng cách tuân theo các hướng dẫn và ví dụ này, bạn sẽ giúp việc phát hành mô hình của mình trên Hugging Face trở nên rõ ràng, hữu ích và có tác động. Điều này giúp công việc của bạn tiếp cận nhiều người hơn, củng cố cộng đồng AI và tăng khả năng hiển thị cho mô hình của bạn.

Chúng tôi không thể chờ đợi để xem điều gì bạn sẽ chia sẻ tiếp theo! 🤗

Update on GitHub

←Thống kê tải xuống các mô hình Phần cứng→