Docs Revamp: Models documentation #117
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
NimaBoscarino
requested review from
osanseviero and
stevhliu
and removed request for
osanseviero and
stevhliu
stevhliu
reviewed
Apr 22, 2022
docs/hub/models-the-hub.md
Outdated
|
|
||
| ## Libraries | ||
|
|
||
| The Hub supports many libraries, and we're working on expanding this support! We're happy to welcome to the Hub a set of Open Source libraries that are pushing Machine Learning forward. |
There was a problem hiding this comment.
I think this could be a little clearer if we briefly describe how the Hub supports third-party libraries. For example, you could say something like:
Integrating the huggingface_hub library into your projects allows users to interact with the Hub directly from your library.
|
|
||
| ## Creating a Widget | ||
|
|
||
| A widget is automatically created for your model when you upload it to the Hub. To determine which pipeline and widget to display (`text-classification`, `token-classification`, `translation`, etc.), we analyze information in the repo, such as the metadata provided in the model card and configuration files. This information is mapped to a single `pipeline_tag`. We choose to expose **only one** widget per model for simplicity. |
There was a problem hiding this comment.
Maybe link to the model-cards page so users can see where this is all controlled?
Co-authored-by: Steven Liu <[email protected]>
NimaBoscarino
added a commit
that referenced
this pull request
May 11, 2022
Add content for models, and move deprecated content to its own folder (for dev purposes). Co-authored-by: Steven Liu <[email protected]>
|
for the assets (screenshots), if possible upload some higher-resolution ones. Here they're a bit blurry on retina screens cc @gary149 |
|
(you can pass them through tinypng.com before adding them to the repo if the files are too heavy |
julien-c
reviewed
May 12, 2022
| - [Model Cards](./models-cards) | ||
| - [CO<sub>2</sub> emissions](./models-cards-co2) | ||
| - [Tasks](./models-tasks) | ||
| - [Interacting with models on the Hub](./models-interacting) |
There was a problem hiding this comment.
Interacting with models sounds vague to me, WDYT of changing to something like downloading and uploading models to/from the hub?
or even split into download and upload
There was a problem hiding this comment.
Sounds good to me! I put that in my to-do list for the final polishing pass :)
NimaBoscarino
added a commit
that referenced
this pull request
May 15, 2022
Add content for models, and move deprecated content to its own folder (for dev purposes). Co-authored-by: Steven Liu <[email protected]>
NimaBoscarino
added a commit
that referenced
this pull request
May 20, 2022
Add content for models, and move deprecated content to its own folder (for dev purposes). Co-authored-by: Steven Liu <[email protected]>
NimaBoscarino
added a commit
that referenced
this pull request
May 24, 2022
Add content for models, and move deprecated content to its own folder (for dev purposes). Co-authored-by: Steven Liu <[email protected]>
osanseviero
added a commit
that referenced
this pull request
May 24, 2022
* 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 <[email protected]> * [Spaces] Changelog update * Update docs/hub/spaces-changelog.md Co-authored-by: Julien Chaumond <[email protected]> * Update docs/hub/spaces-changelog.md Co-authored-by: Julien Chaumond <[email protected]> * Update docs/hub/spaces-changelog.md Co-authored-by: Omar Sanseviero <[email protected]> * Update docs/hub/spaces-changelog.md Co-authored-by: Omar Sanseviero <[email protected]> * Update docs/hub/spaces-changelog.md Co-authored-by: Omar Sanseviero <[email protected]> * Update docs/hub/spaces-changelog.md Co-authored-by: Omar Sanseviero <[email protected]> * Update docs/hub/spaces-changelog.md Co-authored-by: Omar Sanseviero <[email protected]> * Misc changes * Fix rebase mistakes * Fix merge conflict Co-authored-by: Nima Boscarino <[email protected]> Co-authored-by: Steven Liu <[email protected]> Co-authored-by: Julien Chaumond <[email protected]> Co-authored-by: Omar Sanseviero <[email protected]> Co-authored-by: Nima Boscarino <[email protected]>
NimaBoscarino
added a commit
that referenced
this pull request
May 25, 2022
Add content for models, and move deprecated content to its own folder (for dev purposes). Co-authored-by: Steven Liu <[email protected]>
julien-c
added a commit
that referenced
this pull request
May 25, 2022
* 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 <[email protected]> * split Repo licenses into its own page * Some initial doc about pull-requests and discussions Co-authored-by: Nima Boscarino <[email protected]> Co-authored-by: Steven Liu <[email protected]>
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 migrates content (and introduces some new content) to form a "Models" section, with several subsections. The scope of this section is to help readers understand how to find, use, upload, and manage models on the Hub.
Anything that's specifically about using
huggingface_hubis omitted from this section. I'm sure there are other ways to structure the hierarchy of the content in this section, so let me know if you have any ideas!Note: Images have been uploaded to the repo here, but will be moved to the documentation-images dataset repo in a future PR (I'll do all the images all at once). Also, most headings have not been renamed. If we want to go with simpler headings (i.e. from this convo #62 (comment)) then I figured that could happen in a separate PR, where all the headings in the docs get redone at the same time to ensure consistency.