-
Notifications
You must be signed in to change notification settings - Fork 476
Docs: pre-release model pages #2660
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
Draft
coyotte508
wants to merge
8
commits into
main
Choose a base branch
from
pre-release-model-pages-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
aecbb79
Docs: pre-release model pages
coyotte508 5c0c267
Remove trailing whitespace from model cards documentation
coyotte508 a4bc09d
Remove outdated release notification limitations
coyotte508 01ea9b7
Remove outdated model upload restriction note
coyotte508 0677f81
Update models-release-announcements.md
coyotte508 686a537
Clarify model release announcement process and private requirement
coyotte508 96c1a87
Update docs/hub/models-release-announcements.md
coyotte508 9165335
Update docs/hub/models-release-announcements.md
coyotte508 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| # Pre-Release Model Pages | ||
|
|
||
| > [!WARNING] | ||
| > This feature is available to organizations on an <a href="https://huggingface.co/enterprise">Enterprise</a> plan or above — or <a href="https://huggingface.co/contact/sales?from=enterprise" target="_blank">contact us</a>. | ||
|
|
||
| Pre-release model pages let your organization announce an upcoming model while it is still private. Instead of a 404 page, visitors see a dedicated announcement page with a live countdown to the release date and a **Like and Notify on release** button, so they can be notified by email the moment your model is out. When you make the model public, it is released. | ||
|
|
||
| ## Eligibility | ||
|
|
||
| - Your organization must be subscribed to an [Enterprise](https://huggingface.co/enterprise) plan or above. | ||
| - The model repository must live under the **organization namespace** (e.g. `my-org/my-upcoming-model`). User-owned repositories are not eligible. | ||
| - The model repository must be **private**. Making the model public releases it (see [below](#notify-your-subscribers-on-release)). | ||
|
|
||
| ## Announce your model | ||
|
|
||
| To turn a **private** model's page into a pre-release page, add a `release_date` field to the model card metadata (the YAML section at the top of the repo's `README.md`): | ||
|
|
||
| ```yaml | ||
| --- | ||
| release_date: 2026-07-27 | ||
| description: "A short tagline shown on the pre-release page" | ||
| --- | ||
| ``` | ||
|
|
||
| The `release_date` field accepts either a YAML date, or a quoted ISO 8601 timestamp if you want to target a specific time: | ||
|
|
||
| ```yaml | ||
| release_date: "2026-07-27T15:00:00Z" | ||
| ``` | ||
|
|
||
| Invalid values are rejected by the metadata validator and ignored. A few more things to know: | ||
|
|
||
| - The optional `description` metadata field is used as the hero tagline of the pre-release page. | ||
| - The markdown body of your model card is rendered as the content of the page, so you can use it to describe what's coming. | ||
| - Metadata changes can take up to a minute to propagate. | ||
|
|
||
| ## What visitors see | ||
|
|
||
| While the model is private and `release_date` is set (and your organization is eligible), visitors see the pre-release page instead of a 404 page: | ||
|
|
||
| - A live **countdown** to the release date, along with your tagline and the model card content. | ||
| - A sidebar showing the number of users waiting for the release, the expected release date, and your organization's latest models. | ||
| - A **Like and Notify on release** button: clicking it likes the repo and subscribes the user to an email notification for the release. Unliking the model unsubscribes. | ||
| - The social-share thumbnail of the page also gets an "Upcoming release" treatment. | ||
|
|
||
| Members with **write access** to the repository always see the regular model page instead, so they can keep managing files and settings while the announcement is up. | ||
|
|
||
| When the countdown reaches zero, the page shows **"Coming very soon"** — the pre-release page stays up until you make the model public. | ||
|
|
||
| ## Notify your subscribers on release | ||
|
|
||
| When you're ready to release: | ||
|
|
||
| 1. Push the model files to the repository. | ||
| 2. Make the model **public**. This releases the model: the pre-release page becomes a regular model page — no need to remove the `release_date` field. | ||
| 3. Repo members with write access will see a banner reading "N users are waiting to be notified about this release", with a **Send release notifications** button. | ||
| 4. Click **Send release notifications** to email each subscriber that your model is now available on Hugging Face. | ||
|
|
||
| Notifications are respect each user's notification preferences. | ||
|
coyotte508 marked this conversation as resolved.
Outdated
|
||
|
|
||
| ## Things to keep in mind | ||
|
|
||
| - **The page stays up past the date**: reaching the release date does not automatically take the pre-release page down; make the model public to release it and switch back to the regular model page. | ||
| - **Making the model public is the release**: release notifications can only be sent once the model is public. | ||
| - **Making the model private again** (while `release_date` is still set) turns the pre-release page back on. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.