Hub 文件
帶註釋的模型卡模板
並獲得增強的文件體驗
開始使用
帶註釋的模型卡模板
模板
說明
完整填寫模型卡需要不同角色的輸入。（一個人可以扮演多個角色。）我們將這些角色稱為**開發者**，負責編寫程式碼和執行訓練；**社會技術人員**，擅長長期分析技術和社會互動（包括律師、倫理學家、社會學家或權利倡導者）；以及**專案組織者**，負責瞭解模型的總體範圍和影響力，大致填寫卡片的每個部分，並作為模型卡更新的聯絡人。
**開發者**需要填寫訓練過程和技術規格。他們對偏見、風險和限制中的“限制”部分也特別有用。他們負責提供評估的結果，並理想情況下與其他角色協作定義評估的其餘部分：測試資料、因素和指標。
**專案組織者**需要填寫模型詳情和用途。他們也可以填寫訓練資料。專案組織者還可以負責引用、詞彙表、模型卡聯絡人、模型卡作者和更多資訊。
說明在下方以斜體顯示。
模板變數名以等寬字型顯示。
模型名稱
章節概述：提供模型名稱和對模型的 1-2 句總結。
model_id
model_summary
目錄
章節概述：提供此部分並附帶指向每個章節的連結，以便人們輕鬆跳轉/在其他位置使用保留的 TOC/列印內容/等。
模型詳情
章節概述：本節提供有關模型的名稱、當前狀態以及來源的基本資訊。對於任何想要引用模型的人來說，它都應該是有用的。
模型描述
model_description
提供有關模型的基本詳細資訊。這包括架構、版本、是否在論文中介紹、是否有原始實現以及建立者。任何版權都應在此處註明。有關訓練過程、引數和重要免責宣告的一般資訊也可以在本節中提及。
- 開發人員：
developers
列出（最好連結到）構建模型的人員。
- 資助方：
funded_by
列出（最好連結到）在財務、計算或其他方面支援或促成此模型的資助來源。
- 共享者 [可選]：
shared_by
列出（最好連結到）在網上提供模型的人員/組織。
- 模型型別：
model_type
您可以將“型別”命名為
1. 監督/學習方法
2. 機器學習型別
3. 模態
- 語言(s) [NLP]：
language
當系統使用或處理自然（人類）語言時，請使用此欄位。
- 許可證：
license
命名並連結到正在使用的許可證。
- 從以下模型微調 [可選]：
base_model
如果此模型以另一個模型為基礎，請在此處連結到該模型。
模型來源（可選）
- 倉庫：
repo - 論文 [可選]：
paper - 演示 [可選]：
demo
提供使用者可以直接檢視模型及其詳細資訊的來源。其他型別的資源——訓練日誌、經驗教訓等——應放在更多資訊部分。如果此部分只包含一項內容，請連結到倉庫。
用途
章節概述：本節討論模型在不同應用場景中的預期用途，討論模型的潛在使用者（包括受模型影響的使用者），並描述超出範圍或濫用模型的用途。請注意，本節不旨在包含許可證使用詳細資訊。為此，請直接連結到許可證。
直接使用
direct_use
解釋如何在不進行微調、後處理或插入管道的情況下使用模型。建議提供一個示例程式碼片段。
下游使用（可選）
downstream_use
解釋當模型針對特定任務進行微調或插入到更大的生態系統或應用程式中時，如何使用此模型。建議提供一個示例程式碼片段。
超出範圍的使用
out_of_scope_use
列出模型可能被誤用（以無法正常工作的方式使用）的方式，並說明使用者不應該對模型做什麼。
偏見、風險和限制
章節概述：本節識別可預見的危害、誤解以及技術和社會技術限制。它還提供有關警告和潛在緩解措施的資訊。偏見、風險和限制有時是不可分割的/指代相同的問題。通常，偏見和風險是社會技術方面的，而限制是技術方面的。
- 偏見是針對某些子人群的刻板印象或不成比例的表現（偏差）。
- 風險是模型可能引起的一個社會相關問題。
- 限制是可能透過遵循列出的建議來解決的常見故障模式。
bias_risks_limitations
該模型已知或可預見的問題有哪些？
建議
bias_recommendations
針對可預見的問題有哪些建議？這可以包括從“下采樣影像”到過濾顯式內容的一切。
訓練詳情
章節概述：本節提供描述和重現訓練所需的資訊，包括訓練資料、訓練元素的速度和大小以及訓練對環境的影響。這與技術規範也密切相關，此處內容應在與訓練過程相關時連結到該章節。對於想要了解模型輸入和訓練足跡的人來說，它很有用。對於任何想要了解模型學習基礎知識的人來說，它都相關。
訓練資料
training_data
用 1-2 句話說明訓練資料是什麼。理想情況下，此處應連結到資料集卡以獲取更多資訊。有關資料預處理或額外過濾的文件連結也可以放在此處以及更多資訊中。
訓練過程（可選）
預處理
preprocessing
詳細說明標記化、調整大小/重寫（取決於模態）等。
速度、大小、時間
speeds_sizes_times
詳細說明吞吐量、開始/結束時間、檢查點大小等。
評估
章節概述：本節描述評估協議，評估中衡量的內容，並提供結果。評估理想情況下至少有兩部分，一部分著眼於一般效能的定量測量（測試資料、因素和指標），例如透過基準測試完成；另一部分著眼於特定社會安全問題的效能（社會影響評估），例如透過紅隊測試完成。您還可以以結構化方式在模型卡元資料中指定模型的評估結果。結果由 Hub 解析並顯示在模型頁面的小部件中。請參閱https://huggingface.co/docs/hub/model-cards#evaluation-results。
測試資料、因素和指標
評估理想情況下應根據不同因素（例如任務、領域和人口子群）進行**分解**，並使用對可預見的使用場景最有意義的指標進行計算。不同子群的評估效能相等被認為是這些子群之間的“公平”；應根據模型使用中哪些錯誤更可能成為問題來確定目標公平性指標。但是，本節最常用於報告不同任務基準的彙總評估效能。
測試資料
testing_data
描述測試資料或連結到其資料集卡片。
因素
testing_factors
哪些可預見的特徵將影響模型的行為？評估理想情況下應根據這些因素進行分解，以揭示效能差異。
指標
testing_metrics
將用於評估的指標是什麼？
結果
results
結果應基於上面定義的因素和指標。
總結
results_summary
結果說明了什麼？這可以作為普通受眾的總結。
社會影響評估（可選）
使用此自由文字部分解釋如何評估該模型是否存在社會危害風險，例如兒童安全、NCII、隱私和暴力。這可能以回答以下問題的形式出現：
- 此模型是否對兒童安全？為什麼或為什麼不？
- 此模型是否已測試以評估與非自願私密影像（包括 CSEM）相關的風險？
- 此模型是否已測試以評估與暴力活動或暴力描繪相關的風險？結果如何？
也可以提供每個問題的定量資料。
模型檢查（可選）
章節概述：這是一個實驗性章節，一些開發者開始新增，其中可能包含可解釋性/可理解性方面的工作。
model_examination
環境影響
章節概述：總結計算電力使用和碳排放等環境影響所需的資訊。
- 硬體型別：
hardware_type - 使用小時數：
hours_used - 雲提供商：
cloud_provider - 計算區域：
cloud_region - 碳排放量：
co2_emitted
碳排放量可以使用 Lacoste 等人（2019 年）提出的機器學習影響計算器估算。
技術規範（可選）
章節概述：本節包括有關模型目標和架構以及計算基礎設施的詳細資訊。對於對模型開發感興趣的人來說，它很有用。編寫本節通常需要模型開發人員直接參與。
模型架構和目標
model_specs
計算基礎設施
compute_infrastructure
硬體
hardware_requirements
最低硬體要求是什麼，例如處理、儲存和記憶體要求？
軟體
software
引文（可選）
章節概述：開發者對該模型的首選引文。這通常是一篇論文。
BibTeX
citation_bibtex
APA
citation_apa
詞彙表（可選）
章節概述：本節定義常用術語和指標的計算方法。
glossary
清晰定義術語，以便所有受眾都能理解。
更多資訊（可選）
章節概述：本節提供指向資料集建立、技術規範、經驗教訓和初始結果的文章連結。
more_information
模型卡作者（可選）
章節概述：本章節列出了模型卡的建立者，對模型卡的詳細工作進行認可和問責。
model_card_authors
模型卡聯絡方式
章節概述：提供了一種讓需要更新模型卡、提出建議或有疑問的人員聯絡模型卡作者的方式。
model_card_contact
如何開始使用模型
章節概述：提供程式碼片段以演示如何使用模型。
get_started_code
請引用：Ozoani, Ezi 和 Gerchick, Marissa 和 Mitchell, Margaret。模型卡指南。Hugging Face，2022 年。https://huggingface.co/docs/hub/en/model-card-guidebook
< > 在 GitHub 上更新