Who's there?
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
pip install -U whos-there
or install with Poetry
poetry add whos-there
🤯
How to use it
from whos_there.callback import NotificationCallback
from whos_there.senders.debug import DebugSender
trainer = pl.Trainer(
callbacks=[
NotificationCallback(senders=[
# Add your senders here
DebugSender(),
])
]
)
Requires your e-mail provider specific SMTP settings.
from whos_there.senders.email import EmailSender
# ...
EmailSender(
host="smtp.example.de",
port=587,
sender_email="[email protected]",
password="*********",
recipient_emails=[
"[email protected]",
"[email protected]",
]
)
Discord
Requires your Discord channel's webhook URL.
from whos_there.senders.discord import DiscordSender
# ...
DiscordSender(
webhook_url="https://discord.com/api/webhooks/XXXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
)
Slack
Requires your Slack room webhook URL and optionally your user id (if you want to tag yourself or someone else).
from whos_there.senders.slack import SlackSender
# ...
SlackSender(
webhook_url="https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX",
channel="channel_name",
user_mentions=[
"XXXXXXXX"
]
)
Teams
Requires your Team Channel webhook URL.
from whos_there.senders.teams import TeamsSender
# ...
TeamsSender(
webhook_url="https://XXXXX.webhook.office.com/",
user_mentions=[
"twsl"
]
)
Telegram
You can also use Telegram Messenger to get notifications. You'll first have to create your own notification bot by following the three steps provided by Telegram here and save your API access TOKEN. Telegram bots are shy and can't send the first message so you'll have to do the first step. By sending the first message, you'll be able to get the chat_id required (identification of your messaging room) by visiting https://api.telegram.org/bot
and get the int under the key message['chat']['id'].
from whos_there.senders.telegram import TelegramSender
# ...
TelegramSender(
chat_id=1234567890,
token="XXXXXXX:XXXXXXXXXXXXXXXXXXXXXXXXXXX"
)
🛡
License
This project is licensed under the terms of the MIT license. See LICENSE for more details.
🏅
Credits
This project was generated with
Big thanks to knockknock for the idea and code snippets.
183 Dec 29, 2022
4 Dec 15, 2022
167 Dec 14, 2022
633 Jan 04, 2023
95 Jan 02, 2023
68 Jan 03, 2023
44 Dec 28, 2022
829 Dec 31, 2022
762 Jan 02, 2023
956 Jan 01, 2023
2 Aug 02, 2022
216 Dec 30, 2022
3 Dec 05, 2022
12 Dec 15, 2022
110 Dec 03, 2022
1 Feb 22, 2022
38 Jan 05, 2023
10 Oct 18, 2022
3k Jan 08, 2023
2 Oct 24, 2022