Metadata-Version: 2.1
Name: MAMMOth-commons
Version: 0.0.29
Summary: Component interfaces of the MAMMOth fairness toolkit.
Home-page: https://github.com/mammoth-eu/mammoth-commons
Author: Emmanouil (Manios) Krasanakis
Author-email: maniospas@hotmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy==1.*
Requires-Dist: markdown2
Requires-Dist: dill
Provides-Extra: deployment
Requires-Dist: numpy==1.*; extra == "deployment"
Requires-Dist: markdown2; extra == "deployment"
Requires-Dist: dill; extra == "deployment"
Provides-Extra: test
Requires-Dist: numpy==1.*; extra == "test"
Requires-Dist: pandas; extra == "test"
Requires-Dist: fairbench; extra == "test"
Requires-Dist: PyYAML; extra == "test"
Requires-Dist: kfp; extra == "test"
Requires-Dist: onnxruntime; extra == "test"
Requires-Dist: markdown2; extra == "test"
Requires-Dist: dill; extra == "test"
Requires-Dist: timm; extra == "test"
Requires-Dist: torch; extra == "test"
Requires-Dist: torchvision; extra == "test"
Requires-Dist: cvbiasmitigation; extra == "test"
Requires-Dist: facextool; extra == "test"
Requires-Dist: pygrank; extra == "test"
Requires-Dist: flask; extra == "test"
Requires-Dist: Flask-Bootstrap; extra == "test"
Requires-Dist: Flask-WTF; extra == "test"
Requires-Dist: Flask-Session; extra == "test"

# 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](catalogue/README.md). These modules are developed by and
depend on datatypes found in commons.

## :thumbsup: Contributing

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