update docs

Signed-off-by: Kleynhans, Bernard <bernard.kleynhans@fmr.com>

docs/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 76108fe78c4653083ab1ce8c62cfe9cc
+config: 38aa1a07e02eb2f91589ebcc20857182
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_sources/index.rst.txt

@@ -70,6 +70,7 @@ Available Neighborhood Policies:
 * K-Nearest
 * LSH Nearest
 * Radius
+* TreeBandit
 
 Bug Reports
 ===========
@@ -80,18 +81,32 @@ Citation
 ========
 You can cite MABWiser as:
 
-E. Strong,  B. Kleynhans, and S. Kadioglu, "MABWiser: A Parallelizable Contextual Multi-Armed Bandit Library for Python," in 2019 IEEE 31st International Conference on Tools with Artificial Intelligence (ICTAI 2019) (pp.885-890). IEEE, 2019.
+* **[IJAIT 2021]** [E. Strong,  B. Kleynhans, and S. Kadioglu, "MABWiser: Parallelizable Contextual Multi-Armed Bandits"](https://www.worldscientific.com/doi/abs/10.1142/S0218213021500214)
+* **[ICTAI 2019]** [E. Strong,  B. Kleynhans, and S. Kadioglu, "MABWiser: A Parallelizable Contextual Multi-Armed Bandit Library for Python"](https://ieeexplore.ieee.org/document/8995418)
 
 .. code-block:: bibtex
 
-    @inproceedings{mabwiser2019,
-      author    = {Strong, Emily and Kleynhans, Bernard and Kadioglu, Serdar},
-      title     = {MABWiser: A Parallelizable Contextual Multi-Armed Bandit Library for Python},
-      booktitle = {2019 IEEE 31st International Conference on Tools with Artificial Intelligence (ICTAI 2019)},
-      year      = {2019},
-      pages     = {885-890},
-      organization = {IEEE},
-      url       = {https://github.com/fidelity/mabwiser}
+       @article{DBLP:journals/ijait/StrongKK21,
+      author    = {Emily Strong and Bernard Kleynhans and Serdar Kadioglu},
+      title     = {{MABWiser:} Parallelizable Contextual Multi-armed Bandits},
+      journal   = {Int. J. Artif. Intell. Tools},
+      volume    = {30},
+      number    = {4},
+      pages     = {2150021:1--2150021:19},
+      year      = {2021},
+      url       = {https://doi.org/10.1142/S0218213021500214},
+      doi       = {10.1142/S0218213021500214},
+    }
+
+    @inproceedings{DBLP:conf/ictai/StrongKK19,
+    author    = {Emily Strong and Bernard Kleynhans and Serdar Kadioglu},
+    title     = {MABWiser: {A} Parallelizable Contextual Multi-Armed Bandit Library for Python},
+    booktitle = {31st {IEEE} International Conference on Tools with Artificial Intelligence, {ICTAI} 2019, Portland, OR, USA, November 4-6, 2019},
+    pages     = {909--914},
+    publisher = {{IEEE}},
+    year      = {2019},
+    url       = {https://doi.org/10.1109/ICTAI.2019.00129},
+    doi       = {10.1109/ICTAI.2019.00129},
     }
 
 

docs/_sources/installation.rst.txt

@@ -14,17 +14,7 @@ Requirements
 ------------
 
 The library requires Python **3.6+**. The ``requirements.txt`` lists the necessary
-packages. The following packages are used currently:
-
-.. code-block:: python
-
-	joblib
-	numpy
-	pandas
-	scikit-learn>=0.22.0
-	scipy
-	seaborn>=0.9.0
-
+packages.
 
 Source Code
 -----------

docs/_sources/new_bandit.rst.txt

@@ -19,6 +19,7 @@ In this section, we provide high-level guidelines on how to introduce a new band
 --------------------------
 
 Imagine you would like to introduce a new bandit algorithm, called ``MyCoolPolicy``, with an hyper-parameter ``my_parameter``.
+Here we consider introducing a new learning policy, but the case introducing a new neighborhood policy is similar.
 
 First and foremost, the users of MABWiser need to be able to access your cool bandit algorithm.
 This is how it would look like in a usage example. Notice how the ``mab`` model is created with your new policy.
@@ -183,7 +184,7 @@ Every test starts with the ``test_`` prefix followed by some descriptive name.
 
     from tests.test_base import BaseTest
 
-    class PopularityTest(BaseTest):
+    class MyCoolBanditTest(BaseTest):
 
         # First, implement a simple case using the Public API you created in the first section
         # Utilize the self.predict() utility wrapper method from base test to create test cases quickly
@@ -265,7 +266,6 @@ b. Update the library version. You can use a keyword search for "version" to mak
 c. Update the README.md, if necessary.
 d. Update the documentation rst files under the /docsrc folder , if necessary.
 e. If you update any documentation, make sure to recompile the docs by running ``make github`` under the /docsrc folder. If you have mabwiser installed and it isn't in development mode, you will need to uninstall it, as Sphinx first looks for an installed version before using the local package. To install in development mode use pip install -e.
-f. Build a new wheel package and remove the old one in /dist folder. See installation page on how to build a package.
 
 **Congratulations!!** You are ready to send a Pull Request and include your changes in the MABWiser library.
 How cool is that? :)

docs/_static/basic.css

@@ -15,6 +15,12 @@ div.clearer {
     clear: both;
 }
 
+div.section::after {
+    display: block;
+    content: '';
+    clear: left;
+}
+
 /* -- relbar ---------------------------------------------------------------- */
 
 div.related {
@@ -328,8 +334,8 @@ p.sidebar-title {
     font-weight: bold;
 }
 
-div.admonition, div.topic, pre, div[class|="highlight"] {
-    clear: both;
+div.admonition, div.topic, blockquote {
+    clear: left;
 }
 
 /* -- topics ---------------------------------------------------------------- */
@@ -338,7 +344,6 @@ div.topic {
     border: 1px solid #ccc;
     padding: 7px;
     margin: 10px 0 10px 0;
-    overflow-x: auto;
 }
 
 p.topic-title {
@@ -353,7 +358,6 @@ div.admonition {
     margin-top: 10px;
     margin-bottom: 10px;
     padding: 7px;
-    overflow-x: auto;
 }
 
 div.admonition dt {
@@ -378,6 +382,15 @@ div.admonition > :last-child {
     margin-bottom: 0;
 }
 
+div.sidebar::after,
+div.topic::after,
+div.admonition::after,
+blockquote::after {
+    display: block;
+    content: '';
+    clear: both;
+}
+
 /* -- tables ---------------------------------------------------------------- */
 
 table.docutils {
@@ -513,28 +526,31 @@ ol.upperroman {
     list-style: upper-roman;
 }
 
-ol > li:first-child > :first-child,
-ul > li:first-child > :first-child {
+:not(li) > ol > li:first-child > :first-child,
+:not(li) > ul > li:first-child > :first-child {
     margin-top: 0px;
 }
 
-ol ol > li:first-child > :first-child,
-ol ul > li:first-child > :first-child,
-ul ol > li:first-child > :first-child,
-ul ul > li:first-child > :first-child {
-    margin-top: revert;
+:not(li) > ol > li:last-child > :last-child,
+:not(li) > ul > li:last-child > :last-child {
+    margin-bottom: 0px;
 }
 
-ol > li:last-child > :last-child,
-ul > li:last-child > :last-child {
-    margin-bottom: 0px;
+ol.simple ol p,
+ol.simple ul p,
+ul.simple ol p,
+ul.simple ul p {
+    margin-top: 0;
 }
 
-ol ol > li:last-child > :last-child,
-ol ul > li:last-child > :last-child,
-ul ol > li:last-child > :last-child,
-ul ul > li:last-child > :last-child {
-    margin-bottom: revert;
+ol.simple > li:not(:first-child) > p,
+ul.simple > li:not(:first-child) > p {
+    margin-top: 0;
+}
+
+ol.simple p,
+ul.simple p {
+    margin-bottom: 0;
 }
 
 dl.footnote > dt,
@@ -677,14 +693,18 @@ pre {
     overflow-y: hidden;  /* fixes display issues on Chrome browsers */
 }
 
+pre, div[class*="highlight-"] {
+    clear: both;
+}
+
 span.pre {
     -moz-hyphens: none;
     -ms-hyphens: none;
     -webkit-hyphens: none;
     hyphens: none;
 }
 
-div[class^="highlight-"] {
+div[class*="highlight-"] {
     margin: 1em 0;
 }
 

docs/_static/documentation_options.js

@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '1.11.1',
+    VERSION: '1.12.0',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

docs/_static/pygments.css

@@ -1,5 +1,10 @@
+pre { line-height: 125%; margin: 0; }
+td.linenos pre { color: #000000; background-color: #f0f0f0; padding-left: 5px; padding-right: 5px; }
+span.linenos { color: #000000; background-color: #f0f0f0; padding-left: 5px; padding-right: 5px; }
+td.linenos pre.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
+span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
 .highlight .hll { background-color: #ffffcc }
-.highlight  { background: #f8f8f8; }
+.highlight { background: #f8f8f8; }
 .highlight .c { color: #408080; font-style: italic } /* Comment */
 .highlight .err { border: 1px solid #FF0000 } /* Error */
 .highlight .k { color: #008000; font-weight: bold } /* Keyword */

docs/_static/searchtools.js

@@ -166,8 +166,7 @@ var Search = {
           objectterms.push(tmp[i].toLowerCase());
       }
 
-      if ($u.indexOf(stopwords, tmp[i].toLowerCase()) != -1 || tmp[i].match(/^\d+$/) ||
-          tmp[i] === "") {
+      if ($u.indexOf(stopwords, tmp[i].toLowerCase()) != -1 || tmp[i] === "") {
         // skip this "word"
         continue;
       }

docs/about.html

@@ -3,11 +3,11 @@
 <!DOCTYPE html>
 <html class="writer-html5" lang="en" >
 <head>
-  <meta charset="utf-8">
+  <meta charset="utf-8" />
 
-  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-  <title>About Multi-Armed Bandits &mdash; MABWiser 1.11.1 documentation</title>
+  <title>About Multi-Armed Bandits &mdash; MABWiser 1.12.0 documentation</title>
 
 
 
@@ -16,7 +16,10 @@
 
 
 
+
+
 
+
 
 
 
@@ -53,7 +56,7 @@
 
 
 
-            <a href="index.html" class="icon icon-home" alt="Documentation Home"> MABWiser
+            <a href="index.html" class="icon icon-home"> MABWiser
 
 
 
@@ -132,6 +135,8 @@
 
 
 
+
+
 <div role="navigation" aria-label="breadcrumbs navigation">
 
   <ul class="wy-breadcrumbs">
@@ -143,7 +148,7 @@
 
       <li class="wy-breadcrumbs-aside">
 
-            
+
             <a href="_sources/about.rst.txt" rel="nofollow"> View page source</a>
 
 
@@ -186,37 +191,29 @@
 
           </div>
           <footer>
-
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
-
-        <a href="installation.html" class="btn btn-neutral float-right" title="Installation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
-
-
-        <a href="index.html" class="btn btn-neutral float-left" title="MABWiser Contextual Multi-Armed Bandits" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
-
+        <a href="installation.html" class="btn btn-neutral float-right" title="Installation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="index.html" class="btn btn-neutral float-left" title="MABWiser Contextual Multi-Armed Bandits" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
     </div>
-
 
   <hr/>
 
   <div role="contentinfo">
     <p>
-
-        &copy; Copyright Copyright (C), FMR LLC
+        &#169; Copyright Copyright (C), FMR LLC.
 
     </p>
   </div>
 
 
 
-    Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
+    Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
 
-    <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
 
     provided by <a href="https://readthedocs.org">Read the Docs</a>. 
 
 </footer>
-
         </div>
       </div>