You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/hub/datasets-gated.md
+18-1Lines changed: 18 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,10 @@
1
1
# Gated datasets
2
2
3
-
To give dataset creators more control over how their datasets are used, the Hub allows users to enable **User Access requests** through a dataset's **Settings** tab. Enabling this setting requires users to agree to share their contact information in order to access the dataset. The contact information is stored in a database, and dataset owners are able to download a copy of the user access report.
3
+
To give dataset creators more control over how their datasets are used, the Hub allows users to enable **User Access requests** through a dataset's **Settings** tab.
4
+
Enabling this setting requires users to agree to share their contact information and accept the dataset authors' terms and conditions in order to access the dataset.
5
+
The contact information is stored in a database, and dataset owners are able to download a copy of the user access report.
6
+
7
+
## Modifying the prompt
4
8
5
9
The User Access request dialog can be modified to include additional text and checkbox fields in the prompt. To do this, add a YAML section to the dataset's `README.md` file (create one if it does not already exist) and add an `extra_gated_fields` property. Within this property, you'll be able to add as many custom fields as you like and whether they are a `text` or `checkbox` field. An `extra_gated_prompt` property can also be included to add a customized text message.
6
10
@@ -21,6 +25,19 @@ extra_gated_fields:
21
25
22
26
The `README.md` file for a dataset is called a [Dataset Card](./datasets-cards). Visit the documentation to learn more about how to use it and to see the properties that you can configure.
23
27
28
+
## Manual approval
29
+
30
+
By default, requests to access the dataset are automatically accepted.
31
+
Dataset authors can set the approval mode to "Manual reviews" from the dataset's **Settings** tab.
32
+
Doing so enforces that each access request will be manually reviewed and approved by the dataset authors.
33
+
Only users whose access requests have been approved will be able to access the dataset's content.
In some cases, you might also want to modify the text in the heading of the gate as well as the text in the button. For those use cases you can modify `extra_gated_heading` and `extra_gated_button_content`.
Copy file name to clipboardExpand all lines: docs/hub/models-gated.md
+17-1Lines changed: 17 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,8 @@
1
1
# Gated models
2
2
3
-
To give model creators more control over how their models are used, the Hub allows users to enable **User Access requests** through a model's **Settings** tab. Enabling this setting requires users to agree to share their contact information in order to access the model. The contact information is stored in a database, and model owners are able to download a copy of the user access report.
3
+
To give model creators more control over how their models are used, the Hub allows users to enable **User Access requests** through a model's **Settings** tab.
4
+
Enabling this setting requires users to agree to share their contact information and accept the model owners' terms and conditions in order to access the model.
5
+
The contact information is stored in a database, and model owners are able to download a copy of the user access report.
4
6
5
7
Note that to download a gated model you'll need to be authenticated. You can log in by installing the [`huggingface_hub` client library](https://huggingface.co/docs/huggingface_hub/index) and running the following in your terminal:
6
8
@@ -40,6 +42,20 @@ extra_gated_fields:
40
42
41
43
The `README.md` file for a model is called a [model Card](./model-cards). Visit the documentation to learn more about how to use it and to see the properties that you can configure.
42
44
45
+
## Manual approval
46
+
47
+
By default, requests to access the model are automatically accepted.
48
+
Model authors can set the approval mode to "Manual reviews" from the model's **Settings** tab.
49
+
Doing so enforces that each access request will be manually reviewed and approved by the model authors.
50
+
Only users whose access requests have been approved will be able to access the model's content.
In some cases, you might also want to modify the text in the heading of the gate as well as the text in the button. For those use cases you can modify `extra_gated_heading` and `extra_gated_button_content`.
0 commit comments