{"id":15065066,"url":"https://github.com/ilias-ant/tf-notify","last_synced_at":"2025-04-10T13:13:13.724Z","repository":{"id":48938746,"uuid":"513957222","full_name":"ilias-ant/tf-notify","owner":"ilias-ant","description":"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.","archived":false,"fork":false,"pushed_at":"2022-12-28T15:57:28.000Z","size":247,"stargazers_count":12,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-02T00:46:53.035Z","etag":null,"topics":["callback","keras","notifications","slack","telegram","tensoflow"],"latest_commit_sha":null,"homepage":"https://tf-notify.readthedocs.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ilias-ant.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null}},"created_at":"2022-07-14T15:39:51.000Z","updated_at":"2023-01-25T17:49:04.000Z","dependencies_parsed_at":"2023-01-31T07:01:20.652Z","dependency_job_id":null,"html_url":"https://github.com/ilias-ant/tf-notify","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ilias-ant%2Ftf-notify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ilias-ant%2Ftf-notify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ilias-ant%2Ftf-notify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ilias-ant%2Ftf-notify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ilias-ant","download_url":"https://codeload.github.com/ilias-ant/tf-notify/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248225653,"owners_count":21068078,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["callback","keras","notifications","slack","telegram","tensoflow"],"created_at":"2024-09-25T00:30:21.830Z","updated_at":"2025-04-10T13:13:13.401Z","avatar_url":"https://github.com/ilias-ant.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tf-notify\n\n[![PyPI](https://img.shields.io/pypi/v/tf-notify?color=blue\u0026label=PyPI\u0026logo=PyPI\u0026logoColor=white)](https://pypi.org/project/tf-notify/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/tf-notify?logo=python\u0026logoColor=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\u0026style=flat)](https://www.tensorflow.org/)\n[![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)\n[![Documentation Status](https://readthedocs.org/projects/tf-notify/badge/?version=latest)](https://tf-notify.readthedocs.io/en/latest/?badge=latest)\n[![PyPI - Wheel](https://img.shields.io/pypi/wheel/tf-notify?color=orange)](https://www.python.org/dev/peps/pep-0427/)\n\n\u003e Want to get notified on the progress of your TensorFlow model training?\n\nThis 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.\n\n## Install\n\nThe recommended installation is via `pip`:\n\n```bash\npip install tf-notify\n```\n\n## Supported Apps\n\nThe following apps are currently supported. But, do check the project frequently, as many more will soon be supported!\n\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\n      \u003cimg src=\"https://raw.githubusercontent.com/ilias-ant/tf-notify/main/static/logos/slack.png\" height=\"128\" width=\"128\" style=\"max-height: 128px; max-width: 128px;\"\u003e\u003ca href=\"https://tf-notify.readthedocs.io/en/latest/api/#tf_notify.callbacks.slack.SlackCallback\"\u003eSlack\u003c/a\u003e\n    \u003c/td\u003e\n   \u003ctd\u003e\n      \u003cimg src=\"https://raw.githubusercontent.com/ilias-ant/tf-notify/main/static/logos/telegram.png\" height=\"128\" width=\"128\" style=\"max-height: 128px; max-width: 128px;\"\u003e\u003ca href=\"https://tf-notify.readthedocs.io/en/latest/api/#tf_notify.callbacks.telegram.TelegramCallback\"\u003eTelegram\u003c/a\u003e\n    \u003c/td\u003e\n   \u003ctd\u003e\n      \u003cimg src=\"https://raw.githubusercontent.com/ilias-ant/tf-notify/main/static/logos/email.png\" height=\"128\" width=\"128\" style=\"max-height: 128px; max-width: 128px;\"\u003e\u003ca href=\"https://tf-notify.readthedocs.io/en/latest/api/#tf_notify.callbacks.email.EmailCallback\"\u003eEmail (SMTP)\u003c/a\u003e\n    \u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n## Usage\n\n```python\nimport tensorflow as tf\nfrom tf_notify import SlackCallback\n\n\n# define the tf.keras model to add callbacks to\nmodel = tf.keras.Sequential(name='neural-network')\nmodel.add(tf.keras.layers.Dense(1, input_dim=784))\nmodel.compile(\n    optimizer=tf.keras.optimizers.RMSprop(learning_rate=0.1),\n    loss=\"mean_squared_error\",\n    metrics=[\"mean_absolute_error\"],\n)\n\nmodel.fit(\n    x_train,\n    y_train,\n    batch_size=128,\n    epochs=2,\n    verbose=0,\n    validation_split=0.5,\n    callbacks=[\n        SlackCallback(webhook_url='https://url.to/webhook')\n    ],  # send a Slack notification when training ends!\n)\n```\n\nYou should see something like this on your Slack:\n\n\u003cimg src=\"https://raw.githubusercontent.com/ilias-ant/tf-notify/main/static/slack_notification_example.png\" width=\"50%\" text=\"https://www.researchgate.net/figure/Sample-images-from-MURA-dataset_fig2_348282230\"\u003e\n\n\n\n## How to contribute\n\nIf you wish to contribute, [this](CONTRIBUTING.md) is a great place to start!\n\n## License\n\nDistributed under the [Apache-2.0 license](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Filias-ant%2Ftf-notify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Filias-ant%2Ftf-notify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Filias-ant%2Ftf-notify/lists"}