Skip to content

Commit

Permalink
adding to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dvatterott committed Jan 6, 2019
1 parent 59d6cc9 commit 17a59ab
Showing 1 changed file with 30 additions and 1 deletion.
31 changes: 30 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,41 @@ predeval



This software is built to identify unexpected changes in a model output before evaluation data becomes available. For example, if you create a churn model, you will have to wait X number of weeks before learning whether users churned (and can evaluate your churn model predictions). This software will not guarantee that your model is accurate, but it will alert you if your model's outputs (i.e., predictions) are dramatically different from what they have been in the past.
This software is built to identify changes in a model output before evaluation data becomes available.

For example, if you create a churn model, you will have to wait X number of weeks before learning whether users churned (and can evaluate your churn model predictions).

This software will not guarantee that your model is accurate, but it will alert you if your model's outputs (i.e., predictions) are different from what they have been in the past. A model's output can pass predeval tests and be inaccurate and a model's output can fail predeval and be accurate. That said, unexpected changes in model outputs likely represent a change in accuracy.


* Free software: MIT license
* Documentation: https://predeval.readthedocs.io.

Installation
-------

Installation is described here: https://predeval.readthedocs.io/en/latest/installation.html

Example Usage
-------

Examples can be found here: https://predeval.readthedocs.io/en/latest/usage.html


API Documentation
-------

Documentation of the software can be found here: https://predeval.readthedocs.io/en/latest/api.html

Contributing
-------

Info about contributing can be found here: https://predeval.readthedocs.io/en/latest/contributing.html

Changelog
-------

Changelog can be found here: https://predeval.readthedocs.io/en/latest/history.html

Credits
-------
Expand Down

0 comments on commit 17a59ab

Please sign in to comment.