tf-notify

Want to get notified on the progress of your TensorFlow model training?

This package provides a tf.keras callback to send notifications to a messaging app of your choice.

Install

The recommended installation is via pip:

pip install tf-notify

Supported Apps

The following apps are currently supported. But, do check the project frequently, as many more will soon be supported!

Slack

Telegram

Email (SMTP)

Usage

import tensorflow as tf
from tf_notify import SlackCallback


# define the tf.keras model to add callbacks to
model = tf.keras.Sequential(name='neural-network')
model.add(tf.keras.layers.Dense(1, input_dim=784))
model.compile(
    optimizer=tf.keras.optimizers.RMSprop(learning_rate=0.1),
    loss="mean_squared_error",
    metrics=["mean_absolute_error"],
)

model.fit(
    x_train,
    y_train,
    batch_size=128,
    epochs=2,
    verbose=0,
    validation_split=0.5,
    callbacks=[
        SlackCallback(webhook_url='https://url.to/webhook')
    ],  # send a Slack notification when training ends!
)

You should see something like this on your Slack:

How to contribute

If you wish to contribute, this is a great place to start!

License

Distributed under the Apache-2.0 license.