ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-06-26 18:17:44 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add Jupyter Lab UI app (#730)

Browse Source
This commit is contained in:
pollfly
2023-12-19 19:44:42 +02:00
committed by GitHub
parent 16d2addd7e
commit 2778c1625a
9 changed files with 92 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/img/apps_jupyter_lab.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 214 KiB

48
docs/webapp/applications/apps_jupyter_lab.md Normal file
View File

@@ -0,0 +1,48 @@
---
title: Jupyter Lab
---
:::important Enterprise Feature
The Jupyter Lab application is available under the ClearML Enterprise plan
:::
The Jupyter Lab UI application allows you to launch a remote Jupyter Lab session on a machine that better meets resource needs.
This feature provides a local link to access Jupyter Lab on a remote machine over a secure and encrypted SSH connection,
letting you use the IDE as if you're running on the target machine itself.
The Jupyter Lab session is set up using a [ClearML Agent](../../clearml_agent.md). When configuring an app instance,
select a queue, and the agent servicing that queue will download and launch the IDE on its machine. When the server
setup is complete, the dashboard displays a link to access the Jupyter Lab session.
Once you have launched an app instance, you can view the following information in its dashboard:
* App status indicator
* <img src="/docs/latest/icons/ico-jupyter-lab-loading.svg" alt="Jupyter loading" className="icon size-md" /> - Remote IDE is setting up
* <img src="/docs/latest/icons/ico-jupyter-lab-active.svg" alt="Jupyter active" className="icon size-md" /> - Remote IDE is active
* <img src="/docs/latest/icons/ico-jupyter-lab-idle.svg" alt="Jupyter idle" className="icon size-md" /> - Remote IDE is idle
* <img src="/docs/latest/icons/ico-jupyter-lab-stopped.svg" alt="Jupyter stopped" className="icon size-md" /> - Remote IDE is stopped
* Open IDE - link to the IDE session
* Idle time
* Server's resources monitoring (CPU / GPU / vMem utilization)
* Console - The console log shows the instance's activity, including server setup progress, server status changes
![Jupyter Lab Dashboard](../../img/apps_jupyter_lab.png)
## Extra Python packages to be installedApp Instance Configuration
* **Git** - To access a git repository remotely, add git information.
* Repository
* Branch
* Commit
* **Docker**
* Image - Docker image used to run the IDE in
* Docker arguments - `docker run` arguments, as a single string
* **Extra Packages** - Extra Python packages to be installed
* **Queue** - The queue serviced by the ClearML Agent that will execute the Jupyter Lab session
* **Maximum idle time** (hours) - Maximum time of inactivity, after which the session will shut down. Configure idleness
definitions under `Advanced Options`.
* **Advanced Options**
* Idle Network Threshold (MB/s) - Throughput under which the session will be considered idle
* Idle CPU Threshold (%) - CPU utilization under which the session will be considered idle
* Idle GPU Threshold (%) - GPU utilization under which the session will be considered idle

1
docs/webapp/applications/apps_overview.md
View File

@@ -22,6 +22,7 @@ ClearML provides the following applications:
* [**Project Dashboard**](apps_dashboard.md) - High-level project monitoring with Slack alerts
* [**Task Scheduler**](apps_task_scheduler.md) - Schedule tasks for one-shot and/or periodic execution at specified times (available under ClearML Enterprise Plan)
* [**Trigger Manager**](apps_trigger_manager.md) - Define tasks to be run when predefined events occur (available under ClearML Enterprise Plan)
* [**Jupyter Lab**](apps_jupyter_lab.md) - Launch a Jupyter Lab session on a remote machine (available under ClearML Enterprise Plan)
* [**VS Code**](apps_vscode.md) - Launch a VS Code session on a remote machine (available under ClearML Enterprise Plan)
## App Pages Layout