Skip to content

Commit

Permalink
Small updates in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
carloderamo committed Feb 2, 2021
1 parent c188503 commit 6db96d4
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@

# General information about the project.
project = u'MushroomRL'
copyright = u'2018, 2019, 2020 Carlo D\'Eramo, Davide Tateo'
copyright = u'2018, 2019, 2020, 2021 Carlo D\'Eramo, Davide Tateo'
author = u'Carlo D\'Eramo'

# The version info for the project you're documenting, acts as replacement for
Expand Down
19 changes: 10 additions & 9 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,17 @@ Reinforcement Learning python library
.. highlight:: python

MushroomRL is a Reinforcement Learning (RL) library that aims to be a simple, yet
powerful way to make **RL** and **deep RL** experiments. The idea behind Mushroom
consists in offering the majority of RL algorithms providing a common interface
powerful way to make **RL** and **deep RL** experiments. The idea behind MushroomRL
is to offer the majority of RL algorithms providing a common interface
in order to run them without excessive effort. Moreover, it is designed in such
a way that new algorithms and other stuff can generally be added transparently
without the need of editing other parts of the code. MushroomRL makes a large use
of the environments provided by
a way that new algorithms and other stuff can be added transparently,
without the need of editing other parts of the code. MushroomRL is compatible with RL
libraries like
`OpenAI Gym <https://gym.openai.com/>`_,
`DeepMind Control Suite <https://github.com/deepmind/dm_control>`_ and
`MuJoCo <http://www.mujoco.org/>`_ libraries, and
the `PyTorch <https://pytorch.org>`_ library for tensor computation.
`MuJoCo <http://www.mujoco.org/>`_, and
the `PyTorch <https://pytorch.org>`_ and `Tensorflow <https://www.tensorflow.org/>`_
libraries for tensor computation.

With MushroomRL you can:

Expand All @@ -31,8 +32,8 @@ With MushroomRL you can:
- use all RL environments offered by well-known libraries and build customized
environments as well;
- exploit regression models offered by Scikit-Learn or build a customized one
with PyTorch;
- run experiments on GPU.
with PyTorch or Tensorflow;
- seamlessly run experiments on CPU or GPU.

Basic run example
-----------------
Expand Down
2 changes: 1 addition & 1 deletion docs/source/tutorials/tutorials.0_experiments.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ state and action spaces. An agent can be defined this way:
.. literalinclude:: code/simple_experiment.py
:lines: 13-27

This piece of code creates the policy followed by the agent (e.g. :math:`\epsilon`-greedy)
This piece of code creates the policy followed by the agent (e.g. :math:`\varepsilon`-greedy)
with :math:`\varepsilon = 1`. Then, the policy approximator is created specifying the
parameters to create it and the class (in this case, the ``ExtraTreesRegressor`` class
of scikit-learn is used). Eventually, the agent is created calling the algorithm
Expand Down

0 comments on commit 6db96d4

Please sign in to comment.