microsoft / responsible-ai-toolbox-mitigations

Python library for implementing Responsible AI mitigations.
https://responsible-ai-toolbox-mitigations.readthedocs.io/en/latest/
MIT License
57 stars 6 forks source link

Missing docstrings #23

Closed morrissharp closed 2 years ago

morrissharp commented 2 years ago

https://sturdy-barnacle-3b9f911d.pages.github.io/databalanceanalysis/databalanceanalysis.html#databalanceanalysis.aggregate_measures.AggregateBalanceMeasure

FeatureBalanceMeasure, DistributionBalanceMeasure, and AggregateBalanceMeasure classes should have docstrings, at the very least to explain the params required for init

morrissharp commented 2 years ago

feat_sel_sequential.ipynb needs a few more comments:

morrissharp commented 2 years ago

The Imputation example could use some more explanatory comments https://github.com/microsoft/responsible-ai-toolbox-mitigations/blob/main/notebooks/dataprocessing/module_tests/imputation.ipynb

morrissharp commented 2 years ago

The Rebalance imblearn example has no explanatory comments https://github.com/microsoft/responsible-ai-toolbox-mitigations/blob/main/notebooks/dataprocessing/module_tests/rebalance_imbl.ipynb

morrissharp commented 2 years ago

Each of the scalars should have a short description of what the scaler actually does, before providing a link to the sklearn docs. E.g. for DataStandardScaler: this Scaler transforms the data to have zero mean and unit variance.

This short description could also be used in scaler.ipynb, where the cells using these scalers do not have descriptions.

morrissharp commented 2 years ago

https://github.com/microsoft/responsible-ai-toolbox-mitigations/blob/main/notebooks/dataprocessing/case_study/case2.ipynb

case2.ipynb needs more comments explaining what is going on.

morrissharp commented 2 years ago

case2_stat.ipynb needs comments. Also, it would be helpful to note that some of these cells take a longer to run (10+ min, etc.).