Skip to content

Add Hardware settings doc page#2518

Merged
gary149 merged 4 commits into
mainfrom
add-hardware-settings-doc
Jun 8, 2026
Merged

Add Hardware settings doc page#2518
gary149 merged 4 commits into
mainfrom
add-hardware-settings-doc

Conversation

@gary149

@gary149 gary149 commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

What

Adds a short documentation page for the dedicated Hardware settings page (huggingface.co/settings/hardware), which lets users register the compute hardware they own (GPUs, CPUs, Apple Silicon).

The page covers:

  • Adding hardware (type, provider/model, memory, count, primary).
  • Model compatibility: how saved hardware drives the "Hardware compatibility" estimate on GGUF/MLX model pages.
  • Share & compare: the profile TFLOPS badge and the community hardware page at huggingface.co/hardware.

New file docs/hub/hardware.md, registered in _toctree.yml in the Models section next to Local Apps.

Notes

  • Text-only for now; screenshots can be added later.
  • Verified locally with doc-builder build (page renders, internal links to ./gguf, ./local-apps, ./agents-local resolve).
  • The /settings/hardware page should be live in production before this is merged.

Note

Low Risk
Documentation-only change with no application or security impact.

Overview
Adds Hub documentation for Hardware settings (huggingface.co/settings/hardware): registering GPUs/CPUs/Apple Silicon, the Hardware compatibility panel on GGUF/MLX model pages, profile TFLOPS and the community hardware page, plus light/dark screenshots and links to Local Apps and agents-local.

Registers docs/hub/hardware.md in _toctree.yml under Models, immediately before Local Apps.

Reviewed by Cursor Bugbot for commit e85ccf7. Bugbot is set up for automated code reviews on this repo. Configure here.

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.
@HuggingFaceDocBuilderDev

Copy link
Copy Markdown

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

@gary149
gary149 marked this pull request as draft June 2, 2026 09:03
Comment thread docs/hub/hardware.md Outdated
Comment thread docs/hub/hardware.md
Comment thread docs/hub/hardware.md Outdated
Comment thread docs/hub/hardware.md Outdated
Comment thread docs/hub/hardware.md Outdated
Comment thread docs/hub/hardware.md Outdated
Comment thread docs/hub/hardware.md
- 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'.
@gary149

gary149 commented Jun 2, 2026

Copy link
Copy Markdown
Contributor Author

Thanks both! Updated:

  • Visibility default fixed: you're right, hardware is public by default. The page now says so, and explains you can turn off the Publicly Visible toggle to keep it private. Reworked the intro so the profile-sharing and privacy control read clearly.
  • Applied @pcuenca's wording suggestions ("get up and running", "estimated total compute power").

Re the /settings/hardware link being merged-but-not-yet-deployed: noted, this can land once it's live.

@gary149
gary149 marked this pull request as ready for review June 2, 2026 13:06
@gary149
gary149 requested review from julien-c and pcuenca June 3, 2026 13:18
@gary149
gary149 merged commit 9cf9bd9 into main Jun 8, 2026
3 checks passed
@gary149
gary149 deleted the add-hardware-settings-doc branch June 8, 2026 09:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants