README.md

metadata

title: Voila demo deployed on Hugging Face Spaces
emoji: 🚀
colorFrom: yellow
colorTo: green
sdk: docker
pinned: true
license: mit

:warning: The above header is required by Hugging Face!

Voila demo deployed on Hugging Face Spaces

This repository contains an example of deploying Voila dashboards from GitHub to Hugging Face Spaces.

Links.

• Hugging Face Project: https://huggingface.co/spaces/voila-dashboards/voila-huggingface
• Web App: https://voila-dashboards-voila-huggingface.hf.space/
• Spaces Documentation: https://huggingface.co/docs/hub/spaces

How to deploy your own dashboards.

1. Create a Hugging Face account and generate a user access token with writing rights.

2. Create a new repository on GitHub by using this repository as a template.

3. Create a new blank docker Space on Hugging Face.

4. Replace the project URL defined in .github/workflows/update-hf.yml (current URL is huggingface.co/spaces/voila-dashboards/voila-huggingface) with the URL of your Space project.

5. Add 2 secrets to this repository, named HF_USER for the Hugging Face user name and HF_TOKEN for the access token.

6. Add new notebooks to the notebooks directory.

7. Update dashboard dependencies in the environment.yml file.

8. On every commit to the main branch, the repository will is synced and deployed to the Hugging Face Spaces.

9. To get direct access to your deployment, go to Embed this Space and copy the direct URL of the Space.