Skip to content

Commit

Permalink
Update tutorials.md
Browse files Browse the repository at this point in the history
  • Loading branch information
btjanaka committed Dec 16, 2023
1 parent ca0e72c commit 509e15b
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions docs/tutorials.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ may be [run locally](running-locally) or on
[Google Colab](https://colab.research.google.com/notebooks/intro.ipynb). Each
tutorial page has a link to open the tutorial in Google Colab.

## Key Algorithms
## Algorithms

```{toctree}
:hidden:
Expand All @@ -15,16 +15,19 @@ tutorials/cma_mae
tutorials/tom_cruise_dqd
```

We recommend new users start with these tutorials which demonstrate how to use
the key algorithms in pyribs.
These tutorials demonstrate how to use the key algorithms in pyribs. We
recommend that new users start with the lunar lander tutorial and one or more of
the other algorithm tutorials.

- {doc}`tutorials/lunar_lander`: Covers the CMA-ME algorithm and various basic
library features.
- {doc}`tutorials/lunar_lander`: Our introductory tutorial. Covers the CMA-ME
algorithm and various basic library features.
- {doc}`tutorials/cma_mae`: Shows how to implement CMA-MAE, a powerful algorithm
built on CMA-ME, on the sphere linear projection benchmark.
- {doc}`tutorials/tom_cruise_dqd`: Covers CMA-MEGA and CMA-MAEGA, two algorithms
designed for differentiable quality diversity problems (QD problems where
gradients are available).
- {doc}`tutorials/scalable_cma_mae`: How to use variants of CMA-MAE that scale
to thousands or even millions of parameters.

## Applications

Expand Down

0 comments on commit 509e15b

Please sign in to comment.