-
Notifications
You must be signed in to change notification settings - Fork 632
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 quick start guide #850
Conversation
The documentation is not available anymore as the PR was closed or merged. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot for this. This is a great start, and it shows how we can improve the API.
It would be nice if you would be kind and trim the lines around 80/88 though.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is neat! I left some minor suggestions but overall this looks great!
Thank you 🚀
This PR adds a quick start guide as discussed in #841. It summarizes the core functionalities of the
huggingface_hub
library and quickly demonstrates how a user can interact with the Hub. I chose to show how to download files first since it doesn't require you to create an account and # like creating a repository and uploading files does. Feel free to let me know if that makes sense since typically you'd # and get all setup first before doing other things.I also created a separate section in the
toctree
for the landing page and quick start since they are more introductory-level type docs.