Hugging Face's logo

Hub documentation

Mẫu Thẻ Mô hình Có chú thích

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Mẫu Thẻ Mô hình Có chú thích

Sẵn sàng xuất bản? Xem Danh sách kiểm tra phát hành mô hình để biết các bước thiết yếu cho một bản phát hành mô hình ngắn gọn, đầy đủ thông tin và thân thiện với người dùng.

Mẫu

tệp modelcard_template.md

Hướng dẫn

Việc điền đầy đủ một model card đòi hỏi sự đóng góp từ một số vai trò khác nhau. (Một người có thể đảm nhận nhiều hơn một vai trò.) Chúng tôi sẽ gọi các vai trò này là developer, người viết mã và chạy huấn luyện; sociotechnic, người có kỹ năng phân tích tương tác giữa công nghệ và xã hội trong dài hạn (bao gồm luật sư, nhà đạo đức học, nhà xã hội học hoặc người ủng hộ quyền lợi); và project organizer, người hiểu rõ phạm vi và mức độ ảnh hưởng tổng thể của mô hình, có thể điền sơ bộ từng phần của thẻ và đóng vai trò là người liên hệ cho các bản cập nhật model card.

Các hướng dẫn được cung cấp bên dưới, in nghiêng.

Tên biến trong template được hiển thị bằng monospace.

Tên Mô hình

Tóm tắt phần: Cung cấp tên mô hình và một bản tóm tắt gồm 1-2 câu về mô hình đó.

model_id

model_summary

Mục lục

Tóm tắt phần: Cung cấp điều này kèm liên kết đến từng phần, để mọi người có thể dễ dàng nhảy đến/ sử dụng tệp ở các vị trí khác với mục lục được giữ nguyên/ in nội dung/v.v.

Chi tiết Mô hình

Tóm tắt phần: Phần này cung cấp thông tin cơ bản về mô hình là gì, trạng thái hiện tại và nguồn gốc của nó. Nó nên hữu ích cho bất kỳ ai muốn tham chiếu đến mô hình.

Mô tả Mô hình

model_description

Cung cấp các chi tiết cơ bản về mô hình. Bao gồm kiến trúc, phiên bản, có được giới thiệu trong một bài báo hay không, có sẵn bản triển khai gốc hay không, và các tác giả. Mọi bản quyền cần được ghi nhận tại đây. Thông tin chung về quy trình huấn luyện, tham số và các lưu ý quan trọng cũng có thể được đề cập trong phần này.

  • Do phát triển: developers

Liệt kê (và lý tưởng nhất là liên kết đến) những người đã xây dựng mô hình.

  • Được tài trợ bởi: funded_by

Liệt kê (và lý tưởng nhất là liên kết đến) các nguồn tài trợ đã hỗ trợ hoặc cho phép phát triển mô hình này về mặt tài chính, tính toán hoặc các khía cạnh khác.

  • Do chia sẻ [tùy chọn]: shared_by

Liệt kê (và lý tưởng nhất là liên kết đến) các cá nhân/tổ chức đang cung cấp mô hình trực tuyến.

  • Loại mô hình: model_type

Bạn có thể đặt tên cho “type” như sau:

1. Phương pháp giám sát/học

2. Loại Machine Learning

3. Chế độ

  • Ngôn ngữ [NLP]: language

Sử dụng trường này khi hệ thống sử dụng hoặc xử lý ngôn ngữ tự nhiên (ngôn ngữ con người).

  • Giấy phép: license

Tên và liên kết đến giấy phép đang được sử dụng.

  • Được tinh chỉnh từ Mô hình [tùy chọn]: base_model

Nếu mô hình này có một mô hình khác làm cơ sở, hãy liên kết đến mô hình đó tại đây.

Nguồn mô hình tùy chọn

  • Kho: repo
  • Bài báo [tùy chọn]: paper
  • Trình diễn [tùy chọn]: demo

Cung cấp nguồn để người dùng có thể xem trực tiếp mô hình và các chi tiết của nó. Các loại tài nguyên bổ sung – nhật ký huấn luyện, bài học kinh nghiệm, v.v. – thuộc phần Thông tin thêm. Nếu bạn chỉ đưa ra một mục cho phần này, hãy liên kết đến kho lưu trữ.

Cách sử dụng

Tóm tắt phần: Phần này giải đáp các câu hỏi về cách mô hình được dự định sử dụng trong các bối cảnh ứng dụng khác nhau, thảo luận về người dùng có thể dự đoán được của mô hình (bao gồm những người bị ảnh hưởng bởi mô hình) và mô tả các trường hợp sử dụng được coi là ngoài phạm vi hoặc là sự lạm dụng mô hình. Lưu ý rằng phần này không nhằm mục đích bao gồm các chi tiết về sử dụng giấy phép. Để biết thông tin đó, hãy liên kết trực tiếp đến giấy phép.

Sử dụng trực tiếp

direct_use

Giải thích cách mô hình có thể được sử dụng mà không cần tinh chỉnh, xử lý hậu kỳ hay tích hợp vào pipeline. Khuyến nghị kèm theo một đoạn mã ví dụ.

Sử dụng hạ nguồn tùy chọn

downstream_use

Giải thích cách mô hình này có thể được sử dụng khi được tinh chỉnh cho một tác vụ cụ thể hoặc khi được tích hợp vào một hệ sinh thái hoặc ứng dụng lớn hơn. Khuyến nghị bao gồm một đoạn mã minh họa.

Sử dụng ngoài phạm vi

out_of_scope_use

Liệt kê các cách mà mô hình có thể bị lạm dụng (được sử dụng theo cách mà nó sẽ không hoạt động) và nêu rõ những điều người dùng không nên làm với mô hình.

Điên, rủi ro và hạn chế

Tóm tắt phần: Phần này xác định các tác hại, sự hiểu lầm và các hạn chế kỹ thuật cũng như xã hội - kỹ thuật có thể xảy ra. Nó cũng cung cấp thông tin về các cảnh báo và các biện pháp giảm thiểu tiềm năng. Thiên kiến, rủi ro và hạn chế đôi khi không thể tách rời/nhắc đến cùng một vấn đề. Nhìn chung, thiên kiến và rủi ro mang tính xã hội - kỹ thuật, trong khi hạn chế mang tính kỹ thuật:

  • Độ chệch là một định kiến hoặc hiệu suất không cân xứng (thiên lệch) đối với một số nhóm dân cư con.
  • Một risk là một vấn đề có liên quan đến xã hội mà mô hình có thể gây ra.
  • Hạn chế là một chế độ lỗi có khả năng xảy ra, có thể được xử lý bằng cách làm theo các Khuyến nghị được liệt kê.

bias_risks_limitations

Các vấn đề đã biết hoặc có thể dự đoán được phát sinh từ mô hình này là gì?

Khuyến nghị

bias_recommendations

Đề xuất nào cho các vấn đề có thể dự đoán trước? Điều này có thể bao gồm mọi thứ từ “giảm kích thước ảnh” đến lọc nội dung nhạy cảm.

Chi tiết huấn luyện

Tóm tắt phần: Phần này cung cấp thông tin để mô tả và tái hiện quá trình huấn luyện, bao gồm dữ liệu huấn luyện, tốc độ và kích thước của các thành phần huấn luyện, cũng như tác động môi trường của việc huấn luyện. Nội dung này liên quan chặt chẽ đến Quy cách kỹ thuật, và các nội dung tại đây nên liên kết đến phần đó khi chúng liên quan đến quy trình huấn luyện. Phần này hữu ích cho những người muốn tìm hiểu sâu hơn về đầu vào của mô hình và dấu chân huấn luyện. Nó liên quan đến bất kỳ ai muốn biết những điều cơ bản về những gì mô hình đang học.

Dữ liệu huấn luyện

training_data

Viết 1-2 câu mô tả dữ liệu huấn luyện. Tốt nhất là liên kết đến Dataset Card để có thêm thông tin. Các liên kết đến tài liệu liên quan đến tiền xử lý dữ liệu hoặc lọc bổ sung cũng có thể đặt ở đây cũng như trong Thông tin thêm.

Quy trình huấn luyện tùy chọn

Tiền xử lý

preprocessing

Chi tiết hóa quá trình tokenization, resize/rewrite (tùy thuộc vào modality), v.v.

Tốc độ, Kích thước, Thời gian

speeds_sizes_times

Chi tiết thông lượng, thời gian bắt đầu/kết thúc, kích thước checkpoint, v.v.

Đánh giá

Tóm tắt phần: Phần này mô tả các giao thức đánh giá, những gì được đo lường trong quá trình đánh giá và cung cấp kết quả. Lý tưởng nhất, việc đánh giá gồm ít nhất hai phần, một phần xem xét đo lường định lượng hiệu suất chung (Dữ liệu kiểm thử, Yếu tố & Chỉ số), chẳng hạn như thực hiện qua benchmarking; và phần còn lại xem xét hiệu suất liên quan đến các vấn đề an toàn xã hội cụ thể (Đánh giá tác động xã hội), chẳng hạn như thực hiện qua red-teaming. Bạn cũng có thể chỉ định kết quả đánh giá của mô hình theo cách có cấu trúc trong metadata của model card. Kết quả sẽ được Hub phân tích và hiển thị trong một widget trên trang mô hình. Xem https://huggingface.co/docs/hub/model-cards#evaluation-results.

Dữ liệu kiểm thử, các yếu tố & chỉ số

Việc đánh giá lý tưởng nhất là được tách riêng theo các yếu tố khác nhau, chẳng hạn như tác vụ, lĩnh vực và nhóm dân cư; và được tính toán bằng các chỉ số có ý nghĩa nhất cho các ngữ cảnh sử dụng có thể dự đoán trước. Hiệu suất đánh giá ngang nhau giữa các nhóm con khác nhau được coi là “công bằng” giữa các nhóm con đó; các chỉ số công bằng mục tiêu nên được quyết định dựa trên việc những lỗi nào có khả năng gây ra vấn đề cao hơn xét theo cách sử dụng mô hình. Tuy nhiên, phần này thường được sử dụng để báo cáo hiệu suất đánh giá tổng hợp trên các bộ chuẩn đánh giá tác vụ khác nhau.

Dữ liệu kiểm thử

testing_data

Mô tả dữ liệu kiểm thử hoặc liên kết đến Thẻ Datasets của nó.

Các yếu tố

testing_factors

Những đặc điểm có thể dự đoán được nào sẽ ảnh hưởng đến cách mô hình hoạt động? Việc đánh giá lý tưởng nhất nên được tách riêng theo các yếu tố này nhằm phát hiện những khác biệt về hiệu suất.

Chỉ số

testing_metrics

Các chỉ số nào sẽ được sử dụng để đánh giá?

Kết quả

results

Kết quả nên dựa trên các Yếu tố và Chỉ số được định nghĩa ở trên.

Tóm tắt

results_summary

Kết quả cho thấy điều gì? Phần này có thể đóng vai trò như một bản tóm tắt ngắn gọn cho đối tượng độc giả nói chung.

Đánh giá tác động xã hội tùy chọn

