[RLlib contrib] Fix rllib contrib readmes (ray-project#35347)

Signed-off-by: Avnish <avnishnarayan@gmail.com>
ShuN6211 · May 18, 2023 · 21d66e4 · 21d66e4
1 parent db97dda
commit 21d66e4
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 48 deletions.
diff --git a/rllib_contrib/a3c/README.md b/rllib_contrib/a3c/README.md
@@ -0,0 +1,17 @@
+# A3C (Asynchronous Advantage Actor-Critic)
+
+[A3C](https://arxiv.org/abs/1602.01783) is the asynchronous version of A2C, where gradients are computed on the workers directly after trajectory rollouts, and only then shipped to a central learner to accumulate these gradients on the central model. After the central model update, parameters are broadcast back to all workers. Similar to A2C, A3C scales to 16-32+ worker processes depending on the environment.
+
+
+## Installation
+
+```
+conda create -n rllib-a3c python=3.10
+conda activate rllib-a3c
+pip install -r requirements.txt
+pip install -e '.[development]'
+```
+
+## Usage
+
+[A3C Example](examples/a3c_cartpole_v1.py)
diff --git a/rllib_contrib/a3c/README.rst b/rllib_contrib/a3c/README.rst
diff --git a/rllib_contrib/maml/README.md b/rllib_contrib/maml/README.md
@@ -0,0 +1,23 @@
+# MAML (Model-Agnostic Meta-Learning for Fast Adaptation of Deep Networks)
+
+[MAML](https://arxiv.org/abs/1703.03400) is an on-policy meta RL algorithm. Unlike standard RL algorithms, which aim to maximize the sum of rewards into the future for a single task (e.g. HalfCheetah), meta RL algorithms seek to maximize the sum of rewards for *a given distribution of tasks*.
+
+On a high level, MAML seeks to learn quick adaptation across different tasks (e.g. different velocities for HalfCheetah). Quick adaptation is defined by the number of gradient steps it takes to adapt. MAML aims to maximize the RL objective for each task after `X` gradient steps. Doing this requires partitioning the algorithm into two steps. The first step is data collection. This involves collecting data for each task for each step of adaptation (from `1, 2, ..., X`). The second step is the meta-update step. This second step takes all the aggregated ddata from the first step and computes the meta-gradient.
+
+Code here is adapted from https://github.com/jonasrothfuss, which outperforms vanilla MAML and avoids computation of the higher order gradients during the meta-update step. MAML is evaluated on custom environments that are described in greater detail here.
+
+MAML uses additional metrics to measure performance; episode_reward_mean measures the agent’s returns before adaptation, episode_reward_mean_adapt_N measures the agent’s returns after N gradient steps of inner adaptation, and adaptation_delta measures the difference in performance before and after adaptation.
+
+
+## Installation
+
+```
+conda create -n rllib-maml python=3.10
+conda activate rllib-maml
+pip install -r requirements.txt
+pip install -e '.[development]'
+```
+
+## Usage
+
+[MAML Example](examples/cartpole_mass_maml.py)
diff --git a/rllib_contrib/maml/README.rst b/rllib_contrib/maml/README.rst