From ffb4155e6c71ffb7e347699cdb8377507cf4e198 Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Wed, 15 May 2024 15:54:24 +0300 Subject: [PATCH] Edit remote session sections (#838) --- docs/apps/clearml_session.md | 5 +++-- docs/remote_session.md | 6 +++++- sidebars.js | 2 +- 3 files changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/apps/clearml_session.md b/docs/apps/clearml_session.md index 5319b4f4..662adad0 100644 --- a/docs/apps/clearml_session.md +++ b/docs/apps/clearml_session.md @@ -2,7 +2,7 @@ title: ClearML Session CLI --- -`clearml-session` is a feature that allows to launch a session of JupyterLab and VS Code, and to execute code on a remote +`clearml-session` is a feature that allows to launch a session of JupyterLab, VS Code, and SSH, and to execute code on a remote machine that better meets resource needs. This feature provides local links to access JupyterLab and VS Code on a remote machine over a secure and encrypted SSH connection. By default, the JupyterLab and VS Code remote sessions use ports 8878 and 8898 respectively. @@ -70,7 +70,8 @@ error, you are good to go. ``` Notice the links are to `localhost` since all communication to the remote server itself is done over a secure SSH connection. - + Click on the Jupyter Lab or VScode links, or drop into SSH shell by typing `shell`. + 1. Now start working on the code as if you're running on the target machine itself! ## Re-launching and Shutting Down Sessions diff --git a/docs/remote_session.md b/docs/remote_session.md index dc3f9ec3..2be6599b 100644 --- a/docs/remote_session.md +++ b/docs/remote_session.md @@ -13,7 +13,11 @@ in the UI and send it for long-term training on a remote machine. ClearML provides tools that allow you to launch remote sessions and to execute code on a remote machine that better meets resource needs: -* [Clearml Session CLI](apps/clearml_session.md) - Launch a JupyterLab and VS Code session on a remote machine +* [Clearml Session CLI](apps/clearml_session.md) - Launch an interactive JupyterLab, VS Code, and SSH session on a remote machine: + * Automatically store and sync your [interactive session workspace](apps/clearml_session.md#storing-and-synchronizing-workspace) + * Replicate a previously executed experiment's execution environment and [interactively execute and debug](apps/clearml_session.md#starting-a-debugging-session) it on a remote session + * Develop directly inside your Kubernetes pods [see ClearML Agent](clearml_agent.md#kubernetes) + * And more! * GUI Applications (available under ClearML Enterprise Plan) - These apps provide local links to access JupyterLab or VS Code 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. diff --git a/sidebars.js b/sidebars.js index 3badd25d..7bd75145 100644 --- a/sidebars.js +++ b/sidebars.js @@ -65,7 +65,7 @@ module.exports = { }, 'hyper_datasets', 'model_registry', - {'Remote Session': [ + {'Remote IDE': [ 'remote_session', 'apps/clearml_session', {type: 'ref', id: 'webapp/applications/apps_jupyter_lab'},