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

HuggingFace Spaces server deployment option #1427

Merged
merged 20 commits into from Mar 29, 2023

Conversation

strickvl
Copy link
Contributor

@strickvl strickvl commented Mar 20, 2023

Added a Dockerfile to be used by default in Huggingface Spaces to deploy the ZenML server. Also adds documentation for such a deployment.

A photo and a button will need to be added after we're made 'official' on Huggingface.

This PR includes a draft of the documentation that would be included on Huggingface's own native docs -- i.e. like Argilla have here. Parts of it are replicated in the docs page created on this PR). Once approved, I'll submit the .md file and the image asset in a PR on Huggingface's docs repo.

Pre-requisites

Please ensure you have done the following:

  • I have read the CONTRIBUTING.md document.
  • If my change requires a change to docs, I have updated the documentation accordingly.
  • If I have added an integration, I have updated the integrations table and the corresponding website section.
  • I have added tests to cover my changes.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Other (add details above)

@strickvl strickvl added documentation Improvements or additions to documentation enhancement New feature or request internal To filter out internal PRs and issues labels Mar 20, 2023
@strickvl strickvl requested a review from schustmi March 20, 2023 16:18
@strickvl strickvl marked this pull request as ready for review March 21, 2023 15:05
@strickvl strickvl requested a review from schustmi March 21, 2023 15:05
docs/book/drafts/spaces-sdks-docker-zenml.md Outdated Show resolved Hide resolved

You can deploy ZenML on HuggingFace Spaces with just a few clicks:

BUTTON GOES HERE
Copy link
Contributor

Choose a reason for hiding this comment

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

Which button :-)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Same here. We need to wait for them before we get the button I think.

@strickvl
Copy link
Contributor Author

@htahir1 perhaps you want to give this a glance over. This includes a text (the one inside the drafts folder) that will go up on the Huggingface docs site, so possible first point of call for people ever learning about ZenML...

Copy link
Contributor

@htahir1 htahir1 left a comment

Choose a reason for hiding this comment

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

Looks good, had minor comments

docs/book/drafts/spaces-sdks-docker-zenml.md Outdated Show resolved Hide resolved
docs/book/drafts/spaces-sdks-docker-zenml.md Outdated Show resolved Hide resolved
docs/book/drafts/spaces-sdks-docker-zenml.md Outdated Show resolved Hide resolved
@strickvl strickvl requested a review from htahir1 March 22, 2023 10:33
Copy link
Contributor

@htahir1 htahir1 left a comment

Choose a reason for hiding this comment

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

Looks good on my side!

@strickvl
Copy link
Contributor Author

HF docs PR made here just now. Will wait for the official space (and the photo) before merging on our side.

@stefannica stefannica self-requested a review March 24, 2023 08:48
@stefannica
Copy link
Collaborator

All good on my end.

@strickvl strickvl merged commit ca8f88b into develop Mar 29, 2023
3 checks passed
@strickvl strickvl deleted the feature/APL-138-hf-spaces-deployment branch March 29, 2023 12:32
strickvl added a commit that referenced this pull request Mar 29, 2023
* add HF spaces deployment type to enums

* update HF dockerfile with default user and password

* update Dockerfile

* start docs

* update docs WIP

* further docs edits

* simplify Dockerfile

* complete docs page

* add photo placeholder

* update docs adding diagram

* tweak language

* add HF-native documentation draft

* fix typo

* update button and photo

* update connect command

* update next steps

* update security precautions

* remove draft doc

* update HF docs

(cherry picked from commit ca8f88b)
strickvl added a commit that referenced this pull request Mar 29, 2023
* add HF spaces deployment type to enums

* update HF dockerfile with default user and password

* update Dockerfile

* start docs

* update docs WIP

* further docs edits

* simplify Dockerfile

* complete docs page

* add photo placeholder

* update docs adding diagram

* tweak language

* add HF-native documentation draft

* fix typo

* update button and photo

* update connect command

* update next steps

* update security precautions

* remove draft doc

* update HF docs

(cherry picked from commit ca8f88b)
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 enhancement New feature or request internal To filter out internal PRs and issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants