Feature/lingreedy (#52)

fidelity · Mar 9, 2022 · e03d242 · e03d242
1 parent 27f1637
commit e03d242
Show file tree

Hide file tree

Showing 27 changed files with 1,080 additions and 171 deletions.
diff --git a/CHANGELOG.txt b/CHANGELOG.txt
@@ -2,6 +2,12 @@
 MABWiser CHANGELOG
 =====================
 
+March, 8, 2022 2.3.0
+-------------------------------------------------------------------------------
+major:
+- New Algorithm: LinGreedy as a learning policy.
+- Thanks to Yevgeny Popkov for suggesting this algorithm.
+
 -------------------------------------------------------------------------------
 March, 2, 2022 2.2.0
 -------------------------------------------------------------------------------

diff --git a/README.md b/README.md
@@ -36,6 +36,7 @@ mab.predict()
 
 Available Learning Policies:
 * Epsilon Greedy [1, 2]
+* LinGreedy [1, 2]
 * LinTS [3]
 * LinUCB [4]
 * Popularity [2]

diff --git a/docs/.buildinfo b/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: 0c40804aec5172c7d3aad80d6f786052
+config: be8d7ae06467e3a22a202d69cb2b24ab
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -56,6 +56,7 @@ Available Bandit Policies
 Available Learning Policies:
 
 * Epsilon Greedy
+* LinGreedy
 * LinTS
 * LinUCB
 * Popularity
@@ -81,32 +82,32 @@ Citation
 ========
 You can cite MABWiser as:
 
-* **[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)
+* **[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
 
-       @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},
+    @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},
+        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},
     }
 
 

diff --git a/docs/_sources/new_bandit.rst.txt b/docs/_sources/new_bandit.rst.txt
@@ -274,6 +274,8 @@ Every test starts with the ``test_`` prefix followed by some descriptive name.
 To strengthen your test suite, consider other unittests with different number of arms,
 decisions and rewards to assert that your bandit behaves correctly.
 
+Add corresponding unittests in ``test_invalid.py`` to validate the parameters that are passed to your ``_MyCoolPolicy`` class.
+
 **Congratulations!!** You are now ready to share your new cool policy with everyone. Next, let's send a pull request for code review.
 
 4. Sending a Pull Request

diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '2.2.0',
+    VERSION: '2.3.0',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/about.html b/docs/about.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>About Multi-Armed Bandits &mdash; MABWiser 2.2.0 documentation</title>
+  <title>About Multi-Armed Bandits &mdash; MABWiser 2.3.0 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>