Rehaul 'how to integrate your library' docs #1442
Conversation
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
Co-authored-by: Omar Sanseviero <[email protected]>
Vaibhavs10
left a comment
Vaibhavs10
left a comment
There was a problem hiding this comment.
Niceee! 🔥 - Read through the PR didn't find any grammatical errors and such. Love the overall flow of the doc as well.
docs/hub/models-adding-libraries.md
Outdated
| } | ||
| ``` | ||
| 3. Finally, run the following test to ensure everything works as expected: | ||
| Here is a minimal [example](https://github.com/huggingface/huggingface.js/pull/561/files) adding integration for Grok-1. |
There was a problem hiding this comment.
Should we have an example including a snippet and a simpler download rule?
There was a problem hiding this comment.
What about this one? https://github.com/huggingface/huggingface.js/pull/885/files - It looks quite clean and has download counts and snippets both.
There was a problem hiding this comment.
Thanks! The VFI Mamba PR is indeed very nice with a complete PR and still concise. I've merged your suggestiong @Vaibhavs10 + updated the second link (Grok-1 PR was referenced twice). We should be good now!
|
Thanks for the reviews ❤️ Let's get this merged and hopefully see some high-quality PRs flowing in 😄 |
Reverting #913 now that huggingface/hub-docs#1442 has been merged. The PR template was not discoverable at all. Now users should be redirected to https://huggingface.co/docs/hub/models-adding-libraries which contains the same information.
I first started to work on this PR to document how to integrate a library with the Hub (i.e. how to open the PR on huggingface.js). In the end, I've updated more than that to focus the page on "how to implement the integration?" + "how to register your library?".
I feel that some sections are outdated, typically the "how to login" (out of scope for a library integration?) and "how to add inference API" (we don't want to add new libs to api-inference-community, right?) so I removed them. Let me know if you feel strongly against it.
Once merged, I will open a PR to delete https://github.com/huggingface/huggingface.js/blob/main/.github/pull_request_template/new_library.md which is currently useless (not discoverable 😕)
For reviewers: https://moon-ci-docs.huggingface.co/docs/hub/pr_1442/en/models-adding-libraries