MAMMOth-commons 0.0.28

Component interfaces of the MAMMOth fairness toolkit.

MAMMOth-commons

Fast component development for the MAMMOth fairness toolkit. Components refer to model loaders, dataset loaders, or metrics. The library holds common datatypes that are shared between components, and automates the integration strategy by only needing to add a decorator.

:microscope: Investigate fairness

This repo includes a thinned down variation of the MAMMOth toolkit that you can quickly install and run locally. Instructions to launch the web application locally in your machine:

1. Download this repository.
2. Create a virtual environment. This is optional but recommended.
3. Install dependencies with pip install -r requirements.txt. This can take a bit of time to download and install everything, but you will be able to run all modules and interface with most popular data types.
4. Launch the local app server with python demonstrator/app.py. When everything is ready, this script will also open a browser window to the app's serving page at http://localhost:5050.

:clipboard: Catalogue

Find a catalogue of modules implemented by the MAMMOth consortium here. These modules are developed by and depend on datatypes found in commons.

:thumbsup: Contributing

Instructions on how to add new modules are here. Use the GitHub issue tracker to ask questions, request features/improvements for the core library or modules, or report bugs.