Add logo and trustscore example (SeldonIO#65)

arnaudvl · May 3, 2019 · 7f87ec6 · 7f87ec6
1 parent 97cfc3d
commit 7f87ec6
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,6 @@
-# Alibi
+<p align="center">
+  <img src="doc/source/_static/Alibi_Logo.png" alt="Alibi Logo" width="50%">
+</p>
 
 [Alibi](https://docs.seldon.io/projects/alibi) is an open source Python library aimed at machine learning model inspection and interpretation. The initial focus on the library is on black-box, instance based model explanations.
 
@@ -31,4 +33,7 @@ Prediction: 4             |  Pertinent Negative: 9               | Pertinent Pos
 :-------------------------:|:-------------------:|:------------------:
 ![mnist_orig](doc/source/methods/mnist_orig.png)  | ![mnsit_pn](doc/source/methods/mnist_pn.png) | ![mnist_pp](doc/source/methods/mnist_pp.png)
 
+[**Trust scores applied to a softmax classifier trained on MNIST:**](examples/trustscore_mnist.ipynb)
+
+![trust_mnist](doc/source/_static/trustscores.png)
 
diff --git a/doc/source/_static/Alibi_Logo.png b/doc/source/_static/Alibi_Logo.png
diff --git a/doc/source/_static/Alibi_Logo_White.png b/doc/source/_static/Alibi_Logo_White.png
diff --git a/doc/source/_static/trustscores.png b/doc/source/_static/trustscores.png
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -119,12 +119,16 @@
 # a list of builtin themes.
 #
 html_theme = 'sphinx_rtd_theme'
+html_logo = '_static/Alibi_Logo_White.png'
+
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
-# html_theme_options = {}
+html_theme_options = {
+        'logo_only': True
+    }
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

diff --git a/doc/source/landing.md b/doc/source/landing.md
@@ -1,4 +1,6 @@
-# Alibi
+<p align="center">
+  <img src="_static/Alibi_Logo.png" alt="Alibi Logo" width="50%">
+</p>
 
 [Alibi](https://github.com/SeldonIO/alibi) is an open source Python library aimed at machine learning
 model inspection and interpretation. The initial focus on the library is on black-box, instance