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

[WIP] Revisit documentation #1226

Closed
wants to merge 14 commits into from
Closed

[WIP] Revisit documentation #1226

wants to merge 14 commits into from

Conversation

Wauplin
Copy link
Contributor

@Wauplin Wauplin commented Nov 25, 2022

This goal of this PR is to track all changes made to documentation in a single place.
The work will be split in multiple smaller PRs. Both todo-list are purely indicative. If anyone sees something to add/remove, feel free to comment or directly do it.

Done in #1233:

  • adopt divio framework
  • configuration page
  • installation page
  • make index / quickstart / installation pages consistent
  • update href links in index (the 4-cells part)

Done in #1245 and #1249:

  • Difference HTTP-based / GIT-based

TODO

  • Move existing guides to either guides/ or tutorials/ folders
  • add redirections for guides that have been moved to guides folder
  • harmonize docstrings (the optional thingy, the <tip> vs raises sections,...)
  • Guide to download / upload a model
  • HfApi.upload_file vs hf_hub_download vs Repository: what should I use? When?
  • How to use endpoints and private models ?
  • (?) End to end guide for a MLOps engineer: entire ML lifecycle using just code.
  • Manage a repo (create, delete, add tag, add branch, rename, change_visibility,...)
  • Manage discussion on a repo (list discussion, reply, change status,...)
  • Manage a local clone (Repository object)
  • Download a file / a folder / all files (get file metadata, file existence)
  • Upload a file, upload a folder, update some files, delete some files
  • How to build an integration ? (push_to_hub, from_pretrained) (programmatically, mixin, cli)
  • Modelcards
  • Inference API
  • utils:
    • Make HTTP request
    • Handle cache
    • Runtime
    • Logging
    • Validators
    • TQDM

@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint.

@Wauplin
Copy link
Contributor Author

Wauplin commented Jul 11, 2023

Most of the task points in the description have now being handled. I'm closing this PR without merging.

@Wauplin Wauplin closed this Jul 11, 2023
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.

2 participants