Skip to content

whos-there: The spiritual successor to knockknock for PyTorch Lightning, get notified when your training ends

Welcome to whos-there's documentation!

Build Documentation GitHub Release PyPI - Package Version PyPI - Python Version Dependencies Status Conda - Platform Conda (channel only) Docs with MkDocs Poetry linting: ruff pre-commit Checked with pyright security: bandit vulnerability: safety Semantic Versions License

The spiritual successor to knockknock for PyTorch Lightning, to get a notification when your training is complete or when it crashes during the process with a single callback.

Features

  • Supports E-Mail, Discord, Slack, Teams, Telegram

Installation

With pip: 

python -m pip install whos-there

With poetry: 

poetry add whos-there

With conda:

conda install conda-forge::whos-there
Check here for more information.

Usage

from whos_there.callback import NotificationCallback
from whos_there.senders.debug import DebugSender

See a more complete example in the notebooks folder.

API

Check the API reference for more details.