Sử dụng phần văn bản tự do miễn phí này để giải thích cách mô hình này được đánh giá về rủi ro gây hại cho xã hội, chẳng hạn như về an toàn của trẻ em, NCII, quyền riêng tư và bạo lực. Điều này có thể được thể hiện dưới dạng câu trả lời cho các câu hỏi sau:

  • Mô hình này có an toàn cho trẻ em sử dụng không? Vì sao?
  • Mô hình này đã được kiểm tra để đánh giá các rủi ro liên quan đến hình ảnh thân mật không có sự đồng thuận (bao gồm CSEM) chưa?
  • Mô hình này đã được kiểm tra để đánh giá các rủi ro liên quan đến các hoạt động bạo lực, hoặc các hình ảnh mô tả bạo lực chưa? Kết quả là gì?

Các con số định lượng cho từng vấn đề cũng có thể được cung cấp.

Kiểm tra Mô hình tùy chọn

Tóm tắt phần: Đây là một phần thử nghiệm mà một số nhà phát triển đang bắt đầu thêm vào, nơi các công việc về khả năng giải thích/khả năng diễn giải có thể được thực hiện.

model_examination

Tác động đến môi trường

Tóm tắt phần: Tóm tắt các thông tin cần thiết để tính toán tác động môi trường như mức tiêu thụ điện và lượng khí thải carbon.

  • Loại phần cứng: hardware_type
  • Giờ đã sử dụng: hours_used
  • Nhà cung cấp đám mây: cloud_provider
  • Khu vực tính toán: cloud_region
  • Carbon phát thải: co2_emitted

Khí thải carbon có thể được ước tính bằng trình tính tác động của Machine Learning được trình bày trong Lacoste et al. (2019).

Thông số kỹ thuật tùy chọn

Tóm tắt phần: Phần này bao gồm các chi tiết về mục tiêu và kiến trúc của mô hình, cũng như hạ tầng tính toán. Nó hữu ích cho những người quan tâm đến việc phát triển mô hình. Việc viết phần này thường đòi hỏi nhà phát triển mô hình phải tham gia trực tiếp.

Kiến trúc Mô hình và Mục tiêu

model_specs

Hạ tầng tính toán

compute_infrastructure

Phần cứng

hardware_requirements

Yêu cầu phần cứng tối thiểu là gì, ví dụ như yêu cầu về xử lý, lưu trữ và bộ nhớ?

Phần mềm

software

Trích dẫn tùy chọn

Tóm tắt phần: Trích dẫn được các nhà phát triển ưu tiên cho mô hình này. Thường đây là một bài báo.

BibTeX

citation_bibtex

APA

citation_apa

Bảng thuật ngữ tùy chọn

Tóm tắt phần: Phần này định nghĩa các thuật ngữ chung và cách tính toán các chỉ số.

glossary

Định nghĩa rõ ràng các thuật ngữ để dễ tiếp cận với nhiều đối tượng.

Thông tin thêm tùy chọn

Tóm tắt phần: Phần này cung cấp các liên kết đến các bài viết về việc tạo bộ dữ liệu, thông số kỹ thuật, bài học kinh nghiệm và kết quả ban đầu.

more_information

Tác giả Thẻ Mô hình tùy chọn

Tóm tắt phần: Phần này liệt kê những người tạo thẻ mô hình, nhằm ghi nhận và đảm bảo trách nhiệm cho công việc chi tiết trong quá trình xây dựng thẻ.

model_card_authors

Liên hệ Thẻ Mô hình

Tóm tắt mục: Cung cấp cách thức để những người có cập nhật cho Thẻ Mô hình, đề xuất hoặc câu hỏi có thể liên hệ với tác giả của Thẻ Mô hình

model_card_contact

Cách bắt đầu với Mô hình

Tóm tắt mục: Cung cấp một đoạn mã để minh họa cách sử dụng mô hình.

get_started_code

Vui lòng trích dẫn như sau: Ozoani, Ezi and Gerchick, Marissa and Mitchell, Margaret. Model Card Guidebook. Hugging Face, 2022. https://huggingface.co/docs/hub/en/model-card-guidebook

Update on GitHub

←Câu hỏi thường gặp Hướng dẫn Thẻ Mô hình→