Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] Update "Download files from the Hub" doc #948

Merged
merged 7 commits into from
Jul 26, 2022
Merged

Conversation

julien-c
Copy link
Member

Main change is not promote the deprecated cached_download anymore, and instead focus primarily on hf_hub_download

@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Jul 20, 2022

The documentation is not available anymore as the PR was closed or merged.

Copy link
Member

@stevhliu stevhliu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love simplifying it to just use hf_hub_download instead of (hf_hub_url + cached_download)!

docs/source/how-to-downstream.mdx Outdated Show resolved Hide resolved
docs/source/how-to-downstream.mdx Outdated Show resolved Hide resolved
docs/source/how-to-downstream.mdx Outdated Show resolved Hide resolved
docs/source/how-to-downstream.mdx Show resolved Hide resolved
src/huggingface_hub/README.md Outdated Show resolved Hide resolved
src/huggingface_hub/README.md Outdated Show resolved Hide resolved
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Copy link
Contributor

@SBrandeis SBrandeis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

src/huggingface_hub/README.md Outdated Show resolved Hide resolved
src/huggingface_hub/README.md Show resolved Hide resolved
src/huggingface_hub/README.md Show resolved Hide resolved
Copy link
Member

@LysandreJik LysandreJik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool, thanks!

docs/source/how-to-downstream.mdx Outdated Show resolved Hide resolved
src/huggingface_hub/README.md Show resolved Hide resolved
src/huggingface_hub/README.md Show resolved Hide resolved
Copy link
Contributor

@osanseviero osanseviero left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this PR!

docs/source/how-to-downstream.mdx Outdated Show resolved Hide resolved
docs/source/how-to-downstream.mdx Outdated Show resolved Hide resolved
@@ -4,8 +4,6 @@

[[autodoc]] huggingface_hub.snapshot_download

[[autodoc]] huggingface_hub.cached_download
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are we removing this?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's deprecated so I wouldn't promote the method in the package reference anymore.

Do you feel strongly otherwise?

src/huggingface_hub/README.md Outdated Show resolved Hide resolved
julien-c and others added 2 commits July 26, 2022 12:00
Co-authored-by: Omar Sanseviero <osanseviero@gmail.com>
Co-authored-by: Simon Brandeis <33657802+SBrandeis@users.noreply.github.com>
@julien-c
Copy link
Member Author

Ok, this seems to be in good shape, I'll merge it soon and we can always iterate in later PRs.

Also tagging @Wauplin for review when he joins=)

@julien-c julien-c merged commit 10908f8 into main Jul 26, 2022
@julien-c julien-c deleted the doc-downloads branch July 26, 2022 10:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants