docs: add expose ports section to Jobs configuration guide#2551
Merged
Conversation
Document the new --expose / expose=[] option that lets users expose container ports through the public jobs proxy (available since huggingface_hub v1.19.0). Includes CLI and Python examples, URL format, and authentication requirements. Complements #2550 which covers pricing. Co-authored-by: Lucain <Wauplin@users.noreply.github.com>
Wauplin
marked this pull request as draft
June 11, 2026 13:05
|
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. |
Wauplin
marked this pull request as ready for review
June 11, 2026 13:12
Mention that expose ports makes Jobs a great fit for building sandboxes (temporary self-contained environments for agents and LLM applications). Co-authored-by: Lucain <Wauplin@users.noreply.github.com>
julien-c
approved these changes
Jun 11, 2026
davanstrien
reviewed
Jun 11, 2026
davanstrien
left a comment
davanstrien
left a comment
Member
There was a problem hiding this comment.
Smoke-tested the feature end-to-end (CLI + Python API on a cpu-basic job) — everything works as documented. A few inline wording suggestions below.
davanstrien
approved these changes
Jun 11, 2026
davanstrien
left a comment
davanstrien
left a comment
Member
There was a problem hiding this comment.
Smoke-tested the feature end-to-end (CLI + Python API on a cpu-basic job) and it worked well.
Left some suggested changes for clarity but also fine if these are refined later.
Co-authored-by: Daniel van Strien <davanstrien@users.noreply.github.com>
Co-authored-by: Daniel van Strien <davanstrien@users.noreply.github.com>
Wauplin
added a commit
that referenced
this pull request
Jun 19, 2026
* docs: add SSH section to Jobs configuration guide Document the new --ssh / ssh=True option that opens an interactive SSH session into a running Job, plus the new `hf jobs ssh <job_id>` command (with --dry-run and -i/--identity-file). Includes CLI and Python examples, the ssh://<job_id>@ssh.hf.jobs endpoint format, and access requirements (write access to the namespace + a registered SSH key). SSH is not billed on top of the job's hardware price. Complements #2551 which covers exposing ports. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * better * docs: add SSH port forwarding section to Jobs guide Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * Update docs/hub/jobs-configuration.md Co-authored-by: Pedro Cuenca <pedro@huggingface.co> --------- Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com> Co-authored-by: Pedro Cuenca <pedro@huggingface.co>
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
6 participants
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.
Document the new
--expose/expose=[]option that lets users expose container ports through the public jobs proxy, introduced inhuggingface_hubv1.19.0.Changes
docs/hub/jobs-configuration.md— Adds an Expose Ports section covering:--expose <port>and example outputexpose=[<port>]expose_urlsfield onJobStatushuggingface_hub>= 1.19.0) and link to pricingdocs/hub/jobs-examples.md— Adds a Sandboxes section noting that expose ports makes Jobs a great fit for building sandboxes (temporary self-contained environments for agents and LLM applications).This complements #2550 which covers exposed-port pricing.
Slack Thread