受限資料集

為了更好地控制資料集的使用方式，Hub 允許資料集作者為其資料集啟用**訪問請求**。啟用後，使用者必須同意與資料集作者共享其聯絡資訊（使用者名稱和電子郵件地址）才能訪問資料集檔案。資料集作者可以透過附加欄位配置此請求。啟用訪問請求的資料集稱為**受限資料集**。訪問請求始終授予給單個使用者，而不是整個組織。受限資料集的常見用例是在廣泛釋出之前提供對早期研究資料集的訪問許可權。

作為資料集作者管理受限資料集

要啟用訪問請求，請轉到資料集設定頁面。預設情況下，資料集不受限制。點選右上角的**啟用訪問請求**。

預設情況下，當用戶請求訪問資料集時，訪問許可權會自動授予給該使用者。這被稱為**自動批准**。在此模式下，任何使用者在與您共享其個人資訊後，都可以訪問您的資料集。

如果您想手動批准哪些使用者可以訪問您的資料集，則必須將其設定為**手動批准**。在這種情況下，您會看到更多選項

“**新增訪問許可權**”允許您搜尋使用者並授予他們訪問許可權，即使他們沒有請求。
“**通知頻率**”允許您配置何時收到新使用者請求訪問的通知。可以設定為每天一次或即時。預設情況下，電子郵件會發送到您的主要電子郵件地址。對於組織託管的資料集，電子郵件預設傳送給組織的前 5 名管理員。在兩種情況下（使用者或組織），您都可以在“**通知電子郵件**”欄位中設定不同的電子郵件地址。

審查訪問請求

啟用訪問請求後，您可以完全控制誰可以訪問您的資料集，無論審批模式是手動還是自動。您可以從 UI 或透過 API 審查和管理請求。

從 UI

您可以透過單擊**檢視訪問請求**按鈕，從資料集設定頁面檢視誰有權訪問您的受限資料集。這將開啟一個包含 3 個使用者列表的模態框

**待處理**：等待批准以訪問您資料集的使用者列表。除非您選擇了**手動批准**，否則此列表為空。您可以**接受**或**拒絕**該請求。如果請求被拒絕，則使用者無法訪問您的資料集，也無法再次請求訪問。
**已接受**：有權訪問您資料集的完整使用者列表。您可以隨時選擇**拒絕**任何使用者的訪問許可權，無論批准模式是手動還是自動。您還可以**取消**批准，這將把使用者移動到*待處理*列表。
**已拒絕**：您手動拒絕的使用者列表。這些使用者無法訪問您的資料集。如果他們訪問您的資料集儲存庫，他們將看到一條訊息：“您訪問此儲存庫的請求已被儲存庫作者拒絕”。

透過 API

您可以使用 API 自動化訪問請求的批准。您必須傳遞一個對受限儲存庫具有 `write` 訪問許可權的 `token`。要生成令牌，請轉到您的使用者設定。

方法	URI	描述	標頭	有效負載
`GET`	`/api/datasets/{repo_id}/user-access-request/pending`	檢索待處理請求列表。	`{"authorization": "Bearer $token"}`
`GET`	`/api/datasets/{repo_id}/user-access-request/accepted`	檢索已接受請求列表。	`{"authorization": "Bearer $token"}`
`GET`	`/api/datasets/{repo_id}/user-access-request/rejected`	檢索已拒絕請求列表。	`{"authorization": "Bearer $token"}`
`POST`	`/api/datasets/{repo_id}/user-access-request/handle`	將給定訪問請求的狀態更改為 `status`。	`{"authorization": "Bearer $token"}`	`{"status": "accepted"/"rejected"/"pending", "user": "username", "rejectionReason": "可選的拒絕原因，對使用者可見（最多 200 個字元）。"}}`
`POST`	`/api/datasets/{repo_id}/user-access-request/grant`	允許特定使用者訪問您的儲存庫。	`{"authorization": "Bearer $token"}`	`{"user": "username"}`

上述 HTTP 端點的基本 URL 是 `https://huggingface.co`。

**新功能！**這些端點現在已正式支援我們的 Python 客戶端 `huggingface_hub`。使用 `list_pending_access_requests`、`list_accepted_access_requests` 和 `list_rejected_access_requests` 列出您資料集的訪問請求。您還可以使用 `accept_access_request`、`cancel_access_request`、`reject_access_request` 接受、取消和拒絕訪問請求。最後，您可以使用 `grant_access` 授予使用者訪問許可權。

下載訪問報告

