Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Gating Group Collections #1525

Merged
merged 14 commits into from
Dec 13, 2024
2 changes: 2 additions & 0 deletions docs/hub/_toctree.yml
Original file line number Diff line number Diff line change
Expand Up @@ -350,6 +350,8 @@
title: Analytics
- local: enterprise-hub-network-security
title: Network Security
- local: enterprise-hub-gating-group-collections
title: Network Security
loicsay marked this conversation as resolved.
Show resolved Hide resolved
- local: billing
title: Billing
- local: security
Expand Down
10 changes: 9 additions & 1 deletion docs/hub/collections.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Collections have many use cases:
- Showcase and share a complete project with its paper(s), dataset(s), model(s) and Space(s).
- Bookmark things you find on the Hub in categories.
- Have a dedicated page of curated things to share with others.
- Gate a group of models/datasets (Enterprise only)

This is just a list of possible uses, but remember that collections are just a way of grouping things, so use them in the way that best fits your use case.

Expand Down Expand Up @@ -54,6 +55,14 @@ Use the **history feature** to keep track of who has edited the collection.

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.

### Gating Group Collection (Enterprise only)
loicsay marked this conversation as resolved.
Show resolved Hide resolved

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.

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 files when enabled.
loicsay marked this conversation as resolved.
Show resolved Hide resolved

Please note that this feature is only available to Enterprise subscribers: more information about Gating Group Collection can be found in [our doc](https://huggingface.co/docs/hub/en/enterprise-hub-gating-group-collections).
loicsay marked this conversation as resolved.
Show resolved Hide resolved

### Ordering your collections and their items

You can use the drag and drop handles in the collections list (on the left side of your collections page) to change the order of your collections (1). The first two collections will be directly visible on your profile/organization pages.
Expand Down Expand Up @@ -85,7 +94,6 @@ To start adding images to your collection, you can click on the image icon in th

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.


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

You can re-order images by drag-and-dropping them. Clicking on an image will open it in full-screen mode.
Expand Down
6 changes: 6 additions & 0 deletions docs/hub/datasets-gated.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,12 @@ extra_gated_button_content: "Acknowledge license"
---
```

## Manage gated datasets as an organization (Enterprise Hub)

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.

More information about Gating Group collections can be found in [our doc](https://huggingface.co/docs/hub/en/enterprise-hub-gating-group-collections).
loicsay marked this conversation as resolved.
Show resolved Hide resolved

## Access gated datasets as a user


Expand Down
71 changes: 71 additions & 0 deletions docs/hub/enterprise-hub-gating-group-collections.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Gating Group Collections

<Tip warning={true}>
This feature is part of the <a href="https://huggingface.co/enterprise">Enterprise Hub</a>.
</Tip>

Gating Group collections allows organizations to configure gate all the repos in a collection, enabling **access requests** for all models or datasets in it.
loicsay marked this conversation as resolved.
Show resolved Hide resolved

## Manage gating group as an organization admin

To enable access requests, go to the collection page and click on **Gating group** in the bottom-right corner.

<div class="flex justify-center" style="max-width: 750px">
<img
class="block dark:hidden !m-0"
src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/collections/gating-group-collection-disabled.webp"
alt="Hugging Face collection page with gating group collection feature disabled"
/>
<img
class="hidden dark:block !m-0"
src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/collections/dark-gating-group-collection-disabled.webp"
alt="Hugging Face collection page with gating group collection feature disabled"
/>
</div>
loicsay marked this conversation as resolved.
Show resolved Hide resolved

By default, gating group is disabled: click on **Configure Access Requests** to open the settings

<div class="flex justify-center" style="max-width: 750px">
<img
class="block dark:hidden !m-0"
src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/collections/gating-group-disabled.webp"
loicsay marked this conversation as resolved.
Show resolved Hide resolved
alt="Hugging Face gating group collection settings with gating disabled"
/>
<img
class="hidden dark:block !m-0"
src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/collections/dark-gating-group-disabled.webp"
loicsay marked this conversation as resolved.
Show resolved Hide resolved
alt="Hugging Face gating group collection settings with gating disabled"
/>
</div>

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.
loicsay marked this conversation as resolved.
Show resolved Hide resolved

<div class="flex justify-center" style="max-width: 750px">
<img
class="block dark:hidden !m-0"
src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/collections/gating-group-enabling.webp"
alt="Hugging Face gating group collection settings with automatic mode selected"
/>
<img
class="hidden dark:block !m-0"
src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/collections/dark-gating-group-enabling.webp"
alt="Hugging Face gating group collection settings with gating with automatic mode selected"
loicsay marked this conversation as resolved.
Show resolved Hide resolved
/>
</div>

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:
loicsay marked this conversation as resolved.
Show resolved Hide resolved

<div class="flex justify-center" style="max-width: 750px">
<img
class="block dark:hidden !m-0"
src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/collections/gating-group-changes.webp"
alt="Hugging Face gating group collection settings with manual review mode selected"
/>
<img
class="hidden dark:block !m-0"
src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/collections/dark-gating-group-changes.webp"
alt="Hugging Face gating group collection settings with manual review mode selected"
/>
</div>

**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.
loicsay marked this conversation as resolved.
Show resolved Hide resolved
1 change: 1 addition & 0 deletions docs/hub/enterprise-hub.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,6 @@ In this section we will document the following Enterprise Hub features:
- [Tokens Management](./enterprise-hub-tokens-management)
- [Analytics](./enterprise-hub-analytics)
- [Network Security](./enterprise-hub-network-security)
- [Gating Group Collections](./enterprise-hub-gating-group-collections)

Finally, Enterprise Hub includes 1TB of [private repository storage](./storage-limits) per seat in the subscription, i.e. if your organization has 40 members, then you have 40TB included storage for your private models and datasets.
6 changes: 6 additions & 0 deletions docs/hub/models-gated.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,12 @@ Possible use cases of programmatic management include:
- Here's an [example repo](https://huggingface.co/Trelis/openchat_3.5-function-calling-v3) from TrelisResearch that uses this use case.
- [@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.

## Manage gated models as an organization (Enterprise Hub)

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.
loicsay marked this conversation as resolved.
Show resolved Hide resolved

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

## Access gated models as a user


Expand Down
Loading