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 quick start guide #850

Merged
merged 3 commits into from
Apr 26, 2022
Merged

Add quick start guide #850

merged 3 commits into from
Apr 26, 2022

Conversation

stevhliu
Copy link
Member

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.

@stevhliu stevhliu added the documentation Improvements or additions to documentation label Apr 21, 2022
@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Apr 21, 2022

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

@stevhliu stevhliu mentioned this pull request Apr 21, 2022
5 tasks
Copy link
Contributor

@adrinjalali adrinjalali left a 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.

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.

This is neat! I left some minor suggestions but overall this looks great!

Thank you 🚀

@adrinjalali adrinjalali merged commit b37d7b5 into huggingface:main Apr 26, 2022
@stevhliu stevhliu deleted the quick-start branch April 26, 2022 16:11
@stevhliu stevhliu mentioned this pull request Apr 26, 2022
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants