diff --git a/docs/_source/_static/images/installation/huggingface-spaces/hf-no-persistent-storage.PNG b/docs/_source/_static/images/installation/huggingface-spaces/hf-no-persistent-storage.PNG new file mode 100644 index 0000000000..d5b3ceb513 Binary files /dev/null and b/docs/_source/_static/images/installation/huggingface-spaces/hf-no-persistent-storage.PNG differ diff --git a/docs/_source/_static/images/installation/huggingface-spaces/persistent-storage.PNG b/docs/_source/_static/images/installation/huggingface-spaces/persistent-storage.PNG new file mode 100644 index 0000000000..f72c4923a0 Binary files /dev/null and b/docs/_source/_static/images/installation/huggingface-spaces/persistent-storage.PNG differ diff --git a/docs/_source/getting_started/installation/deployments/huggingface-spaces.md b/docs/_source/getting_started/installation/deployments/huggingface-spaces.md index 92f9358375..1c0abb9ab2 100644 --- a/docs/_source/getting_started/installation/deployments/huggingface-spaces.md +++ b/docs/_source/getting_started/installation/deployments/huggingface-spaces.md @@ -3,7 +3,7 @@ Argilla nicely integrates with the Hugging Face stack (`datasets`, `transformers`, `hub`, and `setfit`), and now it can also be deployed using the Hub's Spaces. ```{warning} -HuggingFace Spaces now have persistent storage and this is supported from Argilla 1.11.0 onwards, but you will need to manually activate it via the HuggingFace Spaces settings. Otherwise, unless you're on a paid space upgrade, after 48 hours of inactivity the space will be shut off and you will lose all the data. To avoid losing data, we highly recommend using the persistent storage layer offered by HuggingFace. +Hugging Face Spaces now have persistent storage and this is supported from Argilla 1.11.0 onwards, but you will need to manually activate it via the Hugging Face Spaces settings. Otherwise, unless you're on a paid space upgrade, after 48 hours of inactivity the space will be shut off and you will lose all the data. To avoid losing data, we highly recommend using the persistent storage layer offered by Hugging Face. For more info check the ["Setting up persistent storage"](#setting-up-persistent-storage) section. ``` In this guide, you'll learn to deploy your own Argilla app and use it for data labeling workflows right from the Hub. @@ -22,9 +22,7 @@ You can deploy Argilla on Spaces with just a few clicks: You need to define the **Owner** (your personal account or an organization), a **Space name**, and the **Visibility** (`Public` or `Private`, in which case you will need to [set a `HF_TOKEN`](https://huggingface.co/settings/tokens)). If you plan to use the Space frequently or handle large datasets for data labeling and feedback collection, upgrading the hardware with a more powerful CPU and increased RAM can enhance performance. -
- -
+![HF_Spaces](../../../_static/images/installation/huggingface-spaces/hf-no-persistent-storage.PNG) :::{tip} If you want to customize the title, emojis, and colors of your space, go to "Files and Versions" and edit the metadata of your README.md file. @@ -42,7 +40,7 @@ You'll see the login screen where you need to use either `admin` or `argilla` wi :::{tip} -For quick experimentation, you can jump directly into the next section. If you want to add access restrictions, go to the "Setting up secret environment variables" at the end of this document. Setting up secret variables is recommended for longer-term usage. +For quick experimentation, you can jump directly into the next section. If you want to add access restrictions, go to the ["Setting up secret environment variables"](#setting-up-secret-environment-variables) at the end of this document. In addition, if you prefer to enable persistent storage, go to the following [section](#setting-up-persistent-storage). Setting up secret variables and persistent storage is recommended for longer-term usage. ::: ### Your Argilla Space URL @@ -138,6 +136,14 @@ As a next step, you can check the [Argilla Tutorials](https://docs.argilla.io/en If you have improvement suggestions or need specific support, please join [Argilla Slack community](https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g) or reach out on [Argilla's GitHub repository](https://github.com/argilla-io/argilla). +## Setting up persistent storage + +Hugging Face Spaces recently introduced a feature for persistent storage, which must be enabled manually through the Hugging Face Spaces settings. Without this activation, and if you're not subscribed to a paid space upgrade, the space will automatically shut down after 48 hours of inactivity, resulting in data loss. To prevent this, we highly recommend using the persistent storage layer offered by Hugging Face. + +To enable [persistent storage](https://huggingface.co/docs/hub/spaces-storage#persistent-storage), go to the "Settings" tab on your created Space and click on the desired plan on the "Persistent Storage" section. This will enable persistent storage for your Space and you will be able to use it for data labeling and feedback collection. + +![Alt text](../../../_static/images/installation/huggingface-spaces/persistent-storage.PNG) + ## Setting up secret environment variables The Space template provides a way to set up different **optional settings** focusing on securing your Argilla Space.