Documentation Revamp #156
Merged
Documentation Revamp #156
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
Create Hugging Face Hub main doc page, with bolded items intended as future links to docs. Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Add a "Repositories" page with several subpages, outlining how repos are used on the hub, and best practices for creating and maintaining them. Some content remains WIP. Co-authored-by: Omar Sanseviero <osanseviero@gmail.com> Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Create Hugging Face Hub main doc page, with bolded items intended as future links to docs. Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Add content for models, and move deprecated content to its own folder (for dev purposes). Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Add documentation for Spaces, with tutorial for Gradio and Streamlit. Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Add documentation for Datasets
Add docs for organizations, security, API Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> Co-authored-by: Omar Sanseviero <osanseviero@gmail.com>
Modify docs to make them compatible with doc-builder.
* Docs Revamp: Models documentation (#117) Add content for models, and move deprecated content to its own folder (for dev purposes). Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * [Spaces] Changelog update * Update docs/hub/spaces-changelog.md Co-authored-by: Julien Chaumond <julien@huggingface.co> * Update docs/hub/spaces-changelog.md Co-authored-by: Julien Chaumond <julien@huggingface.co> * Update docs/hub/spaces-changelog.md Co-authored-by: Omar Sanseviero <osanseviero@gmail.com> * Update docs/hub/spaces-changelog.md Co-authored-by: Omar Sanseviero <osanseviero@gmail.com> * Update docs/hub/spaces-changelog.md Co-authored-by: Omar Sanseviero <osanseviero@gmail.com> * Update docs/hub/spaces-changelog.md Co-authored-by: Omar Sanseviero <osanseviero@gmail.com> * Update docs/hub/spaces-changelog.md Co-authored-by: Omar Sanseviero <osanseviero@gmail.com> * Misc changes * Fix rebase mistakes * Fix merge conflict Co-authored-by: Nima Boscarino <nima@huggingface.co> Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> Co-authored-by: Julien Chaumond <julien@huggingface.co> Co-authored-by: Omar Sanseviero <osanseviero@gmail.com> Co-authored-by: Nima Boscarino <nima.boscarino@gmail.com>
NimaBoscarino
requested review from
osanseviero,
gary149,
julien-c,
mishig25 and
stevhliu
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. |
|
Can we rename files |
* Docs Revamp: Models documentation (#117) Add content for models, and move deprecated content to its own folder (for dev purposes). Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * split Repo licenses into its own page * Some initial doc about pull-requests and discussions Co-authored-by: Nima Boscarino <nima@huggingface.co> Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Pierrci
reviewed
May 25, 2022
|
|
||
| ```bash | ||
| [remote "origin"] | ||
| fetch = +refs/pr/*:refs/remotes/origin/pr/* |
There was a problem hiding this comment.
Suggested change
| fetch = +refs/pr/*:refs/remotes/origin/pr/* | |
| fetch = +refs/pr/*:refs/remotes/origin/pr/* |
stevhliu
reviewed
May 25, 2022
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Pierrci
reviewed
May 27, 2022
Comment on lines
+74
to
76
| * Add the type to `PipelineType`. Note that pipeline types are sorted into different categories (NLP, Audio, Computer Vision, and others). | ||
| * Specify the task color in `PIPELINE_COLOR`. | ||
| * Specify the display order in `PIPELINE_TAGS_DISPLAY_ORDER`. |
There was a problem hiding this comment.
I think this is outdated cc @osanseviero
Co-authored-by: Pierric Cistac <Pierrci@users.noreply.github.com>
Co-authored-by: Merve Noyan <merveenoyan@gmail.com> Co-authored-by: Nima Boscarino <nima@huggingface.co>
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.
(#62) This PR reorganizes the existing Hub docs, and adds some new content to cover previously undocumented features. The docs have been reworked to be delivered via doc-builder, and as such changes to moon landing are required (https://github.com/huggingface/moon-landing/pull/2955).
For an overview of the structure of the docs, visit Notion (closed access). In short, the docs are structures around:
Something that didn't make it into here yet is "Best practices for handling multiple experiments" -- @osanseviero do you think it would be okay for this to be in a future PR? I've read through #53 but I don't quite know enough to write something useful up for it at the moment.
The following PRs should be merged into this branch (or at least merged after this PR):