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

Add documentation for endpoints #155

Merged
merged 11 commits into from
Jul 5, 2021
Merged

Add documentation for endpoints #155

merged 11 commits into from
Jul 5, 2021

Conversation

osanseviero
Copy link
Member

@osanseviero osanseviero commented Jul 2, 2021

Fix #129

Screen Shot 2021-07-02 at 4 57 28 PM

Screen Shot 2021-07-02 at 4 57 34 PM

@osanseviero osanseviero marked this pull request as draft July 2, 2021 14:55
@osanseviero osanseviero removed the request for review from LysandreJik July 2, 2021 14:55
@osanseviero osanseviero marked this pull request as ready for review July 2, 2021 14:58
@Pierrci
Copy link
Member

Pierrci commented Jul 2, 2021

"Hugging Face API"?

@osanseviero
Copy link
Member Author

Couldn't it end up being a bit confusing with the Inference API?

@julien-c
Copy link
Member

julien-c commented Jul 2, 2021

"Hugging Face Hub endpoints" no?

Copy link
Member

@julien-c julien-c left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few changes suggestions:

  • I would split "Endpoint" and "huggingface_hub method" into two distinct colums for clarity
  • (the http method can be in the same column as the endpoint to save space)
  • i would change the order to put list_models and model_info (arguably the most important ones) first

docs/hub/endpoints.md Outdated Show resolved Hide resolved
docs/hub/endpoints.md Outdated Show resolved Hide resolved
osanseviero and others added 2 commits July 2, 2021 17:52
Co-authored-by: Julien Chaumond <julien@huggingface.co>
@osanseviero
Copy link
Member Author

osanseviero commented Jul 2, 2021

[edit]: just saw your edit, I'll try it out

I would split "Endpoint" and "huggingface_hub method" into two distinct colums for clarity

This was my initial approach but I struggled a bit with the column widths. The result was pretty much that a column is "hidden" unless the user scrolls horizontally, which is not super clear that you can do. I tried some hacks (setting img with with, etc) to fix this, but they didn't work.

@osanseviero
Copy link
Member Author

osanseviero commented Jul 2, 2021

I updated based on the comments @julien-c. Let me know if this looks good

Screen Shot 2021-07-02 at 7 09 52 PM

Screen Shot 2021-07-02 at 7 09 56 PM

@osanseviero osanseviero requested a review from julien-c July 2, 2021 17:12
@julien-c
Copy link
Member

julien-c commented Jul 2, 2021

i think it works, what do you think?

docs/hub/_sections.yml Outdated Show resolved Hide resolved
docs/hub/endpoints.md Outdated Show resolved Hide resolved
@osanseviero
Copy link
Member Author

Yes, I think for the time being this works :)

osanseviero and others added 2 commits July 2, 2021 19:16
Co-authored-by: Julien Chaumond <julien@huggingface.co>
Co-authored-by: Julien Chaumond <julien@huggingface.co>
* Document hub webhook

* [skip ci]

* suggestions from @osanseviero

Co-authored-by: Omar Sanseviero <osanseviero@users.noreply.github.com>

Co-authored-by: Omar Sanseviero <osanseviero@users.noreply.github.com>
Copy link
Member

@LysandreJik LysandreJik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, LGTM @osanseviero!

docs/hub/endpoints.md Outdated Show resolved Hide resolved
docs/hub/endpoints.md Outdated Show resolved Hide resolved
docs/hub/endpoints.md Outdated Show resolved Hide resolved
osanseviero and others added 2 commits July 5, 2021 09:11
Co-authored-by: Lysandre Debut <lysandre@huggingface.co>
@osanseviero osanseviero merged commit 73354dc into main Jul 5, 2021
@osanseviero osanseviero deleted the add_endpoints branch July 5, 2021 13:52
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.

Add Documentation page on list_models, model_info, and similar methods
4 participants