From 168c204c7f18177bd1e9dc24ebbc00eb15a7fa92 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Say?= Date: Thu, 12 Dec 2024 12:36:02 +0100 Subject: [PATCH 01/14] feat(collection): gating group --- docs/hub/collections.md | 10 +++++++++- docs/hub/datasets-gated.md | 6 ++++++ docs/hub/enterprise-hub-gating-group-collections.md | 5 +++++ docs/hub/enterprise-hub.md | 1 + docs/hub/models-gated.md | 6 ++++++ 5 files changed, 27 insertions(+), 1 deletion(-) create mode 100644 docs/hub/enterprise-hub-gating-group-collections.md diff --git a/docs/hub/collections.md b/docs/hub/collections.md index 8683f92c4..562d23340 100644 --- a/docs/hub/collections.md +++ b/docs/hub/collections.md @@ -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. @@ -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) + +For [Enterprise](https://huggingface.co/docs/hub/en/enterprise-hub) subscribers, you can gate all the repos in a collection, enabling **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. + +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). + ### 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. @@ -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. diff --git a/docs/hub/datasets-gated.md b/docs/hub/datasets-gated.md index c2e877c83..6bc198848 100644 --- a/docs/hub/datasets-gated.md +++ b/docs/hub/datasets-gated.md @@ -125,6 +125,12 @@ extra_gated_button_content: "Acknowledge license" --- ``` +### Manage gated datasets as an organization (Enterprise) + +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. + +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 datasets as a user diff --git a/docs/hub/enterprise-hub-gating-group-collections.md b/docs/hub/enterprise-hub-gating-group-collections.md new file mode 100644 index 000000000..3d9525ffe --- /dev/null +++ b/docs/hub/enterprise-hub-gating-group-collections.md @@ -0,0 +1,5 @@ +# Gating Group Collections + + +This feature is part of the Enterprise Hub. + diff --git a/docs/hub/enterprise-hub.md b/docs/hub/enterprise-hub.md index 7b4ae640a..b0e8dd100 100644 --- a/docs/hub/enterprise-hub.md +++ b/docs/hub/enterprise-hub.md @@ -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. diff --git a/docs/hub/models-gated.md b/docs/hub/models-gated.md index 4d2089a0c..fa870476e 100644 --- a/docs/hub/models-gated.md +++ b/docs/hub/models-gated.md @@ -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) + +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. + +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 From a130ab149e95dfa9edab6dcaac18cf9055b26280 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Say?= Date: Thu, 12 Dec 2024 15:31:11 +0100 Subject: [PATCH 02/14] first draft of gating group page & fixing enterprise to enterprise hub --- docs/hub/_toctree.yml | 2 + docs/hub/datasets-gated.md | 4 +- ...enterprise-hub-gating-group-collections.md | 68 +++++++++++++++++++ docs/hub/models-gated.md | 4 +- 4 files changed, 74 insertions(+), 4 deletions(-) diff --git a/docs/hub/_toctree.yml b/docs/hub/_toctree.yml index dcee8ed13..3d907de41 100644 --- a/docs/hub/_toctree.yml +++ b/docs/hub/_toctree.yml @@ -350,6 +350,8 @@ title: Analytics - local: enterprise-hub-network-security title: Network Security + - local: enterprise-hub-gating-group-collections + title: Network Security - local: billing title: Billing - local: security diff --git a/docs/hub/datasets-gated.md b/docs/hub/datasets-gated.md index 6bc198848..388e298cb 100644 --- a/docs/hub/datasets-gated.md +++ b/docs/hub/datasets-gated.md @@ -125,9 +125,9 @@ extra_gated_button_content: "Acknowledge license" --- ``` -### Manage gated datasets as an organization (Enterprise) +## Manage gated datasets as an organization (Enterprise Hub) -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. +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. More information about Gating Group collections can be found in [our doc](https://huggingface.co/docs/hub/en/enterprise-hub-gating-group-collections). diff --git a/docs/hub/enterprise-hub-gating-group-collections.md b/docs/hub/enterprise-hub-gating-group-collections.md index 3d9525ffe..4e9499458 100644 --- a/docs/hub/enterprise-hub-gating-group-collections.md +++ b/docs/hub/enterprise-hub-gating-group-collections.md @@ -3,3 +3,71 @@ This feature is part of the Enterprise Hub. + +Gating Group collections allows organizations to configure gate all the repos in a collection, enabling **access requests** for all models or datasets in it. + +## 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. + +
+ Hugging Face collection page with gating group collection feature disabled + +
+ +By default, gating group is disabled: click on **Configure Access Requests** to open the settings + +
+ Hugging Face gating group collection settings with gating disabled + +
+ +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. + +
+ Hugging Face gating group collection settings with automatic mode selected + +
+ +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: + +
+ Hugging Face gating group collection settings with manual review mode selected + + +
+ +**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. diff --git a/docs/hub/models-gated.md b/docs/hub/models-gated.md index fa870476e..1f0f01cdc 100644 --- a/docs/hub/models-gated.md +++ b/docs/hub/models-gated.md @@ -139,9 +139,9 @@ 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) +## Manage gated models as an organization (Enterprise Hub) -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. +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. More information about Gating Group collections can be found in [our doc](https://huggingface.co/docs/hub/en/enterprise-hub-gating-group-collections). From 1dbe0bac14de6b50675ab171eee47f9a0a5497ab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Say?= Date: Thu, 12 Dec 2024 15:32:55 +0100 Subject: [PATCH 03/14] fixup! first draft of gating group page & fixing enterprise to enterprise hub --- docs/hub/collections.md | 2 +- docs/hub/datasets-gated.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/hub/collections.md b/docs/hub/collections.md index 562d23340..4251b03ec 100644 --- a/docs/hub/collections.md +++ b/docs/hub/collections.md @@ -57,7 +57,7 @@ Set your collection to **private** if you don't want it to be accessible via its ### Gating Group Collection (Enterprise only) -For [Enterprise](https://huggingface.co/docs/hub/en/enterprise-hub) subscribers, you can gate all the repos in a collection, enabling **access requests** for all models and datasets in it. +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. diff --git a/docs/hub/datasets-gated.md b/docs/hub/datasets-gated.md index 388e298cb..acc6cd4a3 100644 --- a/docs/hub/datasets-gated.md +++ b/docs/hub/datasets-gated.md @@ -127,7 +127,7 @@ 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 **access requests** for all datasets (and/or models) in it. +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). From 0d69a94cbc5a6f9cfd87d8bbf160db1310ba14a2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Say?= Date: Thu, 12 Dec 2024 15:34:56 +0100 Subject: [PATCH 04/14] fix build --- docs/hub/enterprise-hub-gating-group-collections.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/hub/enterprise-hub-gating-group-collections.md b/docs/hub/enterprise-hub-gating-group-collections.md index 4e9499458..ede690cfd 100644 --- a/docs/hub/enterprise-hub-gating-group-collections.md +++ b/docs/hub/enterprise-hub-gating-group-collections.md @@ -65,9 +65,7 @@ If you want to manually approve which users can access repos in your collection, 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" - /> - **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. From 852b4a25fb284ac84482a37603b610687ce8548f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Say?= Date: Thu, 12 Dec 2024 16:09:47 +0100 Subject: [PATCH 05/14] fix image names & side menu wording --- docs/hub/_toctree.yml | 2 +- docs/hub/enterprise-hub-gating-group-collections.md | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/hub/_toctree.yml b/docs/hub/_toctree.yml index 3d907de41..f47284e8c 100644 --- a/docs/hub/_toctree.yml +++ b/docs/hub/_toctree.yml @@ -351,7 +351,7 @@ - local: enterprise-hub-network-security title: Network Security - local: enterprise-hub-gating-group-collections - title: Network Security + title: Gating Group Collections - local: billing title: Billing - local: security diff --git a/docs/hub/enterprise-hub-gating-group-collections.md b/docs/hub/enterprise-hub-gating-group-collections.md index ede690cfd..4c17c0658 100644 --- a/docs/hub/enterprise-hub-gating-group-collections.md +++ b/docs/hub/enterprise-hub-gating-group-collections.md @@ -28,12 +28,12 @@ By default, gating group is disabled: click on **Configure Access Requests** to
Hugging Face gating group collection settings with gating disabled
@@ -43,12 +43,12 @@ By default, access to the repos in the collection is automatically granted to th
Hugging Face gating group collection settings with automatic mode selected
@@ -58,12 +58,12 @@ If you want to manually approve which users can access repos in your collection,
Hugging Face gating group collection settings with manual review mode selected
From 2001363f6f957238743f6e1b00259f15e4290d8d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Say?= Date: Thu, 12 Dec 2024 16:14:35 +0100 Subject: [PATCH 06/14] fix with suggestions --- docs/hub/collections.md | 8 ++++---- docs/hub/enterprise-hub-gating-group-collections.md | 6 +++--- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/hub/collections.md b/docs/hub/collections.md index 4251b03ec..3357c7e9f 100644 --- a/docs/hub/collections.md +++ b/docs/hub/collections.md @@ -11,7 +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) +- Gate a group of models/datasets (Enterprise Hub) 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. @@ -55,13 +55,13 @@ 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) +### Gating Group Collection (Enterprise Hub) 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. +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. -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). +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). ### Ordering your collections and their items diff --git a/docs/hub/enterprise-hub-gating-group-collections.md b/docs/hub/enterprise-hub-gating-group-collections.md index 4c17c0658..a1c416e79 100644 --- a/docs/hub/enterprise-hub-gating-group-collections.md +++ b/docs/hub/enterprise-hub-gating-group-collections.md @@ -4,7 +4,7 @@ This feature is part of the Enterprise Hub. -Gating Group collections allows organizations to configure gate all the repos in a collection, enabling **access requests** for all models or datasets in it. +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. ## Manage gating group as an organization admin @@ -49,7 +49,7 @@ By default, access to the repos in the collection is automatically granted to th @@ -68,4 +68,4 @@ If you want to manually approve which users can access repos in your collection, /> -**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. +**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. From b3081a55c138c21337895a93e5d515f45f63190c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Say?= Date: Thu, 12 Dec 2024 16:16:45 +0100 Subject: [PATCH 07/14] suggestions --- docs/hub/models-gated.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/hub/models-gated.md b/docs/hub/models-gated.md index 1f0f01cdc..0d2f8fed9 100644 --- a/docs/hub/models-gated.md +++ b/docs/hub/models-gated.md @@ -141,7 +141,7 @@ Possible use cases of programmatic management include: ## 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. +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. More information about Gating Group collections can be found in [our doc](https://huggingface.co/docs/hub/en/enterprise-hub-gating-group-collections). From f7ccf910f2f1ddecd027b8909159656f73092f39 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Say?= Date: Thu, 12 Dec 2024 18:28:59 +0100 Subject: [PATCH 08/14] better images and more documentation --- docs/hub/collections.md | 1 + ...enterprise-hub-gating-group-collections.md | 70 ++++++++++++++++++- 2 files changed, 68 insertions(+), 3 deletions(-) diff --git a/docs/hub/collections.md b/docs/hub/collections.md index 3357c7e9f..2c183045f 100644 --- a/docs/hub/collections.md +++ b/docs/hub/collections.md @@ -94,6 +94,7 @@ 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. diff --git a/docs/hub/enterprise-hub-gating-group-collections.md b/docs/hub/enterprise-hub-gating-group-collections.md index a1c416e79..7f8108d3f 100644 --- a/docs/hub/enterprise-hub-gating-group-collections.md +++ b/docs/hub/enterprise-hub-gating-group-collections.md @@ -55,17 +55,81 @@ By default, access to the repos in the collection is automatically granted to th 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: +**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. +
Hugging Face gating group collection settings with manual review mode selected
-**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. +### Review access requests + +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. + +#### From the UI + +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: + +
+ Hugging Face repo access settings when repo is in a gating group collection + +
+ +This will open a modal with 3 lists of users: + +- **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. +- **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. +- **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_. + +
+ Manage access requests modal for a repo in a gating group collection + + +
+ +#### Via the API + +## Access gated repos in a gating group as a user + +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. + +To know if a collection has gating group enabled, an icon will be shown next to its name: + +
+ Hugging Face collection page with gating group collection feature enabled + +
+ +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. From 17bbe52c90192382a637e0b5f479c6682e0a328d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Say?= Date: Thu, 12 Dec 2024 19:23:48 +0100 Subject: [PATCH 09/14] adding multiple sections --- ...enterprise-hub-gating-group-collections.md | 25 +++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/docs/hub/enterprise-hub-gating-group-collections.md b/docs/hub/enterprise-hub-gating-group-collections.md index 7f8108d3f..711d0a086 100644 --- a/docs/hub/enterprise-hub-gating-group-collections.md +++ b/docs/hub/enterprise-hub-gating-group-collections.md @@ -6,6 +6,13 @@ This feature is part of the Enterpri 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. +To enable gating group in a collection: + +- collection owner must be an organization +- organization must be subscribed to Enterprise Hub +- all models and datasets in the collection must be owned by the same organization as the collection +- all models and datasets in the collection can only be in one gating group collection at once + ## 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. @@ -74,6 +81,8 @@ If you want to manually approve which users can access repos in your collection, 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. +**Approving a request for a repo in a gating group collection will automatically approve access to all repos in that collection.** + #### From the UI 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: @@ -113,6 +122,22 @@ This will open a modal with 3 lists of users: #### Via the API +Automating the approval of access requests by using the API works the same as gated models or repos. + +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. + +#### Download access report + +Access report download for repos in gating group collection works the same as gated models or repos. + +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. + +#### Customize requested information + +Customized information requests for repos in gating group collection works the same way as gated models or repos. + +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. + ## Access gated repos in a gating group as a user 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. From 36e12986e45ec1ac4cb761f70ccb69b715eb6aa4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Say?= Date: Fri, 13 Dec 2024 09:19:21 +0100 Subject: [PATCH 10/14] Apply suggestions from code review Co-authored-by: Pierric Cistac --- docs/hub/collections.md | 8 ++-- docs/hub/datasets-gated.md | 4 +- ...enterprise-hub-gating-group-collections.md | 42 +++++++++++-------- docs/hub/models-gated.md | 4 +- 4 files changed, 31 insertions(+), 27 deletions(-) diff --git a/docs/hub/collections.md b/docs/hub/collections.md index 2c183045f..d27667b02 100644 --- a/docs/hub/collections.md +++ b/docs/hub/collections.md @@ -55,13 +55,11 @@ 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 Hub) +### Gating Group Collections (Enterprise Hub) -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. +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. -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. - -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). +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). ### Ordering your collections and their items diff --git a/docs/hub/datasets-gated.md b/docs/hub/datasets-gated.md index acc6cd4a3..f4762b22e 100644 --- a/docs/hub/datasets-gated.md +++ b/docs/hub/datasets-gated.md @@ -127,9 +127,9 @@ 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. +[Enterprise Hub](https://huggingface.co/docs/hub/en/enterprise-hub) subscribers can create a Gating Group Collection to grant (or reject) access to all the models and datasets in a collection at once. -More information about Gating Group collections can be found in [our doc](https://huggingface.co/docs/hub/en/enterprise-hub-gating-group-collections). +More information about Gating Group Collections can be found in [our dedicated doc](https://huggingface.co/docs/hub/en/enterprise-hub-gating-group-collections). ## Access gated datasets as a user diff --git a/docs/hub/enterprise-hub-gating-group-collections.md b/docs/hub/enterprise-hub-gating-group-collections.md index 711d0a086..30f3534a9 100644 --- a/docs/hub/enterprise-hub-gating-group-collections.md +++ b/docs/hub/enterprise-hub-gating-group-collections.md @@ -4,14 +4,18 @@ This feature is part of the Enterprise Hub. -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. +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**. To enable gating group in a collection: - collection owner must be an organization - organization must be subscribed to Enterprise Hub - all models and datasets in the collection must be owned by the same organization as the collection -- all models and datasets in the collection can only be in one gating group collection at once +- all models and datasets in the collection can only be in one Gating Group Collection at once + + +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. + ## Manage gating group as an organization admin @@ -45,7 +49,7 @@ By default, gating group is disabled: click on **Configure Access Requests** to /> -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. +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.
-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: +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: **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. @@ -79,13 +83,13 @@ If you want to manually approve which users can access repos in your collection, ### Review access requests -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. +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. **Approving a request for a repo in a gating group collection will automatically approve access to all repos in that collection.** #### From the UI -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: +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:
+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. + -## Access gated repos in a gating group as a user +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. -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. +## Access gated repos in a Gating Group Collection as a user -To know if a collection has gating group enabled, an icon will be shown next to its name: +A Gated Group Collection shows a specific icon before its name:
-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. +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. + +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. diff --git a/docs/hub/models-gated.md b/docs/hub/models-gated.md index 0d2f8fed9..928d2f9df 100644 --- a/docs/hub/models-gated.md +++ b/docs/hub/models-gated.md @@ -141,9 +141,9 @@ Possible use cases of programmatic management include: ## 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 **a single access request** for all the models (and/or datasets) in it. +[Enterprise Hub](https://huggingface.co/docs/hub/en/enterprise-hub) subscribers can create a Gating Group Collection to grant (or reject) access to all the models and datasets in a collection at once. -More information about Gating Group collections can be found in [our doc](https://huggingface.co/docs/hub/en/enterprise-hub-gating-group-collections). +More information about Gating Group Collections can be found in [our dedicated doc](https://huggingface.co/docs/hub/en/enterprise-hub-gating-group-collections). ## Access gated models as a user From 04d930db9bb27c5d0aa1af0007008800aa7f78f1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Say?= Date: Fri, 13 Dec 2024 09:22:14 +0100 Subject: [PATCH 11/14] fix tag --- docs/hub/enterprise-hub-gating-group-collections.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/hub/enterprise-hub-gating-group-collections.md b/docs/hub/enterprise-hub-gating-group-collections.md index 30f3534a9..03a585501 100644 --- a/docs/hub/enterprise-hub-gating-group-collections.md +++ b/docs/hub/enterprise-hub-gating-group-collections.md @@ -15,7 +15,7 @@ To enable gating group in a collection: 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. - + ## Manage gating group as an organization admin From 3de55c43552c0e23738cd59c3ac14ba2731decc5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Say?= Date: Fri, 13 Dec 2024 11:14:17 +0100 Subject: [PATCH 12/14] Apply suggestions from code review Co-authored-by: Pedro Cuenca --- ...enterprise-hub-gating-group-collections.md | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/hub/enterprise-hub-gating-group-collections.md b/docs/hub/enterprise-hub-gating-group-collections.md index 03a585501..f9b9fe397 100644 --- a/docs/hub/enterprise-hub-gating-group-collections.md +++ b/docs/hub/enterprise-hub-gating-group-collections.md @@ -8,10 +8,10 @@ Gating Group Collections allow organizations to grant (or reject) access to all To enable gating group in a collection: -- collection owner must be an organization -- organization must be subscribed to Enterprise Hub +- the collection owner must be an organization +- the organization must be subscribed to the Enterprise Hub - all models and datasets in the collection must be owned by the same organization as the collection -- all models and datasets in the collection can only be in one Gating Group Collection at once +- each model or dataset in the collection may only belong to one Gating Group Collection, but they may be present on non-gating collections. 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. @@ -49,7 +49,7 @@ By default, gating group is disabled: click on **Configure Access Requests** to />
-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. +By default, access to the repos in the collection is automatically granted to users when they request it. This is referred to as **automatic approval**. In this mode, any user can access your repos once they’ve agreed to share their contact information with you.
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. -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. - ## Access gated repos in a Gating Group Collection as a user A Gated Group Collection shows a specific icon before its name: @@ -163,4 +163,4 @@ A Gated Group Collection shows a specific icon before its name: 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. -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. +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 learn more about requesting access to a repository. From 8bd06604022eb2617d1fe18764545182120a0513 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Say?= Date: Fri, 13 Dec 2024 11:15:30 +0100 Subject: [PATCH 13/14] More readable sentence Co-authored-by: Pedro Cuenca --- docs/hub/enterprise-hub-gating-group-collections.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/hub/enterprise-hub-gating-group-collections.md b/docs/hub/enterprise-hub-gating-group-collections.md index f9b9fe397..ffbc2f61d 100644 --- a/docs/hub/enterprise-hub-gating-group-collections.md +++ b/docs/hub/enterprise-hub-gating-group-collections.md @@ -4,7 +4,7 @@ This feature is part of the Enterprise Hub. -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**. +Gating Group Collections allow organizations to grant (or reject) access to all the models and datasets in a collection at once, rather than per repo. Users will only have to go through **a single access request**. To enable gating group in a collection: From 0552bdb5197dcf1c1df7c015e584b627f1d3c16e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Say?= Date: Fri, 13 Dec 2024 11:41:16 +0100 Subject: [PATCH 14/14] capitalize --- docs/hub/enterprise-hub-gating-group-collections.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/hub/enterprise-hub-gating-group-collections.md b/docs/hub/enterprise-hub-gating-group-collections.md index ffbc2f61d..7c2749eb6 100644 --- a/docs/hub/enterprise-hub-gating-group-collections.md +++ b/docs/hub/enterprise-hub-gating-group-collections.md @@ -6,7 +6,7 @@ This feature is part of the Enterpri Gating Group Collections allow organizations to grant (or reject) access to all the models and datasets in a collection at once, rather than per repo. Users will only have to go through **a single access request**. -To enable gating group in a collection: +To enable Gating Group in a collection: - the collection owner must be an organization - the organization must be subscribed to the Enterprise Hub