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/collections.md
+3-5Lines changed: 3 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,13 +55,11 @@ Use the **history feature** to keep track of who has edited the collection.
55
55
56
56
Set your collection to **private** if you don't want it to be accessible via its URL (it will not be displayed on your profile/organization page). For organizations, private collections are only available to members of the organization.
57
57
58
-
### Gating Group Collection (Enterprise Hub)
58
+
### Gating Group Collections (Enterprise Hub)
59
59
60
-
For [Enterprise Hub](https://huggingface.co/docs/hub/en/enterprise-hub) subscribers, you can gate all the repos in a collection, enabling **a single access requests** for all models and datasets in it.
60
+
You can use a collection to [gate](https://huggingface.co/docs/hub/en/models-gated)all the models/datasets belonging to it, allowing you to grant (or reject) access to all of them at once.
61
61
62
-
This feature allows you to restrict access to specific collections: users must agree to share their contact information (username and email address) with the organization to access the models and datasets in a gating group collection.
63
-
64
-
Please note that this feature is only available to Enterprise Hub subscribers: more information about Gating Group Collection can be found in [our doc](https://huggingface.co/docs/hub/en/enterprise-hub-gating-group-collections).
62
+
This feature is reserved for [Enterprise Hub](https://huggingface.co/docs/hub/en/enterprise-hub) subscribers: more information about Gating Group Collections can be found in [our dedicated doc](https://huggingface.co/docs/hub/en/enterprise-hub-gating-group-collections).
## Manage gated datasets as an organization (Enterprise Hub)
129
129
130
-
For [Enterprise Hub](https://huggingface.co/docs/hub/en/enterprise-hub) subscribers, you can gate all the repos in a Gating Group collection, enabling **a single access requests** for all datasets (and/or models) in it.
130
+
[Enterprise Hub](https://huggingface.co/docs/hub/en/enterprise-hub) subscriberscan create a Gating Group Collection to grant (or reject) access to all the models and datasets in a collection at once.
131
131
132
-
More information about Gating Group collections can be found in [our doc](https://huggingface.co/docs/hub/en/enterprise-hub-gating-group-collections).
132
+
More information about Gating Group Collections can be found in [our dedicated doc](https://huggingface.co/docs/hub/en/enterprise-hub-gating-group-collections).
Copy file name to clipboardExpand all lines: docs/hub/enterprise-hub-gating-group-collections.md
+24-18Lines changed: 24 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,14 +4,18 @@
4
4
This feature is part of the <ahref="https://huggingface.co/enterprise">Enterprise Hub</a>.
5
5
</Tip>
6
6
7
-
Gating Group Collections allow organizations to configure gated access to all the repos in a collection, enabling **a single access request** for all the models and datasets in it.
7
+
Gating Group Collections allow organizations to grant (or reject) access to all the models and datasets in a collection at once rather than repo per repo. Users will only have to go through **a single access request**.
8
8
9
9
To enable gating group in a collection:
10
10
11
11
- collection owner must be an organization
12
12
- organization must be subscribed to Enterprise Hub
13
13
- all models and datasets in the collection must be owned by the same organization as the collection
14
-
- all models and datasets in the collection can only be in one gating group collection at once
14
+
- all models and datasets in the collection can only be in one Gating Group Collection at once
15
+
16
+
<Tip>
17
+
Gating only applies to models and datasets; any other resource part of the collection (such as a Space or a Paper) won't be affected.
18
+
<Tip>
15
19
16
20
## Manage gating group as an organization admin
17
21
@@ -45,7 +49,7 @@ By default, gating group is disabled: click on **Configure Access Requests** to
45
49
/>
46
50
</div>
47
51
48
-
By default, access to the repos in the collection is automatically granted to the user when requesting it. This is referred to as **automatic approval**. In this mode, any user can access your repos once they’ve shared their personal information with you.
52
+
By default, access to the repos in the collection is automatically granted to the user when requesting it. This is referred to as **automatic approval**. In this mode, any user can access your repos once they’ve shared their contact information with you.
@@ -60,7 +64,7 @@ By default, access to the repos in the collection is automatically granted to th
60
64
/>
61
65
</div>
62
66
63
-
If you want to manually approve which users can access repos in your collection, you must set it to **manual approval**. When this is the case, you will notice a new option:
67
+
If you want to manually approve which users can access repos in your collection, you must set it to **Manual Review**. When this is the case, you will notice a new option:
64
68
65
69
**Notification frequency** lets you configure when to get notified about new users requesting access. It can be set to once a day or real-time. By default, emails are sent to the first 5 admins of the organization. You can also set a different email address in the **Notifications email** field.
66
70
@@ -79,13 +83,13 @@ If you want to manually approve which users can access repos in your collection,
79
83
80
84
### Review access requests
81
85
82
-
Once access requests are enabled, you have full control of who can access repos in your gating group collection or not, whether the approval mode is manual or automatic. You can review and manage requests either from the UI or via the API.
86
+
Once access requests are enabled, you have full control of who can access repos in your gating group collection, whether the approval mode is manual or automatic. You can review and manage requests either from the UI or via the API.
83
87
84
88
**Approving a request for a repo in a gating group collection will automatically approve access to all repos in that collection.**
85
89
86
90
#### From the UI
87
91
88
-
You can review who has access to the repos in your gating group collection from the settings page of one of the repos of the collection by clicking on the **Review access requests** button:
92
+
You can review who has access to the repos in your Gating Group Collection from the settings page of any of the repos of the collection by clicking on the **Review access requests** button:
@@ -102,9 +106,9 @@ You can review who has access to the repos in your gating group collection from
102
106
103
107
This will open a modal with 3 lists of users:
104
108
105
-
-**pending**: the list of users waiting for approval to access your dataset. This list is empty unless you’ve selected **manual approval**. You can either **Accept** or **Reject** the demand. If the demand is rejected, the user cannot access your dataset and cannot request access again.
106
-
-**accepted**: the complete list of users with access to your dataset. You can choose to **Reject** access at any time for any user, whether the approval mode is manual or automatic. You can also **Cancel** the approval, which will move the user to the **pending** list.
107
-
-**rejected**: the list of users you’ve manually rejected. Those users cannot access your datasets. If they go to your dataset repository, they will see a message _Your request to access this repo has been rejected by the repo’s authors_.
109
+
-**pending**: the list of users waiting for approval to access your repository. This list is empty unless you’ve selected **Manual Review**. You can either **Accept** or **Reject** the demand. If the demand is rejected, the user cannot access your repository and cannot request access again.
110
+
-**accepted**: the complete list of users with access to your repository. You can choose to **Reject** access at any time for any user, whether the approval mode is manual or automatic. You can also **Cancel** the approval, which will move the user to the **pending** list.
111
+
-**rejected**: the list of users you’ve manually rejected. Those users cannot access your repositories. If they go to your repository, they will see a message _Your request to access this repo has been rejected by the repo’s authors_.
@@ -122,27 +126,27 @@ This will open a modal with 3 lists of users:
122
126
123
127
#### Via the API
124
128
125
-
Automating the approval of access requests by using the API works the same as gated models or repos.
129
+
You can programmatically manage access requests in a Gated Group Collection through the API of any of its models or datasets.
126
130
127
131
Visit our [gated models](https://huggingface.co/docs/hub/models-gated#via-the-api) or [gated datasets](https://huggingface.co/docs/hub/datasets-gated#via-the-api) documentation to know more about it.
128
132
129
133
#### Download access report
130
134
131
-
Access report download for repos in gating group collection works the same as gated models or repos.
135
+
You can download access reports for the Gated Group Collection through the settings page of any of its models or datasets.
132
136
133
137
Visit our [gated models](https://huggingface.co/docs/hub/models-gated#download-access-report) or [gated datasets](https://huggingface.co/docs/hub/datasets-gated#download-access-report) documentation to know more about it.
134
138
135
139
#### Customize requested information
136
140
137
-
Customized information requests for repos in gating group collection works the same way as gated models or repos.
138
-
139
-
Visit our [gated models](https://huggingface.co/docs/hub/models-gated#customize-requested-information) or [gated datasets](https://huggingface.co/docs/hub/datasets-gated#customize-requested-information) documentation to know more about it.
141
+
<Tipwarning={true}>
142
+
There is currently no way to customize the gate parameters and requested information in a centralized way. If you want to collect the same data no matter which collection's repository a user requests access throughout, you need to add the same gate parameters in the metadata of all the models and datasets of the collection, and keep it synced.
143
+
</Tip>
140
144
141
-
## Access gated repos in a gating group as a user
145
+
Visit our [gated models](https://huggingface.co/docs/hub/models-gated#customize-requested-information) or [gated datasets](https://huggingface.co/docs/hub/datasets-gated#customize-requested-information) documentation to know more about customizing the requested information for a given repository.
142
146
143
-
As a user, if you want to use a gated repo in a gating group collection, you will need to request access to it. This means that you must be logged in to a Hugging Face user account.
147
+
## Access gated repos in a Gating Group Collection as a user
144
148
145
-
To know if a collection has gating group enabled, an icon will be shown next to its name:
149
+
A Gated Group Collection shows a specific icon before its name:
@@ -157,4 +161,6 @@ To know if a collection has gating group enabled, an icon will be shown next to
157
161
/>
158
162
</div>
159
163
160
-
Visit our [gated models](https://huggingface.co/docs/hub/models-gated#access-gated-models-as-a-user) or [gated datasets](https://huggingface.co/docs/hub/datasets-gated#access-gated-datasets-as-a-user) documentation to know more about it.
164
+
To get access to the models and datasets in a Gated Group Collection, a single access request on the page of any of those repositories is needed. Once your request is approved, you will be able to access all the other repositories in the collection, including future ones.
165
+
166
+
Visit our [gated models](https://huggingface.co/docs/hub/models-gated#access-gated-models-as-a-user) or [gated datasets](https://huggingface.co/docs/hub/datasets-gated#access-gated-datasets-as-a-user) documentation to know more requesting access to a repository.
Copy file name to clipboardExpand all lines: docs/hub/models-gated.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -141,9 +141,9 @@ Possible use cases of programmatic management include:
141
141
142
142
## Manage gated models as an organization (Enterprise Hub)
143
143
144
-
For [Enterprise Hub](https://huggingface.co/docs/hub/en/enterprise-hub) subscribers, you can gate all the repos in a Gating Group collection, enabling **a single access request** for all the models (and/or datasets) in it.
144
+
[Enterprise Hub](https://huggingface.co/docs/hub/en/enterprise-hub) subscriberscan create a Gating Group Collection to grant (or reject) access to all the models and datasets in a collection at once.
145
145
146
-
More information about Gating Group collections can be found in [our doc](https://huggingface.co/docs/hub/en/enterprise-hub-gating-group-collections).
146
+
More information about Gating Group Collections can be found in [our dedicated doc](https://huggingface.co/docs/hub/en/enterprise-hub-gating-group-collections).
0 commit comments