Improve Documentation - Githubissues

wayfair / pylift

Uplift modeling package.

http://pylift.readthedocs.io

BSD 2-Clause "Simplified" License

368 stars 76 forks source link

Open sherrywang15 opened 5 years ago

sherrywang15 commented 5 years ago

Some good functionalities of the package are not sufficiently documented on https://pylift.readthedocs.io/, for example

Most optional arguments are only documented in docstring
The capability to initialize TransformedOutcome object with a tuple of custom training and testing dataframes (very neat flexibility) is not documented

rsyi commented 5 years ago

Adding the custom training test dataframes to the usage page in this PR: https://github.com/wayfair/pylift/pull/29

Will spend some time parsing through the docs in the future to make a more comprehensive usage doc. :) Thanks for pointing this out.