Add JupyterLab docs (#1233)

* Add JupyterLab docs * Update docs/hub/spaces-sdks-docker-jupyter.md Co-authored-by: apolinário <[email protected]> * Update docs/hub/spaces-sdks-docker-jupyter.md Co-authored-by: Pedro Cuenca <[email protected]> * Update docs/hub/spaces-sdks-docker-jupyter.md Co-authored-by: apolinário <[email protected]> * Update docs/hub/spaces-sdks-docker-jupyter.md Co-authored-by: Pedro Cuenca <[email protected]> --------- Co-authored-by: apolinário <[email protected]> Co-authored-by: Pedro Cuenca <[email protected]>
huggingface · Mar 7, 2024 · 90fdcdf · 90fdcdf
1 parent 79ae05e
commit 90fdcdf
Show file tree

Hide file tree

Showing 2 changed files with 54 additions and 4 deletions.
diff --git a/docs/hub/_toctree.yml b/docs/hub/_toctree.yml
@@ -204,22 +204,24 @@
         title: Your first Docker Spaces
       - local: spaces-sdks-docker-examples
         title: Example Docker Spaces
+      - local: spaces-sdks-docker-jupyter
+        title: JupyterLab on Spaces
       - local: spaces-sdks-docker-argilla
         title: Argilla on Spaces
+      - local: spaces-sdks-docker-livebook
+        title: Livebook on Spaces
       - local: spaces-sdks-docker-label-studio
         title: Label Studio on Spaces
       - local: spaces-sdks-docker-aim
         title: Aim on Spaces
-      - local: spaces-sdks-docker-livebook
-        title: Livebook on Spaces
       - local: spaces-sdks-docker-shiny
         title: Shiny on Spaces
       - local: spaces-sdks-docker-zenml
         title: ZenML on Spaces
-      - local: spaces-sdks-docker-panel
-        title: Panel on Spaces
       - local: spaces-sdks-docker-chatui
         title: ChatUI on Spaces
+      - local: spaces-sdks-docker-panel
+        title: Panel on Spaces
       - local: spaces-sdks-docker-tabby
         title: Tabby on Spaces
       - local: spaces-sdks-docker-giskard

diff --git a/docs/hub/spaces-sdks-docker-jupyter.md b/docs/hub/spaces-sdks-docker-jupyter.md
@@ -0,0 +1,48 @@
+# JupyterLab on Spaces
+
+[JupyterLab](https://jupyter.org/) is a web-based interactive development environment for Jupyter notebooks, code, and data. It is a great tool for data science and machine learning, and it is widely used by the community. With Hugging Face Spaces, you can deploy your own JupyterLab instance and use it for development directly from the Hugging Face website.
+
+## ⚡️ Deploy a JupyterLab instance on Spaces
+
+You can deploy JupyterLab on Spaces with just a few clicks. First, go to [this link](https://huggingface.co/new-space?template=SpacesExamples/jupyterlab) or click the button below:
+
+<a  href="https://huggingface.co/new-space?template=SpacesExamples/jupyterlab">
+  <img src="https://huggingface.co/datasets/huggingface/badges/resolve/main/deploy-to-spaces-lg.svg" />
+</a>
+
+Spaces requires you to define:
+
+* An **Owner**: either your personal account or an organization you're a
+  part of. 
+
+* A **Space name**: the name of the Space within the account
+  you're creating the Space.
+
+* The **Visibility**: _private_ if you want the
+  Space to be visible only to you or your organization, or _public_ if you want
+  it to be visible to other users. 
+
+* The **Hardware**: the hardware you want to use for your JupyterLab instance. This goes from CPUs to H100s.
+
+* You can optionally configure a `JUPYTER_TOKEN` password to protect your JupyterLab workspace. When unspecified, defaults to `huggingface`. We strongly recommend setting this up if your Space is public or if the Space is in an organization.
+
+<Tip warning={true}}>
+
+Storage in Hugging Face Spaces is ephemeral, and the data you store in the default configuration can be lost in a reboot or reset of the Space. We recommend to save your work to a remote location or to use persistent storage for your data.
+
+</Tip>
+
+### Setting up persistent storage
+
+To set up persistent storage on the Space, you go to the Settings page of your Space and choose one of the options: `small`, `medium` and `large`. Once persistent storage is set up, the JupyterLab image gets mounted in `/data`.
+
+
+## Read more
+
+- [HF Docker Spaces](https://huggingface.co/docs/hub/spaces-sdks-docker)
+
+If you have any feedback or change requests, please don't hesitate to reach out to the owners on the [Feedback Discussion](https://huggingface.co/spaces/SpacesExamples/jupyterlab/discussions/3).
+
+## Acknowledgments
+
+This template was created by [camenduru](https://twitter.com/camenduru) and [nateraw](https://huggingface.co/nateraw), with contributions from [osanseviero](https://huggingface.co/osanseviero) and [azzr](https://huggingface.co/azzr).