https://github.com/outerbounds/metaflowbot

Slack bot for monitoring your Metaflow flows!
https://github.com/outerbounds/metaflowbot

data-science metaflow ml mlops slack slack-bot

Last synced: about 2 months ago
JSON representation

Slack bot for monitoring your Metaflow flows!

• Host: GitHub
• URL: https://github.com/outerbounds/metaflowbot
• Owner: outerbounds
• License: apache-2.0
• Created: 2021-08-02T21:15:06.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-10-07T23:40:51.000Z (about 3 years ago)
• Last Synced: 2024-11-06T15:11:46.505Z (about 2 months ago)
• Topics: data-science, metaflow, ml, mlops, slack, slack-bot
• Language: Python
• Homepage:
• Size: 1.64 MB
• Stars: 27
• Watchers: 3
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Metaflowbot - Slack Bot for your Metaflow flows!

Metaflowbot makes it fun and easy to monitor your Metaflow runs, past and present. Imagine starting a training run that lasts for hours - you can now monitor it anywhere using Slack on your mobile device!

![2021-08-09 15 57 31](https://user-images.githubusercontent.com/763451/128784858-d9e37401-05de-4d02-82c5-29444ab4e1b3.gif)

The bot is [easy to deploy](./docs/deployment.md): It is just a Python process with few external dependencies - no databases needed. Its [security footprint is small](./docs/slack-scopes.md) as it uses only a tightly scoped set of Slack calls. During development you can run the bot on any workstation, so it is quick to [iterate on custom actions](./docs/creating-custom-actions.md) and extend it to suit your needs. For production deployments the bot ships with a [CloudFormation template](./deployment/mfbot-cfn-template.yml) for automating your deployments to AWS.

## Communicating with the bot

There are two ways interact with the Metaflow bot. You can invite the bot on a `channel` or directly speak to it via `direct message`.

- `@flowey help` : Help

- `@flowey tell me a joke`

- `@flowey how to inspect` : How to inspect

- `@flowey inspect HelloFlow` : Inspect `Run`s of a particular `Flow`

- `@flowey inspect savin's HelloFlow`: Inspect `Run`s of a particular `Flow`

- `@flowey inspect savin's HelloFlow tagged some_tag` : Inspect `Run`s of a particular `Flow`

- `@flowey inspect HelloFlow/12` : Inspect an individual `Run` instance

- `@flowey inspect the latest run of HelloFlow` : Inspect an individual `Run` instance

- `@flowey inspect savin's latest run of HelloFlow` : Inspect an individual `Run` instance

If you require some customization for your deployment or need additional help, please feel free to reach out to us at http://slack.outerbounds.co. We are very happy to help!