Welcome to sshlab’s documentation!

Introduction

sshlab is a Python library that simplifies the process of launching Jupyter notebooks, TensorBoard, and managing remote processes on remote servers via SSH. It provides an easy-to-use command-line interface for starting, stopping, and managing Jupyter and TensorBoard instances.

Features

• Launch Jupyter Notebook or JupyterLab instances on remote servers via SSH.

• Launch TensorBoard instances on remote servers via SSH.

• Kill remote Jupyter and TensorBoard processes.

• Automatic port selection for local and remote servers.

• Simple YAML configuration file for managing multiple remote environments.

Contents:

• Installation
• Overview
  • Using the sshlab library
  • Configuration
  • Starting a remote Jupyter instance
  • Starting a remote TensorBoard instance
  • Killing a remote process
• API Documentation
  • sshlab
  • sshlab_kill
  • sshlab_tensorboard
  • utils
• Building the Documentation
  • Prerequisites
  • Building the Documentation

Indices and tables

• Index

• Module Index

• Search Page