Skip to main content

Introduction

LMK is a set of tools intended to help you monitor your long-running processes within Jupyter Notebooks and command-line scripts. You'll finally be able to free yourself of the urge to check back on your jobs frequently. Similarly, you can avoid disappointment when you fail to check back only to find that it ended up failing early in the run! If you'd like to read more about the motivation behind creating LMK, check out the introductory blog post here.

When you monitor a long-running job with LMK, you can remotely see the status of the job and choose at any time to send yourself a notification if it stops or fails with an error.

There are currently two different ways you can use LMK (more to come!):

  • Monitor your running Jupyter notebooks and optionally notify yourself when they stop running

  • Monitor long-running command line tasks

Installation

LMK is distributed as a python package, so you can install it using pip. There are extra dependencies required based on what you'd like to use it for; to install all dependencies you can run:

pip install "lmkapp[jupyter,cli]"

If you're only planning to use it to monitor jupyter notebooks, you can just install the jupyter extras:

pip install "lmkapp[jupyter]"

If you're only planning to use it to monitor command-line processes, you can just install the cli extras:

pip install "lmkapp[cli]"

Get Started

To get started with using LMK, choose one of the two use-cases below that you'd like to use it for: