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

doc for Spaces #189

Merged
merged 6 commits into from
Jul 15, 2021
Merged

doc for Spaces #189

merged 6 commits into from
Jul 15, 2021

Conversation

julien-c
Copy link
Member

Screen capture:

screencapture-localhost-5564-docs-hub-spaces-2021-07-14-14_24_34

@julien-c julien-c added the documentation Improvements or additions to documentation label Jul 14, 2021
@julien-c julien-c requested a review from nateraw July 14, 2021 12:27
Copy link
Contributor

@cbensimon cbensimon left a comment

Choose a reason for hiding this comment

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

Really neat !

(I just need to actually implement pre-installed dependencies and finish Secrets management for the doc to be totally accurate)

@@ -5,7 +5,7 @@ title: Hugging Face Hub Endpoints
# Hugging Face Hub API Endpoints


We have open endpoints that you can use to retrieve information from the Hub as well as perform certain actions such as creating model repos. We offer a wrapper Python library, [`huggingface_hub`](https://github.com/huggingface/huggingface_hub), that allows easy access to these endpoints. We also provide a webhook to receive real-time incremental info about models. Enjoy!
We have open endpoints that you can use to retrieve information from the Hub as well as perform certain actions such as creating model repos. We offer a wrapper Python library, [`huggingface_hub`](https://github.com/huggingface/huggingface_hub), that allows easy access to these endpoints. We also provide a [webhook](#webhook) to receive real-time incremental info about models. Enjoy!
Copy link
Contributor

Choose a reason for hiding this comment

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

Unrelated ?

Copy link
Member Author

Choose a reason for hiding this comment

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

yep sorry

docs/hub/spaces.md Show resolved Hide resolved
@patrickvonplaten
Copy link
Contributor

This is awesome - it'd be great to let participants try that out :-)

In the docs it says that transfomers is not pre-installed. Should we have transformers pre-installed as well next to datasets?

Co-authored-by: Patrick von Platen <patrick.v.platen@gmail.com>
@julien-c
Copy link
Member Author

In the docs it says that transfomers is not pre-installed. Should we have transformers pre-installed as well next to datasets?

Our thinking with @cbensimon was to be model-agnostic (the hub is not just for transformers), but i agree it'd be convenient to have it by default – maybe we can have it but not mention it in the doc?

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.

This is awesome! 🎉

Looking forward to this

docs/hub/spaces.md Outdated Show resolved Hide resolved
@@ -0,0 +1,95 @@
---
title: Documentation for Spaces
Copy link
Member

Choose a reason for hiding this comment

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

Do we have any thumbnail we could add here?


<h1>How to get started with Spaces</h1>

> ⚠️ This feature is currently in private beta, reach out to [julien-c](https://huggingface.co/julien-c) if you'd like to try it out ⚠️
Copy link
Member

Choose a reason for hiding this comment

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

I don't think https://huggingface.co/julien-c provides any email to contact you, should this be your email instead?

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.

Looks great!

Copy link
Member

@n1t0 n1t0 left a comment

Choose a reason for hiding this comment

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

Awesome, looks great!


## How does it work?

We deploy a containerized version of your code on our Infra, each time you commit. As a sidenote, we have many cool infra challenges to solve, if you'd like to help us, please consider reaching out 🙂.
Copy link
Member

Choose a reason for hiding this comment

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

👍

<!-- Add screencap of listing directory -->

Finally, we've been thinking of providing a way to run **custom apps**, for instance Python server code for the backend + a unified set of widgets/frontend JS code, or even custom Docker image serving. Do get in touch if you would like to build something more custom.

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
## Can I create private Spaces?
Yes! Just like with models and datasets, a Hugging Face subscription will allow you to set a new Space as private when creating it. You can create a private Space for your account, or share a private Space within your organization. [Check our our plans](https://huggingface.co/pricing) to get started.

Copy link
Member Author

Choose a reason for hiding this comment

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

technically aren't restricted to Paid users, but we can still have this wording to promote Pro accounts (it's remaining in other parts of the doc too)

@jeffboudier
Copy link
Member

jeffboudier commented Jul 15, 2021 via email

docs/hub/spaces.md Outdated Show resolved Hide resolved
docs/hub/spaces.md Outdated Show resolved Hide resolved
@julien-c julien-c merged commit b93cc68 into main Jul 15, 2021
@julien-c julien-c deleted the docs-spaces branch July 15, 2021 13:41
@julien-c
Copy link
Member Author

Thanks everyone for the reviews, I think I addressed everything, but do let me know if i missed anything

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

8 participants