Merge pull request #147 from PAIR-code/site_updates

Update documentation and bump version to 1.8.0
PAIR-code · Jan 19, 2021 · 697c098 · 697c098
2 parents 763664c + 7c0b518
commit 697c098
Show file tree

Hide file tree

Showing 56 changed files with 877 additions and 84 deletions.
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -1,5 +1,8 @@
 # What-If Tool Development Guide
 
+Building the What-If Tool has been verified to work with bazel version 0.27.
+Later versions of bazel are currently untested and may fail to build the package.
+
 ## First-time Setup
 
 1. Install [Bazel](https://docs.bazel.build/versions/master/install.html)

diff --git a/RELEASE.md b/RELEASE.md
@@ -1,5 +1,20 @@
 # What-If Tool releases
 
+## Release 1.8.0
+
+This version greatly increases the number of datapoints that can be loaded into
+the tool, in both TensorBoard and notebook modes. WIT can now handle on the
+order of hundreds of thousands of datapoints for simple tabular datasets. This
+version also enables witwidget in JupyterLab version 2.x.
+
+### Notable Features
+- #110 - Change file loading rules in TensorBoard.
+- #120 - Allow larger number of examples in colab.
+- #121 - Display actual server error text in tool.
+- #144 - Jupyter notebook scaling update.
+- #128 - Handle large number of examples in TensorBoard.
+- #134 - Enable WitWidget in JupyterLab2.
+
 ## Release 1.7.0
 
 This release has a few notable major features:

diff --git a/docs/ai-fairness.html b/docs/ai-fairness.html
@@ -44,8 +44,8 @@
           <!-- Navigation. We hide it in small screens. -->
           <nav class="mdl-navigation mdl-layout--large-screen-only">
             <a class="mdl-navigation__link" href="/what-if-tool/get-started/">GET STARTED</a>
-            <a class="mdl-navigation__link" href="/what-if-tool/learn/">LEARN</a>
-            <a class="mdl-navigation__link" href="/what-if-tool/explore/">EXPLORE</a>
+            <a class="mdl-navigation__link" href="/what-if-tool/learn/">TUTORIALS</a>
+            <a class="mdl-navigation__link" href="/what-if-tool/explore/">DEMOS</a>
             <a class="mdl-navigation__link" href="/what-if-tool/faqs/">FAQs</a>
             <a class="mdl-navigation__link" href="https://groups.google.com/forum/#!forum/what-if-tool" target="-_blank">GET INVOLVED<img class="header-arrow" src="/what-if-tool/assets/images/arrow-link-out.png"/></a>
             <a class="mdl-navigation__link" href="https://github.com/pair-code/what-if-tool" target="-_blank">GITHUB<img class="header-arrow" src="/what-if-tool/assets/images/arrow-link-out.png"/></a>
@@ -56,8 +56,8 @@
         <span class="mdl-layout__title"><a href="/what-if-tool/">What-If Tool</a></span>
         <nav class="mdl-navigation">
           <a class="mdl-navigation__link" href="/what-if-tool/get-started/">GET STARTED</a>
-          <a class="mdl-navigation__link" href="/what-if-tool/learn/">LEARN</a>
-          <a class="mdl-navigation__link" href="/what-if-tool/explore/">EXPLORE</a>
+          <a class="mdl-navigation__link" href="/what-if-tool/learn/">TUTORIALS</a>
+          <a class="mdl-navigation__link" href="/what-if-tool/explore/">DEMOS</a>
           <a class="mdl-navigation__link" href="/what-if-tool/faqs/">FAQs</a>
           <a class="mdl-navigation__link" href="https://groups.google.com/forum/#!forum/what-if-tool" target="_blank">GET INVOLVED<img class="header-arrow" src="/what-if-tool/assets/images/arrow-link-out.png"/></a>
           <a class="mdl-navigation__link" href="https://github.com/pair-code/what-if-tool" target="-_blank">GITHUB<img class="header-arrow" src="/what-if-tool/assets/images/arrow-link-out.png"/></a>

diff --git a/docs/assets/images/PDP2.gif b/docs/assets/images/PDP2.gif
diff --git a/docs/assets/images/PDP3.gif b/docs/assets/images/PDP3.gif
diff --git a/docs/assets/images/attr-scatters.png b/docs/assets/images/attr-scatters.png
diff --git a/docs/assets/images/capital-gains.png b/docs/assets/images/capital-gains.png
diff --git a/docs/assets/images/counterfactual-attr.png b/docs/assets/images/counterfactual-attr.png
diff --git a/docs/assets/images/custom-predict.png b/docs/assets/images/custom-predict.png
diff --git a/docs/assets/images/datapoint_attrs.png b/docs/assets/images/datapoint_attrs.png
diff --git a/docs/assets/images/mean_attrs.png b/docs/assets/images/mean_attrs.png
diff --git a/docs/assets/images/pdp-controls.png b/docs/assets/images/pdp-controls.png
diff --git a/docs/assets/images/random-custom-predict.png b/docs/assets/images/random-custom-predict.png
diff --git a/docs/assets/images/wit_custom_predict_notebook.png b/docs/assets/images/wit_custom_predict_notebook.png
diff --git a/docs/explore/index.html b/docs/explore/index.html
@@ -44,8 +44,8 @@
           <!-- Navigation. We hide it in small screens. -->
           <nav class="mdl-navigation mdl-layout--large-screen-only">
             <a class="mdl-navigation__link" href="/what-if-tool/get-started/">GET STARTED</a>
-            <a class="mdl-navigation__link" href="/what-if-tool/learn/">LEARN</a>
-            <a class="mdl-navigation__link" href="/what-if-tool/explore/">EXPLORE</a>
+            <a class="mdl-navigation__link" href="/what-if-tool/learn/">TUTORIALS</a>
+            <a class="mdl-navigation__link" href="/what-if-tool/explore/">DEMOS</a>
             <a class="mdl-navigation__link" href="/what-if-tool/faqs/">FAQs</a>
             <a class="mdl-navigation__link" href="https://groups.google.com/forum/#!forum/what-if-tool" target="-_blank">GET INVOLVED<img class="header-arrow" src="/what-if-tool/assets/images/arrow-link-out.png"/></a>
             <a class="mdl-navigation__link" href="https://github.com/pair-code/what-if-tool" target="-_blank">GITHUB<img class="header-arrow" src="/what-if-tool/assets/images/arrow-link-out.png"/></a>
@@ -56,8 +56,8 @@
         <span class="mdl-layout__title"><a href="/what-if-tool/">What-If Tool</a></span>
         <nav class="mdl-navigation">
           <a class="mdl-navigation__link" href="/what-if-tool/get-started/">GET STARTED</a>
-          <a class="mdl-navigation__link" href="/what-if-tool/learn/">LEARN</a>
-          <a class="mdl-navigation__link" href="/what-if-tool/explore/">EXPLORE</a>
+          <a class="mdl-navigation__link" href="/what-if-tool/learn/">TUTORIALS</a>
+          <a class="mdl-navigation__link" href="/what-if-tool/explore/">DEMOS</a>
           <a class="mdl-navigation__link" href="/what-if-tool/faqs/">FAQs</a>
           <a class="mdl-navigation__link" href="https://groups.google.com/forum/#!forum/what-if-tool" target="_blank">GET INVOLVED<img class="header-arrow" src="/what-if-tool/assets/images/arrow-link-out.png"/></a>
           <a class="mdl-navigation__link" href="https://github.com/pair-code/what-if-tool" target="-_blank">GITHUB<img class="header-arrow" src="/what-if-tool/assets/images/arrow-link-out.png"/></a>

diff --git a/docs/faqs/index.html b/docs/faqs/index.html
@@ -44,8 +44,8 @@
           <!-- Navigation. We hide it in small screens. -->
           <nav class="mdl-navigation mdl-layout--large-screen-only">
             <a class="mdl-navigation__link" href="/what-if-tool/get-started/">GET STARTED</a>
-            <a class="mdl-navigation__link" href="/what-if-tool/learn/">LEARN</a>
-            <a class="mdl-navigation__link" href="/what-if-tool/explore/">EXPLORE</a>
+            <a class="mdl-navigation__link" href="/what-if-tool/learn/">TUTORIALS</a>
+            <a class="mdl-navigation__link" href="/what-if-tool/explore/">DEMOS</a>
             <a class="mdl-navigation__link" href="/what-if-tool/faqs/">FAQs</a>
             <a class="mdl-navigation__link" href="https://groups.google.com/forum/#!forum/what-if-tool" target="-_blank">GET INVOLVED<img class="header-arrow" src="/what-if-tool/assets/images/arrow-link-out.png"/></a>
             <a class="mdl-navigation__link" href="https://github.com/pair-code/what-if-tool" target="-_blank">GITHUB<img class="header-arrow" src="/what-if-tool/assets/images/arrow-link-out.png"/></a>
@@ -56,8 +56,8 @@
         <span class="mdl-layout__title"><a href="/what-if-tool/">What-If Tool</a></span>
         <nav class="mdl-navigation">
           <a class="mdl-navigation__link" href="/what-if-tool/get-started/">GET STARTED</a>
-          <a class="mdl-navigation__link" href="/what-if-tool/learn/">LEARN</a>
-          <a class="mdl-navigation__link" href="/what-if-tool/explore/">EXPLORE</a>
+          <a class="mdl-navigation__link" href="/what-if-tool/learn/">TUTORIALS</a>
+          <a class="mdl-navigation__link" href="/what-if-tool/explore/">DEMOS</a>
           <a class="mdl-navigation__link" href="/what-if-tool/faqs/">FAQs</a>
           <a class="mdl-navigation__link" href="https://groups.google.com/forum/#!forum/what-if-tool" target="_blank">GET INVOLVED<img class="header-arrow" src="/what-if-tool/assets/images/arrow-link-out.png"/></a>
           <a class="mdl-navigation__link" href="https://github.com/pair-code/what-if-tool" target="-_blank">GITHUB<img class="header-arrow" src="/what-if-tool/assets/images/arrow-link-out.png"/></a>
@@ -96,7 +96,7 @@ <h3 class="faq-title">How many datapoints can the What-If Tool handle?</h3>
   <div class="faq-copy">
 <p>The number of datapoints depends on the size of the individual datapoints themselves.
 Some factors that impact the number of datapoints that can be handled are the per-page memory limit of web browsers and the front-end for simultaneous visualization.</p>
-<p>For datapoints that contain tabular data or short text segments, the What-If Tool can handle tens of thousands of points. For datapoints that contain encoded images, the tool can only handle a few hundred datapoints, with the exact number depending on the size of the images.</p>
+<p>For datapoints that contain tabular data or short text segments, the What-If Tool can handle <strong>hundreds of thousands of datapoints</strong>. For datapoints that contain encoded images, the tool can only handle a few hundred datapoints, with the exact number depending on the size of the images.</p>
 </div>
 </div>
 <div class="faq-element">

diff --git a/docs/get-started/index.html b/docs/get-started/index.html
@@ -44,8 +44,8 @@
           <!-- Navigation. We hide it in small screens. -->
           <nav class="mdl-navigation mdl-layout--large-screen-only">
             <a class="mdl-navigation__link" href="/what-if-tool/get-started/">GET STARTED</a>
-            <a class="mdl-navigation__link" href="/what-if-tool/learn/">LEARN</a>
-            <a class="mdl-navigation__link" href="/what-if-tool/explore/">EXPLORE</a>
+            <a class="mdl-navigation__link" href="/what-if-tool/learn/">TUTORIALS</a>
+            <a class="mdl-navigation__link" href="/what-if-tool/explore/">DEMOS</a>
             <a class="mdl-navigation__link" href="/what-if-tool/faqs/">FAQs</a>
             <a class="mdl-navigation__link" href="https://groups.google.com/forum/#!forum/what-if-tool" target="-_blank">GET INVOLVED<img class="header-arrow" src="/what-if-tool/assets/images/arrow-link-out.png"/></a>
             <a class="mdl-navigation__link" href="https://github.com/pair-code/what-if-tool" target="-_blank">GITHUB<img class="header-arrow" src="/what-if-tool/assets/images/arrow-link-out.png"/></a>
@@ -56,8 +56,8 @@
         <span class="mdl-layout__title"><a href="/what-if-tool/">What-If Tool</a></span>
         <nav class="mdl-navigation">
           <a class="mdl-navigation__link" href="/what-if-tool/get-started/">GET STARTED</a>
-          <a class="mdl-navigation__link" href="/what-if-tool/learn/">LEARN</a>
-          <a class="mdl-navigation__link" href="/what-if-tool/explore/">EXPLORE</a>
+          <a class="mdl-navigation__link" href="/what-if-tool/learn/">TUTORIALS</a>
+          <a class="mdl-navigation__link" href="/what-if-tool/explore/">DEMOS</a>
           <a class="mdl-navigation__link" href="/what-if-tool/faqs/">FAQs</a>
           <a class="mdl-navigation__link" href="https://groups.google.com/forum/#!forum/what-if-tool" target="_blank">GET INVOLVED<img class="header-arrow" src="/what-if-tool/assets/images/arrow-link-out.png"/></a>
           <a class="mdl-navigation__link" href="https://github.com/pair-code/what-if-tool" target="-_blank">GITHUB<img class="header-arrow" src="/what-if-tool/assets/images/arrow-link-out.png"/></a>
@@ -78,7 +78,7 @@
   <div class="hero-container mdl-grid">
     <div class="mdl-cell--8-col mdl-cell--6-col-tablet mdl-cell--4-col-phone">
 
-      <div class="sub-title">pip install wit-widget</div>
+      <div class="sub-title">pip install witwidget</div>
       <div class="sub-copy">Use the What If Tool directly in your Notebooks, in TensorBoard, and with Cloud AI models.</div>
     </div>
   </div>

diff --git a/docs/index.html b/docs/index.html
@@ -43,8 +43,8 @@
           <!-- Navigation. We hide it in small screens. -->
           <nav class="mdl-navigation mdl-layout--large-screen-only">
             <a class="mdl-navigation__link" href="/what-if-tool/get-started/">GET STARTED</a>
-            <a class="mdl-navigation__link" href="/what-if-tool/learn/">LEARN</a>
-            <a class="mdl-navigation__link" href="/what-if-tool/explore/">EXPLORE</a>
+            <a class="mdl-navigation__link" href="/what-if-tool/learn/">TUTORIALS</a>
+            <a class="mdl-navigation__link" href="/what-if-tool/explore/">DEMOS</a>
             <a class="mdl-navigation__link" href="/what-if-tool/faqs/">FAQs</a>
             <a class="mdl-navigation__link" href="https://groups.google.com/forum/#!forum/what-if-tool" target="-_blank">GET INVOLVED<img class="header-arrow" src="/what-if-tool/assets/images/arrow-link-out.png"/></a>
             <a class="mdl-navigation__link" href="https://github.com/pair-code/what-if-tool" target="-_blank">GITHUB<img class="header-arrow" src="/what-if-tool/assets/images/arrow-link-out.png"/></a>
@@ -55,8 +55,8 @@
         <span class="mdl-layout__title"><a href="/what-if-tool/">What-If Tool</a></span>
         <nav class="mdl-navigation">
           <a class="mdl-navigation__link" href="/what-if-tool/get-started/">GET STARTED</a>
-          <a class="mdl-navigation__link" href="/what-if-tool/learn/">LEARN</a>
-          <a class="mdl-navigation__link" href="/what-if-tool/explore/">EXPLORE</a>
+          <a class="mdl-navigation__link" href="/what-if-tool/learn/">TUTORIALS</a>
+          <a class="mdl-navigation__link" href="/what-if-tool/explore/">DEMOS</a>
           <a class="mdl-navigation__link" href="/what-if-tool/faqs/">FAQs</a>
           <a class="mdl-navigation__link" href="https://groups.google.com/forum/#!forum/what-if-tool" target="_blank">GET INVOLVED<img class="header-arrow" src="/what-if-tool/assets/images/arrow-link-out.png"/></a>
           <a class="mdl-navigation__link" href="https://github.com/pair-code/what-if-tool" target="-_blank">GITHUB<img class="header-arrow" src="/what-if-tool/assets/images/arrow-link-out.png"/></a>

diff --git a/docs/learn/index.html b/docs/learn/index.html
@@ -44,8 +44,8 @@
           <!-- Navigation. We hide it in small screens. -->
           <nav class="mdl-navigation mdl-layout--large-screen-only">
             <a class="mdl-navigation__link" href="/what-if-tool/get-started/">GET STARTED</a>
-            <a class="mdl-navigation__link" href="/what-if-tool/learn/">LEARN</a>
-            <a class="mdl-navigation__link" href="/what-if-tool/explore/">EXPLORE</a>
+            <a class="mdl-navigation__link" href="/what-if-tool/learn/">TUTORIALS</a>
+            <a class="mdl-navigation__link" href="/what-if-tool/explore/">DEMOS</a>
             <a class="mdl-navigation__link" href="/what-if-tool/faqs/">FAQs</a>
             <a class="mdl-navigation__link" href="https://groups.google.com/forum/#!forum/what-if-tool" target="-_blank">GET INVOLVED<img class="header-arrow" src="/what-if-tool/assets/images/arrow-link-out.png"/></a>
             <a class="mdl-navigation__link" href="https://github.com/pair-code/what-if-tool" target="-_blank">GITHUB<img class="header-arrow" src="/what-if-tool/assets/images/arrow-link-out.png"/></a>
@@ -56,8 +56,8 @@
         <span class="mdl-layout__title"><a href="/what-if-tool/">What-If Tool</a></span>
         <nav class="mdl-navigation">
           <a class="mdl-navigation__link" href="/what-if-tool/get-started/">GET STARTED</a>
-          <a class="mdl-navigation__link" href="/what-if-tool/learn/">LEARN</a>
-          <a class="mdl-navigation__link" href="/what-if-tool/explore/">EXPLORE</a>
+          <a class="mdl-navigation__link" href="/what-if-tool/learn/">TUTORIALS</a>
+          <a class="mdl-navigation__link" href="/what-if-tool/explore/">DEMOS</a>
           <a class="mdl-navigation__link" href="/what-if-tool/faqs/">FAQs</a>
           <a class="mdl-navigation__link" href="https://groups.google.com/forum/#!forum/what-if-tool" target="_blank">GET INVOLVED<img class="header-arrow" src="/what-if-tool/assets/images/arrow-link-out.png"/></a>
           <a class="mdl-navigation__link" href="https://github.com/pair-code/what-if-tool" target="-_blank">GITHUB<img class="header-arrow" src="/what-if-tool/assets/images/arrow-link-out.png"/></a>
@@ -108,6 +108,10 @@ <h4 class="tutorial-link-title"><a href="/what-if-tool/learn/tutorials/counterfa
   <h4 class="tutorial-link-title"><a href="/what-if-tool/learn/tutorials/customize-datapoints">How To: Customize the Datapoints Visualization</a></h4>
   <div class="tutorial-link-copy">Learn how to customize visualizations from features in a loaded dataset using the Datapoints visualization.</div>
 </div>
+<div class="tutorial-link-element">
+  <h4 class="tutorial-link-title"><a href="/what-if-tool/learn/tutorials/partial-dependence-plots">How To: Visualize Partial Dependence Plots</a></h4>
+  <div class="tutorial-link-copy">Learn how to view partial dependence plots and what value they provide.</div>
+</div>
 <div class="tutorial-link-element">
   <h4 class="tutorial-link-title"><a href="/what-if-tool/learn/tutorials/features-overview">Features Overview: Understanding Your Feature Distributions</a></h4>
   <div class="tutorial-link-copy">Explore the functionality of the Features Overview dashboard in the What-If Tool.</div>
@@ -120,6 +124,10 @@ <h4 class="tutorial-link-title"><a href="/what-if-tool/learn/tutorials/tensorboa
   <h4 class="tutorial-link-title"><a href="/what-if-tool/learn/tutorials/notebooks">Technical Setup: Getting Started in Notebooks</a></h4>
   <div class="tutorial-link-copy">Set up the What-If Tool inside of notebook environments.</div>
 </div>
+<div class="tutorial-link-element">
+  <h4 class="tutorial-link-title"><a href="/what-if-tool/learn/tutorials/custom-prediction">Custom Prediction Functions</a></h4>
+  <div class="tutorial-link-copy">Learn to use the What-If Tool with arbitrary python functions, and how to include feature attributions in the analysis.</div>
+</div>
 <div class="spacer" style="height:50px;"></div>
 <p><a name="analysis"></a></p>
 <h2>Conducting analysis in the What-If Tool</h2>
@@ -139,6 +147,10 @@ <h4 class="tutorial-link-title"><a href="/what-if-tool/learn/tutorials/non-input
   <h4 class="tutorial-link-title"><a href="/what-if-tool/learn/tutorials/features-overview-bias">Exploring Features Overview To Identify Biases</a></h4>
   <div class="tutorial-link-copy">Explore datapoints in Features Overview to identify sources of bias.</div>
 </div>
+<div class="tutorial-link-element">
+  <h4 class="tutorial-link-title"><a href="/what-if-tool/learn/tutorials/attributions">Exploring Attributions</a></h4>
+  <div class="tutorial-link-copy">Learn how to analyze feature attributions in the What-If Tool.</div>
+</div>
 <div class="spacer" style="height:50px;"></div>
 <p><a name="resources"></a></p>
 <h2>Related resources and posts</h2>