[Xet] Document adaptive concurrency for xet transfers#2260
Merged
Conversation
Describe the adaptive concurrency feature that xet-core uses by default to dynamically adjust parallelism based on network conditions. Update HF_XET_HIGH_PERFORMANCE documentation to reflect that it now raises adaptive concurrency bounds (initial=16, max=124) rather than setting fixed values. Add HF_XET_FIXED_DOWNLOAD/UPLOAD_CONCURRENCY as advanced escape hatches. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Add a comprehensive "Environment Variables" section to the Xet storage docs covering adaptive concurrency, network/retry, data transfer, download buffers, and logging. All variable names and defaults verified against xet-core source. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Contributor
Author
|
@julien-c : (not urgent, can wait until you are back.) |
hoytak
reviewed
Mar 3, 2026
hoytak
reviewed
Mar 3, 2026
hoytak
reviewed
Mar 3, 2026
hoytak
reviewed
Mar 3, 2026
hoytak
reviewed
Mar 3, 2026
- Clarify that default adaptive concurrency already saturates most network paths — no tuning needed for most users - Document HF_XET_HIGH_PERFORMANCE as requiring >=64 GB RAM, warn it may degrade performance on smaller machines - Mark adaptive concurrency env vars as advanced settings - Fix AC_TARGET_RTT description per reviewer suggestion Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
julien-c
approved these changes
Mar 10, 2026
Member
julien-c
left a comment
There was a problem hiding this comment.
nice!
let's communicate widely when this is shipped, as it's very cool feature for power users and casual users alike
Remove redundant pip install line and fix code fence language tag. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
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. |
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.
Summary
hf_xetuses adaptive concurrency by default, dynamically adjusting parallelism based on real-time network conditions (default: 1→64 streams)HF_XET_HIGH_PERFORMANCE=1docs to reflect it now raises adaptive concurrency bounds (initial=16, max=124) and increases buffer sizes, rather than setting fixed valuesHF_XET_FIXED_DOWNLOAD_CONCURRENCY/HF_XET_FIXED_UPLOAD_CONCURRENCYas documented escape hatches for advanced usersFiles changed
docs/hub/models-downloading.mddocs/hub/mlx.mddocs/hub/xet/using-xet-storage.mddocs/xet/upload-protocol.mddocs/xet/download-protocol.mdTest plan
HF_XET_HIGH_PERFORMANCE,HF_XET_FIXED_DOWNLOAD_CONCURRENCY,HF_XET_FIXED_UPLOAD_CONCURRENCY)xet_config/src/groups/client.rsandxet_config/src/xet_config.rs🤖 Generated with Claude Code
Note
Low Risk
Documentation-only changes describing
hf_xet/xet-coretransfer behavior and new/updated environment-variable guidance; no code or runtime behavior is modified.Overview
Documents that
hf_xetuses adaptive concurrency by default for Xet transfers, and updates download guidance to clarify thatHF_XET_HIGH_PERFORMANCE=1raises concurrency bounds and buffer sizes (intended for high-bandwidth machines with �64GB RAM).Expands
using-xet-storage.mdwith a dedicated Environment Variables section (including fixed-concurrency escape hatches viaHF_XET_FIXED_{DOWNLOAD,UPLOAD}_CONCURRENCY) and adds adaptive-concurrency notes to the Xet upload/download protocol specs; also adds a brief HP-mode note to the MLX Hub guide.Written by Cursor Bugbot for commit 4ba1a67. This will update automatically on new commits. Configure here.