Improve Jobs docs onboarding and Quickstart - #2771
Open
davanstrien wants to merge 4 commits into
Open
Conversation
|
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. |
Member
Author
lhoestq
approved these changes
Sep 9, 2026
davanstrien
marked this pull request as ready for review
September 9, 2026 14:53
Member
Author
|
First pass on a bigger Jobs docs refresh. I don’t want to put everything into one PR, but for context I also planning to work on:
This PR focuses on making it easier to understand Jobs and get a first successful run. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Starting a focused refresh of the Jobs docs to make it clearer what Jobs is for, how to run a first workload, and where to go next.
This first pass:
Note
Low Risk
Documentation and a sample script only; no product code, auth, or runtime behavior changes.
Overview
Refreshes Hugging Face Jobs onboarding docs so new readers get a clearer value proposition and a shorter path to a first successful run.
The Jobs landing page (
jobs.md), overview (jobs-overview.md), and feature grid copy are rewritten with direct links into the Quickstart and examples. Long introductory paragraphs are trimmed, and the “run any workload” section is split into clearer Python (hf jobs uv run) vs Docker (hf jobs run) subsections with updated grid labels (e.g. hardware and “run your code” wording).The Quickstart is rebuilt around a CPU Hello World, then a small GPU text-generation example on
t4-small—replacing the previous TRL fine-tuning walkthrough, extra CLI install variants, Docker hello-world, and Hub UI screenshots. It documentshf jobs inspect/logs/cancel, optional local script upload, and a Next steps list pointing to training, datasets, Docker, and agent examples.Adds
examples/jobs/hello_gpu.pyin-repo so the guide can run the sample via a raw GitHub URL or a local file.Reviewed by Cursor Bugbot for commit 4467781. Bugbot is set up for automated code reviews on this repo. Configure here.