minevent

Overview

minevent is a Python library that provides a minimal event system for Machine Learning. It allows to customize a code by adding some piece of code that are executed when an event is fired. minevent is organized around three main concepts:

• event which defines the thing that should happen.
• event handler which is the piece of code to execute when the event happens
• event manager which is responsible to manage the events and event handlers.

The library provides some implemented modules, but it is possible to extend it. It is possible to use all the components or just a subset based on the need. For example, an event handler can be used without the event manager.

• Motivation
• Documentation
• Installation
• Contributing
• API stability
• License

Motivation

minevent provides a minimal event system to customize a piece of code without changing its implementation. Below is an example on how to use minevent library.

>>> from minevent import EventHandler, EventManager
>>> def say_something(manager: EventManager) -> None:
...     print("Hello, I am Bob!")
...     manager.trigger_event("after")
...
>>> manager = EventManager()
>>> say_something(manager)
Hello, I am Bob!
>>> def hello_handler() -> None:
...     print("Hello!")
...
>>> manager.add_event_handler("after", EventHandler(hello_handler))
>>> say_something(manager)
Hello, I am Bob!
Hello!

It allows to customize the function say_something without changing its implementation. Please read the quickstart page to learn more about the library.

Installation

We highly recommend installing a virtual environment. minevent can be installed from pip using the following command:

pip install minevent

To make the package as slim as possible, only the minimal packages required to use minevent are installed. To include all the dependencies, you can use the following command:

pip install minevent[all]

Please check the get started page to see how to install only some specific dependencies or other alternatives to install the library. The following is the corresponding minevent versions and supported dependencies.

Contributing

Please check the instructions in CONTRIBUTING.md.

API stability

:warning: While minevent is in development stage, no API is guaranteed to be stable from one release to the next. In fact, it is very likely that the API will change multiple times before a stable 1.0.0 release. In practice, this means that upgrading minevent to a new version will possibly break any code that was using the old version of minevent.

License

minevent is licensed under BSD 3-Clause "New" or "Revised" license available in LICENSE file.