https://github.com/chaoyivision/python-dprint
An easy-to-use debug print tool for deep learning projects in python. PyPi: https://pypi.org/project/pydprint/
https://github.com/chaoyivision/python-dprint
deep-learning dprint python
Last synced: 6 months ago
JSON representation
An easy-to-use debug print tool for deep learning projects in python. PyPi: https://pypi.org/project/pydprint/
- Host: GitHub
- URL: https://github.com/chaoyivision/python-dprint
- Owner: chaoyivision
- License: mit
- Created: 2022-02-23T21:56:50.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-02-25T06:53:56.000Z (over 4 years ago)
- Last Synced: 2025-09-24T23:51:34.033Z (10 months ago)
- Topics: deep-learning, dprint, python
- Language: Python
- Homepage:
- Size: 306 KB
- Stars: 9
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# python-dprint
An easy-to-use debug print tool for deep learning studies in python.
# Why we need it?
The built-in debugger is great, however, for some reason :upside_down_face:, 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](https://www.geeksforgeeks.org/print-colors-python-terminal/)).
4. 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 :crossed_fingers:.
```
#loss = loss1 + loss2
loss = loss1 + dprint(loss2)
```
3. (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 :innocent:
- Installation
```
pip install pydprint
```
- Import
```
from pydprint import dprint
```
- Demo Usecases: [demo.py](https://github.com/chaoyivision/python-deprint/blob/main/demo.py) (see some examples).