TelePyth

Telegram notification with IPython magics.

Overview

TelePyth (named /teləˈpaɪθ/) — a Telegram bot that is integrated with IPython. It provides an ability to send any text notification to user from Jupyter notebook or IPython CLI.

Bot Commands

Start chat with @telepyth_bot and get access token using /start command. TelePyth Bot understands some other simple commands. Type

• /start to begin interaction with bot;
• /revoke to revoke token issued before;
• /last to get current valid token or nothing if there is no active one;
• /help to see help message and credentials.

Usage

TelePyth command is available as an IPython magic command which could be used in Jupyter notebook as well as in plain IPython, qtconsole etc. TelePyth package could be also used directly in Python. And also, there is an HTTP API through which all the things works.

IPython Magics

It is easy to send messages after token is issued. Just install telepyth package by pip install telepyth, import it and notify

import telepyth

%telepyth -t 123456789
%telepyth 'Very magic, wow!'

HuggingFace Intergration

TelePyth also provides a trainer callback for HuggingFace's transformers. There are several usage scenario. The first one is via setting reporting method in TrainingArguments.

import telepyth.interaction
import transformers

args = TrainingArguments(output_dir, report_to=['telepyth'])

For more fine-grained control on how and when callback should report metrics, one can set up callback directly in a list of callbacks.

callback = TelePythCallback(label='finetune', policy='last')
trainer = Trainer(callbacks=[callback])
trainer.train()

TelePyth Client

TelepythClient allows to send notifications, figures and markdown messages directly without using magics.

from telepyth import TelepythClient

tp = TelepythClient()
tp.send_text('Hello, World!')  # notify with plain text
tp.send_text('_bold text_ and then *italic*')  # or with markdown formatted text
tp.send_figure(some_pyplot_figure, 'Awesome caption here!')  # or even with figure

CLI

TelePyth package also provide command line interface (CLI). It is similar to IPython magic. For example, one can send notifcation as following.

telepyth -t 31415926 "Moar notifications!"

HTTP API

Note that you can use TelePyth to send notifications via Telegram without any wrappers and bindings. This is useful for bash scripting. Just request TelePyth backend directly to notify user. For instance, to send message from bash:

curl https://daskol.xyz/api/notify/<access_token_here> \
    -X POST \
    -H 'Content-Type: plain/text' \
    -d 'Hello, World!'

See more examples and usage details here.

Credentials

© Daniel Bershatsky <daniel.bershatsky@skolkovotech.ru>, 2017-2022