Skip to content

Commit a130ab1

Browse files
author
Loïc Say
committed
first draft of gating group page & fixing enterprise to enterprise hub
1 parent 168c204 commit a130ab1

File tree

4 files changed

+74
-4
lines changed

4 files changed

+74
-4
lines changed

docs/hub/_toctree.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -350,6 +350,8 @@
350350
title: Analytics
351351
- local: enterprise-hub-network-security
352352
title: Network Security
353+
- local: enterprise-hub-gating-group-collections
354+
title: Network Security
353355
- local: billing
354356
title: Billing
355357
- local: security

docs/hub/datasets-gated.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,9 +125,9 @@ extra_gated_button_content: "Acknowledge license"
125125
---
126126
```
127127

128-
### Manage gated datasets as an organization (Enterprise)
128+
## Manage gated datasets as an organization (Enterprise Hub)
129129

130-
For [Enterprise](https://huggingface.co/docs/hub/en/enterprise-hub) subscribers, you can gate all the repos in a Gating Group collection, enabling **access requests** for all datasets (and/or models) in it.
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 **access requests** for all datasets (and/or models) in it.
131131

132132
More information about Gating Group collections can be found in [our doc](https://huggingface.co/docs/hub/en/enterprise-hub-gating-group-collections).
133133

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

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,71 @@
33
<Tip warning={true}>
44
This feature is part of the <a href="https://huggingface.co/enterprise">Enterprise Hub</a>.
55
</Tip>
6+
7+
Gating Group collections allows organizations to configure gate all the repos in a collection, enabling **access requests** for all models or datasets in it.
8+
9+
## Manage gating group as an organization admin
10+
11+
To enable access requests, go to the collection page and click on **Gating group** in the bottom-right corner.
12+
13+
<div class="flex justify-center" style="max-width: 750px">
14+
<img
15+
class="block dark:hidden !m-0"
16+
src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/collections/gating-group-collection-disabled.webp"
17+
alt="Hugging Face collection page with gating group collection feature disabled"
18+
/>
19+
<img
20+
class="hidden dark:block !m-0"
21+
src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/collections/dark-gating-group-collection-disabled.webp"
22+
alt="Hugging Face collection page with gating group collection feature disabled"
23+
/>
24+
</div>
25+
26+
By default, gating group is disabled: click on **Configure Access Requests** to open the settings
27+
28+
<div class="flex justify-center" style="max-width: 750px">
29+
<img
30+
class="block dark:hidden !m-0"
31+
src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/collections/gating-group-disabled.webp"
32+
alt="Hugging Face gating group collection settings with gating disabled"
33+
/>
34+
<img
35+
class="hidden dark:block !m-0"
36+
src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/collections/dark-gating-group-disabled.webp"
37+
alt="Hugging Face gating group collection settings with gating disabled"
38+
/>
39+
</div>
40+
41+
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.
42+
43+
<div class="flex justify-center" style="max-width: 750px">
44+
<img
45+
class="block dark:hidden !m-0"
46+
src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/collections/gating-group-enabling.webp"
47+
alt="Hugging Face gating group collection settings with automatic mode selected"
48+
/>
49+
<img
50+
class="hidden dark:block !m-0"
51+
src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/collections/dark-gating-group-enabling.webp"
52+
alt="Hugging Face gating group collection settings with gating with automatic mode selected"
53+
/>
54+
</div>
55+
56+
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:
57+
58+
<div class="flex justify-center" style="max-width: 750px">
59+
<img
60+
class="block dark:hidden !m-0"
61+
src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/collections/gating-group-changes.webp"
62+
alt="Hugging Face gating group collection settings with manual review mode selected"
63+
/>
64+
<img
65+
class="hidden dark:block !m-0"
66+
src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/collections/dark-gating-group-changes.webp"
67+
alt="Hugging Face gating group collection settings with manual review mode selected"
68+
69+
/>
70+
71+
</div>
72+
73+
**Notification frequency** lets you configure when to get notified if new users request 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.

docs/hub/models-gated.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,9 +139,9 @@ Possible use cases of programmatic management include:
139139
- Here's an [example repo](https://huggingface.co/Trelis/openchat_3.5-function-calling-v3) from TrelisResearch that uses this use case.
140140
- [@RonanMcGovern](https://huggingface.co/RonanMcGovern) has posted a [video about the flow](https://www.youtube.com/watch?v=2OT2SI5auQU) and tips on how to implement it.
141141

142-
### Manage gated models as an organization (Enterprise)
142+
## Manage gated models as an organization (Enterprise Hub)
143143

144-
For [Enterprise](https://huggingface.co/docs/hub/en/enterprise-hub) subscribers, you can gate all the repos in a Gating Group collection, enabling **access requests** for all models (and/or datasets) in it.
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 **access requests** for all models (and/or datasets) in it.
145145

146146
More information about Gating Group collections can be found in [our doc](https://huggingface.co/docs/hub/en/enterprise-hub-gating-group-collections).
147147

0 commit comments

Comments
 (0)