Skip to content

Commit bf211c0

Browse files
authored
Merge pull request #1 from ddbourgin/master
update forks
2 parents 91efa09 + 24c8c76 commit bf211c0

29 files changed

+1584
-16
lines changed

docs/index.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ The purpose of the project is to provide reference implementations of common
77
machine learning components for rapid prototyping and experimentation. With
88
that in mind, don't just read the docs -- read the source!
99

10-
.. _numpy-ml: http://www.github.com/ddbourgin/numpy-ml
11-
.. _NumPy: http://numpy.scipy.org/
10+
.. _numpy-ml: https://www.github.com/ddbourgin/numpy-ml
11+
.. _NumPy: https://numpy.org/
1212
.. _standard library: https://docs.python.org/3/library/
1313

1414
.. topic:: This documentation is under development!
@@ -32,6 +32,8 @@ that in mind, don't just read the docs -- read the source!
3232

3333
numpy_ml.ngram
3434

35+
numpy_ml.bandits
36+
3537
numpy_ml.rl_models
3638

3739
numpy_ml.nonparametric

docs/numpy_ml.bandits.bandits.rst

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
Bandit Environments
2+
===================
3+
4+
``Bandit``
5+
-----------
6+
.. autoclass:: numpy_ml.bandits.bandits.Bandit
7+
:members:
8+
:undoc-members:
9+
:inherited-members:
10+
11+
12+
``MABMultinomialPayoff``
13+
-------------------------
14+
.. autoclass:: numpy_ml.bandits.MABMultinomialPayoff
15+
:members:
16+
:undoc-members:
17+
:show-inheritance:
18+
19+
``MABBernoulliPayoff``
20+
-----------------------
21+
.. autoclass:: numpy_ml.bandits.MABBernoulliPayoff
22+
:members:
23+
:undoc-members:
24+
:show-inheritance:
25+
26+
27+
``MABGaussianPayoff``
28+
----------------------
29+
.. autoclass:: numpy_ml.bandits.MABGaussianPayoff
30+
:members:
31+
:undoc-members:
32+
:show-inheritance:
33+
34+
``MABShortestPath``
35+
--------------------
36+
.. autoclass:: numpy_ml.bandits.MABShortestPath
37+
:members:
38+
:undoc-members:
39+
:show-inheritance:

docs/numpy_ml.bandits.policies.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
Policies
2+
=========
3+
4+
``BanditPolicyBase``
5+
--------------------
6+
.. autoclass:: numpy_ml.bandits.policies.BanditPolicyBase
7+
:members:
8+
:undoc-members:
9+
:inherited-members:
10+
11+
``EpsilonGreedy``
12+
-----------------
13+
.. autoclass:: numpy_ml.bandits.policies.EpsilonGreedy
14+
:members:
15+
:undoc-members:
16+
:show-inheritance:
17+
18+
``UCB1``
19+
--------
20+
.. autoclass:: numpy_ml.bandits.policies.UCB1
21+
:members:
22+
:undoc-members:
23+
:show-inheritance:
24+
25+
``ThompsonSamplingBetaBinomial``
26+
--------------------------------
27+
.. autoclass:: numpy_ml.bandits.policies.ThompsonSamplingBetaBinomial
28+
:members:
29+
:undoc-members:
30+
:show-inheritance:

docs/numpy_ml.bandits.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Multi-armed bandits
2+
###################
3+
4+
.. toctree::
5+
:maxdepth: 3
6+
7+
numpy_ml.bandits.bandits
8+
9+
numpy_ml.bandits.policies
10+
11+
numpy_ml.bandits.trainer
12+

docs/numpy_ml.bandits.trainer.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Trainer
2+
=======
3+
4+
``MABTrainer``
5+
--------------
6+
.. autoclass:: numpy_ml.bandits.trainer.MABTrainer
7+
:members:
8+
:undoc-members:
9+
:inherited-members:
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Utilities
2+
=========
3+
4+
.. automodule:: numpy_ml.rl_models.rl_utils
5+
:members:
6+
:inherited-members:

docs/numpy_ml.rl_models.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ Reinforcement learning
88

99
numpy_ml.rl_models.trainer
1010

11-
numpy_ml.rl_models.utils
11+
numpy_ml.rl_models.rl_utils
1212

1313
numpy_ml.rl_models.tiles

docs/numpy_ml.rl_models.utils.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/numpy_ml.utils.graphs.rst

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
Graphs
2+
======
3+
4+
``Graph``
5+
---------
6+
.. autoclass:: numpy_ml.utils.graphs.Graph
7+
:members:
8+
:undoc-members:
9+
:inherited-members:
10+
11+
``Edge``
12+
--------
13+
.. autoclass:: numpy_ml.utils.graphs.Edge
14+
:members:
15+
:undoc-members:
16+
:inherited-members:
17+
18+
``DiGraph``
19+
-----------
20+
.. autoclass:: numpy_ml.utils.graphs.DiGraph
21+
:members:
22+
:undoc-members:
23+
:show-inheritance:
24+
25+
``UndirectedGraph``
26+
-------------------
27+
.. autoclass:: numpy_ml.utils.graphs.UndirectedGraph
28+
:members:
29+
:undoc-members:
30+
:show-inheritance:
31+
32+
``random_unweighted_graph``
33+
---------------------------
34+
35+
.. autofunction:: numpy_ml.utils.graphs.random_unweighted_graph
36+
37+
``random_DAG``
38+
--------------
39+
40+
.. autofunction:: numpy_ml.utils.graphs.random_DAG

docs/numpy_ml.utils.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ Utilities
88

99
numpy_ml.utils.distance_metrics
1010

11+
numpy_ml.utils.graphs
12+
1113
numpy_ml.utils.kernels
1214

1315
numpy_ml.utils.windows

0 commit comments

Comments
 (0)