mirror of
https://github.com/clearml/clearml-docs
synced 2025-06-26 18:17:44 +00:00
Change headings to title caps (#62)
This commit is contained in:
@@ -11,7 +11,7 @@ in the UI and send it for long-term training on a remote machine.
|
||||
|
||||
**If you are not that lucky**, this section is for you :)
|
||||
|
||||
## What does ClearML Session do?
|
||||
## What Does ClearML Session Do?
|
||||
`clearml-session` is a feature that allows to launch a session of JupyterLab and VS Code, and to execute code on a remote
|
||||
machine that better meets resource needs. With this feature, local links are provided, which can be used to access
|
||||
JupyterLab and VS Code on a remote machine over a secure and encrypted SSH connection. By default, the JupyterLab and
|
||||
@@ -74,18 +74,18 @@ After entering a `clearml-session` command with all specifications:
|
||||
To run a session inside a Docker container, use the `--docker` flag and enter the docker image to use in the interactive
|
||||
session.
|
||||
|
||||
### Installing requirements
|
||||
### Installing Requirements
|
||||
`clearml-session` can install required Python packages when setting up the remote environment. A `requirement.txt` file
|
||||
can be attached to the command using `--requirements </file/location.txt>`.
|
||||
Alternatively, packages can be manually specified, using `--packages "<package_name>"`
|
||||
(for example `--packages "keras" "clearml"`), and they'll be automatically installed.
|
||||
|
||||
### Accessing a git repository
|
||||
### Accessing a Git Repository
|
||||
To access a git repository remotely, add a `--git-credentials` flag and set it to `true`, so the local .git-credentials
|
||||
file will be sent to the interactive session. This is helpful if working on private git repositories, and it allows for seamless
|
||||
cloning and tracking of git references, including untracked changes.
|
||||
|
||||
### Re-launching and shutting down sessions
|
||||
### Re-launching and Shutting Down Sessions
|
||||
If a `clearml-session` was launched locally and is still running on a remote machine, users can easily reconnect to it.
|
||||
To reconnect to a previous session, execute `clearml-session` with no additional flags, and the option of reconnecting
|
||||
to an existing session will show up:
|
||||
@@ -106,7 +106,7 @@ Connect to session [0-1] or 'N' to skip
|
||||
To shut down a remote session, which will free the `clearml-agent` and close the CLI, enter "Shutdown". If a session
|
||||
is shutdown, there is no option to reconnect to it.
|
||||
|
||||
### Connecting to an existing session
|
||||
### Connecting to an Existing Session
|
||||
If a `clearml-session` is running remotely, it's possible to continue working on the session from any machine.
|
||||
When `clearml-session` is launched, it initializes a task with a unique ID in the ClearML Server.
|
||||
|
||||
@@ -117,7 +117,7 @@ To connect to an existing session:
|
||||
1. Click on the JupyterLab / VS Code link that is outputted, or connect directly to the SSH session
|
||||
|
||||
|
||||
### Starting a debugging session
|
||||
### Starting a Debugging Session
|
||||
Previously executed experiments in the ClearML system can be debugged on a remote interactive session.
|
||||
Input into `clearml-session` the ID of a Task to debug, then `clearml-session` clones the experiment's git repository and
|
||||
replicates the environment on a remote machine. Then the code can be interactively executed and debugged on JupyterLab / VS Code.
|
||||
@@ -133,7 +133,7 @@ The Task must be connected to a git repository, since currently single script de
|
||||
1. In JupyterLab / VS Code, access the experiment's repository in the `environment/task_repository` folder.
|
||||
|
||||
|
||||
### Command line options
|
||||
### Command Line Options
|
||||
|
||||
<div className="tbl-cmd">
|
||||
|
||||
|
||||
Reference in New Issue
Block a user