資料集說明卡 (Dataset Cards)

什麼是資料集卡片？

每個資料集都可以透過儲存庫中的 README.md 檔案進行記錄。此檔案稱為資料集卡片 (dataset card)，Hugging Face Hub 會將其內容呈現於資料集的主頁面上。為了讓使用者了解如何負責任地使用這些資料，最好在其中包含有關資料集中潛在偏差的資訊。一般而言，資料集卡片有助於使用者了解資料集的內容，並提供該資料集應如何使用的背景資訊。

您也可以在卡片中新增資料集詮釋資料 (metadata)。這些詮釋資料描述了關於資料集的重要資訊，例如授權條款、語言及規模。它還包含有助於使用者在 Hub 上搜尋到資料集的標籤，以及資料檔案配置選項。標籤定義在 README.md 檔案頂端的 YAML 詮釋資料區塊中。

資料集卡片詮釋資料

資料集儲存庫會將其 README.md 呈現為資料集卡片。若要控制 Hub 顯示卡片的方式，您應該在 README 檔案中建立一個 YAML 區塊來定義一些詮釋資料。首先在頂端加上三個 ---，接著填入所有相關的詮釋資料，並在區塊結尾處使用另一組 --- 將其封閉，如下列範例所示。

language: 
- "List of ISO 639-1 code for your language"
- lang1
- lang2
pretty_name: "Pretty Name of the Dataset"
tags:
- tag1
- tag2
license: "any valid license identifier"
task_categories:
- task1
- task2

您新增至資料集卡片的詮釋資料可啟用 Hub 上的特定互動功能。例如：

• 允許使用者在 https://huggingface.co/datasets 篩選並尋找資料集。
• 如果您使用此表格右側欄位中列出的關鍵字來選擇授權，該授權將會顯示在資料集頁面上。

在 Hub 的資料集儲存庫中建立 README.md 檔案時，請使用詮釋資料介面 (Metadata UI) 來填寫主要詮釋資料。

如需查看詮釋資料欄位，請參閱詳細的資料集卡片規格。

資料集卡片建立指南

若需建立資料集卡片的逐步指南，請查看建立資料集卡片指南。

閱讀現有的資料集卡片（例如 ELI5 資料集卡片）是熟悉常見慣例的好方法。

連結論文

如果資料集卡片包含論文頁面的連結（無論是在 HF 上，還是 Arxiv 的摘要/PDF），Hub 都會提取該 arXiv ID，並以 arxiv:<PAPER ID> 的格式將其包含在資料集標籤中。點擊該標籤即可：

• 造訪論文頁面
• 在 Hub 上篩選引用相同論文的其他模型。

在此閱讀更多關於論文頁面的資訊。

強制設定資料集模態

Hub 會根據資料集包含的檔案（音訊、影片、地理空間等）自動偵測其模態。如果您想強制設定特定模態，可以在資料集卡片詮釋資料中新增一個標籤：3d、audio、geospatial、image、tabular、text、timeseries、video。

例如，若要強制將模態設定為 audio，請在資料集卡片詮釋資料中加入以下內容：

tags:
- audio

將函式庫關聯至資料集

資料集頁面會自動顯示能夠原生載入該資料集的函式庫與工具；但若您希望顯示其他特定函式庫，可以在資料集卡片詮釋資料中新增標籤：argilla、dask、datasets、distilabel、fiftyone、mlcroissant、pandas、webdataset。請參閱支援的函式庫清單以取得更多資訊，或提出新增函式庫的建議。

例如，若要將 argilla 函式庫關聯至資料集卡片，請在資料集卡片詮釋資料中加入以下內容：

tags:
- argilla