您可以使用**下載使用者訪問報告**按鈕下載受限資料集的所有訪問請求報告。單擊它以下載包含使用者列表的 JSON 檔案。每個條目都有

**使用者**：使用者 ID。示例：*julien-c*。
**全名**：Hub 上使用者的姓名。示例：*Julien Chaumond*。
**狀態**：請求狀態。可以是 `“pending”`、`“accepted”` 或 `“rejected”`。
**電子郵件**：使用者的電子郵件。
**時間**：使用者最初提出請求的日期時間。

自定義請求資訊

預設情況下，訪問您受限資料集的使用者將被要求透過點選**同意併發送訪問儲存庫請求**按鈕來分享他們的聯絡資訊（電子郵件和使用者名稱）。

如果您想請求更多使用者資訊以提供訪問許可權，您可以配置其他欄位。此資訊將從**設定**選項卡中訪問。為此，請在您的資料集卡片元資料中新增一個 `extra_gated_fields` 屬性，其中包含鍵/值對列表。*鍵*是欄位的名稱，*值*是其型別或包含 `type` 欄位的物件。欄位型別列表是

`text`：單行文字欄位。
`checkbox`：複選框欄位。
`date_picker`：日期選擇器欄位。
`country`：國家下拉列表。國家列表基於 ISO 3166-1 alpha-2 標準。
`select`：帶有選項列表的下拉選單。選項列表在 `options` 欄位中定義。示例：`options: ["option 1", "option 2", {label: "option3", value: "opt3"}]`。

最後，您還可以使用 `extra_gated_prompt` 額外欄位個性化顯示給使用者的訊息。

這是一個自定義請求表單的示例，其中要求使用者提供其公司名稱和國家/地區，並確認該資料集僅用於非商業用途。

---
extra_gated_prompt: "You agree to not use the dataset to conduct experiments that cause harm to human subjects."
extra_gated_fields:
  Company: text
  Country: country
  Specific date: date_picker
  I want to use this dataset for:
    type: select
    options: 
      - Research
      - Education
      - label: Other
        value: other
  I agree to use this dataset for non-commercial use ONLY: checkbox
---

在某些情況下，您可能還希望修改閘道器標題、描述和按鈕中的預設文字。對於這些用例，您可以像這樣修改 `extra_gated_heading`、`extra_gated_description` 和 `extra_gated_button_content`

---
extra_gated_heading: "Acknowledge license to accept the repository"
extra_gated_description: "Our team may take 2-3 days to process your request"
extra_gated_button_content: "Acknowledge license"
---

作為組織（企業中心）管理受限資料集

企業中心訂閱者可以建立閘道器組集合，以一次性授予（或拒絕）對集合中所有模型和資料集的訪問許可權。

有關閘道器組集合的更多資訊，請參閱我們的專用文件。

作為使用者訪問受限資料集

作為使用者，如果您想使用受限資料集，則需要請求訪問許可權。這意味著您必須登入 Hugging Face 使用者帳戶。

只能透過瀏覽器請求訪問。轉到 Hub 上的資料集，系統將提示您共享您的資訊

單擊**同意**，即表示您同意與資料集作者共享您的使用者名稱和電子郵件地址。在某些情況下，可能會要求提供其他欄位。為了幫助資料集作者決定是否授予您訪問許可權，請儘量完整填寫表格。

一旦訪問請求發出，有兩種可能性。如果審批機制是自動的，您將立即獲得資料集檔案的訪問許可權。否則，請求必須由作者手動批准，這可能需要更多時間。

資料集作者對資料集訪問擁有完全控制權。特別是，他們可以隨時決定阻止您訪問資料集，恕不另行通知，無論審批機制如何或您的請求是否已獲批准。

下載檔案

要從受限資料集下載檔案，您需要進行身份驗證。在瀏覽器中，只要您登入了您的帳戶，這都是自動的。如果您正在使用指令碼，您需要提供一個使用者令牌。在 Hugging Face Python 生態系統（`transformers`、`diffusers`、`datasets` 等）中，您可以使用`huggingface_hub` 庫登入您的機器，並在終端中執行

hf auth login

或者，您可以使用筆記本或指令碼中的 `login()` 進行程式設計登入

>>> from huggingface_hub import login
>>> login()

您還可以直接在指令碼中為庫中的大多數載入方法（`from_pretrained`、`hf_hub_download`、`load_dataset` 等）提供 `token` 引數。

有關如何登入的更多詳細資訊，請檢視登入指南。

< > 在 GitHub 上更新