adding author docs

dvatterott · Jan 4, 2019 · aac7f69 · aac7f69
1 parent 1b70e81
commit aac7f69
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/README.rst b/README.rst
@@ -20,7 +20,7 @@ predeval
 
 
 
-Identify unexpected changes in model outputs before evaluation data becomes available.
+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.
 
 
 * Free software: MIT license

diff --git a/docs/api.rst b/docs/api.rst
@@ -1,10 +1,14 @@
 API
 ========
 
-This page contains a comprehensive list of all classes and functions in predeval
+This page contains a comprehensive list of all classes and functions in predeval.
 
+ContinuousEvaluator
+---------
 .. automodule:: predeval.continuous
    :members:
 
+CategoricalEvaluator
+---------
 .. automodule:: predeval.categorical
   :members: