Tweak docs

scienxlab · Sep 28, 2023 · a3e5e5e · a3e5e5e
1 parent f7f3ed6
commit a3e5e5e
Show file tree

Hide file tree

Showing 3 changed files with 117 additions and 62 deletions.
diff --git a/docs/_static/agile-open-logo-nocircle-grey_40px.png b/docs/_static/agile-open-logo-nocircle-grey_40px.png
diff --git a/docs/_static/redflag_social.svg b/docs/_static/redflag_social.svg
diff --git a/docs/index.rst b/docs/index.rst
@@ -6,14 +6,15 @@
    `Fork on GitHub <https://github.com/scienxlab/redflag>`_
 
 
-Redflag: An Entrance Exam for Data
-==================================
-
-    | ``redflag`` aims to be an automatic safety net for
-    | machine learning datasets. Given a ``DataFrame`` or
-    | ``ndarray``, ``redflag`` will analyse each feature,
-    | including aspects such as class imbalance, leakage, outliers,
-    | anomalous data patterns, threats to the IID assumption, etc.
+Redflag: safer ML by design
+===========================
+
+    | ``redflag`` is a lightweight safety net for machine
+    | learning. Given a ``DataFrame`` or ``ndarray``,
+    | ``redflag`` will analyse the features and the target,
+    | and warn you about class imbalance, leakage, outliers,
+    | anomalous data patterns, threats to the IID assumption,
+    | and more.
 
 
 Quick start