Document hf_transfer more prominently
#1714
Merged
Conversation
This file contains 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
|
The documentation is not available anymore as the PR was closed or merged. |
stevhliu
approved these changes
Oct 5, 2023
Co-authored-by: Steven Liu <[email protected]>
|
Thanks again for the great feedback @stevhliu! And yes always good to lower users expectations 😄 |
|
Just for clarity, lack of features is part of the reason of the speed (progressbars are slowing things down very often). |
LysandreJik
approved these changes
Oct 6, 2023
|
Thanks for the review, I'll merge :) |
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.
Discussed in #1652 and slack (private) cc @Narsil @osanseviero
This PR adds more info about
hf_transferin the docs and promote its usage in the CLI upload/download commands. Still, it is not set by default -and is not planned to be- because of its inherent limitations (progress bars, error handling, resumable download,...). The goal is to make this feature more known while being optional. About the CLI commands if users don't want any log message (including this one), they can set--quietso it should "pollute" too much the output.I also created an alias so that https://huggingface.co/docs/huggingface_hub/hf_transfer redirects to the corresponding section in the docs.