Skip to content

Commit

Permalink
Add extra_gated_description to the gate docs (#1230)
Browse files Browse the repository at this point in the history
* Add `extra_gated_description ` to the gate docs

`extra_gated_description` is available but not documented

* oops

* datasets too

* fix spacing and wording

* Fix spacing and wording

* Update docs/hub/datasets-gated.md

Co-authored-by: Pedro Cuenca <[email protected]>

* Update docs/hub/models-gated.md

Co-authored-by: Pedro Cuenca <[email protected]>

---------

Co-authored-by: Pedro Cuenca <[email protected]>
  • Loading branch information
apolinario and pcuenca authored Mar 2, 2024
1 parent 58a3527 commit aab8c06
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
5 changes: 3 additions & 2 deletions docs/hub/datasets-gated.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,11 +115,12 @@ extra_gated_fields:
```


In some cases, you might also want to modify the text in the gate heading and the text in the button. For those use cases, you can modify `extra_gated_heading` and `extra_gated_button_content` like this:
In some cases, you might also want to modify the default text in the gate heading, description, and button. For those use cases, you can modify `extra_gated_heading`, `extra_gated_description` and `extra_gated_button_content` like this:

```yaml
---
extra_gated_heading: "Acknowledge license to accept the repository"
extra_gated_description: "Our team may take 2-3 days to process your request"
extra_gated_button_content: "Acknowledge license"
---
```
Expand Down Expand Up @@ -163,4 +164,4 @@ Alternatively, you can programmatically login using `login()` in a notebook or a

You can also provide the `token` parameter to most loading methods in the libraries (`from_pretrained`, `hf_hub_download`, `load_dataset`, etc.), directly from your scripts.

For more details about how to login, check out the [login guide](https://huggingface.co/docs/huggingface_hub/quick-start#login).
For more details about how to login, check out the [login guide](https://huggingface.co/docs/huggingface_hub/quick-start#login).
5 changes: 3 additions & 2 deletions docs/hub/models-gated.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,11 +116,12 @@ extra_gated_fields:
```


In some cases, you might also want to modify the text in the gate heading and the text in the button. For those use cases, you can modify `extra_gated_heading` and `extra_gated_button_content` like this:
In some cases, you might also want to modify the default text in the gate heading, description, and button. For those use cases, you can modify `extra_gated_heading`, `extra_gated_description` and `extra_gated_button_content` like this:

```yaml
---
extra_gated_heading: "Acknowledge license to accept the repository"
extra_gated_description: "Our team may take 2-3 days to process your request"
extra_gated_button_content: "Acknowledge license"
---
```
Expand Down Expand Up @@ -177,4 +178,4 @@ Alternatively, you can programmatically login using `login()` in a notebook or a

You can also provide the `token` parameter to most loading methods in the libraries (`from_pretrained`, `hf_hub_download`, `load_dataset`, etc.), directly from your scripts.

For more details about how to login, check out the [login guide](https://huggingface.co/docs/huggingface_hub/quick-start#login).
For more details about how to login, check out the [login guide](https://huggingface.co/docs/huggingface_hub/quick-start#login).

0 comments on commit aab8c06

Please sign in to comment.