Skip to content

Commit

Permalink
Polish documents.
Browse files Browse the repository at this point in the history
  • Loading branch information
zjowowen committed Sep 27, 2024
1 parent 5c381aa commit 7cf37d8
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/source/tutorials/quick_start/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@ Quick Start
===========

Generative model in GenerativeRL
---------
--------------------------------

GenerativeRL support easy-to-use APIs for training and deploying generative model.
We provide a simple example of how to train a diffusion model on the swiss roll dataset in `Colab <https://colab.research.google.com/drive/18yHUAmcMh_7xq2U6TBCtcLKX2y4YvNyk?usp=drive_link>`_.

More usage examples can be found in the folder `grl_pipelines/tutorials/`.

Reinforcement Learning
------------
-----------------------

GenerativeRL provides a simple and flexible interface for training and deploying reinforcement learning agents powered by generative models. Here's an example of how to use the library to train a Q-guided policy optimization (QGPO) agent on the HalfCheetah environment and deploy it for evaluation.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/user_guide/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,5 +53,5 @@ Check whether the installation is successful by running the following command:

.. code-block:: bash
python -c "import generativerl"
python -c "import grl"
2 changes: 1 addition & 1 deletion docs/source/user_guide/training_agents.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
How to train and deploy reinforcement learning agents
-------------------------------------------------
-----------------------------------------------------

In GenerativeRL, the RL algorithms are implemented as a class under the ``grl.algorithms`` module, while the agents are implemented as a class under the ``grl.agents`` module.

Expand Down

0 comments on commit 7cf37d8

Please sign in to comment.