mpdb 1.1.0

A lightweight distributed debugger built on top of ipdb.

mpdb

mpdb (Multiprocess PDB) is a lightweight distributed debugger built on top of ipdb.

Note: This project was formerly known as dpdb. The dpdb package name on PyPI was already taken, so it has been renamed to mpdb. Both import mpdb and import dpdb are supported with identical functionality.

Release Notes

• 1.1.0: rename from dpdb to mpdb.
  • PyPI package name dpdb was already taken, renamed to mpdb (Multiprocess PDB).
  • Full backward compatibility: both import mpdb and import dpdb work identically.
  • pip install mpdb is the recommended installation method.
• 1.0.0: first public release version.
  • single-process debugging
  • distributed command broadcast
  • file-based synchronization for non-torch.distributed scenarios
  • a built-in web UI
  • switching between web and terminal modes during a session

Install

pip install mpdb

Quick Start

import mpdb

def train():
    for step in range(10):
        if step == 5:
            mpdb.set_trace()

Run a script directly:

python -m mpdb your_script.py

Demo

The standalone repository ships with runnable examples under demo/:

python demo/demo_mpdb.py --mode single
python demo/demo_mpdb.py --mode file
python demo/demo_mpdb.py --mode torch

There is also a helper launcher for the torch demo:

bash demo/launch_mpdb.sh

Notes

• torch is optional and only required when you use sync_method='torch'.
• The web UI template is packaged with the wheel and works with pip install mpdb.
• Both import mpdb and import dpdb are supported and behave identically.