diff --git a/docs/hub/_toctree.yml b/docs/hub/_toctree.yml index eaf761df26..515f7f35f2 100644 --- a/docs/hub/_toctree.yml +++ b/docs/hub/_toctree.yml @@ -27,10 +27,12 @@ title: Tokens Management - local: enterprise-hub-analytics title: Publisher Analytics - - local: enterprise-hub-network-security - title: Network Security - local: enterprise-hub-gating-group-collections title: Gating Group Collections + - local: enterprise-hub-network-security + title: Network Security + - local: rate-limits + title: Rate Limits - local: pro title: PRO Plan diff --git a/docs/hub/api.md b/docs/hub/api.md index ff9b11600d..1d64032d53 100644 --- a/docs/hub/api.md +++ b/docs/hub/api.md @@ -17,6 +17,12 @@ You can also access the OpenAPI specification directly: [https://huggingface.co/ +All API calls are subject to the HF-wide [Rate limits](./rate-limits). Upgrade your account if you need elevated, large-scale access. + +> [!INFO] +> The rest of this page is a partial list of some of our API endpoints. But note that the exhaustive reference is our [OpenAPI documentation](https://huggingface.co/spaces/huggingface/openapi). +> It is much more complete and guaranteed to always be up-to-date. + ## Repo listing API The following endpoints help get information about models, datasets, and Spaces stored on the Hub. diff --git a/docs/hub/billing.md b/docs/hub/billing.md index 02a3aef3a1..3c85c0cc9a 100644 --- a/docs/hub/billing.md +++ b/docs/hub/billing.md @@ -26,12 +26,12 @@ Private repository storage above the [included storage](./storage-limits) will b The PRO subscription unlocks essential features for serious users, including: - Higher [storage capacity](./storage-limits) for public and private repositories -- Higher bandwidth and API rate limits +- Higher bandwidth and API [rate limits](./rate-limits) - Included credits for [Inference Providers](/docs/inference-providers/) - Higher tier for ZeroGPU Spaces usage - Ability to create ZeroGPU Spaces and use Dev Mode - Ability to publish Social Posts and Community Blogs -- Leverage the Data Studio on private datasets +- Leverage the [Data Studio](./datasets-viewer) on private datasets - Run and schedule serverless [CPU/ GPU Jobs](https://huggingface.co/docs/huggingface_hub/en/guides/jobs) View the full list of benefits at https://huggingface.co/pro then subscribe over at https://huggingface.co/subscribe/pro diff --git a/docs/hub/enterprise-hub.md b/docs/hub/enterprise-hub.md index 1e0d002614..c777fdec3e 100644 --- a/docs/hub/enterprise-hub.md +++ b/docs/hub/enterprise-hub.md @@ -24,7 +24,8 @@ In this section we will document the following Enterprise Hub features: - [Advanced Security](./enterprise-hub-advanced-security) - [Tokens Management](./enterprise-hub-tokens-management) - [Publisher Analytics](./enterprise-hub-analytics) -- [Network Security](./enterprise-hub-network-security) - [Gating Group Collections](./enterprise-hub-gating-group-collections) +- [Network Security](./enterprise-hub-network-security) +- [Higher Rate limits](./rate-limits) Finally, Team & Enterprise plans include 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/index.md b/docs/hub/index.md index 1e2bbbb285..ebed7f8d57 100644 --- a/docs/hub/index.md +++ b/docs/hub/index.md @@ -17,6 +17,7 @@ The Hugging Face Hub is a platform with over 1.7M models, 400k datasets, and 600 Advanced Security Tokens Management Network Security +Rate Limits
diff --git a/docs/hub/pro.md b/docs/hub/pro.md index 970ff1a656..f05b20a617 100644 --- a/docs/hub/pro.md +++ b/docs/hub/pro.md @@ -3,12 +3,12 @@ The PRO subscription unlocks essential features for serious users, including: - Higher [storage capacity](./storage-limits) for public and private repositories -- Higher bandwidth and API rate limits +- Higher bandwidth and API [rate limits](./rate-limits) - Included credits for [Inference Providers](/docs/inference-providers/) - Higher tier for [ZeroGPU Spaces](./spaces-zerogpu) usage - Ability to create ZeroGPU Spaces and use [Dev Mode](./spaces-dev-mode) - Ability to publish Social Posts and Community Blogs -- Leverage the Data Studio on private datasets +- Leverage the [Data Studio](./datasets-viewer) on private datasets - Run and schedule serverless [CPU/ GPU Jobs](https://huggingface.co/docs/huggingface_hub/en/guides/jobs) View the full list of benefits at **https://huggingface.co/pro** then subscribe over at https://huggingface.co/subscribe/pro \ No newline at end of file diff --git a/docs/hub/rate-limits.md b/docs/hub/rate-limits.md new file mode 100644 index 0000000000..c427dffcd0 --- /dev/null +++ b/docs/hub/rate-limits.md @@ -0,0 +1,100 @@ +# Hub Rate limits + +To protect our platform's integrity and ensure availability to as many AI community members as possible, we enforce rate limits on all requests made to the Hugging Face Hub. + +We define different rate limits for distinct classes of requests. We distinguish three main buckets: + +- **Hub APIs** + - e.g. model or dataset search, repo creation, user management, etc. All endpoints that belong to this bucket are documented in [Hub API Endpoints](./api). +- **Resolvers** + - They're all the URLs that contain a `/resolve/` segment in their path, which serve user-generated content from the Hub. Concretely, those are the URLs that are constructed by open source libraries (transformers, datasets, vLLM, llama.cpp, …) or AI applications (LM Studio, Jan, ollama, …) to download model/dataset files from HF. + - Specifically, this is the ["Resolve a file" endpoint](https://huggingface.co/spaces/huggingface/openapi#tag/models/get/{namespace}/{repo}/resolve/{rev}/{path}) documented in our OpenAPI spec. + - Resolve requests are heavily used by the community, and since we optimize our infrastructure to serve them with maximum efficiency, the rate limits for Resolvers are the highest. +- **Pages** + - All the Web pages we host on huggingface.co. + - Usually Web browsing requests are made by humans, hence rate limits don't need to be as high as the above mentioned programmatic endpoints. + +> [!TIP] +> All values are defined over 5-minute windows, which allows for some level of "burstiness" from an application or developer's point of view. + +If you, your organization, or your application need higher rate limits, we encourage you to upgrade your account to PRO, Team, or Enterprise. We prioritize support requests from PRO, Team, and Enterprise customers – see built-in limits in [Rate limit Tiers](#rate-limit-tiers). + +## Billing dashboard + +At any point, you can check your rate limit status on your (or your org’s) Billing page: https://huggingface.co/settings/billing + +![dashboard for rate limits](https://cdn-uploads.huggingface.co/production/uploads/5dd96eb166059660ed1ee413/0pzQQyuVG3c9tWjCqrX9Y.png) + +On the right side, you will see three gauges, one for each bucket of Requests. + +Each bucket presents the number of current (last 5 minutes) requests, and the number of allowed requests based on your user account or organization plan. + +Whenever you exceed the limit in the past 5 minutes (the view is updated in real-time), the bar will turn red. + +Note: You can use the context switcher to easily switch between your user account and your orgs. + +## HTTP Headers + +Whenever you or your organization hits a rate limit, you will receive a **429** `Too Many Requests` HTTP error. + +We implement the mechanism described in the [IETF draft (Version 9)](https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/) titled “RateLimit HTTP header fields for HTTP” (also known as `draft-ietf-httpapi-ratelimit-headers`). + +The goal is to define standardized HTTP headers that servers can use to advertise quota / rate-limit policies and communicate current usage / limits to clients so that they can avoid being throttled. + +Precisely, we implement the following headers: + +| Header | Purpose / Meaning | +| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | +| **`RateLimit`** | The total allowed rate limit for the current window. “How many requests (of this type) you’re allowed to perform.” | +| **`RateLimit-Policy`** | Carries the rate limit policy itself (e.g. “100 requests per 5 minutes”). It’s informative; shows what policy the client is subject to. | + +A set of examples is as follows: + +| Header | Example | +| ---------------------- | ----------------------------------------------------------------------------------------------------- | +| **`RateLimit`** | `"api\|pages\|resolvers";r=[remaining];t=[seconds remaining until reset]` | +| **`RateLimit-Policy`** | `"fixed window";"api\|\pages\|resolvers";q=[total allowed for window];w=[window duration in seconds]` | + +## Rate limit Tiers + +Here are the current rate limits (in September '25) based on your plan: + +| Plan | API | Resolvers | Pages | +| ------------------------------------------------------------------------- | -------- | --------- | ------ | +| Anonymous user (per IP address) | 500 \* | 3,000 \* | 100 \* | +| Free user | 1,000 \* | 5,000 \* | 200 \* | +| PRO user | 2,500 | 12,000 | 400 | +| Team organization | 3,000 | 15,000 | 400 | +| Enterprise organization | 6,000 | 30,000 | 600 | +| Enterprise Plus organization | 10,000 | 50,000 | 1,000 | +| Enterprise Plus organization
When Organization IP Ranges are defined | 100,000 | 500,000 | 10,000 | +| Academia Hub organization | 2,500 | 12,000 | 400 | + +\* Anonymous and Free users are subject to change over time depending on platform health 🤞 + +Note: For organizations, rate limits are applied individually to each member, not shared among members. + +## What if I get rate-limited + +First, make sure you always pass a `HF_TOKEN`, and it is passed downstream to all libraries or applications that download _stuff_ from the Hub. + +This is the number one reason users get rate limited and is a very easy fix. + +Despite passing `HF_TOKEN` if you are still rate limited, you can: + +- spread out your requests over longer periods of time +- replace Hub API calls with Resolver calls, whenever possible (Resolver rate limits are much higher and much more optimized). +- upgrade to PRO, Team, or Enterprise. + +## Granular user action Rate limits + +In addition to those main classes of rate limits, we enforce limits on certain specific kinds of user actions, like: + +- repo creation +- repo commits +- discussions and comments +- moderation actions +- etc. + +We don't currently document the rate limits for those specific actions, given they tend to change over time more often. If you get quota errors, we encourage you to upgrade your account to PRO, Team, or Enterprise. +Feel free to get in touch with us via the support team. diff --git a/docs/hub/search.md b/docs/hub/search.md index 9c38d01f6a..2cd547f37d 100644 --- a/docs/hub/search.md +++ b/docs/hub/search.md @@ -1,6 +1,6 @@ # Search -You can now easily search anything on the Hub with **Full-text search**. We index model cards, dataset cards, and Spaces app.py files. +You can easily search anything on the Hub with **Full-text search**. We index model cards, dataset cards, and Spaces app.py files. Go directly to https://huggingface.co/search or, using the search bar at the top of https://huggingface.co, you can select "Try Full-text search" to help find what you seek on the Hub across models, datasets, and Spaces: diff --git a/docs/hub/webhooks.md b/docs/hub/webhooks.md index 70e9deffe5..cc1849be45 100644 --- a/docs/hub/webhooks.md +++ b/docs/hub/webhooks.md @@ -242,7 +242,7 @@ This can be helpful if accessing the HTTP headers of the request is complicated Each Webhook is limited to 1,000 triggers per 24 hours. You can view your usage in the Webhook settings page in the "Activity" tab. -If you need to increase the number of triggers for your Webhook, contact us at website@huggingface.co. +If you need to increase the number of triggers for your Webhook, upgrade to PRO, Team or Enterprise and contact us at website@huggingface.co. ## Developing your Webhooks