DAME-FLAME-Python-Package icon indicating copy to clipboard operation
DAME-FLAME-Python-Package copied to clipboard

Documentation updates needed

Open nehargupta opened this issue 3 years ago • 3 comments

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 avatar Aug 23 '22 14:08 nehargupta

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

nehargupta avatar Feb 08 '23 03:02 nehargupta

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

nehargupta avatar Feb 08 '23 03:02 nehargupta

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

nehargupta avatar Feb 08 '23 15:02 nehargupta