adding text to documentation

dvatterott · Jan 4, 2019 · 6847313 · 6847313
1 parent cc9a594
commit 6847313
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/README.rst b/README.rst
@@ -20,7 +20,7 @@ predeval
 
 
 
-Identify bad model outputs at prediction time.
+Identify unexpected changes in model outputs before evaluation data becomes available.
 
 
 * Free software: MIT license

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,6 +1,8 @@
 Welcome to predeval's documentation!
 ======================================
 
+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.
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
@@ -9,6 +11,7 @@ Welcome to predeval's documentation!
    installation
    usage
    modules
+   api
    contributing
    authors
    history