Skip to content
New issue

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

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

Already on GitHub? # to your account

Add a quick start guide #841

Closed
stevhliu opened this issue Apr 16, 2022 · 2 comments
Closed

Add a quick start guide #841

stevhliu opened this issue Apr 16, 2022 · 2 comments
Labels
discussion documentation Improvements or additions to documentation

Comments

@stevhliu
Copy link
Member

Currently, the docs don't have an end-to-end guide demonstrating how users can string everything together in the huggingface_hub library. There are three guides, and each of them highlight a different aspect of the library. I think adding a quick start guide would add value for users by capturing the core parts that are representative of the library (namely downloading, uploading, and creating/managing files and repositories).

For the quick start guide, I think we should start with the simplest option:

  1. hf_hub_download for downloading files instead of the two-step hf_hub_url and cached_download wombo combo.
  2. create_repo to create a repo.
  3. upload_file to upload files.

Would love to hear if you think there is anything else we should include in the quick start or any other feedback, thanks :)

@stevhliu stevhliu added documentation Improvements or additions to documentation discussion labels Apr 16, 2022
@adrinjalali
Copy link
Contributor

also related to #824

@stevhliu
Copy link
Member Author

Closed by #850.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
discussion documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants