search

almost-matching-exactly / DAME-FLAME-Python-Package

A Python Package providing two algorithms, DAME and FLAME, for fast and interpretable treatment-control matches of categorical data
https://almost-matching-exactly.github.io/DAME-FLAME-Python-Package/
MIT License
57 stars 14 forks source link

Documentation updates needed #53

Open nehargupta opened 2 years ago

nehargupta commented 2 years ago

https://github.com/almost-matching-exactly/DAME-FLAME-Python-Package/blob/e37e182620ca193acf70626b393c33710102af99/dame_flame/flame_algorithm.py#L239

Looking here, it looks like "early_stop_pe_frac" should be a percent change variable from the previous predictive error, but in the documentation I didn't really describe it this way and instead described it as a raw value not a percent change: https://almost-matching-exactly.github.io/DAME-FLAME-Python-Package/api-documentation/DAME (search "early_stop_pe_frac").

This needs to be double checked (run the code on a sample dataset and confirm) and then the documentation needs to be updated if that's the case....

nehargupta commented 1 year ago

Attributes of matching class also not all listed in documentation, for example, we also offer input_data as an attribute of the class

nehargupta commented 1 year ago

Double check code an documentation -- possibly the early_stop_pe_frac default value is 0.05, not 0.01?

nehargupta commented 1 year ago

Attributes of matching class also not all listed in documentation, for example, we also offer input_data as an attribute of the class

Actually I think input_data is listed in the documentation (after .fit ) but others might not be