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

Step by step guide on adding Model Hub support to libraries #86

Merged
merged 14 commits into from
Jun 18, 2021

Conversation

LysandreJik
Copy link
Member

This PR adds a detailed guide on adding Model Hub support to downstream libraries.

It covers:

  • Downstream: Usage from the hub
  • Upstream: Repository creation/uploads to the hub
  • Setting up the tool stack: inference API, widgets

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.

LysandreJik and others added 4 commits June 9, 2021 09:40
Co-authored-by: osanseviero <osanseviero@gmail.com>
Co-authored-by: Julien Chaumond <julien@huggingface.co>
Copy link
Contributor

@Narsil Narsil left a 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

Copy link
Member

@osanseviero osanseviero left a 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)

docs/adding-a-library.md Outdated Show resolved Hide resolved
docs/adding-a-library.md Outdated Show resolved Hide resolved
docs/adding-a-library.md Outdated Show resolved Hide resolved
docs/adding-a-library.md Show resolved Hide resolved
docs/adding-a-library.md Outdated Show resolved Hide resolved
@nreimers
Copy link

nreimers commented Jun 9, 2021

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

@mpariente
Copy link

Thanks for pinging, this looks great.

@sw005320
Copy link

sw005320 commented Jun 9, 2021

Year, that looks great!

Copy link
Contributor

@epwalsh epwalsh left a 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!

docs/adding-a-library.md Outdated Show resolved Hide resolved
docs/adding-a-library.md Outdated Show resolved Hide resolved
docs/adding-a-library.md Outdated Show resolved Hide resolved
docs/adding-a-library.md Outdated Show resolved Hide resolved
docs/adding-a-library.md Outdated Show resolved Hide resolved
osanseviero and others added 7 commits June 18, 2021 15:00
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>
@osanseviero osanseviero changed the base branch from main to add-framework-to-snapshot-download June 18, 2021 14:15
@osanseviero osanseviero changed the base branch from add-framework-to-snapshot-download to main June 18, 2021 14:15
@osanseviero
Copy link
Member

I did a second pass, updated some links and added some new images. Feel free to take a look :)

@julien-c
Copy link
Member

lgtm

docs/adding-a-library.md Outdated Show resolved Hide resolved
@osanseviero osanseviero merged commit fa1e71c into main Jun 18, 2021
@osanseviero osanseviero deleted the step-by-step-guide branch June 18, 2021 21:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

9 participants