update documentation

tojo-soraai · Apr 6, 2020 · a418968 · a418968
1 parent c73da03
commit a418968
Show file tree

Hide file tree

Showing 7 changed files with 37 additions and 28 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -32,6 +32,8 @@ that in mind, don't just read the docs -- read the source!
 
    numpy_ml.ngram
 
+   numpy_ml.bandits
+
    numpy_ml.rl_models
 
    numpy_ml.nonparametric

diff --git a/docs/numpy_ml.bandits.bandits.rst b/docs/numpy_ml.bandits.bandits.rst
@@ -1,31 +1,39 @@
 Bandit Environments
 ===================
 
-``MultiArmedBanditMultinomialPayoff``
------------------------------------
-.. autoclass:: numpy_ml.bandits.bandits.MultiArmedBanditMultinomialPayoff
+``Bandit``
+-----------
+.. autoclass:: numpy_ml.bandits.bandits.Bandit
     :members:
     :undoc-members:
     :inherited-members:
 
-``MultiArmedBanditBernoulliPayoff``
------------------------------------
-.. autoclass:: numpy_ml.bandits.bandits.MultiArmedBanditBernoulliPayoff
+
+``MABMultinomialPayoff``
+-------------------------
+.. autoclass:: numpy_ml.bandits.MABMultinomialPayoff
     :members:
     :undoc-members:
-    :inherited-members:
+    :show-inheritance:
 
+``MABBernoulliPayoff``
+-----------------------
+.. autoclass:: numpy_ml.bandits.MABBernoulliPayoff
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
-``MultiArmedBanditGaussianPayoff``
------------------------------------
-.. autoclass:: numpy_ml.bandits.bandits.MultiArmedBanditGaussianPayoff
+
+``MABGaussianPayoff``
+----------------------
+.. autoclass:: numpy_ml.bandits.MABGaussianPayoff
     :members:
     :undoc-members:
-    :inherited-members:
+    :show-inheritance:
 
-``ShortestPathBandit``
------------------------
-.. autoclass:: numpy_ml.bandits.bandits.ShortestPathBandit
+``MABShortestPath``
+--------------------
+.. autoclass:: numpy_ml.bandits.MABShortestPath
     :members:
     :undoc-members:
-    :inherited-members:
+    :show-inheritance:
diff --git a/docs/numpy_ml.bandits.policies.rst b/docs/numpy_ml.bandits.policies.rst
@@ -13,18 +13,18 @@ Policies
 .. autoclass:: numpy_ml.bandits.policies.EpsilonGreedy
     :members:
     :undoc-members:
-    :inherited-members:
+    :show-inheritance:
 
 ``UCB1``
 --------
 .. autoclass:: numpy_ml.bandits.policies.UCB1
     :members:
     :undoc-members:
-    :inherited-members:
+    :show-inheritance:
 
 ``ThompsonSamplingBetaBinomial``
 --------------------------------
 .. autoclass:: numpy_ml.bandits.policies.ThompsonSamplingBetaBinomial
     :members:
     :undoc-members:
-    :inherited-members:
+    :show-inheritance:
diff --git a/docs/numpy_ml.rl_models.rl_utils.rst b/docs/numpy_ml.rl_models.rl_utils.rst
@@ -0,0 +1,6 @@
+Utilities 
+=========
+
+.. automodule:: numpy_ml.rl_models.rl_utils
+    :members:
+    :inherited-members:
diff --git a/docs/numpy_ml.rl_models.rst b/docs/numpy_ml.rl_models.rst
@@ -8,6 +8,6 @@ Reinforcement learning
 
    numpy_ml.rl_models.trainer
 
-   numpy_ml.rl_models.utils
+   numpy_ml.rl_models.rl_utils
 
    numpy_ml.rl_models.tiles
diff --git a/docs/numpy_ml.rl_models.utils.rst b/docs/numpy_ml.rl_models.utils.rst
diff --git a/docs/numpy_ml.utils.graphs.rst b/docs/numpy_ml.utils.graphs.rst
@@ -20,14 +20,14 @@ Graphs
 .. autoclass:: numpy_ml.utils.graphs.DiGraph
     :members:
     :undoc-members:
-    :inherited-members:
+    :show-inheritance:
 
 ``UndirectedGraph``
 -------------------
 .. autoclass:: numpy_ml.utils.graphs.UndirectedGraph
     :members:
     :undoc-members:
-    :inherited-members:
+    :show-inheritance:
 
 ``random_unweighted_graph``
 ---------------------------