Skip to content
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

Merged
merged 10 commits into from Apr 27, 2022
Merged

Conversation

stevhliu
Copy link
Member

@stevhliu stevhliu commented Apr 15, 2022

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:

  1. How to upload files (commit context manager, push_to_hub and Git LFS).
  2. How to create and manage a repository (create_repo, delete_repo update_repo_visibility, the Repository class and its associated git-commands). This page is still a work in progress :)
  3. Documents other Repository commands like pull, add, commit and push. I think it's nice for users to see they can manually do this if they want to instead of using the commit context manager or push_to_hub.
  4. Rename some section headers so it's easier for users to find what they're looking for. Users might not know what snapshot_download is when they scan the headers.
  5. Adds InferenceApi to the API Reference.

Something I would appreciate feedback on:

Do we still want to keep the list_model/dataset(filter=...) and model/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:

  • Finish doc on how to create and manage a repository.

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

HuggingFaceDocBuilderDev commented Apr 16, 2022

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

@osanseviero osanseviero self-requested a review April 19, 2022 10:55
Copy link
Member

@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 super nice, I left some comments/suggestions

docs/source/_toctree.yml Outdated Show resolved Hide resolved
docs/source/_toctree.yml Outdated Show resolved Hide resolved
docs/source/how-to-downstream.mdx Outdated Show resolved Hide resolved
docs/source/how-to-downstream.mdx Outdated Show resolved Hide resolved
docs/source/how-to-manage.mdx Outdated Show resolved Hide resolved
docs/source/how-to-manage.mdx Outdated Show resolved Hide resolved
docs/source/how-to-upstream.mdx Show resolved Hide resolved
Copy link
Member

@LysandreJik LysandreJik left a 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

docs/source/how-to-downstream.mdx Outdated Show resolved Hide resolved
@adrinjalali
Copy link
Contributor

Shouldn't this PR go to https://github.com/huggingface/hub-docs ?

@LysandreJik
Copy link
Member

The guides that are affected here are guides related to the huggingface_hub client library, as can be seen here: https://huggingface.co/docs/huggingface_hub/index

The following PR #833 removed the guides that were unrelated to huggingface_hub as they're hosted in hub-docs.

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).

@osanseviero
Copy link
Member

@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

@stevhliu stevhliu mentioned this pull request Apr 21, 2022
5 tasks
@stevhliu stevhliu marked this pull request as ready for review April 26, 2022 18:21
@stevhliu stevhliu mentioned this pull request Apr 26, 2022
@LysandreJik LysandreJik merged commit dabcc83 into huggingface:main Apr 27, 2022
@stevhliu stevhliu deleted the clarify-how-to-guides branch April 27, 2022 17:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants