adebayoj / fairml

Other
360 stars 74 forks source link

readme.md example code not consistent with example.py #4

Open achimkoh opened 7 years ago

achimkoh commented 7 years ago

Hi, I noticed that some lines in the example are different from example.py, and seem to call (presumably) deprecated functions.

Regarding from fairml import plot_generic_dependence_dictionary: There is no plot_generic_dependence_dictionary. Importing plot_dependencies worked for me.

Also, fig = plot_dependencies( total.get_compress_dictionary_into_key_median(), reverse_values=False, title="FairML feature dependence" ) results in: AttributeError: 'AuditResult' object has no attribute 'get_compress_dictionary_into_key_median', while total.median() works.

adebayoj commented 7 years ago

Hi @achimkoh, you are right. I'll push an update shortly to handle the issues that you mentioned. I'll also update the readme to reflect the changes. Thanks for the issues, please free feel to update us on any other issues you have.

thanks!

achimkoh commented 7 years ago

Hi thanks for the reply. I had a few minutes and made a pull request so you can have a look!

JoshuaC3 commented 7 years ago

This would be great to have as an IPython notebook. IMO the more examples the better. If I find time I can do one.