Add quick start guide #850
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The documentation is not available anymore as the PR was closed or merged. |
adrinjalali
reviewed
Apr 22, 2022
osanseviero
approved these changes
Apr 24, 2022
merveenoyan
reviewed
Apr 25, 2022
adrinjalali
approved these changes
Apr 26, 2022
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds a quick start guide as discussed in #841. It summarizes the core functionalities of the
huggingface_hublibrary 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 sign in like creating a repository and uploading files does. Feel free to let me know if that makes sense since typically you'd sign in and get all setup first before doing other things.I also created a separate section in the
toctreefor the landing page and quick start since they are more introductory-level type docs.