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
Update how to guides #840
Update how to guides #840
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.
This is super nice, I left some comments/suggestions
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.
Very nice! Thanks for working on this, @stevhliu
Shouldn't this PR go to https://github.com/huggingface/hub-docs ? |
The guides that are affected here are guides related to the The following PR #833 removed the guides that were unrelated to It's the guides that are affected here should be removed from hub-docs IMO as they're currently duplicated (cc @osanseviero, happy to open a PR). |
@LysandreJik with the docs revamp from @NimaBoscarino a significant part of it will be removed, I'm not sure if it's worth opening a PR for removing that as soon all of it will be removed/updated |
As discussed in #818, this PR de-emphasizes integrating download/upload functions into third-party libraries. The guides simply tell a user how to use these functions. We can follow this up with an integration guide that provides more value to library maintainers/developers who want to integrate these functions into their libraries. This PR also splits the old upstream utility doc into:
commit
context manager,push_to_hub
and Git LFS).create_repo
,delete_repo
update_repo_visibility
, theRepository
class and its associated git-commands).This page is still a work in progress :)Repository
commands likepull
,add
,commit
andpush
. I think it's nice for users to see they can manually do this if they want to instead of using thecommit
context manager orpush_to_hub
.snapshot_download
is when they scan the headers.InferenceApi
to the API Reference.Something I would appreciate feedback on:
Do we still want to keep the
list_model/dataset(filter=...)
andmodel/dataset_info
sections? It looks like you can do the same thing more efficiently with what is currently in the Searching the Hub doc.To do: