https://github.com/ilias-ant/tf-notify

Want to get notified on the progress of your TensorFlow model training? Enter, a TensorFlow Keras callback to send notifications on the messaging app of your choice.
https://github.com/ilias-ant/tf-notify

callback keras notifications slack telegram tensoflow

Last synced: 4 months ago
JSON representation

Want to get notified on the progress of your TensorFlow model training? Enter, a TensorFlow Keras callback to send notifications on the messaging app of your choice.

• Host: GitHub
• URL: https://github.com/ilias-ant/tf-notify
• Owner: ilias-ant
• License: apache-2.0
• Created: 2022-07-14T15:39:51.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-12-28T15:57:28.000Z (about 2 years ago)
• Last Synced: 2024-09-30T10:03:30.739Z (4 months ago)
• Topics: callback, keras, notifications, slack, telegram, tensoflow
• Language: Python
• Homepage: https://tf-notify.readthedocs.io
• Size: 241 KB
• Stars: 12
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        
# tf-notify

[![PyPI](https://img.shields.io/pypi/v/tf-notify?color=blue&label=PyPI&logo=PyPI&logoColor=white)](https://pypi.org/project/tf-notify/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/tf-notify?logo=python&logoColor=white)](https://www.python.org/) [![TensorFlow version](https://shields.io/badge/tensorflow-2.7%20%7C%202.8%20%7C%202.9%20-simple?logo=tensorflow&style=flat)](https://www.tensorflow.org/)

[![codecov](https://codecov.io/gh/ilias-ant/tf-notify/branch/main/graph/badge.svg?token=2H0VB8I8IH)](https://codecov.io/gh/ilias-ant/tf-notify) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/ilias-ant/tf-notify/ci.yml?branch=main)](https://github.com/ilias-ant/tf-notify/actions/workflows/ci.yml)

[![Documentation Status](https://readthedocs.org/projects/tf-notify/badge/?version=latest)](https://tf-notify.readthedocs.io/en/latest/?badge=latest)

[![PyPI - Wheel](https://img.shields.io/pypi/wheel/tf-notify?color=orange)](https://www.python.org/dev/peps/pep-0427/)

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

This package provides a [tf.keras](https://www.tensorflow.org/api_docs/python/tf/keras/callbacks/Callback) callback to send notifications to a messaging app of your choice.

## Install

The recommended installation is via `pip`:

```bash

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

```python

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](CONTRIBUTING.md) is a great place to start!

## License

Distributed under the [Apache-2.0 license](LICENSE).