Skip to content

Commit aaa0ae1

Browse files
author
ddbourgin
committed
expand documentation
1 parent 0182546 commit aaa0ae1

6 files changed

+26
-41
lines changed

docs/numpy_ml.bandits.bandits.rst

+23-9
Original file line numberDiff line numberDiff line change
@@ -9,31 +9,45 @@ Bandit Environments
99
:inherited-members:
1010

1111

12-
``MABMultinomialPayoff``
12+
``MultinomialBandit``
1313
-------------------------
14-
.. autoclass:: numpy_ml.bandits.MABMultinomialPayoff
14+
.. autoclass:: numpy_ml.bandits.MultinomialBandit
1515
:members:
1616
:undoc-members:
1717
:show-inheritance:
1818

19-
``MABBernoulliPayoff``
19+
``BernoulliBandit``
2020
-----------------------
21-
.. autoclass:: numpy_ml.bandits.MABBernoulliPayoff
21+
.. autoclass:: numpy_ml.bandits.BernoulliBandit
2222
:members:
2323
:undoc-members:
2424
:show-inheritance:
2525

2626

27-
``MABGaussianPayoff``
27+
``GaussianBandit``
2828
----------------------
29-
.. autoclass:: numpy_ml.bandits.MABGaussianPayoff
29+
.. autoclass:: numpy_ml.bandits.GaussianBandit
3030
:members:
3131
:undoc-members:
3232
:show-inheritance:
3333

34-
``MABShortestPath``
35-
--------------------
36-
.. autoclass:: numpy_ml.bandits.MABShortestPath
34+
``ShortestPathBandit``
35+
-----------------------
36+
.. autoclass:: numpy_ml.bandits.ShortestPathBandit
37+
:members:
38+
:undoc-members:
39+
:show-inheritance:
40+
41+
``ContextualBernoulliBandit``
42+
------------------------------
43+
.. autoclass:: numpy_ml.bandits.ContextualBernoulliBandit
44+
:members:
45+
:undoc-members:
46+
:show-inheritance:
47+
48+
``ContextualLinearBandit``
49+
------------------------------
50+
.. autoclass:: numpy_ml.bandits.ContextualLinearBandit
3751
:members:
3852
:undoc-members:
3953
:show-inheritance:

docs/numpy_ml.bandits.trainer.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
Trainer
22
=======
33

4-
``MABTrainer``
5-
--------------
6-
.. autoclass:: numpy_ml.bandits.trainer.MABTrainer
4+
``BanditTrainer``
5+
------------------
6+
.. autoclass:: numpy_ml.bandits.trainer.BanditTrainer
77
:members:
88
:undoc-members:
99
:inherited-members:

docs/numpy_ml.neural_nets.models.vae.rst

-9
This file was deleted.

docs/numpy_ml.neural_nets.models.w2v.rst

-9
This file was deleted.

docs/numpy_ml.neural_nets.models.wgan_gp.rst

-9
This file was deleted.

docs/numpy_ml.rl_models.rst

-2
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,3 @@ Reinforcement learning
99
numpy_ml.rl_models.trainer
1010

1111
numpy_ml.rl_models.rl_utils
12-
13-
numpy_ml.rl_models.tiles

0 commit comments

Comments
 (0)