ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-02-07 05:20:07 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Edit remote session sections (#838)

Browse Source
This commit is contained in:
pollfly 2024-05-15 15:54:24 +03:00 committed by GitHub
parent e2dc79e91f
commit ffb4155e6c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/apps/clearml_session.md
View File

@ -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

6
docs/remote_session.md
View File

@ -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.

2
sidebars.js
View File

@ -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'},