DataResponsibly / ShaRP

Implementation of the algorithm proposed in the paper "ShaRP: Explaining Rankings with Shapley Values", by Pliatsika et al.
MIT License
0 stars 0 forks source link

Add documentation for QOI classes #2

Closed joaopfonseca closed 11 months ago

joaopfonseca commented 11 months ago

Describe the issue linked to the documentation

The QOI script contains several classes, but none of which are described/explained/documented.

Suggest a potential alternative/fix

@venetiap , could you add some simple docstrings for me to better understand what's what? This is important because I believe most of this script will be used nearly as-is.