Skip to content

Commit

Permalink
Fixed docs errors
Browse files Browse the repository at this point in the history
- fixed wrong docs of parameters
- fixed errors in doc compilation
- deleted folders utils
  • Loading branch information
boris-il-forte committed Dec 7, 2023
1 parent 8d0be98 commit 1ae4000
Show file tree
Hide file tree
Showing 7 changed files with 113 additions and 129 deletions.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = 'en'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
Expand Down
13 changes: 10 additions & 3 deletions docs/source/features/mushroom_rl.features.tensors.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
Tensors
=======

Gaussian tensor
---------------
.. automodule:: mushroom_rl.features.tensors.constant_tensor
:members:
:private-members:
:show-inheritance:

.. automodule:: mushroom_rl.features.tensors.basis_tensor
:members:
:private-members:
:show-inheritance:

.. automodule:: mushroom_rl.features.tensors.gaussian_tensor
.. automodule:: mushroom_rl.features.tensors.random_fourier_tensor
:members:
:private-members:
:show-inheritance:
13 changes: 12 additions & 1 deletion docs/source/mushroom_rl.approximators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,20 @@ Regressor
:show-inheritance:


Approximator
Approximators
-------------

Tabular
~~~~~~~

.. automodule:: mushroom_rl.approximators.table
:members:
:private-members:
:inherited-members:
:show-inheritance:



Linear
~~~~~~

Expand Down
82 changes: 82 additions & 0 deletions docs/source/mushroom_rl.rl_utils.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
Eligibility trace
-----------------

.. automodule:: mushroom_rl.rl_utils.eligibility_trace
:members:
:private-members:
:inherited-members:
:undoc-members:
:show-inheritance:

Optimizers
----------

.. automodule:: mushroom_rl.rl_utils.optimizers
:members:
:private-members:
:inherited-members:
:undoc-members:
:show-inheritance:

Parameters
----------

.. automodule:: mushroom_rl.rl_utils.parameters
:members:
:private-members:
:inherited-members:
:show-inheritance:


Preprocessors
-------------

.. automodule:: mushroom_rl.rl_utils.preprocessors
:members:
:private-members:
:inherited-members:
:show-inheritance:

Replay memory
-------------

.. automodule:: mushroom_rl.rl_utils.replay_memory
:members:
:private-members:
:inherited-members:
:show-inheritance:

Running Statistics
------------------

.. automodule:: mushroom_rl.rl_utils.running_stats
:members:
:private-members:
:inherited-members:
:show-inheritance:

Spaces
------

.. automodule:: mushroom_rl.rl_utils.spaces
:members:
:show-inheritance:


Value Functions
---------------

.. automodule:: mushroom_rl.rl_utils.value_functions
:members:
:private-members:
:inherited-members:
:show-inheritance:

Variance parameters
-------------------

.. automodule:: mushroom_rl.rl_utils.variance_parameters
:members:
:private-members:
:inherited-members:
:show-inheritance:
80 changes: 4 additions & 76 deletions docs/source/mushroom_rl.utils.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,30 +8,6 @@ Angles
:members:
:show-inheritance:

Callbacks
---------

.. automodule:: mushroom_rl.utils.callbacks
:members:
:show-inheritance:

Dataset
-------

.. automodule:: mushroom_rl.utils.dataset
:members:
:show-inheritance:

Eligibility trace
-----------------

.. automodule:: mushroom_rl.utils.eligibility_trace
:members:
:private-members:
:inherited-members:
:undoc-members:
:show-inheritance:

Features
--------

Expand All @@ -41,14 +17,6 @@ Features
:inherited-members:
:show-inheritance:

Folder
------

.. automodule:: mushroom_rl.utils.folder
:members:
:private-members:
:inherited-members:
:show-inheritance:

Frames
------
Expand Down Expand Up @@ -79,50 +47,27 @@ Numerical gradient
:inherited-members:
:show-inheritance:

Parameters
----------

.. automodule:: mushroom_rl.utils.parameters
:members:
:private-members:
:inherited-members:
:show-inheritance:

Plots
-----

.. automodule:: mushroom_rl.utils.plots
.. automodule:: mushroom_rl.utils.plot
:members:
:private-members:
:inherited-members:
:show-inheritance:


Replay memory
-------------

.. automodule:: mushroom_rl.utils.replay_memory
:members:
:private-members:
:inherited-members:
:show-inheritance:

Spaces
Record
------

.. automodule:: mushroom_rl.utils.spaces
:members:
:show-inheritance:

Table
-----

.. automodule:: mushroom_rl.utils.table
.. automodule:: mushroom_rl.utils.record
:members:
:private-members:
:inherited-members:
:show-inheritance:


Torch
-----

Expand All @@ -132,23 +77,6 @@ Torch
:inherited-members:
:show-inheritance:

Value Functions
---------------

.. automodule:: mushroom_rl.utils.value_functions
:members:
:private-members:
:inherited-members:
:show-inheritance:

Variance parameters
-------------------

.. automodule:: mushroom_rl.utils.variance_parameters
:members:
:private-members:
:inherited-members:
:show-inheritance:

Viewer
------
Expand Down
8 changes: 4 additions & 4 deletions docs/source/tutorials/tutorials.3_deep.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,25 +27,25 @@ Now, we define useful functions, set some hyperparameters, and create the ``mdp`
and the policy ``pi``:

.. literalinclude:: code/dqn.py
:lines: 57-99
:lines: 55-97

Differently from the literature, we use ``Adam`` as the optimizer.

Then, the ``approximator``:

.. literalinclude:: code/dqn.py
:lines: 101-113
:lines: 99-111

Finally, the ``agent`` and the ``core``:

.. literalinclude:: code/dqn.py
:lines: 115-129
:lines: 113-127

Eventually, the learning loop is performed. As done in literature, learning and
evaluation steps are alternated:

.. literalinclude:: code/dqn.py
:lines: 131-158
:lines: 129-156

Solving MuJoCo with DDPG
------------------------
Expand Down
44 changes: 0 additions & 44 deletions mushroom_rl/utils/folder.py

This file was deleted.

0 comments on commit 1ae4000

Please sign in to comment.