Commit 507ba06b authored by Steven Cordwell's avatar Steven Cordwell

Add directives to module docstrings

Link to the modules, classes or functions that each module provides in
the module level docstring.
parent e074075f
......@@ -7,11 +7,12 @@ descrete-time Markov Decision Processes.
Available modules
-----------------
example
:mod:`~mdptoolbox.example`
Examples of transition and reward matrices that form valid MDPs
mdp
:mod:`~mdptoolbox.mdp`
Makov decision process algorithms
util
:mod:`~mdptoolbox.util`
Functions for validating and working with an MDP
How to use the documentation
......
......@@ -7,10 +7,13 @@ reward matrices.
Available functions
-------------------
forest
:func:`~mdptoolbox.example.forest`
A simple forest management example
rand
:func:`~mdptoolbox.example.rand`
A random example
:func:`~mdptoolbox.example.small`
A very small example
"""
......
......@@ -7,21 +7,21 @@ Decision Processes.
Available classes
-----------------
MDP
:class:`~mdptoolbox.mdp.MDP`
Base Markov decision process class
FiniteHorizon
:class:`~mdptoolbox.mdp.FiniteHorizon`
Backwards induction finite horizon MDP
PolicyIteration
:class:`~mdptoolbox.mdp.PolicyIteration`
Policy iteration MDP
PolicyIterationModified
:class:`~mdptoolbox.mdp.PolicyIterationModified`
Modified policy iteration MDP
QLearning
:class:`~mdptoolbox.mdp.QLearning`
Q-learning MDP
RelativeValueIteration
:class:`~mdptoolbox.mdp.RelativeValueIteration`
Relative value iteration MDP
ValueIteration
:class:`~mdptoolbox.mdp.ValueIteration`
Value iteration MDP
ValueIterationGS
:class:`~mdptoolbox.mdp.ValueIterationGS`
Gauss-Seidel value iteration MDP
"""
......
......@@ -8,17 +8,18 @@ solved.
Available functions
-------------------
check
:func:`~mdptoolbox.util.check`
Check that an MDP is properly defined
checkSquareStochastic
:func:`~mdptoolbox.util.checkSquareStochastic`
Check that a matrix is square and stochastic
getSpan
:func:`~mdptoolbox.util.getSpan`
Calculate the span of an array
isNonNegative
:func:`~mdptoolbox.util.isNonNegative`
Check if a matrix has only non-negative elements
isSquare
:func:`~mdptoolbox.util.isSquare`
Check if a matrix is square
isStochastic
:func:`~mdptoolbox.util.isStochastic`
Check if a matrix is row stochastic
"""
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment