Skip to content

Commit 9cf9bd9

Browse files
authored
Add Hardware settings doc page (#2518)
* Add Hardware settings doc page Document the dedicated Hardware settings page: how to register the GPUs, CPUs and Apple Silicon you own, and how that drives model compatibility estimates, the profile TFLOPS badge, and the community hardware page. Adds docs/hub/hardware.md and registers it in the Models nav next to Local Apps. * Put Hardware before Local Apps in the nav * Address review: hardware is public by default, wording tweaks - Fix the visibility default: hardware is public by default; turn off Publicly Visible to keep it private (per review). - Reframe the intro so profile sharing and the privacy control are clear. - Minor wording: 'get up and running', 'estimated total compute power'. * Add Hardware settings screenshot (light/dark)
1 parent c83b9ad commit 9cf9bd9

2 files changed

Lines changed: 41 additions & 0 deletions

File tree

docs/hub/_toctree.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,8 @@
181181
title: Models Download Stats
182182
- local: model-release-checklist
183183
title: Model Release Checklist
184+
- local: hardware
185+
title: Hardware
184186
- local: local-apps
185187
title: Local Apps
186188
- local: models-faq

docs/hub/hardware.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Hardware
2+
3+
Tell the Hub which compute hardware you own (GPUs, CPUs, or Apple Silicon) and it will help you find models that run on your setup. It also appears on your public profile, so you can compare your setup with the community, and you can make it private any time.
4+
5+
Manage it any time from your [Hardware settings](https://huggingface.co/settings/hardware).
6+
7+
<div class="flex justify-center">
8+
<img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/hardware-settings-light.png" alt="Hardware settings page in light mode."/>
9+
<img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/hardware-settings-dark.png" alt="Hardware settings page in dark mode."/>
10+
</div>
11+
12+
## Add your hardware
13+
14+
On your [Hardware settings](https://huggingface.co/settings/hardware) page, add each piece of hardware you own:
15+
16+
1. Pick a **type**: GPU, CPU, or Apple Silicon.
17+
2. Choose the **provider** and **model** (for example, NVIDIA RTX 4090).
18+
3. Set the **memory** (VRAM, RAM, or unified memory) and the **number of units** you have.
19+
20+
Add as many items as you like. If you own several, mark one as your **primary** hardware so it appears first on model pages.
21+
22+
> [!TIP]
23+
> Your hardware is public by default. Turn off the **Publicly Visible** toggle to keep it private.
24+
25+
## See which models fit your hardware
26+
27+
On model pages that offer [GGUF](./gguf) or MLX files, a **Hardware compatibility** panel estimates whether each quantization will run on your saved hardware, so you can choose a size that fits before downloading. Pair it with [Local Apps](./local-apps) to get up and running in a couple of clicks.
28+
29+
## Share and compare
30+
31+
While your hardware is public:
32+
33+
- A **TFLOPS** badge appears on your profile, summarizing your estimated total compute power.
34+
- You can browse [what the community is running](https://huggingface.co/hardware) and see how your setup compares across GPUs, CPUs, and Apple Silicon.
35+
36+
## Next steps
37+
38+
- [Use AI Models Locally](./local-apps) — run models with your favorite local app.
39+
- [Local Agents with llama.cpp](./agents-local) — build a coding agent on your own hardware.

0 commit comments

Comments
 (0)