Improve Docs for Gated Models

[patrickvonplaten]

With more and more powerful models being released in the field of "generative AI", gating models will become more and more important IMO.

The current state of the model docs can be improved IMO.

• "Gated models" don't show up here: https://huggingface.co/docs/hub/index , but are IMO very important docs. Let's add them there as well no?
• The are put under "model cards" here, which is def not the place where I'd look for them. IMO they have much more functionality than model cards, e.g. allow model authors to download stats etc... -> or is this just a bug?
• Not a huge fan of the docs: https://huggingface.co/docs/hub/models-gated . Think they mix information for "model authors" and "model users" too much. I'd write the docs a bit differently here:
  1. Why gated models?
  2. For authors: How to set-up gated models?
  3. For users: How to use gated models

=> Happy to open a PR to potentially improve the docs there.

wdyt @osanseviero @julien-c ?

[osanseviero]

• Yes, let's add them to the index!
• They are not a sub-section under model cards. They are a top section under models and the next one to model cards/
• Sounds good, yes!

[julien-c]

👍

if you rewrite gated models, please also rewrite gated datasets, as they should be consistent

also cc @SBrandeis who wrote the initial doc

[osanseviero]

We now have gated models and datasets docs. I agree with

Not a huge fan of the docs: https://huggingface.co/docs/hub/models-gated . Think they mix information for "model authors" and "model users" too much. I'd write the docs a bit differently here: Why gated models? For authors: How to set-up gated models? For users: How to use gated models

would be cool to rewrite some of this as gated repos are being used more and more. We also have no docs on the settings tab and button to download the info. There is also @Wauplin's issue with examples on using it programmatically. I like the idea of rewriting with proposed structure

1. Intro - why gated models
2. How to use gated models (just clicking things through form, logging in, etc)
3. How to manage gated models

WDYT? cc @apolinario as well

[julien-c]

(nit) for me would be more logical in that order:

1. Intro - why gated models
2. How to manage gated models
3. How to use gated models (just clicking things through form, logging in, etc)

agree with everything else!

[Wauplin]

Opened a PR for it: https://github.com/huggingface/hub-docs/pull/1128.