-
Notifications
You must be signed in to change notification settings - Fork 456
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
Step by step guide on adding Model Hub support to libraries #86
Conversation
Co-authored-by: osanseviero <osanseviero@gmail.com> Co-authored-by: Julien Chaumond <julien@huggingface.co>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very nice ! A thorough and easy to read doc item IMO
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great, neat and easy to read!
I left minor nits.
Just three suggestions
- Use Hugging Face consistently (sometimes you use HuggingFace and sometimes HuggingFace)
- Similarly, use either the Hub or Hugging Face Hub consistently. turbo nit: please capitalize it :)
- If possible, add a link to a PR that shows how to do each of these three parts (download example, etc)
Nice documentation :) In the future, the documentation on adding the docker image to the inference API could be a bit more extensive, e.g. what is the principle architecture, what is the purpose of the pipelines, how to add different tasks that a library is supporting etc. So far for me it would be mainly checking the other examples and copy&pasting their code and hoping that I don't break anything. Also how to test your docker container locally if everything is correct (i.e. how does the input request has to look like, and are there requirements for the output?) Not super important for now, but might be interesting in the long term if we want to include more libs in the inference API |
Thanks for pinging, this looks great. |
Year, that looks great! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great @LysandreJik, super helpful!
Co-authored-by: Julien Chaumond <julien@huggingface.co>
Co-authored-by: Julien Chaumond <julien@huggingface.co>
Co-authored-by: Julien Chaumond <julien@huggingface.co>
Co-authored-by: Julien Chaumond <julien@huggingface.co>
…uggingface_hub into step-by-step-guide
I did a second pass, updated some links and added some new images. Feel free to take a look :) |
lgtm |
This PR adds a detailed guide on adding Model Hub support to downstream libraries.
It covers:
Pinging current library owners that have integrated with the model hub for potential feedback 🤗:
Looking forward to your feedback! The file is visible here, and it will end up on the huggingface.co website when merged.