Added the ability to track progress of individual file downloads in snapshot_download() through inner_tqdm_class addition #2718
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.
1: Fixed a bug regarding the type of the tqdm_class argument of snapshot_download().
2: Added the ability to track progress of individual file downloads in snapshot_download().
Users can now pass an
inner_tqdm_class
argument to snapshot_download(), which will be eventually passed onto http_get(), which will use that class if available to instantiate its instance of tqdm.This enables the user to track the progress of individual file downloads, rather than overall progress (tracked through the regular
tqdm_class
argument passed into snapshot_download()).Example helpful scenario:
In my Local-LLM project, I would like to relay the progress of model downloads to the user. Presently, there is no mechanism for such behavior, but through this addition, I can now pass in a custom tqdm class into
inner_tqdm_class
and receive progress updates through my custom class.Note: The code below is still a work in progress, but should be sufficient to help illustrate the utility of the addition.
Feel free to edit.