DocsJupyterlab Integration

JupyterLab Integration

PyPI Package: trainwave-jupyter | Latest Version: 0.1.2

Seamlessly run your Jupyter notebooks on powerful GPU infrastructure with Trainwave. The Trainwave Jupyter Extension brings cloud GPU computing directly into your JupyterLab environment, letting you convert notebooks into scalable GPU jobs with just a few clicks.

Features

  • One-Click Job Launch: Convert notebooks to GPU jobs directly from the toolbar
  • Secure Authentication: Integrated login with your Trainwave account
  • Real-time Job Monitoring: Track job status and progress in real-time
  • Flexible Configuration: Customize GPU types, counts, and project settings
  • Auto-save: Automatically saves your notebook before launching jobs
  • Job History: View and manage your recent jobs from the extension

Installation

Prerequisites

  • Python 3.9 or higher
  • JupyterLab 4.0 or higher

Install from PyPI

pip install trainwave-jupyter

After installation, restart JupyterLab and look for the Trainwave icon in your notebook toolbar.

Quick Start

1. Sign In to Trainwave

  1. Open a Jupyter notebook
  2. Click the Trainwave icon in the toolbar
  3. Click “Sign In” and authenticate with your Trainwave account

2. Configure Your Settings

  1. Click the settings icon in the Trainwave dropdown
  2. Select your organization and project
  3. Choose your preferred GPU type and count
  4. Save your configuration

3. Launch Your First Job

  1. Open or create a notebook with your code
  2. Click the Trainwave icon in the toolbar
  3. Click “Launch Job”
  4. Enter a name for your job
  5. Your notebook will be automatically saved and submitted to Trainwave

4. Monitor Your Jobs

  • View active jobs in the Trainwave dropdown
  • Click on job names to open them in the Trainwave web interface
  • Jobs are automatically polled for status updates

Configuration

Environment Variables

export TRAINWAVE_API_ENDPOINT="https://backend.trainwave.ai"
export TRAINWAVE_POLLING_INTERVAL=10  # seconds
export TRAINWAVE_POLLING_TIMEOUT=300  # seconds

JupyterLab Settings

  1. Go to Settings → Advanced Settings Editor
  2. Select “Trainwave Jupyter Extension”
  3. Modify configuration as needed

Troubleshooting

Extension Not Appearing

If you don’t see the Trainwave icon in your notebook toolbar:

  1. Restart JupyterLab after installation
  2. Check installation: 
    jupyter labextension list
  3. Manually enable (if needed): 
    jupyter serverextension enable --py trainwave-jupyter
jupyter labextension enable trainwave-jupyter

Authentication Issues

  • Clear browser cache and try signing in again
  • Check network connectivity to trainwave.ai
  • Verify API endpoint in settings if using custom configuration

Job Launch Failures

  • Ensure your notebook is saved before launching
  • Confirm organization and project are selected in settings
  • Ensure you are properly authenticated

Support

support@trainwave.ai

ImagesAuthentication