Skip to content

Latest commit

 

History

History
30 lines (24 loc) · 1.78 KB

README.md

File metadata and controls

30 lines (24 loc) · 1.78 KB

python-dprint

An easy-to-use debug print tool for deep learning studies in python.

img

Why we need it?

The built-in debugger is great, however, for some reason 🙃, we may still want to print them out for debugging purpose. For such scenarios, we would like it to have the following feats. (especially when running deep learning projects - where our monitoring/debugging variables are being updated within loops).

  1. Context Info. We may like to display the invoking positions for these variables (to help us identify back each of them), including their file name, func name, and line number.

  2. Different Color. We may like it to be clearly distinguishable from tons of normal printings within loops, such as displaying training loss. The default color is YELLOW now, which could be custmozed in future releases soon (full color-code can be found here).

  3. Pass-Through Print. We may like to monitor things without breaking current code structure, i.e., print-and-return. Note: you can still simply dprint() them (just like print() in python) - it's compatible to both usecases 🤞.

#loss = loss1 + loss2
loss = loss1 + dprint(loss2)
  1. (Optional) Multiple Variables. We may not like to leave too much print() statement in our code - they look redundent - instead, we may like to display multiple variable within lines as less as possible (by passing them all as a dict).

How we use it?

Very easy 😇

  • Installation
pip install pydprint
  • Import
from pydprint import dprint
  • Demo Usecases: demo.py (see some examples).