Skip to content

Commit f7ccf91

Browse files
author
Loïc Say
committed
better images and more documentation
1 parent b3081a5 commit f7ccf91

File tree

2 files changed

+68
-3
lines changed

2 files changed

+68
-3
lines changed

docs/hub/collections.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ To start adding images to your collection, you can click on the image icon in th
9494

9595
Then, add images by dragging and dropping images from your computer. You can also click on the gray zone to select image files from your computer's file system.
9696

97+
9798
![Collection image drop zone with images](https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/collections/collections-image-gallery.webp)
9899

99100
You can re-order images by drag-and-dropping them. Clicking on an image will open it in full-screen mode.

docs/hub/enterprise-hub-gating-group-collections.md

Lines changed: 67 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,17 +55,81 @@ By default, access to the repos in the collection is automatically granted to th
5555

5656
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:
5757

58+
**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.
59+
5860
<div class="flex justify-center" style="max-width: 750px">
5961
<img
6062
class="block dark:hidden !m-0"
61-
src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/collections/gating-group-modal-changes.webp"
63+
src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/collections/gating-group-modal-manual.webp"
6264
alt="Hugging Face gating group collection settings with manual review mode selected"
6365
/>
6466
<img
6567
class="hidden dark:block !m-0"
66-
src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/collections/dark-gating-group-modal-changes.webp"
68+
src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/collections/dark-gating-group-modal-manual.webp"
6769
alt="Hugging Face gating group collection settings with manual review mode selected"
6870
/>
6971
</div>
7072

71-
**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.
73+
### Review access requests
74+
75+
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.
76+
77+
#### From the UI
78+
79+
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:
80+
81+
<div class="flex justify-center" style="max-width: 750px">
82+
<img
83+
class="block dark:hidden !m-0"
84+
src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/collections/gating-group-repo-settings.webp"
85+
alt="Hugging Face repo access settings when repo is in a gating group collection"
86+
/>
87+
<img
88+
class="hidden dark:block !m-0"
89+
src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/collections/dark-gating-group-repo-settings.webp"
90+
alt="Hugging Face repo access settings when repo is in a gating group collection"
91+
/>
92+
</div>
93+
94+
This will open a modal with 3 lists of users:
95+
96+
- **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.
97+
- **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.
98+
- **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_.
99+
100+
<div class="flex justify-center" style="max-width: 750px">
101+
<img
102+
class="block dark:hidden"
103+
src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/models-gated-enabled-pending-users.png"
104+
alt="Manage access requests modal for a repo in a gating group collection"
105+
/>
106+
<img
107+
class="hidden dark:block"
108+
src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/models-gated-enabled-pending-users-dark.png"
109+
alt="Manage access requests modal for a repo in a gating group collection"
110+
/>
111+
112+
</div>
113+
114+
#### Via the API
115+
116+
## Access gated repos in a gating group as a user
117+
118+
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.
119+
120+
To know if a collection has gating group enabled, an icon will be shown next to its name:
121+
122+
<div class="flex justify-center" style="max-width: 750px">
123+
<img
124+
class="block dark:hidden !m-0"
125+
src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/collections/gating-group-collection-enabled.webp"
126+
alt="Hugging Face collection page with gating group collection feature enabled"
127+
/>
128+
<img
129+
class="hidden dark:block !m-0"
130+
src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/collections/dark-gating-group-collection-enabled.webp"
131+
alt="Hugging Face collection page with gating group collection feature enabled"
132+
/>
133+
</div>
134+
135+
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.

0 commit comments

Comments
 (0)